class IUIPMListener

IUIPMListener receives calls from UIPM.

Inheritance:

Public Methods

[more]virtual list<map<string, IProfile*>*> * getContexts()
[more]virtual list<string> * getAvailableTargetIds(map<string, IProfile*>*context)
Get the identifiers of the available targets.
[more]virtual string getTargetName(string targetId)
Get the name of a target for the specified targetId.
[more]virtual map<string, void *> * getTargetProps(string targetId)
Get the target Properties for the specified targetId.
[more]virtual list<map<string, IProfile*>*> * getTargetContexts(string targetId)
[more]virtual list<string> * getSocketNames(string targetName)
Returns List of socket Names for the specified Target Name.
[more]virtual string getSocketDescriptionUri(string socketName)
Get the URI for retrieving the Socket Description of the specified targetName and socketName.
[more]virtual 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]virtual 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]virtual void closeSession(string sessionId)
Closes a Session for the specified sessionId.
[more]virtual map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)
Returns a value/state of the specified socket elements.
[more]virtual 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]virtual string getSocketDescriptionUri(string targetName, string socketName)
Returns the URI for the Socket Description for specified Target Name.
[more]virtual string getTargetDescriptionUri(string targetName)
Get the URI for retrieving the Target Description for the specified targetName.
[more]virtual string getSocketFriendlyName(string targetId, string socketName)
Get Friendly Name of the Socket for the specified socketName and targetId.
[more]virtual string getSocketName(string sessionId)
Get the SocketName for the specified sessionId.
[more]virtual bool isImplemented(string functionName)
Checks whether specified function is implemented or not.
[more]virtual 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]virtual string getDocument(string uri, string postData, map<string, IProfile*>* context)
Get specified document through HTTP GET or POST.
[more]virtual void removeCompatibleUIs(list<string>*uris)
Tells the UCH to remove user interface URIs from the UIList that were previously added by addCompatibleUI().
[more]virtual 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]virtual 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]virtual void addUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)
[more]virtual void removeUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)
[more]virtual string getIpAddress()
Get the IP address of the UCH.
[more]virtual bool isElementAvailable(string targetId, string socketName, string elementId)
Checks whether a given socketElement is available in the specified Socket of specified Target or not.
[more]virtual IUCHStore* getLocalUCHStore()
Get the Local UCH Store.
[more]virtual map<string, string> * getLocators(string targetName)
Get a map of locatores containing locatorId and locatorType for a specified target Name.
[more]virtual void invokeLocator(string targetId, string locatorId)
Invoke the specified locator function of the specified targetId.
[more]virtual list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)
Get Indices available on specific level of dimension of dimensional Element.
[more]virtual map<string, string> * getUCHProps()
Get a Map of UCH Properties.
[more]virtual list<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)
Upload Resources on Resource Server.
[more]virtual bool getDependencyValue(string sessionId, string path, string dependency)
Get the actual value of a dependency.
[more]virtual string getElementRef(string sessionId, string path)
Get the elementRef URI that points to a particular socket element/set.
[more]virtual bool isSessionSuspendable(string sessionId)
Check whether the given session can be suspended.
[more]virtual long suspendSession(string sessionId, long suggestedTimeout)
The target is requested to suspend the given session with a suggested timeout value.
[more]virtual bool isSessionResumable(string sessionId)
Checks whether the given session can be resumed.
[more]virtual bool resumeSession(string sessionId)
The target is requested to resume the given session.
[more]virtual void removeUIPM(IUIPM* uipm)
Removes the specified uipm from the UCH.

Public Members

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

Documentation

IUIPMListener receives calls from UIPM. UCH implements this interface.

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

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

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

Returns:
List<String>

ovirtual string getTargetName(string targetId)
Get the name of a target for the specified targetId.

Parameters:
targetId - a String value of targetId
Returns:
a String

ovirtual map<string, void *> * getTargetProps(string targetId)
Get the target Properties for the specified targetId.

Parameters:
targetId - a String value of targetId
Returns:
Map<String, Object>

ovirtual list<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

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

ovirtual string getSocketDescriptionUri(string socketName)
Get the URI for retrieving the Socket Description of the specified targetName and socketName.

Parameters:
targetName - a String value of targetName
socketName - a String value of socketName
Returns:
a String representing Socket Description URI @throws TAFatalException

ovirtual 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
resProps - list<map<string, list<string>*>*> of Resource Properties
Returns:
an list<list<map<string,list<string>*>*>*> representing Resources

ovirtual 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.

Parameters:
targetId - a String value of targetId
socketName - a String value of socketName
clientProps - Map<String,String>
Returns:
Map<String,String>

ovirtual void closeSession(string sessionId)
Closes a Session for the specified sessionId.

Parameters:
sessionId - a String value of sessionId

ovirtual map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)
Returns a value/state of the specified socket elements.

Parameters:
sessionId - a String value of sessionId
paths - a List<String> of elementPath
includeSets - a List<Boolean> of includeSets
Returns:
a Map<String, String> of values @throws TAFatalException

