edu.wisc.trace.urcsdk.client
Interface IClient

All Known Implementing Classes:

GenericClient

public interface IClient

IClient Interface to be implemented for creating a Client to interact with Targets.

Author:

Parikshit Thakur

Method Summary

void	addListener(IClientListener listener) addListener sets the listener for the Client
void	closeSession(java.lang.String sessionId) closeSession closes session for the requested sessionId
java.util.List<TargetMirror>	getAvailableTargets() getAvailableTargets
java.lang.String[]	getElementIDs(java.lang.String sessionId) Returns an array of elementID's for the requested SessionID
java.lang.String	getElementRef(java.lang.String sessionId, java.lang.String elementId) getElementRef gets the ElementRef for the elementID
java.lang.String	getLabel(java.lang.String sessionId, java.lang.String elementId, java.lang.String stringURI) getLabel gets the Label for the particular elementID
java.lang.String	getLabelForCurrentValue(java.lang.String sessionId, java.lang.String elementId, java.lang.String stringURI) getLabelForCurrentValue gets the Label for the Current Value of the elementID
java.lang.String	getLabelForSocket(java.lang.String targetId, java.lang.String socketName) getLabelForSocket returns the label for the requested SocketName.
java.lang.String	getLabelForTarget(java.lang.String targetId) getLabelForTarget returns Label for requested TargetID.
java.util.Locale	getLocale() getLocale
UserPreferences	getPreferences() getPreferences retrieves the current preferences for resource retrieval, such as language, text/image, etc...
java.lang.String	getResource(java.lang.String sessionId, java.lang.String elementId, java.lang.String role) getResource indirect call to getResource
java.lang.String	getResource(java.lang.String targetId, java.lang.String elementId, java.lang.String valueRef, java.lang.String opRef, java.lang.String role) getResource calls the getResource method of the ResourceManager
java.lang.String	getResourceForOperation(java.lang.String sessionId, java.lang.String elementId, java.lang.String role, java.lang.String opRef) getResourceForOperation indirect call to getResource
java.lang.String	getResourceForValue(java.lang.String sessionId, java.lang.String elementId, java.lang.String role, java.lang.String valRef) getResourceForValue indirect call to getResource
ClientSession	getSessionById(java.lang.String sessionId) Utility method
java.lang.String[]	getSocketIdsForTarget(java.lang.String targetId, java.lang.String filterSocketURI) Returns an array of SocketID's for requested TargetID.
java.lang.String[]	getSocketNamesForTarget(java.lang.String targetId, java.lang.String filterSocketURI) Returns an array of SocketID's for requested TargetID.
java.lang.String	getSocketUriForName(java.lang.String targetId, java.lang.String socketName) Returns an array of URI's for requested SocketName.
java.lang.String[]	getTargetIDs(java.lang.String filterTargetURI) getTargetIDs returns an array of TargetID's for available Targets.
java.lang.String	getTargetUriForId(java.lang.String targetId) getTargetUriForId returns the URI for requested TargetID.
java.util.List<IClientTun>	getTuns() Return a list of all TUNs registed with this Client.
java.lang.Object	getValue(java.lang.String sessionId, java.lang.String elementId) getValue returns the value of the particular elementID
java.lang.Object[]	getValues(java.lang.String sessionId) Returns an array of values for respective elementID's (as returned by getElementIDs) for the requested SessionID
java.lang.String	invokeCommandRequest(java.lang.String sessionId, java.lang.String elementId) invokeCommandRequest Called by the User Interface to modify value of a SocketElement.
boolean	isAvailable(java.lang.String sessionId, java.lang.String elementId) isAvailable
boolean	isReadable(java.lang.String sessionId, java.lang.String elementId) isReadable
boolean	isWritable(java.lang.String sessionId, java.lang.String elementId) isWritable
java.lang.String	openSessionRequest(java.lang.String targetId, java.lang.String socketName) Sends a request to the Target to open a Session
void	sessionAborted(ClientSession clientSession) sessionAborted called from the TunManager when a Session is aborted
boolean	setElementStateRequest(java.lang.String sessionId, java.lang.String elementId, java.lang.String value) setElementStateRequest Called by the User Interface to modify value of a SocketElement.
void	setLanguages(java.lang.String languages) setLanguages Sets the URC's currently available languages to the space-separated parameter languages.
void	setLocale(java.util.Locale locale) setLocale
void	setPreference(java.lang.String name, java.lang.String value) setPreference Sets a preference for the Client specified by name to a given value.
void	targetDiscarded(TargetMirror targetMirror) targetDiscarded is the overridable method for handling when a Target is discarded on a TUN registered with the URC.
void	targetDiscovered(TargetMirror targetMirror) targetDiscovered is the overridable method for handling when a Target is discovered on a TUN registered with the URC.

