class UIServiceHandler

Provide methods for add/remove/get CompatibleUIs.

Public Methods

UIServiceHandler(UCH* uch, string ipAddress, string portNoStr)

Provide the reference of UCH, ipAddress and portNo to local variables.

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

Add compatible UIs for specified target and its socket.

void removeCompatibleUIs(list<string>*uris)

Remove the specified URIs from Compatible UI list.

string startUriService(IUIPM* uipm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible)

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)

The TA 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)

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

void stopUriService(string uri)

Stop URI Service on specified URI.

void removeUIPM(IUIPM* uipm)

Remove specified UIPM, its services and related compatible UIs.

void removeTDM(ITDM* tdm)

Remove specified TDM, its services and related compatible UIs.

void removeTA(ITA* ta)

Remove specified TA, its services and related compatible UIs.

string getCompatibleUIs(string hostName, map<string, IProfile*>* context)

Get the XML string of compatible UIs for specified context.

void controllerRequest(string baseUri, string requestedURI, map<string, string>* requestMap, map<string, string>* responseMap, map<string, IProfile*>* context)

Handle the ControllerRequest and call relevant method of relevant TA, TDM or UIPM.

Documentation

Provide methods for add/remove/get CompatibleUIs. Also provide methods to start/stop URI service.

UIServiceHandler(UCH* uch, string ipAddress, string portNoStr)

Provide the reference of UCH, ipAddress and portNo to local variables.

Parameters:

uch - an Object of UCH
ipAddress - a String value of IP Address
portNo - an int value of Port No

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

Add compatible UIs for specified target and its socket.

Parameters:

targetId - a String value of Target Id
socketNames - an Object of List<String> specifies Socket Names
protocolShortName - a String value of Protocol Short Name
uris - an Object of List<String> specifies URIs
protocolInfo - an Object of Map<String, List<String>>

Returns:

a boolean value specifies whether compatible UI added successfully or not. @throws UCHException an Object of UCHException

void removeCompatibleUIs(list<string>*uris)

Remove the specified URIs from Compatible UI list.

Parameters:

uris - an Object of List<String> specifies List of URI @throws UCHException an Object of UCHException

string startUriService(IUIPM* uipm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible)

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 targetRequest().

Parameters:

uipm - an object of IUIPM
scheme - a String value of scheme
port - an int value of portNo.
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)

The TA 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 targetRequest().

Parameters:

ta - an object of ITA
scheme - a String value of scheme
port - an int value of portNo.
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)

The TA 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 targetRequest().

Parameters:

ta - an object of ITA
scheme - a String value of scheme
port - an int value of portNo.
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)

Stop URI Service on specified URI.

Parameters:

uri - a String value of URI

void removeUIPM(IUIPM* uipm)

Remove specified UIPM, its services and related compatible UIs.

Parameters:

uipm - an Object of IUIPM

void removeTDM(ITDM* tdm)

Remove specified TDM, its services and related compatible UIs.

Parameters:

tdm - an Object of ITDM

void removeTA(ITA* ta)

Remove specified TA, its services and related compatible UIs.

Parameters:

ta - an Object of ITA

string getCompatibleUIs(string hostName, map<string, IProfile*>* context)

Get the XML string of compatible UIs for specified context.

Parameters:

hostName - a String value of HostName
context - an Object of Map<String, IProfile>

Returns:

a String value represents Compatible UIs XML

void controllerRequest(string baseUri, string requestedURI, map<string, string>* requestMap, map<string, string>* responseMap, map<string, IProfile*>* context)

Handle the ControllerRequest and call relevant method of relevant TA, TDM or UIPM.

Parameters:

baseUri - a String value of Base URI
uri - a String value of request URI
request - an Object of Map<String,String>
response - an Object of Map<String,String>

This class has no child classes.

Author:

Parikshit Thakur & Team, Trace R&D Center

Version:

Revision: 1.1

Alphabetic index HTML hierarchy of classes or Java