class IUIPM

UIPM - User Interface Protocol Module, takes care of communication from the end-client to the UCH.

Public Methods

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

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

virtual void init(IUIPMListener*uipmListener, map<string, string>* uipmProps, map<string, string>* uchProps, list<map<string, IProfile*>*>* contexts)

When the UIPM is installed and loaded, the UCH calls this method prior to any other UIPM function and allows the UIPM to initialize itself.

virtual void finalize()

The UCH should call finalize() before it uninstalls or unloads the UIPM.

virtual map<string, string> * getUIPMProps()

Returns Properties of UIPM.

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

This function is called by UCH when a new target has been discovered after initialization of the UIPM.

virtual void targetDiscarded(string targetId)

This function is called by UCH when a target has been discarded after initialization of the UIPM.

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

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

virtual void sessionForwardRequest(string sessionId, map<string, string>* forwardInfo)

The target requests the UIPM to open a session with a different socket.

virtual void sessionAborted(string sessionId)

The target has terminated a session.

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

The target's status has changed, affecting one or more sessions.

virtual bool isImplemented(string functionName)

Checks whether specified function is implemented or not.

virtual void controllerRequest(map<string, string>* requestMap, map<string, string>*responseMap)

The UCH calls this function if it has received a request from a controller to a URI that the UIPM has claimed for itself by a previous call to startUriService()It call desired methods of IUIPMListener and make changes to response object.

Documentation

UIPM - User Interface Protocol Module, takes care of communication from the end-client to the UCH.

After getting information from ITDMListener regarding Discovery and Discarding of devices, UCH instantiates UIPM if it is not instantiated, if it is already instantiated then UCH informs UIPM about Discovery and Discarding of the devices. UIPM forwards calls to the UCH and gets desired response.

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

Parameters:

contexts - a List<Map<String, IProfile>> of user and controller profile map @throws UIPMFatalException an Object of org.myurc.uch.UIPMFatalException

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

Parameters:

contexts - a List<Map<String, IProfile>> of user and controller profile map @throws UIPMFatalException an Object of org.myurc.uch.UIPMFatalException

virtual void init(IUIPMListener*uipmListener, map<string, string>* uipmProps, map<string, string>* uchProps, list<map<string, IProfile*>*>* contexts)

When the UIPM is installed and loaded, the UCH calls this method prior to any other UIPM function and allows the UIPM to initialize itself.

Parameters:

uipmListener - an Object of IUIPMListener
uipmProps - a Map<String, String> of IUIPM Properties
uchProps - a Map<String, String> of UCH Properties @throws UIPMFatalException

virtual void finalize()

The UCH should call finalize() before it uninstalls or unloads the UIPM.

virtual map<string, string> * getUIPMProps()

Returns Properties of UIPM.

Returns:

Map<String, String>

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

This function is called by UCH when a new target has been discovered after initialization of the UIPM.

Parameters:

targetId - a String value of targetId @throws UIPMFatalException

virtual void targetDiscarded(string targetId)

This function is called by UCH when a target has been discarded after initialization of the UIPM.

Parameters:

targetId - a String value of targetId @throws UIPMFatalException

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

Parameters:

targetId - a String value of targetId
contexts - a List<Map<String, IProfile>> of user and controller profile map @throws UIPMFatalException an Object of UIPMFatalException

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

Parameters:

targetId - a String value of targetId
contexts - a List<Map<String, IProfile>> of user and controller profile map @throws UIPMFatalException an Object UIPMFatalException

virtual void sessionForwardRequest(string sessionId, map<string, string>* forwardInfo)

The target requests the UIPM to open a session with a different socket.

Parameters:

sessionId - a String value of sessionId
forwardInfo - a Map<String, String> value @throws UIPMFatalException

virtual void sessionAborted(string sessionId)

The target has terminated a session.

Parameters:

sessionId - a String value of sessionId @throws UIPMFatalException

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

The target's status has changed, affecting one or more sessions.

Parameters:

sessionIds - a List<String> of sessionIds
paths - a List<String> of paths
operations - a List<String> of operations
values - a List<String> of values
hasDynRes - a List<Boolean> of hasDynRes @throws UIPMFatalException

virtual 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

virtual void controllerRequest(map<string, string>* requestMap, map<string, string>*responseMap)

The UCH calls this function if it has received a request from a controller to a URI that the UIPM has claimed for itself by a previous call to startUriService()It call desired methods of IUIPMListener and make changes to response object.

Parameters:

request - an Object of HttpServletRequest
response - an Object of HttpServletResponse

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