class UCH

It implements IUIPMListener and delegates the call from IUIPM to TargetListener and vice-versa.

Public Methods

UCH()

Default Constructor Instantiates TargetListener and other local variables

static UCH* getInstance()

Returns an Instance of UCH.

map<string, void *> * getTargetProps(string targetId)

Get the target Properties for the specified targetId.

string getTargetName(string targetId)

Get the name of a target for the specified targetId.

list<string> * getSocketNames(string targetName)

Returns List of socket Names for the specified Target Name.

map<string, string> * openSessionRequest(string targetId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* contexts)

Request for opening a session with the specified target and socket.

string targetDiscovered(map<string, void*>*targetProps, map<string, string>*taProps, list<map<string, IProfile*>*>* contexts)

Call the same method on TAListener.

void targetDiscarded(string targetId)

Called when any existing target is Discarded from the network.

map<string, list<string>*> * setValuesRequest(string sessionId, list<string>* paths, list<string>* operations, list<string>* reqValues)

The UIPM requests to change the target state in one or more operations on specified socket elements.

void updateValues(list<string>* sessionIds, list<string>* paths, list<string>* operations, list<string>* values, list<bool>* hasDynRes)

Informs the UIPM that the values have been updated for particular Session.

map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)

The UIPM asks for the values/states of specified socket elements.

string getSocketFriendlyName(string targetId, string socketName)

Returns Socket Friendly Name for the specified Target Name.

string getSocketDescriptionUri(string targetName, string socketName)

Returns the URI for the Socket Description for specified Target Name.

string getTargetDescriptionUri(string targetName)

Get the URI for the Target Description for the specified targetName.

string getSocketName(string sessionId)

Returns the Socket Name for the specified sessionId.

list<list<map<string, list<string>*>*>*> * getResources(string sessionId, list<map<string, list<string>*>*>*resPropsList)

Returns the matching Resource with the Resource Properties specified by 'resProps'.

list<list<map<string, list<string>*>*>*> * getResources(list<map<string, list<string>*>*>*resPropsList)

Get Resources from Local Resources, Resource Server, Target Adapter or Resource Sheet as par the requested resource property resourceType.

void instantiateUIPMs(string targetId, string targetName, list<map<string, IProfile*>*>* contexts)

Instantiate UIPM for the matching target Properties.

bool addCompatibleUI(string targetId, list<string>* socketNames, string protocolShortName, list<string>* uris, map<string, list<string>*>* protocolInfo)

Tell the UCH to add a user interface item (advertised by the UIPM) to its UIList which is exposed to controllers on request.

void removeCompatibleUIs(list<string>*uris)

Tells the UCH to remove user interface URIs from the UIList that were previously added by one call to addCompatibleUI().

string getCompatibleUIs(string httpURI, map<string, string>*httpRequestMap)

Prepare a response for representing all Compatible UIs.

void postRequest(map<string, string>* requestMap, map<string, string>* responseMap)

Choose IUIPM using the URI get by request void* that the UIPM has claimed for itself by a previous call to startUriService().

string startUriService(IUIPM* uipm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The UIPM requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path.

string startUriService(ITA* ta, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The ITA requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path.

string startUriService(ITDM* tdm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The ITDM requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path.

void stopUriService(string uri)

The UIPM requests the UCH to stop servicing a URI that was requested to be serviced in a previous call to startUriService().

void addResourceDir(string tdUri)

Adds 'resDir' tag from the file represented by 'tdUri' to resourceManager.

void updateDynRes(list<string>* sessionIds, list<string>* eltIds)

Signals that the set of atomic resources pertaining to a specific socket element has changed.

list<map<string, void*>*> * getDynRes(string sessionId, list<map<string, string>*>* resProps)

Get a dynamic atomic resource from the TA.

void abortSession(string sessionId)

Cleanup relative information about the session specified by 'sessionId'.

void closeSession(string sessionId)

Closes a Session with the Target.

string getIpAddress()

Get the IP address of the UCH.

string getPortNo()

Get the IP address of the UCH.

list<string> * getAvailableTargetIds(map<string, IProfile*>*context)

Get the identifiers of the available targets.

bool isElementAvailable(string targetId, string socketName, string elementId)

Checks whether a specified socket Element is available or not.

IUCHStore* getLocalUCHStore()

Get the Local UCH Store.

bool isImplemented(string functionName)

Checks whether the function is implemented by IUIPMListener or not.

map<string, string> * getLocators(string targetName)

Get a map with Locator ids and locator types for a specific target type.

void invokeLocator(string targetId, string locatorId)

Invoke the specified locator function on the specified target.

map<string, string> * getUCHProps()

Get UCH Propeties

string getDocument(string uri, string postData, map<string, IProfile*>* context)

Get description document through HTTP GET or POST.

list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)

This function will return map containing pairs of element identifiers and it's indexed values.

bool isResServerEnable()

Checks for Resource Server is available or not.

static RetrievalManager* getRetrievalManager()

Get the instance for retrieval Manager

string getPlatform()

Get the Platform on which UCH is installed and running

static string getDocRoot()

Get the Base Path of UCH

string convertURI(string clientLocalAt)

Convert the client local uri to http uri, this will be done in reference to apache root directory

list<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)

Call the same method on ResourceManager.

IBonjour* getBonjourServer()

Returns the Bonjour server object

bool isUriContainsResServerAppPath(string uri)

Check whether uri contains resource server path or not.

string retrieveResource(string uri)

Retrieve resource directly from resource server uri

void removeUIPM(IUIPM* uipm)

Call the same method on UIServiceHandler.

void removeTDM(ITDM* tdm)

Call the same method on UIServiceHandler.

void removeTA(ITA* ta)

Call the same method on UIServiceHandler.

list<string> * getURIs(map<string, IProfile*>* context)

Call the same method on UserContextManager.

void openUserContext(map<string, string>* request, map<string, string>* response, string userName, string password)

Open Context with specified User.

void closeUserContext(map<string, string>* request)

Get session from request and found user from it and close context with that user.

list<map<string, IProfile*>*> * getContexts()

Get all Contexts.

void addUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)

