class ITDMListener

ITDMListener receives calls from TDM.

Inheritance:

Public Methods

[more]virtual list<map<string, IProfile*>*> * getContexts()
[more]virtual void targetContextsAdded(string targetId, list<map<string, IProfile*>*>*contexts)
[more]virtual void targetContextsRemoved(string targetId, list<map<string, IProfile*>*>* contexts)
[more]virtual 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.
[more]virtual void targetDiscarded(string targetId)
A TDM calls this function when a target has been disappeared from the network.
[more]virtual IUCHStore* getLocalUCHStore()
Get the Local UCH Store.
[more]virtual string getDocument(string uri, string postData, map<string, IProfile*>*context)
Get specified document through HTTP GET or POST.
[more]virtual list<list<map<string,list<string>*>*>*> * getResources(string sessionId, list<map<string, list<string>*>*>* resPropsList)
Get resource from the UCH specified by Resource Properties.
[more]virtual map<string, string> * getUCHProps()
Get a Map of UCH Properties.
[more]virtual bool isImplemented(string functionName)
Checks whether specified function is implemented or not.
[more]virtual string getIpAddress()
Get the IP address of the UCH.
[more]virtual 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.
[more]virtual 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().
[more]virtual void addUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)
[more]virtual void removeUriServiceContexts(string uri, list<map<string, IProfile*>*>* contexts)
[more]virtual list<map<string, string>*> * uploadResources(list<map<string, list<string>*>*>* props, list<string>* resourceUri)
Upload Resources on Resource Server.
[more]virtual void removeTDM(ITDM* tdm)
Removes the specified tdm from the UCH.

Documentation

ITDMListener receives calls from TDM. UCH implements this interface. The Listener gets information from TDM regarding Discovery and Discarding of devices.

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

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

ovirtual 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

ovirtual 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

ovirtual 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

ovirtual 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

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

Returns:
an Object of IUCHStore

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

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

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

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 string getIpAddress()
Get the IP address of the UCH.

Returns:
return a string value

ovirtual 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

ovirtual 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

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

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

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

ovirtual void removeTDM(ITDM* tdm)
Removes the specified tdm from the UCH.

Parameters:
tdm - an Object of ITDM

Direct child classes:
TDMListener
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++.