class UpnpSatelliteBoxTAFacade

Provides the method to Get/Set target Value/State and forward update and received events to ITAListener.

Inheritance:

Public Methods

UpnpSatelliteBoxTAFacade()

Basic Constructor for UpnpSatelliteBoxTAFacade

void init(ITAListener* taListener, map<string, string>* taProps, map<string, string>* uchProps)

When the TA is installed and loaded, the UCH calls this method prior to any other TA function.

void registerTarget(string targetId, map<string, void*>* targetProps)

Register Target Adapter with specified targetId.

map<string, string> * openSessionRequest(string targetId, string socketName, map<string, string>* clientProps)

The UCH asks for permission to open a session with a specified client on a specified socket.

void sessionOpened(string targetId, string sessionId, string socketName, map<string, string>* clientProps)

If the TA has accepted an open session request, and if the UCH succeeded in the necessary steps to open a session with the client, the UCH will call sessionOpened and provide the sessionId pertaining to the new session.

void unregisterTarget(string targetId)

Called when target has been disappeared from the network.

void eventNotification(string sid, string changes)

It is called from IUpdateListener when any eventNotification is received and forward the call by invoking updateValues method of relative UpnpSatelliteBoxTA .

string getSocketFriendlyName(string targetName, string socketName)

Get Friendly Name for a socket.

string getSocketName(string sessionId)

Get the Socket Name for the specified sessionId.

list<string> * getSocketNames(string targetName)

Get the name of the sockets for specified targetName.

string getTargetName(string targetId)

Get the name of the Target.

string getTargetDescriptionUri(string targetName)

Get the URI for retrieving the Target Description.

string getSocketDescriptionUri(string targetName, string socketName)

Get the URI for retrieving the Socket Description.

map<string, list<string>*> * setValuesRequest(string sessionId, list<string>* paths, list<string>* operations, list<string>* reqValues)

The client requests to change the target state in one or more operations on specified socket elements.

map<string, string> * getValues(string sessionId, list<string>* paths)

Returns a value/state of the specified socket elements.

bool isElementAvailable(string targetId, string socketName, string eltId)

Checks whether a given socketElement is available or not.

map<string, void*> * getTargetProps(string targetId)

Get the Target's Properties for specified targetId.

list<string> * getRegisteredTargetIds()

Get the target identifiers that the TA is currently representing.

void sessionClosed(string sessionId)

Closes the Session with specific sessionId and do the necessary clean-up for the target.

void finalize()

The UCH should call finalize() before it Un-installs or Unloads the TA.

list<map<string,void*>*> * getDynRes(string targetId, list<map<string, string>*>* resProps)

Get the Dynamic atomic Resources from the TA.

map<string, string> * getLocators(string targetName)

Get a map with Locator ids and locator types for a specific target type.

bool isImplemented(string functionName)

Checks whether any of the functions are implemented by the TA or not.

Inherited from IUpdateListener:

Documentation

Provides the method to Get/Set target Value/State and forward update and received events to ITAListener.

UpnpSatelliteBoxTAFacade()

Basic Constructor for UpnpSatelliteBoxTAFacade

void init(ITAListener* taListener, map<string, string>* taProps, map<string, string>* uchProps)

When the TA is installed and loaded, the UCH calls this method prior to any other TA function. Within this method the TA should initialize itself.

Parameters:

taListener - an Object of ITAListener
taProps - a Map<String, String> of ITA Properties
uchProps - a Map<String, String> of UCH Properties @throws TAFatalException

void registerTarget(string targetId, map<string, void*>* targetProps)

Register Target Adapter with specified targetId.

Parameters:

targetId - a String value of targetId
targetProps - Map<String, Object> @throws TAException @throws TAFatalException

map<string, string> * openSessionRequest(string targetId, string socketName, map<string, string>* clientProps)

The UCH asks for permission to open a session with a specified client on a specified socket. If it is permitted then a map returns a keyValue pair {"Result", "A"} i.e. Accept Else it returns a keyValue pair {"Result", "R"} i.e. rejection.

Parameters:

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

Returns:

Map<String, String> @throws TAFatalException

void sessionOpened(string targetId, string sessionId, string socketName, map<string, string>* clientProps)