Call the same method on UserContextManager.

void removeUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)

Call the same method on UserContextManager.

void targetContextsAdded(string targetId, list<map<string, IProfile*>*>*contexts)

Call the same method on UserContextManager, TAListener and UIPMListenr.

void targetContextsRemoved(string targetId, list<map<string, IProfile*>*>*contexts)

Call the same method on UserContextManager, TAListener and UIPMListenr.

list<map<string, IProfile*>*> * getTargetContexts(string targetId)

Call the same method on TDMListener

UCHConfigUtil* getUCHConfigUtil()

Returns UCHConfigUtil Object

string getConformsTo()

Get the value of UCH Property 'http:purlorg/dc/terms/conformsTo'.

void targetDiscovered(string targetId, list<map<string, IProfile*>*>* contexts)

Call the same method on TAListener.

ITDMListener* getTDMListener()

Returns TDMListener Object

bool validateContextUser(map<string, string>*request, string userName, string password)

Check whether specified userName and password is valid or not.

void contextsOpened(list<map<string, IProfile*>*>* contexts)

Call the same method on TDMListener and UIPMListener.

void contextsClosed(list<map<string, IProfile*>*>* contexts)

Call the same method on TDMListener and UIPMListener.

Public Members

Personalisation //////////////////////////////////////////////

Documentation

It implements IUIPMListener and delegates the call from IUIPM to TargetListener and vice-versa. This class follows the Singleton pattern, hence the contructor is private. The singleton instance can be retrieved by using the getInstance() method

UCH()

Default Constructor Instantiates TargetListener and other local variables

static UCH* getInstance()

Returns an Instance of UCH. Singleton Pattern.

Returns:

an void* of UCH

map<string, void *> * getTargetProps(string targetId)

Get the target Properties for the specified targetId.

Parameters:

targetId - a String value of targetId

Returns:

Map<String, void*>. Map has a value void* as it can contain List or Map for some key

string getTargetName(string targetId)

Get the name of a target for the specified targetId.

Parameters:

targetId - a String value of targetId

Returns:

a String Value of target name

list<string> * getSocketNames(string targetName)

Returns List of socket Names for the specified Target Name.

Parameters:

targetName - a String value of targetName

Returns:

List<String> Object

map<string, string> * openSessionRequest(string targetId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* contexts)

Request for opening a session with the specified target and socket.

Parameters:

uipm - Object of IUIPM
targetId - a String value of targetId
socketName - a String value of socketName
clientProps - Map<String,String>

Returns:

Map<String,String>

string targetDiscovered(map<string, void*>*targetProps, map<string, string>*taProps, list<map<string, IProfile*>*>* contexts)

Call the same method on TAListener.

Parameters:

targetProps - an Object of Map<String, Object> specifies Target Properties
taProps - an Object of Map<String, String> specifies TA Properties
contexts - an Object of List<Map<String, IProfile>>

Returns:

a String value specifies Target Id

void targetDiscarded(string targetId)

Called when any existing target is Discarded from the network.

Parameters:

targetId - a map value of targetId

