class ITA

TA (Target Adapter) is the link inbetween UCH and final proprietory Target.

Public Methods

[more]virtual void targetContextsAdded(string targetId, list<map<string, IProfile*>*>* contexts)
[more]virtual void targetContextsRemoved(string targetId, list<map<string, IProfile*>*>* contexts)
[more]virtual void init(ITAListener* taListener, map<string, string>* taProps, map<string, string>* uchProps)
When the TA is installed and loaded, this method is called by UCH prior to any other TA function.
[more]virtual void finalize()
This method is called by UCH before Un-installing or Unloading the TA.
[more]virtual map<string, string> * getTAProps()
Get Target Adapter Properties Map.
[more]virtual void registerTarget(string targetId, map<string, void*>* targetProps, list<map<string, IProfile*>*>* contexts)
Register Target Adapter with specified targetId.
[more]virtual void unregisterTarget(string targetId)
Called when target has been disappeared from the network.
[more]virtual list<string> * getRegisteredTargetIds()
Get the target identifiers that the TA is currently representing.
[more]virtual string getTargetName(string targetId)
Get the TargetName specified by targetId.
[more]virtual map<string, void*> * getTargetProps(string targetId)
Get the Target's Properties for specified targetId.
[more]virtual list<string> * getSocketNames(string targetName)
Get the List of SocketName for specified targetName.
[more]virtual string getSocketName(string sessionId)
Get the SocketName for the specified sessionId.
[more]virtual list<string> * getSessionIds(string targetId, string socketName)
Get the Session Identifiers for specified targetId and socketName.
[more]virtual string getSocketDescriptionUri(string targetName, string socketName)
[more]virtual map<string, string> * openSessionRequest(string targetId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* contexts)
The UCH asks for permission to open a session with a specified client on a specified socket.
[more]virtual void sessionOpened(string targetId, string sessionId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* context)
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.
[more]virtual void sessionClosed(string sessionId)
Closes the Session for specified sessionId and do the necessary clean-up for the target.
[more]virtual map<string, list<string>*> * setValuesRequest(string sessionId, bool isValidated, 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.
[more]virtual map<string, string> * getValues(string sessionId, list<string>* paths, list<bool>* includeSets)
Returns a value/state of the specified socket elements.
[more]virtual list<map<string, void*>*> * getDynRes(string targetId, list<map<string, string>*>* resProps)
Get the Dynamic Resources from the TA.
[more]virtual bool isImplemented(string functionName)
Checks whether specified function is implemented by the TA or not.
[more]virtual string getSocketFriendlyName(string targetName, string socketName)
Get the Socket Friendly Name for the specified socketName and targetId.
[more]virtual string getTargetDescriptionUri(string targetName)
Get the URI for retrieving the Target Description.
[more]virtual bool isElementAvailable(string targetId, string socketName, string eltId)
Checks whether a given socketElement is available in specified Socket of specified Target or not.
[more]virtual map<string, string> * getLocators(string targetName)
Get a map of locators containing locatorId and locatorType for a specific target.
[more]virtual void invokeLocator(string targetId, string locatorId)
Invoke the specified locator function on a target.
[more]virtual void targetRequest( map<string, string>* requestMap, map<string, string>* responseMap, map<string, IProfile*>* context )
The UCH calls this function if it has received a request from a target to a URI that the TA has claimed for itself by a previous call to startUriService()It modify the response object according to request object.
[more]virtual list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)
Get Indices available on specific level of dimension of dimensional Element.
[more]virtual bool suspendSessionRequest(string sessionId)
The UCH asks for permission to suspend a session.
[more]virtual long sessionSuspended(string sessionId, long suggestedTimeout)
The UCH signals the TA that the client has suspended a session with one of the TA’s targets.
[more]virtual bool resumeSessionRequest(string sessionId)
The UCH asks for permission to resume a session.
[more]virtual void sessionResumed(string sessionId)
The UCH signals the TA that the session has resumed.

Documentation