If the TA has accepted an open session request, and if the UCH succeeded in the necessary steps to open a session with the client, the UCH will call sessionOpened and provide the sessionId pertaining to the new session. It opens a new Session for specified socketName with the targetId mentioned.

Parameters:

targetId - a String value of targetId
sessionId - a String value of sessionId
socketName - a String value of socketName
clientProps - Map<String, String> @throws TAFatalException

void unregisterTarget(string targetId)

Called when target has been disappeared from the network.

Parameters:

targetId - a String value of targetId @throws TAFatalException

void eventNotification(string sid, string changes)

It is called from IUpdateListener when any eventNotification is received and forward the call by invoking updateValues method of relative UpnpSatelliteBoxTA .

Parameters:

sid - a String value of the subscriptionId
changes - a String representing update

string getSocketFriendlyName(string targetName, string socketName)

Get Friendly Name for a socket.

Parameters:

targetId - a String value of targetId
socketName - a String value of socketName

Returns:

a String

string getSocketName(string sessionId)

Get the Socket Name for the specified sessionId.

Parameters:

sessionId - a String value of sessionId

Returns:

a String @throws TAFatalException

list<string> * getSocketNames(string targetName)

Get the name of the sockets for specified targetName.

Parameters:

targetName - a String value of targetName

Returns:

List<String> @throws TAFatalException

string getTargetName(string targetId)

Get the name of the Target.

Parameters:

targetId - a String value of targetId

Returns:

a String @throws TAFatalException

string getTargetDescriptionUri(string targetName)

Get the URI for retrieving the Target Description.

Parameters:

targetName - a String value of targetName

Returns:

a String @throws TAFatalException

string getSocketDescriptionUri(string targetName, string socketName)

Get the URI for retrieving the Socket Description.

Parameters:

targetName - a String value of targetName
socketName - a String value of socketName

Returns:

a String representing Socket Description URI @throws TAFatalException

map<string, list<string>*> * setValuesRequest(string sessionId, list<string>* paths, list<string>* operations, list<string>* reqValues)

The client 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, operations, identifiers and requested new values.

Parameters:

sessionId - a String value of sessionId
isValidated - a boolean value of isValidated
paths - List<String> of paths
operations - List<String> of operations
reqValues - List<String> of reqValues

Returns:

Map<String, List<String>> @throws TAFatalException

map<string, string> * getValues(string sessionId, list<string>* paths)

Returns a value/state of the specified socket elements.

Parameters:

sessionId - a String value of sessionId
paths - List<String>

Returns:

Map<String, String> @throws TAFatalException

bool isElementAvailable(string targetId, string socketName, string eltId)

Checks whether a given socketElement is available or not.

Parameters:

targetId - a String value of targetId
socketName - a String value of socketName
eltId - a String value of eltId

Returns:

boolean @throws TAFatalException

map<string, void*> * getTargetProps(string targetId)

Get the Target's Properties for specified targetId.

Parameters:

targetId - a String value of targetId

Returns:

Map<String, Object> @throws TAFatalException

list<string> * getRegisteredTargetIds()

Get the target identifiers that the TA is currently representing.

Returns:

List<String> @throws TAFatalException

void sessionClosed(string sessionId)

Closes the Session with specific sessionId and do the necessary clean-up for the target.

Parameters:

sessionId - @throws TAFatalException

void finalize()

The UCH should call finalize() before it Un-installs or Unloads the TA.

list<map<string,void*>*> * getDynRes(string targetId, list<map<string, string>*>* resProps)

Get the Dynamic atomic Resources from the TA. The UCH shall specify the properties of the requested resource as many as possible.

Parameters:

targetId - a String value
resProps - List<Map<String, String>>

Returns:

List<Object> @throws TAFatalException

map<string, string> * getLocators(string targetName)

Get a map with Locator ids and locator types for a specific target type.

Parameters:

targetName - a String value of targetName

Returns:

a Map<string, String> of LocatorID V/S Locator Type

bool isImplemented(string functionName)

Checks whether any of the functions are implemented by the TA or not.

Parameters:

functionName - a String value of functionName

Returns:

boolean

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