class UrcHttpUIPM

After getting information from ITDMListener regarding Discovery and Discarding of devices, UCH instantiates UrcHttpUIPM if relative target is discovered.

Inheritance:

Public Fields

IUIPMListener* uipmListener

Pointer to IUIPMListener

SearchUIPMClientsThread* searchUIPMClientsThread

Pointer to SearchUIPMClientsThread

static string PROPERTY_CONFORMS_TO_VALUE

static string

static string PROPERTY_WRAPS_PROTOCOL_SHORT_NAME_VALUE

static string

static string PROPERTY_PROTOCOL_SHORT_NAME_DEFAULT_VALUE

static string

bool canChangeURIList

Boolean specifying that URI List can be modified

bool updateUIPMClientNow

Boolean which commands the searchThread to update the UCH immediately

map<string, string> uipmClientUriTargetIdMap

Map for UIPM Client URI Vs TargetId

ContextManager* contextManager

ContextManager Object

Public Methods

UrcHttpUIPM()

Default Constructor

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

Collect relative information from IUIPMListener to invoke the method addCompatibleUI() of IUIPMListener for discovered target and invoke it.

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

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

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

void targetDiscarded( string targetId )

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

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.

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.

void finalize()

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

map<string, long> * getSessionIdLastAccessedMap()

Return a Map of SessionId V/S Time from last access of that Session.

void sessionAborted(string sessionId)

The target has terminated a session.

map<string, string> * getUIPMProps()

Returns Properties of UIPM.

bool isImplemented(string functionName)

Checks whether the 'functionName' has been implemented or not in IUIPM.

map<string, string> * getUchProps()

Returns the property map fo UCH

string getPropValueFromPropMap(string propName, map<string, list<string>*>* uipmClientPropsMap)

Returns the value of requested property Name from uipm Client Property Map

map<string, list<string>*> * getUipmClientInfo(string eltRef)

Get the uipm client info from supplied elfRef

void addURIToList(string uri)

Add URI to the client List

list<string> * getURIList()

Returns List of all available URI

map<string,TargetDetails*> * getTargetIdTargetDetailMap()

Returns the TargetId Vs TargetDetail Class Map @retrun map<string,TargetDetails*>

void freeMemory(list<map<string, list<string>*>*>*uipmClientRequestPropList, list<list<map<string, list<string>*>*>*>*uipmClientList)

Frees the memory after every call to get resources

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

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

list<map<string, IProfile*>*> * getUriServiceContexts(string uri)

Returns all available user profile context for given uri

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

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

Documentation

After getting information from ITDMListener regarding Discovery and Discarding of devices, UCH instantiates UrcHttpUIPM if relative target is discovered. UCH informs UIPM about Discovery and Discarding of the devices. It forwards relative call from UCH to ITA and get desired response and forwards to UCH for further process.

UrcHttpUIPM()

Default Constructor

IUIPMListener* uipmListener

Pointer to IUIPMListener

SearchUIPMClientsThread* searchUIPMClientsThread

Pointer to SearchUIPMClientsThread

static string PROPERTY_CONFORMS_TO_VALUE

static string

static string PROPERTY_WRAPS_PROTOCOL_SHORT_NAME_VALUE

static string

static string PROPERTY_PROTOCOL_SHORT_NAME_DEFAULT_VALUE

static string

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

Collect relative information from IUIPMListener to invoke the method addCompatibleUI() of IUIPMListener for discovered target and invoke it. Also start service for uris by invoking the method startUriService() of IUIPMListener.

Parameters:

targetId - a String value of targetId @throws TAFatalException

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

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

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

Parameters:

targetId - a String value of targetId @throws UIPMFatalException

void targetDiscarded( string targetId )

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

Parameters:

targetId - a String value of targetId @throws UIPMFatalException

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.

Parameters:

request - an Object of map<string, string>
response - an Object of map<string, string>

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 - List<String>
paths - List<String>
operations - List<String>
values - List<String>
hasDynRes - List<Boolean> @throws UIPMFatalException

void finalize()

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

map<string, long> * getSessionIdLastAccessedMap()

Return a Map of SessionId V/S Time from last access of that Session.

Returns:

a Map<String, Long> of SessionId V/S Time from last access of that Session.

void sessionAborted(string sessionId)

The target has terminated a session.

Parameters:

sessionId - a String value of sessionId @throws UIPMFatalException

map<string, string> * getUIPMProps()

Returns Properties of UIPM.

Returns:

Map<String, String>

bool isImplemented(string functionName)

Checks whether the 'functionName' has been implemented or not in IUIPM.

Parameters:

functionName - a String value of functionName

Returns:

boolean 'true' if function is implemented in IUIPM else 'false'

map<string, string> * getUchProps()

Returns the property map fo UCH

Parameters:

Map - <String,String> of UCH Properties

string getPropValueFromPropMap(string propName, map<string, list<string>*>* uipmClientPropsMap)

Returns the value of requested property Name from uipm Client Property Map

Parameters:

propName - a String whose value is required to be searched
uipmClientPropsMap - a map<string, list<string>*> from which value will be searched

Returns:

a String value of propName

map<string, list<string>*> * getUipmClientInfo(string eltRef)

Get the uipm client info from supplied elfRef

Parameters:

eltRef - a String value of elementRefId

Returns:

map<string, list<string>*>

void addURIToList(string uri)

Add URI to the client List

Parameters:

uri - a String value of URI

list<string> * getURIList()

Returns List of all available URI

Returns:

list<string>

bool canChangeURIList

Boolean specifying that URI List can be modified

bool updateUIPMClientNow

Boolean which commands the searchThread to update the UCH immediately

map<string,TargetDetails*> * getTargetIdTargetDetailMap()

Returns the TargetId Vs TargetDetail Class Map @retrun map<string,TargetDetails*>

void freeMemory(list<map<string, list<string>*>*>*uipmClientRequestPropList, list<list<map<string, list<string>*>*>*>*uipmClientList)

Frees the memory after every call to get resources

Parameters:

uipmClientRequestPropList - a list<map<string, list<string>*>*> UIPM Client Request Property List
uipmClientList - a list<list<map<string, list<string>*>*>*> UIPM Client List

map<string, string> uipmClientUriTargetIdMap

Map for UIPM Client URI Vs TargetId

ContextManager* contextManager

ContextManager Object

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

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

Parameters:

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

list<map<string, IProfile*>*> * getUriServiceContexts(string uri)

Returns all available user profile context for given uri

Parameters:

uri - a String Value of uri

Returns:

List<Map<String, IProfile>> contexts

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 org.myurc.uch.UIPMFatalException

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 of org.myurc.uch.UIPMFatalException

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