class TAListener

Implements the methods of ITAListener.

Inheritance:

Public Methods

TAListener(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()

Gets an Object of LocalUCHStore.

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)

Returns whether specified function is implemented or not.

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

The ITA 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 ITA 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.

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

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

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

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

void abortSession(string sessionId)

The TA has terminated a session.

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

The TA requests the client to open a session with different socket.

bool setValidation(ITA* ta, bool activate)

Check whether to do validation for the TA or not.

void updateDynRes(list<string>* sessionIds, list<string>* eltIds)

Signals that the set of atomic resources pertaining to a specific socket element has changed.

string targetDiscovered(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 disappeared from the network.

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

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

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

Returns a value/state of the specified socket elements.

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.

list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)

This function will return map containing pairs of element identifiers and it's indexed values.

void closeSession(string sessionId)

Closes the session with specified sessionId.

list<string> * getAvailableTargetIds()

Get List of available targetIds

string getSocketDescriptionUri(string targetId, string socketName)

Get the URI of the Socket Description for the specified targetId and socketName.

string getSocketFriendlyName(string targetId, string socketName)

Get the Socket Friendly Name for the specified targetId and socketName.

string getSocketName(string sessionId)

Get String value of Socket Name specified by 'sessionId'.

list<string> * getSocketNames(string targetName)

Get socket Names for the specified Target Name.

string getTargetDescriptionUri(string targetName)

Get the URI of the Target Description for the specified Target Name.

string getTargetName(string targetId)

Get the Target Name for specified targetId.

string getTargetFriendlyName( string targetId )

Get Friendly Name of Target

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

Get Target Properties specified by 'targetId'

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

Return whether the AbstractUISocketElement specified by 'elementId' is available in the target specified by 'targetId'

void invokeLocator(string targetId, string locatorId)

Invoke the specified locator function on the specified target.

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

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

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

Get the Dynamic atomic Resources from the TA.

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

Find relative TA for specified targetId and add contexts to it.

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

Find relative TA for specified targetId and remove contexts from it.

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

The TA signals a change in the target�s status, affecting one or more sessions.

Inherited from ITAListener:

Documentation

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

TAListener(UCH*uch)

Constructor. Provide the reference of UCH to 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
context - a Map<string, IProfile>

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

Gets an Object of LocalUCHStore.

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)

Returns 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(ITA* ta, string scheme, int port, bool portIsFlexible, string basePath, bool basePathIsFlexible, list<map<string, IProfile*>*>* contexts)

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

Parameters:

ta - an ITA object
scheme - a String value of schema
port - a port no
portIsFlexible - a boolean value
basePath - a String value of basePath
basePathIsFlexible - a boolean value
contexts - a List<Map<String, IProfile>>

Returns:

a String value of URI @throws UCHException

void stopUriService(string uri)

The ITA 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 Map<String, String>

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 an Object of org.myurc.uch.UCHException

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

Parameters:

targetId - a String value of targetId

Returns:

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

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 an Object of org.myurc.uch.UCHException

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

Parameters:

targetId - a String value of targetId

Returns:

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

void abortSession(string sessionId)

The TA has terminated a session.

Parameters:

sessionId - a String value of sessionId

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

The TA requests the client to open a session with different socket.

Parameters:

sessionId - a String value of sessionId
forwardInfo - Map<String, String>

bool setValidation(ITA* ta, bool activate)

Check whether to do validation for the TA or not.

Parameters:

ta - an Object of ITA
activate - a boolean value of activate

Returns:

boolean whether to do validation for the TA or not

void updateDynRes(list<string>* sessionIds, list<string>* eltIds)

Signals that the set of atomic resources pertaining to a specific socket element has changed. It is called by ITA and it's for dynamic resource.

Parameters:

sessionIds - a List<String> value of sessionIds
eltIds - a List<String> value of eltIds

string targetDiscovered(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:

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 disappeared from the network.

Parameters:

targetId - a String value of targetId

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

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

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

Returns a value/state of the specified socket elements.

Parameters:

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

Returns:

Map<String, String> @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
paths - List<String>
operations - List<String>(allowed operations are "S", "A", "R", "I" or "K" )
reqValues - List<String>

Returns:

Map<String, List<String>>. Map contains keys "paths","values" and "operations". Various Values of paths, operations and values are stored in List<string>. @throws TAFatalException

list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)

This function will return map containing pairs of element identifiers and it's indexed values.

Parameters:

sessionId - String Value of sessionId
eltIds - list of elementids
indexNos - list of indices

Returns:

Map containing element identifiers and indexed values

void closeSession(string sessionId)

Closes the session with specified sessionId.

Parameters:

sessionId - a String value of sessionId @throws TAFatalException

list<string> * getAvailableTargetIds()

Get List of available targetIds

Returns:

a List<String> of targetIds

string getSocketDescriptionUri(string targetId, string socketName)

Get the URI of the Socket Description for the specified targetId and socketName.

Parameters:

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

Returns:

String of Socket Description URI @throws TAFatalException

string getSocketFriendlyName(string targetId, string socketName)

Get the Socket Friendly Name for the specified targetId and socketName.

Parameters:

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

Returns:

String of Socket Friendly Name

string getSocketName(string sessionId)

Get String value of Socket Name specified by 'sessionId'.

Parameters:

sessionId - a String value of sessionId

Returns:

String Value of socket name

list<string> * getSocketNames(string targetName)

Get socket Names for the specified Target Name.

Parameters:

targetName - a String value of targetName

Returns:

List<String> of socket Names @throws TAFatalException

string getTargetDescriptionUri(string targetName)

Get the URI of the Target Description for the specified Target Name.

Parameters:

targetName - a String value of targetName

Returns:

String of TargetDescriptionUri @throws TAFatalException

string getTargetName(string targetId)

Get the Target Name for specified targetId.

Parameters:

targetId - a String value of targetId

Returns:

String Value of target Name

string getTargetFriendlyName( string targetId )

Get Friendly Name of Target

Parameters:

targetId - a String variable

Returns:

a String variable - FriendlyName

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

Get Target Properties specified by 'targetId'

Parameters:

targetId - a String value of targetId

Returns:

a Map<String, Object> of Target Properties

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

Return whether the AbstractUISocketElement specified by 'elementId' is available in the target specified by 'targetId'

Parameters:

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

Returns:

whether element specified by elementId is available or not. @throws TAFatalException

void invokeLocator(string targetId, string locatorId)

Invoke the specified locator function on the specified target.

Parameters:

targetId - a String value of TargetId
locatorId - a String value of LocatorId

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

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

Get the Dynamic atomic Resources from the TA. Retrives resource for elements specified by ITA using method updateDynRes to ITAListener. The UCH shall specify the properties of the requested resource as much as possible.

Parameters:

sessionId - String Value of 'sessionId'
resProps - a List<Map<String, String>>

Returns:

a list<map<string, Object>> for given resProps List

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

Find relative TA for specified targetId and add contexts to it.

Parameters:

targetId - a String value of targetId
contexts - an object of List<Map<String, IProfile<< specifies contexts

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

Find relative TA for specified targetId and remove contexts from it.

Parameters:

targetId - a String value of targetId
contexts - an object of List<Map<String, IProfile<< specifies contexts

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

The TA signals a change in the target�s status, 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

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