class UIPMListener

Implements the methods of UIPMListener.

Inheritance:

Public Methods

[more] UIPMListener(UCH* uch)
Constructor.
[more]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.
[more]void closeSession(string sessionId)
Closes a Session with the Target.
[more]list<string> * getAvailableTargetIds(map<string, IProfile*>*context)
Get the identifiers of the available targets.
[more]string getDocument(string uri, string postData, map<string, IProfile*>* context)
Get description document through HTTP GET or POST.
[more]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.
[more]string getIpAddress()
Get the IP address of the UCH.
[more]IUCHStore* getLocalUCHStore()
Get the Local UCH Store.
[more]map<string, string> * getLocators(string targetName)
Get a map with Locator ids and locator types for a specific target type.
[more]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'.
[more]string getSocketDescriptionUri(string targetName, string socketName)
Returns the URI for the Socket Description for specified Target Name.
[more]string getSocketFriendlyName(string targetId, string socketName)
Returns Socket Friendly Name for the specified Target Name.
[more]string getSocketName(string sessionId)
Returns the Socket Name for the specified sessionId.
[more]list<string> * getSocketNames(string targetName)
Returns List of socket Names for the specified Target Name.
[more]string getTargetDescriptionUri(string targetName)
Get the URI for the Target Description for the specified targetName.
[more]string getTargetName(string targetId)
Get the name of a target for the specified targetId.
[more]map<string, void *> * getTargetProps(string targetId)
Get the target Properties for the specified targetId.
[more]map<string, string> * getUCHProps()
Get UCH Propeties
[more]map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)
The UIPM asks for the values/states of specified socket elements.
[more]void invokeLocator(string targetId, string locatorId)
Invoke the specified locator function on the specified target.
[more]bool isElementAvailable(string targetId, string socketName, string elementId)
Checks whether a specified socket Element is available or not.
[more]bool isImplemented(string functionName)
Checks whether the function is implemented by IUIPMListener or not.
[more]map<string, string> * openSessionRequest(IUIPM* uipm, string targetId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* context)
Request for opening a session with the specified target and socket.
[more]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().
[more]void removeUIPM(IUIPM* uipm)
Removes the specified uipm from the UCH.
[more]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.
[more]list<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)
Upload Resources on Resource Server.
[more]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.
[more]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().
[more]void addUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)
[more]void removeUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)
[more]list<map<string, IProfile*>*> * getContexts()
[more]list<map<string, IProfile*>*> * getTargetContexts(string targetId)
[more]void abortSession(string sessionId)
Cleanup relative information about the session specified by 'sessionId'.
[more]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.
[more]void instantiateUIPMs(string targetId, string targetName, list<map<string, IProfile*>*>* contexts)
Instantiate UIPM for the matching target Properties.
[more]void targetDiscovered(string targetId, list<map<string, IProfile*>*>* contexts)
Called when any new target is Discovered in the network and informs to relative IUIPM.
[more]void targetDiscarded(string targetId)
Called when any existing target is Discarded from the network.
[more]void contextsOpened(list<map<string, IProfile*>*>* contexts)
Call the same method on all UIPMs.
[more]void contextsClosed(list<map<string, IProfile*>*>* contexts)
Call the same method on all UIPMs.
[more]void targetContextsAdded(string targetId, list<map<string, IProfile*>*>* contexts)
[more]void targetContextsRemoved(string targetId, list<map<string, IProfile*>*>*contexts)
[more]bool getDependencyValue(string sessionId, string path, string dependency)
Returns the dependency value
[more]string getElementRef(string sessionId, string path)
Returns element ref
[more]bool isSessionSuspendable(string sessionId)
Checks whether session is suspendable or not
[more]long suspendSession(string sessionId, long suggestedTimeout)
Suspend the session
[more]bool isSessionResumable(string sessionId)
Checks whether session is resumable or not
[more]bool resumeSession(string sessionId)
Resume the session

Public Members

[more] optional methods/////////////////////////////

Inherited from IUIPMListener:

Documentation

Implements the methods of UIPMListener. Also maintain information about TDMs.

o UIPMListener(UCH* uch)
Constructor. Provide the reference of UCH to local variable.

Parameters:
uch - an Object of UCH

obool 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

ovoid closeSession(string sessionId)
Closes a Session with the Target.

Parameters:
sessionId - a string value of sessionId

