class TDMListener

Implements the methods of ITDMListener.

Inheritance:

Public Methods

TDMListener(UCH* uch)

Constructor.

string getDocument(string uri, string postData, map<string, IProfile*>* context)

Get specified document through HTTP GET or POST.

string getIpAddress()

Get the IP address of the UCH.

IUCHStore* getLocalUCHStore()

Get the Local UCH Store.

list<list<map<string, list<string>*>*>*> * getResources(string sessionId, list<map<string, list<string>*>*>*resPropsList)

Get resource from the UCH specified by Resource Properties.

map<string, string> * getUCHProps()

Get a Map of UCH Properties.

bool isImplemented(string functionName)

Checks whether specified function is implemented or not.

string startUriService(ITDM* tdm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

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

void stopUriService(string uri)

The ITDM requests the UCH to stop servicing a URI that was requested to be serviced in a previous call to startUriService().

list<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)

Upload Resources on Resource Server.

string targetDiscovered(ITDM* tdm, map<string, void*>*targetProps, map<string, string>*taProps, list<map<string, IProfile*>*>* contexts)

This function is called by a TDM when it has discovered a new target and loads appropriate TA for the new target.

void targetDiscarded(string targetId)

A TDM calls this function when a target has been disappeared from the network.

void removeTDM(ITDM* tdm)

Removes the specified tdm from the UCH.

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

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

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

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

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

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

void instantiateTDMs()

Instantiate Local TDMs

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

Call the same method in all TDMs.

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

Call the same method in all TDMs.

Inherited from ITDMListener:

Documentation

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

TDMListener(UCH* uch)

Constructor. Provide the reference of UCH to the local variable.

Parameters:

uch - an Object of UCH

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

string getIpAddress()

Get the IP address of the UCH.

Returns:

return a string value

IUCHStore* getLocalUCHStore()

Get the Local UCH Store.

Returns:

an Object of IUCHStore

list<list<map<string, list<string>*>*>*> * getResources(string sessionId, list<map<string, list<string>*>*>*resPropsList)

Get resource from the UCH specified by Resource Properties.

Parameters:

sessionId - a String value of sessionId
resProps - a list<map<string, list<string>*>*> of Resource Properties

Returns:

a list<list<map<string,list<string>*>*>*> value

map<string, string> * getUCHProps()

Get a Map of UCH Properties.

Returns:

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

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

string startUriService(ITDM* tdm, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

The ITDM requests the UCH to start servicing a URI which is made up of a given scheme, port, and base path. If successful, then the UCH will forward all messages that have this URI as its base, to controllerRequest().

Parameters:

tdm - an Object of ITDM
scheme - a String value of scheme
port - an int value of port number
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)

The ITDM 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

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

string targetDiscovered(ITDM* tdm, map<string, void*>*targetProps, map<string, string>*taProps, list<map<string, IProfile*>*>* contexts)

This function is called by a TDM when it has discovered a new target and loads appropriate TA for the new target. If the corresponding TA is already installed, the new target should be registered with the already installed TA.

Parameters:

tdm - an Object of ITDM
targetProps - a Map<String, Object> of discovered Target Properties
taProps - a Map<String, String> of TA(Target Adapter)'s Properties

Returns:

a String The UCH shall return the targetId (String) that it has assigned the newly discovered target. This may be identical to the property 'targetInstance' in targetProps

void targetDiscarded(string targetId)

A TDM calls this function when a target has been disappeared from the network.

Parameters:

targetId - a String value of targetId

void removeTDM(ITDM* tdm)

Removes the specified tdm from the UCH.

Parameters:

tdm - an Object of ITDM

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

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

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

Returns:

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

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

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

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

Parameters:

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

void instantiateTDMs()

Instantiate Local TDMs

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

Call the same method in all TDMs.

Parameters:

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

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

Call the same method in all TDMs.

Parameters:

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

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