Method Detail

addListener

void addListener(IClientListener listener)

addListener sets the listener for the Client

Parameters:

listener - an IClientListener value

setLocale

void setLocale(java.util.Locale locale)

setLocale

Parameters:

locale - - Sets the locale that the Client should use when generating its UI.

setPreference

void setPreference(java.lang.String name,
                   java.lang.String value)

setPreference Sets a preference for the Client specified by name to a given value. Examples of preferences are "Language":"en", "RenderType":"text", etc.

Parameters:

name - a String value: the key for a preference's value.

value - a String value: the value for a preference's key.

setLanguages

void setLanguages(java.lang.String languages)

setLanguages Sets the URC's currently available languages to the space-separated parameter languages.

Parameters:

languages - a space-separated String value such as "en de ja".

getAvailableTargets

java.util.List<TargetMirror> getAvailableTargets()

getAvailableTargets

Returns:

A List<TargetMirror> of the currently connected Targets.

getTuns

java.util.List<IClientTun> getTuns()

Return a list of all TUNs registed with this Client.

Returns:

a List<IClientTun>

targetDiscarded

void targetDiscarded(TargetMirror targetMirror)

targetDiscarded is the overridable method for handling when a Target is discarded on a TUN registered with the URC. It is called whenever a Target is removed (either voluntarily or forcibly) from a TUN. Any Target-lost cleanup code should be implemented within this method.

Parameters:

targetMirror - a TargetMirror value

targetDiscovered

void targetDiscovered(TargetMirror targetMirror)

targetDiscovered is the overridable method for handling when a Target is discovered on a TUN registered with the URC. It is called whenever a Target is added to a TUN. Any Target-found init code should go here.

Parameters:

targetMirror - a TargetMirror value

sessionAborted

void sessionAborted(ClientSession clientSession)

sessionAborted called from the TunManager when a Session is aborted

Parameters:

clientSession - a ClientSession value

getPreferences

UserPreferences getPreferences()

getPreferences retrieves the current preferences for resource retrieval, such as language, text/image, etc...

Returns:

an UserPreferences value

getLocale

java.util.Locale getLocale()

getLocale

Returns:

Locale

setElementStateRequest

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

setElementStateRequest Called by the User Interface to modify value of a SocketElement. This is common method used for changing the value of a variable and acknowledging a Notification

Parameters:

sessionId - a String value

elementId - a String value

value - a String value

Returns:

a boolean value

Throws:

UrcException

invokeCommandRequest

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

invokeCommandRequest Called by the User Interface to modify value of a SocketElement. Method used for invoking a Command

Parameters:

sessionId - a String value

elementId - a String value

Returns:

a String value

Throws:

UrcException

getTargetUriForId

java.lang.String getTargetUriForId(java.lang.String targetId)

getTargetUriForId returns the URI for requested TargetID.

Parameters:

targetId - String

Returns:

a String value

getLabelForTarget

java.lang.String getLabelForTarget(java.lang.String targetId)

getLabelForTarget returns Label for requested TargetID.

Parameters:

targetId - String

Returns:

a String value

getSocketIdsForTarget

java.lang.String[] getSocketIdsForTarget(java.lang.String targetId,
                                         java.lang.String filterSocketURI)
                                         throws UrcException

Returns an array of SocketID's for requested TargetID.

Parameters:

targetId - String

filterSocketURI - String is a filter for selection of SocketID's

Returns:

String[]

Throws:

UrcException

getSocketNamesForTarget

java.lang.String[] getSocketNamesForTarget(java.lang.String targetId,
                                           java.lang.String filterSocketURI)
                                           throws UrcException

Returns an array of SocketID's for requested TargetID.

Parameters:

targetId - String

filterSocketURI - String is a filter for selection of SocketID's

Returns:

String[]

Throws:

UrcException

getSocketUriForName

java.lang.String getSocketUriForName(java.lang.String targetId,
                                     java.lang.String socketName)
                                     throws UrcException