ovirtual 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> a List of elementPaths
operations - List<String> a List of operations (allowed operations are "S", "A", "R", "I" or "K" )
reqValues - List<String> a List of Requested Values
Returns:
Map<String, List<String>> a Map of set Values

ovirtual 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

ovirtual string getTargetDescriptionUri(string targetName)
Get the URI for retrieving the Target Description for the specified targetName.

Parameters:
targetName - a String value of targetName
Returns:
a Target Description URI String

ovirtual string getSocketFriendlyName(string targetId, string socketName)
Get Friendly Name of the Socket for the specified socketName and targetId.

Parameters:
targetId - a String value of targetId
socketName - a String value of socketName
Returns:
a String value of Socket Friendly Name

ovirtual string getSocketName(string sessionId)
Get the SocketName for the specified sessionId.

Parameters:
sessionId - a String value of sessionId
Returns:
a String of SocketName @throws TAFatalException

ovirtual bool isImplemented(string functionName)
Checks whether specified function is implemented or not.

Parameters:
functionName - a String value of function Name
Returns:
whether the function is implemented or not

ovirtual 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

ovirtual string getDocument(string uri, string postData, map<string, IProfile*>* context)
Get specified document through HTTP GET or POST.

Parameters:
uri - a String value of URI
postData - a String value of postData
Returns:
a String value of requested Document @throws UCHException

ovirtual void removeCompatibleUIs(list<string>*uris)
Tells the UCH to remove user interface URIs from the UIList that were previously added by addCompatibleUI().

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

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

ovirtual 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

ovirtual void 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 an Object of org.myurc.uch.UCHException

ovirtual void 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

ovirtual string getIpAddress()
Get the IP address of the UCH.

Returns:
return a string value

ovirtual bool isElementAvailable(string targetId, string socketName, string elementId)
Checks whether a given socketElement is available in the specified Socket of specified Target or not.

Parameters:
targetId - a String value of targetId
socketName - a String value of socketName
eltId - a String value of eltId
Returns:
boolean whether specified socketElement is exists or not @throws TAFatalException

ovirtual IUCHStore* getLocalUCHStore()
Get the Local UCH Store.

Returns:
an Object of IUCHStore

ovirtual map<string, string> * getLocators(string targetName)
Get a map of locatores containing locatorId and locatorType for a specified target Name.

Parameters:
targetName - a String value of targetName
Returns:
a Map<string, String> of LocatorID V/S Locator Type

ovirtual void invokeLocator(string targetId, string locatorId)
Invoke the specified locator function of the specified targetId.

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

ovirtual list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)
Get Indices available on specific level of dimension of dimensional Element.

Parameters:
sessionId - a String value of sessionId
eltIds - a List<String> of elementIds
indexNos - a List<Integer> of indexNo
Returns:
a List<Set<Integer> of indices

ovirtual map<string, string> * getUCHProps()
Get a Map of UCH Properties.

Returns:
an object of Map<String, String> or UCH Properties

ovirtual list<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>>

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

ovirtual bool getDependencyValue(string sessionId, string path, string dependency)
Get the actual value of a dependency. If IUIPMListener does not support this functionality then UCHNotImplementedException is thrown by this function.

Parameters:
sessionId - a String value of sessionId
path - a String value of path
dependency - a String value of dependency
Returns:
whether the dependency is true or false. @throws UCHNotImplementedException

ovirtual string getElementRef(string sessionId, string path)
Get the elementRef URI that points to a particular socket element/set. If IUIPMListener does not support this functionality then UCHNotImplementedException is thrown by this function.

Parameters:
sessionId - a String value of sessionId
path - a String value of path
Returns:
a String value of elementRef @throws UCHNotImplementedException

ovirtual bool isSessionSuspendable(string sessionId)
Check whether the given session can be suspended. If IUIPMListener does not support this functionality then UCHNotImplementedException is thrown by this function.

Parameters:
sessionId - a String value of sessionId
Returns:
whether the given session can be suspended or not @throws UCHNotImplementedException

ovirtual long suspendSession(string sessionId, long suggestedTimeout)
The target is requested to suspend the given session with a suggested timeout value. If IUIPMListener does not support this functionality then UCHNotImplementedException is thrown by this function.

Parameters:
sessionId - a String value of sessionId
suggestedTimeout - a long value
Returns:
a long value of timeOut @throws UCHNotImplementedException

ovirtual bool isSessionResumable(string sessionId)
Checks whether the given session can be resumed. If IUIPMListener does not support this functionality then UCHNotImplementedException is thrown by this function.

Parameters:
sessionId - a String value of sessionId
Returns:
whether the given session can be resumed or not @throws UCHNotImplementedException

ovirtual bool resumeSession(string sessionId)
The target is requested to resume the given session. If IUIPMListener does not support this functionality then UCHNotImplementedException is thrown by this function.

Parameters:
sessionId - a String value of sessionId
Returns:
whether request for resume session is granted or not. @throws UCHNotImplementedException

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

Parameters:
uipm - an Object of IUIPM

Direct child classes:
UIPMListener
Author:
Parikshit Thakur & Team, Trace R&D Center
Version:
Revision: 1.0

Alphabetic index HTML hierarchy of classes or Java


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