map<string, list<string>*> * setValuesRequest(string sessionId, list<string>* paths, list<string>* operations, list<string>* reqValues)

The UIPM requests to change the target state in one or more operations on specified socket elements. The requested operations are coded as cross-indexed arrays of paths, operation identifiers and requested new values.

Parameters:

sessionId - a String value of sessionId
paths - List<String>
operations - List<String>
reqValues - List<String>

Returns:

Map<String, List<String>>

void updateValues(list<string>* sessionIds, list<string>* paths, list<string>* operations, list<string>* values, list<bool>* hasDynRes)

Informs the UIPM that the values have been updated for particular Session.

Parameters:

sessionIds - as List<String>
paths - as List<String>
operations - as List<String>
values - as List<String>
hasDynRes - as List<Boolean>

map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)

The UIPM asks for the values/states of specified socket elements.

Parameters:

sessionId - a String value of sessionId
paths - List<String>
includeSets - a List<Boolean> of includeSets

Returns:

Map<String, String>

string getSocketFriendlyName(string targetId, string socketName)

Returns Socket Friendly Name for the specified Target Name.

Parameters:

targetName - a String value of targetName
socketName - a String value of socketName

Returns:

String Value of socket friendly name

string getSocketDescriptionUri(string targetName, string socketName)

Returns the URI for the Socket Description for specified Target Name.

Parameters:

targetName - a String value of targetName
socketName - a String value of socketName

Returns:

a Socket Description URI String

string getTargetDescriptionUri(string targetName)

Get the URI for the Target Description for the specified targetName.

Parameters:

targetName - a String value of targetName

Returns:

a Target Description URI String

string getSocketName(string sessionId)

Returns the Socket Name for the specified sessionId.

Parameters:

sessionId - a String value of sessionId

Returns:

String Value of socket name

list<list<map<string, list<string>*>*>*> * getResources(string sessionId, list<map<string, list<string>*>*>*resPropsList)

Returns the matching Resource with the Resource Properties specified by 'resProps'.

Parameters:

sessionId - a String value of SessionId
resPropsList - list<map<string, list<string>*>*> of Resource Properties

Returns:

an list<list<map<string, list<string>*>*>*> representing Resources. Map inside the List has value void* as it may contain single String value or List of String Values

list<list<map<string, list<string>*>*>*> * getResources(list<map<string, list<string>*>*>*resPropsList)

Get Resources from Local Resources, Resource Server, Target Adapter or Resource Sheet as par the requested resource property resourceType. If request properties contains property 'http:myurc.org/ns/restype' and its value is 'http:myurc.org/restypesatomic' then go for atomic or dynamic resource. Else find resource from local resources and if not found then go to resource server to get it.

Parameters:

sessionId - a String value of SessionId
resPropsList - an Object of List<Map<String, List<String>>>

Returns:

a List<Map<String, Object>> of Resources.

void instantiateUIPMs(string targetId, string targetName, list<map<string, IProfile*>*>* contexts)

Instantiate UIPM for the matching target Properties.

Parameters:

uipmProps - a map<map, map> of UIPM Properties

bool addCompatibleUI(string targetId, list<string>* socketNames, string protocolShortName, list<string>* uris, map<string, list<string>*>* protocolInfo)

Tell the UCH to add a user interface item (advertised by the UIPM) to its UIList which is exposed to controllers on request.

Parameters:

targetId - a String value of targetId
socketNames - a List<String> value of socketNames
protocolShortName - a String value of protocolShortName
uris - a List<String> value of uris
protocolInfo - a Map<String, String> of protocol Information

Returns:

whether CompatibleUI is added or not. @throws UCHException

void removeCompatibleUIs(list<string>*uris)

Tells the UCH to remove user interface URIs from the UIList that were previously added by one call to addCompatibleUI().

Parameters:

uris - a List<String> of URIs @throws UCHException

string getCompatibleUIs(string httpURI, map<string, string>*httpRequestMap)

Prepare a response for representing all Compatible UIs.

Returns:

a String representing all Compatible UIs.

void postRequest(map<string, string>* requestMap, map<string, string>* responseMap)

Choose IUIPM using the URI get by request void* that the UIPM has claimed for itself by a previous call to startUriService(). Then call controllerRequest() of that IUIPM.

Parameters:

request - as Map<String,String> of Request
response - as Map<String,String> of Response