TA (Target Adapter) is the link inbetween UCH and final proprietory Target. It converts URC protocol to Target proprietory protocol and vice-versa. A Target Adapter (TA) represents one or multiple targets to the UCH. It is installed and loaded upon the discovery of a first target that it can represent. The UCH will register new targets with the TA as they are discovered by the TDM; and unregister after they have disappeared from the network. After having opened a session on a target’s socket, the TA is responsible for managing the values of the pertaining socket instance.

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 @throws UIPMFatalException an Object of org.myurc.uch.UIPMFatalException

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 @throws UIPMFatalException an Object of org.myurc.uch.UIPMFatalException

ovirtual void init(ITAListener* taListener, map<string, string>* taProps, map<string, string>* uchProps)
When the TA is installed and loaded, this method is called by UCH prior to any other TA function. Within this method the TA initializes 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

ovirtual void finalize()
This method is called by UCH before Un-installing or Unloading the TA.

ovirtual map<string, string> * getTAProps()
Get Target Adapter Properties Map.

Returns:
an object of Map<String, String> of Target Adapter Properties

ovirtual void registerTarget(string targetId, map<string, void*>* targetProps, list<map<string, IProfile*>*>* contexts)
Register Target Adapter with specified targetId.

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

ovirtual void unregisterTarget(string targetId)
Called when target has been disappeared from the network.

Parameters:
targetId - a String value of targetId @throws TAFatalException

ovirtual list<string> * getRegisteredTargetIds()
Get the target identifiers that the TA is currently representing.

Returns:
List<String> @throws TAFatalException

ovirtual string getTargetName(string targetId)
Get the TargetName specified by targetId.

Parameters:
targetId - a String value of targetId
Returns:
a String value of targetName @throws TAFatalException

ovirtual map<string, void*> * getTargetProps(string targetId)
Get the Target's Properties for specified targetId.

Parameters:
targetId - a String value of targetId
Returns:
a Map<String, Object> value of Target Properties @throws TAFatalException

ovirtual list<string> * getSocketNames(string targetName)
Get the List of SocketName for specified targetName.

Parameters:
targetName - a String value of targetName
Returns:
List<String> of SocketName @throws TAFatalException

ovirtual string getSocketName(string sessionId)
Get the SocketName for the specified sessionId.

Parameters:
sessionId - a String value of sessionId
Returns:
a String of SocketName @throws TAFatalException

ovirtual list<string> * getSessionIds(string targetId, string socketName)
Get the Session Identifiers for specified targetId and socketName.

Parameters:
targetId - a String value of targetId
socketName - a String value of socketName
Returns:
List<String> of sessionId @throws TAFatalException

ovirtual string getSocketDescriptionUri(string targetName, string socketName)

Get the URI for retrieving the Socket Description for specified targetName and socketName.

Parameters:
targetName - a String value of targetName
socketName - a String value of socketName
Returns:
a String representing Socket Description URI @throws TAFatalException

ovirtual map<string, string> * openSessionRequest(string targetId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* contexts)
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

ovirtual void sessionOpened(string targetId, string sessionId, string socketName, map<string, string>* clientProps, map<string, IProfile*>* context)
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

ovirtual void sessionClosed(string sessionId)
Closes the Session for specified sessionId and do the necessary clean-up for the target.

Parameters:
sessionId - a String value of sessionId @throws TAFatalException