olist<string> * getAvailableTargetIds(map<string, IProfile*>*context)
Get the identifiers of the available targets.

Returns:
List<string>

ostring 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

olist<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

ostring getIpAddress()
Get the IP address of the UCH.

Returns:
a string value of IP Address

oIUCHStore* getLocalUCHStore()
Get the Local UCH Store.

Returns:
an Object of UCHStore

omap<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

olist<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

ostring 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

ostring 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

ostring getSocketName(string sessionId)
Returns the Socket Name for the specified sessionId.

Parameters:
sessionId - a string value of sessionId
Returns:
string Value of socket name

olist<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

ostring 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

ostring 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

omap<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

omap<string, string> * getUCHProps()
Get UCH Propeties
Returns:
map<string, string> containing key value pair map for UCH properties

omap<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>

ovoid 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

obool 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

obool isImplemented(string functionName)
Checks whether the function is implemented by IUIPMListener or not.

Parameters:
functionName - a string value of functionName
Returns:
boolean

omap<string, string> * openSessionRequest(IUIPM* uipm, string targetId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* context)
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>

ovoid 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

ovoid removeUIPM(IUIPM* uipm)
Removes the specified uipm from the UCH.

Parameters:
uipm - an Object of IUIPM

omap<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>>

olist<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)
Upload Resources on Resource Server.

Parameters:
props - an Object of List<Map<String, List<String>>>
resourceUri - an Object of List<String>
Returns:
an Object of List<Map<String, String>>

ostring 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

ovoid 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

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

Parameters:
uri - a String value of URI
contexts - a List<Map<String, IProfile>> of user and controller profile map @throws UCHException

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

Parameters:
uri - a String value of URI
contexts - a List<Map<String, IProfile>> of user and controller profile map @throws UCHException an Object of org.myurc.uch.UCHException

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

Returns:
a List<Map<String, IProfile>> of user and controller profile map

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

Parameters:
targetId - a String value of targetId
Returns:
a List<Map<String, IProfile>> of user and controller profile map

ovoid 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

ovoid 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>

ovoid 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

ovoid targetDiscovered(string targetId, list<map<string, IProfile*>*>* contexts)
Called when any new target is Discovered in the network and informs to relative IUIPM.

Parameters:
targetId - a String value of targetId
contexts - a List<Map<String, IProfile>> of user and controller profile map

ovoid targetDiscarded(string targetId)
Called when any existing target is Discarded from the network.

Parameters:
targetId - a String value of targetId

ovoid contextsOpened(list<map<string, IProfile*>*>* contexts)
Call the same method on all UIPMs.

Parameters:
contexts - an object of List<Map<String, IProfile>>

ovoid contextsClosed(list<map<string, IProfile*>*>* contexts)
Call the same method on all UIPMs.

Parameters:
contexts - an object of List<Map<String, IProfile>>

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

Called by IUIPM for adding context for the particular targetId

Parameters:
targetId - a String value of targetId
contexts - an object of List<Map<String, IProfile>>

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

Called by IUIPM for removing context for the particular targetId

Parameters:
targetId - a String value of targetId
contexts - an object of List<Map<String, IProfile>>

o optional methods/////////////////////////////
optional methods/

obool getDependencyValue(string sessionId, string path, string dependency)
Returns the dependency value
Parameters:
sessionId - a String value of sessionId
path - a String value of path
dependency - a String value of dependency
Returns:
@throws UCHNotImplementedException

ostring getElementRef(string sessionId, string path)
Returns element ref
Parameters:
sessionId - a String value of sessionId
path - a String value of path
Returns:
@throws UCHNotImplementedException

obool isSessionSuspendable(string sessionId)
Checks whether session is suspendable or not
Parameters:
sessionId - a String value of sessionId
Returns:
@throws UCHNotImplementedException

olong suspendSession(string sessionId, long suggestedTimeout)
Suspend the session
Parameters:
sessionId - a String value of sessionId
suggestedTimeout - a long value
Returns:
@throws UCHNotImplementedException

obool isSessionResumable(string sessionId)
Checks whether session is resumable or not
Parameters:
sessionId - a String value of sessionId
Returns:
@throws UCHNotImplementedException

obool resumeSession(string sessionId)
Resume the session
Parameters:
sessionId - a String value of sessionId
Returns:
@throws UCHNotImplementedException

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


This page was generated with the help of DOC++.