UpnpSatelliteBoxTAFacade (UCH(Universal Control Hub) Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

edu.wisc.trace.uch.ta.upnpsatellitebox
Class UpnpSatelliteBoxTAFacade

java.lang.Object
  edu.wisc.trace.uch.ta.upnpsatellitebox.UpnpSatelliteBoxTAFacade

All Implemented Interfaces:: ITA

public class UpnpSatelliteBoxTAFacade
extends Object
implements ITA
extends Object
implements ITA

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

Version:: $Revision: 1.15 $
Author:: Parikshit Thakur & Team, Trace R&D Center

Constructor Summary
`UpnpSatelliteBoxTAFacade()` Default Constructor.

Method Summary
`void`	`finalize()` This method is called by UCH before Un-installing or Unloading the TA.
`List<Map<String,Object>>`	`getDynRes(String targetId, List<Map<String,String>> resProps)` Get the Dynamic Resources from the TA.
`List<Set<String>>`	`getIndices(String sessionId, List<String> eltIds, List<Integer> indexNos)` Get Indices available on specific level of dimension of dimensional Element.
`Map<String,String>`	`getLocators(String targetName)` Get a map of locators containing locatorId and locatorType for a specific target.
`List<String>`	`getRegisteredTargetIds()` Get the target identifiers that the TA is currently representing.
`List<String>`	`getSessionIds(String targetId, String socketName)` Get the Session Identifiers for specified targetId and socketName.
`String`	`getSocketDescriptionUri(String targetName, String socketName)` Get the URI for retrieving the Socket Description for specified targetName and socketName.
`String`	`getSocketFriendlyName(String targetId, String socketName)` Get the Socket Friendly Name for the specified socketName and targetId.
`String`	`getSocketName(String sessionId)` Get the SocketName for the specified sessionId.
`List<String>`	`getSocketNames(String targetName)` Get the List of SocketName for specified targetName.
`Map<String,String>`	`getTAProps()` Get Target Adapter Properties Map.
`String`	`getTargetDescriptionUri(String targetName)` Get the URI for retrieving the Target Description.
`String`	`getTargetName(String targetId)` Get the targetName for specified targetId.
`Map<String,Object>`	`getTargetProps(String targetId)` Get the Target's Properties for specified targetId.
`Map<String,String>`	`getValues(String sessionId, List<String> paths, List<Boolean> includeSets)` Returns a value/state of the specified socket elements.
`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.
`void`	`invokeLocator(String targetId, String locaterId)` Invoke the specified locator function on a target.
`boolean`	`isElementAvailable(String targetId, String socketName, String eltId)` Checks whether a given socketElement is available in specified Socket of specified Target or not.
`boolean`	`isImplemented(String functionName)` Checks whether specified function is implemented by the TA or not.
`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.
`void`	`registerTarget(String targetId, Map<String,Object> targetProps, List<Map<String,IProfile>> contexts)` Register Target Adapter with specified targetId.
`boolean`	`resumeSessionRequest(String sessionId)` The UCH asks for permission to resume a session.
`void`	`sessionClosed(String sessionId)` Closes the Session for specified sessionId and do the necessary clean-up for the target.
`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.
`void`	`sessionResumed(String sessionId)` The UCH signals the TA that the session has resumed.
`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.
`Map<String,List<String>>`	`setValuesRequest(String sessionId, boolean 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.
`boolean`	`suspendSessionRequest(String sessionId)` The UCH asks for permission to suspend a session.
`void`	`targetContextsAdded(String targetId, List<Map<String,IProfile>> contexts)` Called when one or more contexts got added to an existing target.
`void`	`targetContextsRemoved(String targetId, List<Map<String,IProfile>> contexts)` Called when one or more contexts got removed to an existing target.
`void`	`targetRequest(HttpServletRequest request, HttpServletResponse response, 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.
`void`	`unregisterTarget(String targetId)` Called when target has been disappeared from the network.

Methods inherited from class java.lang.Object
`clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

UpnpSatelliteBoxTAFacade

public UpnpSatelliteBoxTAFacade()

Default Constructor.

Method Detail