Table of Contents

Classes

• AResourceDescription Parse and Store <AResDesc> element of ResourceSheet.
• AbstractUISocketElement This class is the interface used for creating UI Socket Element Objects.
• CommonUtilities CommonUtilities class is a Utility class which provides following functionality.
• CompatibleUI Stores relative information for getting Compatible UIs.
• Constants Defines Constant values.
• ControllerProfileManager Provide the Controller Profile.
• Encryption It provide custom encryption algorithm.
• FileUtil Provide methods to create and copy files and directory.
• GetDocumentRequestHandler Handle the GetDocument request.
• IBonjour Interface class for Bonjour Server
• IRUIServer Interface class for RUIServer
• ITA TA (Target Adapter) is the link inbetween UCH and final proprietory Target.
• ITAListener ITAListener receives calls from TA.
• ITDM ITDM is responsible for Discovering & Discarding of the devices from the network and forwards call to ITDMListener.
• ITDMListener ITDMListener receives calls from TDM.
• IUCHStore In some cases two different modules (UIPMs, TDMs, TAs) may wish to share data with each other.
• IUIPM UIPM - User Interface Protocol Module, takes care of communication from the end-client to the UCH.
• IUIPMListener IUIPMListener receives calls from UIPM.
• LocalResourceManager Parse all ucf(UCH Config File) files from specific location.
• LocalUploadManager Provide methods to upload resources locally
• Logger Creates a project-wide logger with handlers and formatters.
• MemoryHandler This class gives idea about the memory usage by UCHe.
• OpenUserContextAction Provide method to open user context.
• PathExtractUtility PathExtractUtility is utility single-ton class for obtaining necessary data for given a path of elements.
• Profile Provide the implementation of IProfile.
• PropertyModifier Provide methods to modify resource properties.
• PropertyValidator Provide methods to validate properties.
• Protocol Stores the information for the Protocol to be displayed as Compatible UIs
• ResServerUploadManager Provide Method to Upload Resources to Resource Server.
• ResourceContext Parse and Store childNodes and attributes of <Context> Element of <AResDesc> Element of ResourceSheet and provide methods to retrieve its properties.
• ResourceDetails Maintains the resource detail of already downloaded resource
• ResourceDirectory Parse ResourceSheet and provide method for getting matched Resource.
• ResourceFilter Provide method to filter specific kind of resources.
• ResourceManager Manage Resources for discovered targets and provide methods to retrieve matched Resources.
• ResourceSheet Parse Resource Sheet File(rsheet) and provide methods to retrieve matched Resource.
• ResourceSheetManager Handle all request for managing Atomic(Resource Sheet) Resources.
• ResourceSheetProperties Store Resource Sheet Properties like localAt, conformsTo, type, aResDescForDomain, forLang and role.
• ResourceStore Provide a Store to save local resources.
• ResourceUtil Provide methods to use information from resource properties.
• RetrievalManager Retrieve the resource from given resource properties map or directly from given URL
• ServerSocket This is basic class acting as TCP-IP Server
• Session It maintains the State of Socket Elements and provides methods to Set/Retrieve Values/State of Socket Elements.
• Socket This is basic class acting as TCP-IP Server
• SocketDescription Parses the UI Socket Description file and stores all the Elements and makes Socket Document information accessible.
• SocketException Socket exception in case of TCP-IP error
• SocketUtilities SocketUtilities class is a Utility class which provides following functionality.
• TAException This allows developers to distinguish TA exception from other exceptions.
• TAFatalException This allows developers to distinguish TA Fatal exceptions from other exceptions.
• TAListener Implements the methods of ITAListener.
• TANotImplementedException This class allows developers to distinguish TANotImplemented Exception from other exceptions.
• TDMFatalException TDMFatalException is thrown by the TDM.
• TDMListener Implements the methods of ITDMListener.
• TargetDescription Parses the Target Description file and provides access to the components contained within.
• TargetDetail Stores information like targetId, targetName and target properties related to targets.
• UCH It implements IUIPMListener and delegates the call from IUIPM to TargetListener and vice-versa.
• UCHConfigUtil Utilities provided for the UCH.
• UCHException This allows developers to distinguish UIPM Fatal exceptions from other exceptions.
• UCHLocalStore Maintain the Store and provide methods to get/set information.
• UCHNotImplementedException This allows developers to distinguish UCH exceptions from other exceptions.
• UCHUtil Utilities provided for the UCH.
• UIPMFatalException This allows developers to distinguish UIPM Fatal exceptions from other exceptions.
• UIPMListener Implements the methods of UIPMListener.
• UIServiceHandler Provide methods for add/remove/get CompatibleUIs.
• UISocketBasicCommand UISocketBasicCommand is a variant of UISocketCommand.
• UISocketCommand UISocketCommand is the command variant of UISocketElement.
• UISocketCommandParam Maintains 'param' Element of 'Command' of the Socket Description File.
• UISocketNotification UISocketNotification is the notification variant of UISocketElement.
• UISocketSet UISocketSet is the variant of UISocketElement.
• UISocketTimedCommand UISocketTimedCommand is a variant of UISocketCommand.
• UISocketVariable UISocketVariable is the variable variant of UISocketElement.
• UISocketVoidCommand UISocketVoidCommand is a variant of UISocketCommand.
• UcfFileParser Provide methods to parse UCH Config File.
• UcfFileUtil Provide method to create and write data to file.
• UploadManager Provide methods to upload resources locally and on resource server.
• UserContextManager Manage contexts, contexts for targets and contexts for URI.
• UserProfile Store values like 'userName', 'password' and 'IProfile' of user and provides methods to get their values.
• UserProfileManager Manage user profiles and provides methods to get it.
• UserProfileParser Provide methods to parse User Profile File.
• UserValidation This will valid the username and password for UCH users.

Macros

• _CONSTANTS_H
• _ITA_H
• _LOGGERUTIL_H
• _MEMORYHANDLER_H
• _RESOURCEDIRECTORY_H
• _RESOURCESHEETPROPERTIES_H
• _UCHUTIL_H

Enums, Unions, Structs

• SocketElementList It's Link List Object which maintains the List of SocketElements.
• cmdParamStruct Stores the list of the UISocketCommandParam.
• dimCmdStruct Stores the cloned copy of the UISocketCommand for dimensional purposeIf UISocketVariable Element is Non-dimentional then pointer dimCmdStruct is NULL.
• dimNotifyStruct Stores the cloned copy of the UISocketNotifications for dimensional purposeIf UISocketNotification Element is Non-dimentional then pointer dimVarNotify is NULL.
• dimSetStruct Stores the cloned copy of the UISocketSet for dimensional purposeIf UISocketSet Element is Non-dimentional then pointer dimSetStruct is NULL.
• dimVarStruct Stores the cloned copy of the UISocketVariables for dimensional purposeIf UISocketVariable Element is Non-dimentional then pointer dimVarStruct is NULL.

Hierarchy of classes