string startUriService(IUIPM* uipm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The UIPM requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path. If successful, the UCH will forward all messages that have this URI as its base, to controllerRequest().

Parameters:

uipm - an IUIPM void*
scheme - a String value of schema
port - a port no
portIsFlexible - a boolean value
basePath - a String value of basePath
basePathIsFlexible - a boolean value

Returns:

a String value of URI @throws UCHException

string startUriService(ITA* ta, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The ITA requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path. If successful, the UCH will forward all messages that have this URI as its base, to controllerRequest().

Parameters:

ta - an ITA object
scheme - a String value of schema
port - a port no
portIsFlexible - a boolean value
basePath - a String value of basePath
basePathIsFlexible - a boolean value

Returns:

a String value of URI @throws UCHException

string startUriService(ITDM* tdm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The ITDM requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path. If successful, the UCH will forward all messages that have this URI as its base, to controllerRequest().

Parameters:

tdm - an Object of ITDM
scheme - a String value of scheme
port - an int value of port number
portIsFlexible - a boolean value
basePath - a String value of basePath
basePathIsFlexible - a boolean value

Returns:

a String value of URI @throws UCHException

void stopUriService(string uri)

The UIPM requests the UCH to stop servicing a URI that was requested to be serviced in a previous call to startUriService().

Parameters:

uri - a String value of URI @throws UCHException

void addResourceDir(string tdUri)

Adds 'resDir' tag from the file represented by 'tdUri' to resourceManager.

Parameters:

tdUri - a map value of tdUri

void updateDynRes(list<string>* sessionIds, list<string>* eltIds)

Signals that the set of atomic resources pertaining to a specific socket element has changed.

Parameters:

sessionIds - a List<String> value of sessionIds
eltIds - a List<String> value of eltIds

list<map<string, void*>*> * getDynRes(string sessionId, list<map<string, string>*>* resProps)

Get a dynamic atomic resource from the TA.

Parameters:

sessionId - a map value of sessionId
resProps - a List<Map<String,Stirng>> value of resProps

Returns:

a List<Map<String,Object>> representing Matched Resources

void abortSession(string sessionId)

Cleanup relative information about the session specified by 'sessionId'. Also call the method abortSession() or relative IUIPM.

Parameters:

sessionId - a String value of sessionId

void closeSession(string sessionId)

Closes a Session with the Target.

Parameters:

sessionId - a String value of sessionId

string getIpAddress()

Get the IP address of the UCH.

Returns:

a string value of IP Address

string getPortNo()

Get the IP address of the UCH.

Returns:

a string value of IP Address

list<string> * getAvailableTargetIds(map<string, IProfile*>*context)

Get the identifiers of the available targets.

Returns:

List<String>

bool isElementAvailable(string targetId, string socketName, string elementId)

Checks whether a specified socket Element is available or not.

Parameters:

targetId - a String value of targetId
socketName - a String value of socketName
elementId - a String value of elementId

Returns:

boolean

IUCHStore* getLocalUCHStore()

Get the Local UCH Store.

Returns:

an Object of UCHStore

bool isImplemented(string functionName)

Checks whether the function is implemented by IUIPMListener or not.

Parameters:

functionName - a String value of functionName

Returns:

boolean

map<string, string> * getLocators(string targetName)

Get a map with Locator ids and locator types for a specific target type.

Parameters:

targetName - a String value of targetName

Returns:

a Map<string, String> of LocatorID V/S Locator Type

void invokeLocator(string targetId, string locatorId)

Invoke the specified locator function on the specified target.

Parameters:

targetId - a String value of TargetId
locatorId - a String value of LocatorId

map<string, string> * getUCHProps()

Get UCH Propeties

Returns:

map<String, String> containing key value pair map for UCH properties

string getDocument(string uri, string postData, map<string, IProfile*>* context)

Get description document through HTTP GET or POST.

Parameters:

uri - a String value of URI
postData - a String value of postData

Returns:

String value of Document @throws UCHException

list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)

This function will return map containing pairs of element identifiers and it's indexed values.

Parameters:

sessionId - String Value of session Id
eltIds - list of elementids
indexNos - list of indices

Returns:

List<List<String>*> contain element identifiers and indexed values

bool isResServerEnable()

Checks for Resource Server is available or not. It is defined by uch.config

Returns:

boolean 'true' if resource server URL is valid in uch.config else 'false'

static RetrievalManager* getRetrievalManager()

Get the instance for retrieval Manager

Returns:

the RetrievalManager Object

string getPlatform()

Get the Platform on which UCH is installed and running

Returns:

String Value of platform i.e intel, arm etc

static string getDocRoot()

Get the Base Path of UCH

Returns:

UCH's documentation root directory

string convertURI(string clientLocalAt)

Convert the client local uri to http uri, this will be done in reference to apache root directory

Parameters:

clientLocalAt - a String Value of client local uri

Returns:

String Value of http uri

list<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)

Call the same method on ResourceManager.

Parameters:

props - an Object of List<Map<String, List<String>>> specifies Resource Properties
owners - an Object of List<String> specifies owners of Resource
groups - an Object of List<String> specifies groups of Resource
rights - an Object of Map<String, List<String>> specifies rights of Resource
resourceUri - a String value of local resource path URI

Returns:

an Object of List<Map<String, String>>

Personalisation //////////////////////////////////////////////

Personalisation

IBonjour* getBonjourServer()

Returns the Bonjour server object

Returns:

Bonjour Server

bool isUriContainsResServerAppPath(string uri)

Check whether uri contains resource server path or not.

Parameters:

uri - a String Value of uri

Returns:

bool true if uri contains resource server path else false

string retrieveResource(string uri)

Retrieve resource directly from resource server uri

Parameters:

uri - a String Value of uri

Returns:

String Value of local path to resource

void removeUIPM(IUIPM* uipm)

Call the same method on UIServiceHandler.

Parameters:

uipm - an Object of IUIPM

void removeTDM(ITDM* tdm)

Call the same method on UIServiceHandler.

Parameters:

tdm - an Object of ITDM

void removeTA(ITA* ta)

Call the same method on UIServiceHandler.

Parameters:

ta - an Object of ITA

list<string> * getURIs(map<string, IProfile*>* context)

Call the same method on UserContextManager.

Parameters:

context - an Object of Map<String, IProfile>

Returns:

an Object of List<String>

void openUserContext(map<string, string>* request, map<string, string>* response, string userName, string password)

Open Context with specified User. Also open a session with same user.

Parameters:

request - an map Object of Http Request
response - an map Object of Http Response
userName - a String value of userName
password - a String value of password

Returns:

a boolean value specifies whether userName and password is valid or not.

void closeUserContext(map<string, string>* request)

Get session from request and found user from it and close context with that user. Also close same session.

Parameters:

request - an map Object of Http Request

list<map<string, IProfile*>*> * getContexts()

Get all Contexts.

Returns:

an Object of List<Map<String, IProfile>>

void addUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)