ovirtual map<string, list<string>*> * setValuesRequest(string sessionId, bool isValidated, 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> a List of elementPaths
operations - List<String> a List of operations (allowed operations are "S", "A", "R", "I" or "K" )
reqValues - List<String> a List of Requested Values
Returns:
Map<String, List<String>> of set Values @throws TAFatalException

ovirtual 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 - a List<String> of elementPath
includeSets - a List<Boolean> of includeSets
Returns:
a Map<String, String> of values @throws TAFatalException

ovirtual list<map<string, void*>*> * getDynRes(string targetId, list<map<string, string>*>* resProps)
Get the Dynamic Resources from the TA. The UCH shall specify the properties of the requested resource as many as possible.

Parameters:
sessionId - a String value of sessionId
resProps - a List<Map<String, String>> value of Resource Properties
Returns:
a List<Object> of resources @throws TAFatalException

ovirtual bool isImplemented(string functionName)
Checks whether specified function is implemented by the TA or not.

Parameters:
functionName - a String value of functionName
Returns:
boolean whether specified function is implemented by the TA or not.

ovirtual string getSocketFriendlyName(string targetName, string socketName)
Get the Socket Friendly Name for the specified socketName and targetId.

Parameters:
targetId - a String value of targetId
socketName - a String value of socketName
Returns:
a String value of Socket Friendly Name

ovirtual string getTargetDescriptionUri(string targetName)
Get the URI for retrieving the Target Description.

Parameters:
targetName - a String value of targetName
Returns:
a String value of Target Description URI @throws TAFatalException

ovirtual bool isElementAvailable(string targetId, string socketName, string eltId)
Checks whether a given socketElement is available in specified Socket of specified Target or not.

Parameters:
targetId - a String value of targetId
socketName - a String value of socketName
eltId - a String value of eltId
Returns:
boolean whether specified socketElement is exists or not @throws TAFatalException

ovirtual map<string, string> * getLocators(string targetName)
Get a map of locators containing locatorId and locatorType for a specific target.

Parameters:
targetName - a String value of targetName
Returns:
a Map<string, String> of LocatorID V/S Locator Type

ovirtual void invokeLocator(string targetId, string locatorId)
Invoke the specified locator function on a target. This requires a prior call to registerTarget on this target.

Parameters:
targetId - a String value of targetId
locatorId - a String value of locaterId @throws TAException @throws TAFatalException

ovirtual void targetRequest( map<string, string>* requestMap, map<string, string>* responseMap, map<string, IProfile*>* context )
The UCH calls this function if it has received a request from a target to a URI that the TA has claimed for itself by a previous call to startUriService()It modify the response object according to request object.

Parameters:
request - a request Map Object
response - a response Map Object @throws TAFatalException

ovirtual list<list<string>*> * getIndices(string sessionId, list<string>*eltIds, list<string>*indexNos)
Get Indices available on specific level of dimension of dimensional Element.

Parameters:
sessionId - a String value of sessionId
eltIds - a List<String> of elementIds
indexNos - a List<Integer> of indexNo
Returns:
a List<Set<Integer> of indices

ovirtual bool suspendSessionRequest(string sessionId)
The UCH asks for permission to suspend a session. If TA does not support this function then throw TANotImplementedException.

Parameters:
sessionId - a String value of sessionId
Returns:
whether permission for session suspend is granted or not @throws TAFatalException @throws TANotImplementedException

ovirtual long sessionSuspended(string sessionId, long suggestedTimeout)
The UCH signals the TA that the client has suspended a session with one of the TA’s targets. The TA do the necessary actions internally and with the target. The session is now suspended until a subsequent call to resumeSessionRequest(), or until the TA terminates the session for timing out or other reasons, in which case the TA shall call sessionAborted().

Parameters:
sessionId - a String value of sessionId
suggestedTimeout - a long value of suggestedTimeout
Returns:
whether permission is granted or not @throws TAException @throws TAFatalException @throws TANotImplementedException

ovirtual bool resumeSessionRequest(string sessionId)
The UCH asks for permission to resume a session. If TA does not support this function then throw TANotImplementedException.

Parameters:
sessionId - a String value of sessionId
Returns:
a a Long value of timeOut @throws TAFatalException @throws TANotImplementedException

ovirtual void sessionResumed(string sessionId)
The UCH signals the TA that the session has resumed. A call to this function shall only occur after a resume session request has been granted by the TA.

Parameters:
sessionId - a string value of sessionId @throws TAException @throws TAFatalException @throws TANotImplementedException

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


This page was generated with the help of DOC++.