C# Client Introduction

Introduction

C# Client is a class libary running on Windows .NET Framework. It enables applications that can use .NET Framework libraries to handle its globalization easily.

Features in C# Client

• Getting the translation.
• Getting messages by cache interfaces.
• Getting configuration content.
• Enrich implementations by extending different extension interfaces.

APIs Available

• Factory Class
  • I18N
• Interface For Configuration
  • IConfig
  • IConfigItem
• Interface For Release
  • IRelease
• Interface For Translation
  • ITranslation
  • ISource
• Interface For Cache Messages
  • IReleaseMessages
  • ILocaleMessages
  • IComponentMessages
• Interface For Extension
  • IExtension
  • ICacheManager
  • ICacheComponentManager
  • ICacheMessages
  • ILog
  • IResourceParser
  • IAccessService

Factory Class

I18N

• It’s the factory class that creates and initializes the configuration object and the release object.

public sealed class I18N
{
    public static IConfig LoadConfig(string resourceBaseName, Assembly assembly, string configResourceName);
    public static IConfig GetConfig(string product, string version);
    public static IRelease GetRelease(IConfig config);
    public static IExtension GetExtension();
}

I18N / LoadConfig

• Load a configuration json or yaml text from the resource defined by a resx file and initialize a correspondent release object.

I18N / GetConfig

• Get a loaded configuration object by product and version.

I18N / GetRelease

• Get the release object initialized by a configuration object.

I18N / GetExtension

• Get the extension interface to change ways of implementation.

Interface For Configuration

IConfig

public interface IConfig
{
    IConfigItem GetItem(string key);
    List<string> GetComponentList();
    IConfigItem GetComponentAttribute(string component, string key);
    List<string> GetLocaleList(string component);
    IConfigItem GetLocaleAttribute(string component, string locale, string key);
    string ReadResourceText(string resourceBaseName, string resourceName);
    Hashtable ReadResourceMap(string resourceName, string format, string locale);
}

IConfig / GetItem

• Get the definition item by key.

IConfig / GetComponentList

• Get the component list.

IConfig / GetComponentAttribute

• Get the definition item of an attribute of the component.

IConfig / GetLocaleList

• Get the defined locale list of a component.

IConfig / GetLocaleAttribute

• Get the definition item of an attribute of the locale information for a component.

IConfig / ReadResourceText

• Read a text from the Assembly resource.

IConfig / ReadResourceMap

• Read a key-value map from a resx resource.

IConfigItem

public interface IConfigItem
{
    string GetString();
    List<string> GetStringList();
    bool GetBool();
    int GetInt();
    IConfigItem GetMapItem(string key);
    List<string> GetArrayItemList(string key);
    IConfigItem GetArrayItem(string key, string value);
}

IConfigItem / GetString

• Get string value of the configuration item.

IConfigItem / GetStringList

• Get string list of the configuration item.

IConfigItem / GetBool

• Get boolean value of the configuration item.

IConfigItem / GetInt

• Get integer value of the configuration item.

IConfigItem / GetMapItem

• Read the child configuration item by a key.

IConfigItem / GetArrayItemList

• Get a string list from the configuration child item array by a key.

IConfigItem / GetArrayItem

• Read the child configuration item by a key and its correspondent value from a configuration item array.

Interface For Release

IRelease

public interface IRelease
{
    IConfig GetConfig();
    IReleaseMessages GetMessages();
    ITranslation GetTranslation();
}

IRelease / GetConfig

• Get the configuration object owned the release object.

IRelease / GetMessages

• Get the configuration object owned by the release object.

IRelease / GetTranslation

• Get the interface to access translation.

Interface For Translation

ITranslation

public interface ITranslation
{
    ISource CreateSource(string component, string key, string source = null, string comment = null);
    string GetString(string locale, ISource source);
    string GetString(string component, string key, string source = null, string comment = null);
    string Format(string locale, ISource source, params object[] objects);
    bool SetCurrentLocale(string locale);
    string GetCurrentLocale();
    string GetLocaleSupported(string locale);
}

ITranslation / CreateSource

• Create a source object for other methods.

ITranslation / GetString

• Get translation message.

ITranslation / GetString

• Get translation message according to current locale.

ITranslation / Format

• Get translation message according to the format.

ITranslation / SetCurrentLocale

• Set current locale.

ITranslation / GetCurrentLocale

• Get current locale.

ITranslation / GetLocaleSupported

