edu.wisc.trace.urcsdk.target
Interface ITargetTunListener

All Known Implementing Classes:

TargetTunManager

public interface ITargetTunListener

ITargetTunListener is used to listen to ITargetTun

Version:

$Revision: 1.21 $

Author:

Parikshit Thakur & Team

Method Summary

void	acknowledgeNotification(java.lang.String sessionId, java.lang.String elementId) acknowledgeNotification is called from the lower level of the Tun, when a Urc acknowledges a Notification
void	closeSession(java.lang.String sessionId) closeSession is called from the lower level of the Tun, when a Urc wants to close a Session
java.lang.Object	getElementState(java.lang.String sessionId, java.lang.String elementId) getElementState is an incoming call from the lower levels of the Tun, from a Client that needs the current value of a SocketElement
java.util.HashMap<java.lang.String,java.lang.Object>	getElementValueMap(java.lang.String sessionId) Get Map of SocketElement ID versus its Value
java.lang.String	invokeCommandRequest(java.lang.String sessionId, java.lang.String elementId) invokeCommandRequest is called from the lower level of the Tun, when a Urc wants to invoke a Command
void	invokeLocator(java.lang.String targetName, java.lang.String locatorId) invokeLocator is called from the lower level of the Tun, when a Urc wants to invoke a Locator on the Target
java.lang.String	openSessionRequest(java.lang.String targetName, java.lang.String socketName, ITargetTun tun) openSessionRequest is called from the lower level of the Tun, when a Client needs to open a session.
boolean	setElementStateRequest(java.lang.String sessionId, java.lang.String elementId, java.lang.Object value) setElementStateRequest is called from the lower level of the Tun, when a Urc wants to set the value of a stateElement.

Method Detail

openSessionRequest

java.lang.String openSessionRequest(java.lang.String targetName,
                                    java.lang.String socketName,
                                    ITargetTun tun)

openSessionRequest is called from the lower level of the Tun, when a Client needs to open a session.

Parameters:

targetName - a String value

socketName - a String value

tun - a ITargetTun value

Returns:

a String sessionId

invokeCommandRequest

java.lang.String invokeCommandRequest(java.lang.String sessionId,
                                      java.lang.String elementId)

invokeCommandRequest is called from the lower level of the Tun, when a Urc wants to invoke a Command

Parameters:

sessionId - a String value

elementId - a String value

Returns:

a String Status

setElementStateRequest

boolean setElementStateRequest(java.lang.String sessionId,
                               java.lang.String elementId,
                               java.lang.Object value)

setElementStateRequest is called from the lower level of the Tun, when a Urc wants to set the value of a stateElement.

Parameters:

sessionId - a String value

elementId - a String value

value - a Object value

Returns:

a boolean response

getElementState

java.lang.Object getElementState(java.lang.String sessionId,
                                 java.lang.String elementId)

getElementState is an incoming call from the lower levels of the Tun, from a Client that needs the current value of a SocketElement

Parameters:

sessionId - a String value

elementId - a String value

Returns:

a Object Value

acknowledgeNotification

void acknowledgeNotification(java.lang.String sessionId,
                             java.lang.String elementId)

acknowledgeNotification is called from the lower level of the Tun, when a Urc acknowledges a Notification

Parameters:

sessionId - a String value

elementId - a String value

invokeLocator

void invokeLocator(java.lang.String targetName,
                   java.lang.String locatorId)

invokeLocator is called from the lower level of the Tun, when a Urc wants to invoke a Locator on the Target

Parameters:

targetName - a String

locatorId - a String

closeSession

void closeSession(java.lang.String sessionId)

closeSession is called from the lower level of the Tun, when a Urc wants to close a Session

Parameters:

sessionId - a String

getElementValueMap

java.util.HashMap<java.lang.String,java.lang.Object> getElementValueMap(java.lang.String sessionId)

Get Map of SocketElement ID versus its Value

Parameters:

sessionId -

Returns:

map of socketElement IDs and its values