edu.wisc.trace.urcsdk.target
Class TargetTunManager

java.lang.Object
  edu.wisc.trace.urcsdk.target.TargetTunManager

All Implemented Interfaces:

ITargetTunListener

public class TargetTunManager
extends java.lang.Object
implements ITargetTunListener

TargetTunManager manages communication inbetween ITarget's and ITargetTun's

Version:

$Revision: 1.21 $

Author:

Parikshit Thakur & Team

Nested Class Summary

class

TargetTunManager.TunTargetAssociation TunTargetAssociation Used for maintaining Map of Target and TargetTuns.

Field Summary

protected java.util.logging.Logger

logger

Method Summary

void	abortSession(ITarget target, java.lang.String sessionId) abortSession is called from the Target to alert a Client of aborted Session
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
ITargetTun	bindToTargetTun(ITarget target, java.lang.String tunClassName, java.util.Map<java.lang.String,java.lang.Object> parameterMap) bindToTargetTun Used to Bind a Target to a particular TargetTun
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
static TargetTunManager	getInstance() getInstance Get static instance of TargetTunManager.
TargetSession	getSessionById(java.lang.String sessionId) getSessionById Utility method
java.util.List<ITarget>	getTargetsForTargetTun(ITargetTun tTun) getTargetsForTargetTun Utility method
ITargetTun	getTargetTun(java.lang.String tunClassName) getTargetTun Returns the TargetTun instance for the tunClassName specified.
java.util.List<ITargetTun>	getTargetTunsForTarget(ITarget target) getTargetTunsForTarget Utility method
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
ITargetTun	isTunExists(java.lang.String tunClassName) isTunExists Utility Method
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.
void	propagateUpdates(ITarget target, java.lang.String sessionId, java.util.HashMap<java.lang.String,java.lang.Object> accUpdateMap) propogateUpdates is called from the Target to pass a socketElementh update to a Client.
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.
void	unbindTargetTun(ITarget target, java.lang.String tunClassName) unbindTargetTun used to unbind a Target from a particular TargetTun
void	updateElementState(ITarget target, java.lang.String sessionId, IUISocketElement element) updateElementState is called from the Target to alert a Client of a change to a socketElement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected java.util.logging.Logger logger

Method Detail

getInstance

public static TargetTunManager getInstance()

getInstance Get static instance of TargetTunManager. Singleton Pattern.

Returns:

TargetTunManager

updateElementState

public void updateElementState(ITarget target,
                               java.lang.String sessionId,
                               IUISocketElement element)
                        throws UrcException

updateElementState is called from the Target to alert a Client of a change to a socketElement.

Parameters:

target - a ITarget value

sessionId - a String value

element - an IUISocketElement object

Throws:

UrcException

propagateUpdates

public void propagateUpdates(ITarget target,
                             java.lang.String sessionId,
                             java.util.HashMap<java.lang.String,java.lang.Object> accUpdateMap)
                      throws UrcException

propogateUpdates is called from the Target to pass a socketElementh update to a Client.

Parameters:

target -

sessionId -

accUpdateMap -

Throws:

UrcException

abortSession

public void abortSession(ITarget target,
                         java.lang.String sessionId)
                  throws UrcException

abortSession is called from the Target to alert a Client of aborted Session

Parameters:

target - a ITarget value

sessionId - a String value

Throws:

UrcException

openSessionRequest

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

Description copied from interface: ITargetTunListener

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

Specified by:

openSessionRequest in interface ITargetTunListener

Parameters:

targetName - a String value

socketName - a String value

tun - a ITargetTun value

Returns:

a String sessionId

setElementStateRequest

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

Description copied from interface: ITargetTunListener

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

Specified by:

setElementStateRequest in interface ITargetTunListener

Parameters:

sessionId - a String value

elementId - a String value

value - a Object value

Returns:

a boolean response

bindToTargetTun

public ITargetTun bindToTargetTun(ITarget target,
                                  java.lang.String tunClassName,
                                  java.util.Map<java.lang.String,java.lang.Object> parameterMap)
                           throws UrcException

bindToTargetTun Used to Bind a Target to a particular TargetTun

Parameters:

target - ITarget

tunClassName - String

parameterMap - Map

Returns:

ITargetTun

Throws:

UrcException

getTargetTun

public ITargetTun getTargetTun(java.lang.String tunClassName)

getTargetTun Returns the TargetTun instance for the tunClassName specified. Creates a new one if it doesn't exist.

Parameters:

tunClassName - String

Returns:

ITargetTun

isTunExists

public ITargetTun isTunExists(java.lang.String tunClassName)

isTunExists Utility Method

Parameters:

tunClassName - String

Returns:

ITargetTun

unbindTargetTun

public void unbindTargetTun(ITarget target,
                            java.lang.String tunClassName)
                     throws UrcException

unbindTargetTun used to unbind a Target from a particular TargetTun

Parameters:

target - ITarget

tunClassName - String

Throws:

UrcException

getSessionById

public TargetSession getSessionById(java.lang.String sessionId)

getSessionById Utility method

Parameters:

sessionId - String

Returns:

TargetSession

getTargetsForTargetTun

public java.util.List<ITarget> getTargetsForTargetTun(ITargetTun tTun)

getTargetsForTargetTun Utility method

Parameters:

tTun - ITargetTun

Returns:

a List of ITarget

getTargetTunsForTarget

public java.util.List<ITargetTun> getTargetTunsForTarget(ITarget target)

getTargetTunsForTarget Utility method

Parameters:

target - ITarget

Returns:

a List of ITargetTun

invokeCommandRequest

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

Description copied from interface: ITargetTunListener

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

Specified by:

invokeCommandRequest in interface ITargetTunListener

Parameters:

sessionId - a String value

elementId - a String value

Returns:

a String Status

getElementState

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

Description copied from interface: ITargetTunListener

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

Specified by:

getElementState in interface ITargetTunListener

Parameters:

sessionId - a String value

elementId - a String value

Returns:

a Object Value

acknowledgeNotification

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

Description copied from interface: ITargetTunListener

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

Specified by:

acknowledgeNotification in interface ITargetTunListener

Parameters:

sessionId - a String value

elementId - a String value

invokeLocator

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

Description copied from interface: ITargetTunListener

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

Specified by:

invokeLocator in interface ITargetTunListener

Parameters:

targetName - a String

locatorId - a String

closeSession

public void closeSession(java.lang.String sessionId)

Description copied from interface: ITargetTunListener

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

Specified by:

closeSession in interface ITargetTunListener

Parameters:

sessionId - a String

getElementValueMap

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

Description copied from interface: ITargetTunListener

Get Map of SocketElement ID versus its Value

Specified by:

getElementValueMap in interface ITargetTunListener

Returns:

map of socketElement IDs and its values