Returns an array of URI's for requested SocketName.

Parameters:

targetId - String

socketName - String

Returns:

String[]

Throws:

UrcException

getLabelForSocket

java.lang.String getLabelForSocket(java.lang.String targetId,
                                   java.lang.String socketName)
                                   throws UrcException

getLabelForSocket returns the label for the requested SocketName.

Parameters:

targetId - String

socketName - String

Returns:

String

Throws:

UrcException

getResource

java.lang.String getResource(java.lang.String targetId,
                             java.lang.String elementId,
                             java.lang.String valueRef,
                             java.lang.String opRef,
                             java.lang.String role)

getResource calls the getResource method of the ResourceManager

Parameters:

targetId - String

elementId - String

valueRef - String

opRef - String

role - String

Returns:

String

getSessionById

ClientSession getSessionById(java.lang.String sessionId)

Utility method

Parameters:

sessionId - a String value

Returns:

a ClientSession value

getElementIDs

java.lang.String[] getElementIDs(java.lang.String sessionId)

Returns an array of elementID's for the requested SessionID

Parameters:

sessionId - String

Returns:

String[]

getValues

java.lang.Object[] getValues(java.lang.String sessionId)

Returns an array of values for respective elementID's (as returned by getElementIDs) for the requested SessionID

Parameters:

sessionId - String

Returns:

Object[]

getValue

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

getValue returns the value of the particular elementID

Parameters:

sessionId - String

elementId - String

Returns:

Object

getElementRef

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

getElementRef gets the ElementRef for the elementID

Parameters:

sessionId - String

elementId - String

Returns:

String

getLabel

java.lang.String getLabel(java.lang.String sessionId,
                          java.lang.String elementId,
                          java.lang.String stringURI)

getLabel gets the Label for the particular elementID

Parameters:

sessionId - String

elementId - String

stringURI -

Returns:

String

getLabelForCurrentValue

java.lang.String getLabelForCurrentValue(java.lang.String sessionId,
                                         java.lang.String elementId,
                                         java.lang.String stringURI)

getLabelForCurrentValue gets the Label for the Current Value of the elementID

Parameters:

sessionId - String

elementId - String

stringURI -

Returns:

String

getResource

java.lang.String getResource(java.lang.String sessionId,
                             java.lang.String elementId,
                             java.lang.String role)

getResource indirect call to getResource

Parameters:

sessionId - String

elementId - String

role - String

Returns:

String

getResourceForValue

java.lang.String getResourceForValue(java.lang.String sessionId,
                                     java.lang.String elementId,
                                     java.lang.String role,
                                     java.lang.String valRef)

getResourceForValue indirect call to getResource

Parameters:

sessionId - String

elementId - String

role - String

valRef - String

Returns:

String

getResourceForOperation

java.lang.String getResourceForOperation(java.lang.String sessionId,
                                         java.lang.String elementId,
                                         java.lang.String role,
                                         java.lang.String opRef)

getResourceForOperation indirect call to getResource

Parameters:

sessionId - String

elementId - String

role - String

opRef - String

Returns:

String

isWritable

boolean isWritable(java.lang.String sessionId,
                   java.lang.String elementId)

isWritable

Parameters:

sessionId - String

elementId - String

Returns:

boolean

isReadable

boolean isReadable(java.lang.String sessionId,
                   java.lang.String elementId)

isReadable

Parameters:

sessionId - String

elementId - String

Returns:

boolean

isAvailable

boolean isAvailable(java.lang.String sessionId,
                    java.lang.String elementId)

isAvailable

Parameters:

sessionId - String

elementId - String

Returns:

boolean

getTargetIDs

java.lang.String[] getTargetIDs(java.lang.String filterTargetURI)

getTargetIDs returns an array of TargetID's for available Targets.

Parameters:

filterTargetURI - String is a filter for selection of TargetID's

Returns:

String[]

closeSession

void closeSession(java.lang.String sessionId)
                  throws UrcException

closeSession closes session for the requested sessionId

Parameters:

sessionId - String

Throws:

UrcException

openSessionRequest

java.lang.String openSessionRequest(java.lang.String targetId,
                                    java.lang.String socketName)
                                    throws UrcException

Sends a request to the Target to open a Session

Parameters:

targetId - String

socketName - String

Returns:

String sessionId

Throws:

UrcException