• Get supported or nearest locale of the locale.

ISource

public interface ISource
{
    string GetComponent();
    string GetKey();
    string GetSource();
    string GetComment();
}

Interface For Cache Messages

IReleaseMessages

public interface IReleaseMessages
{
    List<string> GetLocaleList();
    List<string> GetComponentList();
    ILocaleMessages GetLocaleMessages(string locale, bool asSource = false);
    Dictionary<string, ILocaleMessages> GetAllLocaleMessages();
}

IReleaseMessages / GetLocaleList

• Get the locale list of release messages.

IReleaseMessages / GetComponentList

• Get the component list of release messages.

IReleaseMessages / GetLocaleMessages

• Get the locale messagess from release messages by locale.

IReleaseMessages / GetAllLocaleMessages

• Get all locale messagess of the release messages that don’t include source.

ILocaleMessages

public interface ILocaleMessages
{
    string GetLocale();
    List<string> GetComponentList();
    IComponentMessages GetComponentMessages(string component);
    string GetString(string component, string key);
}

ILocaleMessages / GetLocale

• Get locale of the messages.

ILocaleMessages / GetComponentList

• Get the component list of locale messages.

ILocaleMessages / GetComponentMessages

• Get the component messagess from locale messages by component.

ILocaleMessages / GetString

• Get the message from locale messages by component and key.

IComponentMessages

public interface IComponentMessages
{
    void SetString(string key, string message);
    string GetString(string key);
    ICollection GetKeys();
    int GetCount();
    string GetLocale();
    string GetComponent();
    void SetResourcePath(string resourcePath);
    string GetResourcePath();
    void SetResourceType(string resourceType);
    string GetResourceType();
}

IComponentMessages / SetString

• Set message of the key.

IComponentMessages / GetString

• Get the message from component messages by key.

IComponentMessages / GetKeys

• Get all keys of component messages.

IComponentMessages / GetCount

• Get count of messages.

IComponentMessages / GetLocale

• Get locale of component messages.

IComponentMessages / GetComponent

• Get component name of component messages.

IComponentMessages / SetResourcePath

• Set resource path where stores the component messages.

IComponentMessages / GetResourcePath

• Get resource path where stores the component messages.

IComponentMessages / SetResourceType

• Set resource type which is used to know how the resource is stored and what parser to select.

IComponentMessages / GetResourceType

• Get resource type.

Interface For Extension

IExtension

public interface IExtension
{
    void RegisterCacheManager(ICacheManager cacheManager, string cacheManagerName);
    void RegisterCacheComponentManager(ICacheComponentManager cacheComponentManager,
        string cacheComponentManagerName);
    void RegistertLogger(ILog logger, string loggerName);
    void RegisterResourceParser(IResourceParser parser, string parserName);
    void RegisterAccessService(IAccessService accessService, string accessName);
}

IExtension / RegisterCacheManager

• Register cache manager object with its name.

IExtension / RegisterCacheComponentManager

• Register component cache manager object with its name.

IExtension / RegistertLogger

• Register a logger with its name.

IExtension / RegisterResourceParser

• Register a resource parser with its name.

IExtension / RegisterAccessService

• Register an accessing service object with its name.

ICacheManager

public interface ICacheManager
{
    ICacheMessages GetReleaseCache(string product, string version);
}

ICacheManager / GetReleaseCache

• Get the release cache by product and version.

ICacheMessages

public interface ICacheMessages
{
    ILocaleMessages GetLocaleMessages(string locale, bool asSource = false);
}

ICacheMessages / GetLocaleMessages

• Get the locale messages from the release cache.

ICacheComponentManager

public interface ICacheComponentManager
{
    IComponentMessages NewComponentCache(string locale, string component);
}

ICacheComponentManager / NewComponentCache

• Create a new component messages object.

ILog

public interface ILog
{
    void Log(LogType logType, string text);
}

ILog / Log

• Log a string with a type.

LogType

public enum LogType
{
    Debug,
    Info,
    Warning,
    Error,
    None
}

IResourceParser

public interface IResourceParser
{
    Hashtable Parse(string text);
}

IResourceParser / Parse

• Parse a text into a key-value map.

IAccessService

public interface IAccessService
{
    string HttpGet(string url, Hashtable headers);
    string HttpPost(string url, string text, Hashtable headers);
}

IAccessService / HttpGet

• Get data from http service.

IAccessService / HttpPost

• Send data to http service.