Call the same method on UserContextManager.

Parameters:

uri - a String value of URI
contexts - an Object of List<Map<String, IProfile>>

void removeUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)

Call the same method on UserContextManager.

Parameters:

uri - a String value of URI
contexts - an Object of List<Map<String, IProfile>>

void targetContextsAdded(string targetId, list<map<string, IProfile*>*>*contexts)

Call the same method on UserContextManager, TAListener and UIPMListenr.

Parameters:

targetId - a String value of targetId
contexts - an Object of List<Map<String, IProfile>>

void targetContextsRemoved(string targetId, list<map<string, IProfile*>*>*contexts)

Call the same method on UserContextManager, TAListener and UIPMListenr.

Parameters:

targetId - a String value of targetId
contexts - an Object of List<Map<String, IProfile>>

list<map<string, IProfile*>*> * getTargetContexts(string targetId)

Call the same method on TDMListener

Parameters:

targetId - a String value of Target Id

Returns:

an Object of List<Map<String, IProfile>>

UCHConfigUtil* getUCHConfigUtil()

Returns UCHConfigUtil Object

Returns:

UCHConfigUtil Object

string getConformsTo()

Get the value of UCH Property 'http:purlorg/dc/terms/conformsTo'.

Returns:

a String value

void targetDiscovered(string targetId, list<map<string, IProfile*>*>* contexts)

Call the same method on TAListener.

Parameters:

targetProps - an Object of Map<String, Object> specifies Target Properties
taProps - an Object of Map<String, String> specifies TA Properties
contexts - an Object of List<Map<String, IProfile>>

Returns:

a String value specifies Target Id

ITDMListener* getTDMListener()

Returns TDMListener Object

Returns:

TDMListener Object

bool validateContextUser(map<string, string>*request, string userName, string password)

Check whether specified userName and password is valid or not.

Parameters:

request - an map Object of Http Request
userName - a String value of userName
password - a String value of password

Returns:

a boolean value specifies whether userName and password is valid or not.

void contextsOpened(list<map<string, IProfile*>*>* contexts)

Call the same method on TDMListener and UIPMListener. That will further call the same methods on all TAs and UIPMs.

Parameters:

contexts - an Object of List<Map<String, IProfile>>

void contextsClosed(list<map<string, IProfile*>*>* contexts)

Call the same method on TDMListener and UIPMListener. That will further call the same methods on all TAs and UIPMs.

Parameters:

contexts - an Object of List<Map<String, IProfile>>

This class has no child classes.

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java