Package uk.ac.gda.client.interfaces.impl

Class BatonStateProviderBean

java.lang.Object

uk.ac.gda.client.interfaces.impl.BatonStateProviderBean

All Implemented Interfaces:

IBatonStateProvider

public class BatonStateProviderBean
extends Object
implements IBatonStateProvider

Method Summary

Modifier and Type	Method	Description
void	addBatonChangedObserver(gda.observable.IObserver anObserver)
boolean	amIBatonHolder()	Checks if the caller is the holder of the baton
void	assignBaton(int receiverIndex, int holderIndex)
void	changeVisitID(String visitID)	Switches the visit this client will collect data as when it holds the baton.
void	deleteBatonChangedObserver(gda.observable.IObserver anObserver)
ClientDetails	getBatonHolder()	Returns the baton holder from the list of known clients connected, even if the baton holder is this client.
List<UserMessage>	getMessageHistory()	Returns previous messages sent during this visit.
ClientDetails	getMyDetails()	Returns the current ClientDetails for this client.
ClientDetails[]	getOtherClientInformation()
boolean	isBatonHeld()	This checks if the baton is held, at all, by any client.
boolean	requestBaton()
void	returnBaton()
void	revertToOriginalUser()	Reverts to the original user this client was initially logged in as.
void	sendMessage(String message)	Broadcast a message to other users on this beamline.
boolean	switchUser(String username, String password)
void	update(Object dataSource, Object data)

Methods inherited from class java.lang.Object

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

Method Details

isBatonHeld

public boolean isBatonHeld()

Description copied from interface: IBatonStateProvider

This checks if the baton is held, at all, by any client. It does not check it the caller is the baton holder.

Specified by:

isBatonHeld in interface IBatonStateProvider

Returns:

true if the baton is held by any client, false otherwise

See Also:

• to check if the caller is the baton holder
• Jython.isBatonHeld()

addBatonChangedObserver

public void addBatonChangedObserver(gda.observable.IObserver anObserver)

Specified by:

addBatonChangedObserver in interface IBatonStateProvider

Parameters:

anObserver -

deleteBatonChangedObserver

public void deleteBatonChangedObserver(gda.observable.IObserver anObserver)

Specified by:

deleteBatonChangedObserver in interface IBatonStateProvider

Parameters:

anObserver -

amIBatonHolder

public boolean amIBatonHolder()

Description copied from interface: IBatonStateProvider

Checks if the caller is the holder of the baton

Specified by:

amIBatonHolder in interface IBatonStateProvider

Returns:

true if the caller holds the baton false otherwise

See Also:

• Jython.amIBatonHolder(String)

getBatonHolder

public ClientDetails getBatonHolder()

Description copied from interface: IBatonStateProvider

Returns the baton holder from the list of known clients connected, even if the baton holder is this client.

Specified by:

getBatonHolder in interface IBatonStateProvider

Returns:

ClientDetails

returnBaton

public void returnBaton()

Specified by:

returnBaton in interface IBatonStateProvider

See Also:

• Jython.requestBaton(String)

requestBaton

public boolean requestBaton()

Specified by:

requestBaton in interface IBatonStateProvider

Returns:

boolean

See Also:

• Jython.requestBaton(String)

assignBaton

public void assignBaton(int receiverIndex,
 int holderIndex)

Specified by:

assignBaton in interface IBatonStateProvider

Parameters:

receiverIndex -

holderIndex -

See Also:

• Jython.assignBaton(String,int,int)

getOtherClientInformation

public ClientDetails[] getOtherClientInformation()

Specified by:

getOtherClientInformation in interface IBatonStateProvider

Returns:

ClientDetails[]

See Also:

• Jython.getOtherClientInformation(String)

getMyDetails

public ClientDetails getMyDetails()

Description copied from interface: IBatonStateProvider

Returns the current ClientDetails for this client. What is returned will change depending on the baton status and if the user has been switched using the switchUser method.

The authorisationLevel returned takes into account any alternate user, but not whether the baton is held. For this, call getAuthorisationLevel().

Specified by:

getMyDetails in interface IBatonStateProvider

Returns:

ClientDetails

update

public void update(Object dataSource,
 Object data)

Specified by:

update in interface IBatonStateProvider

Parameters:

dataSource -

data -

revertToOriginalUser

public void revertToOriginalUser()

Description copied from interface: IBatonStateProvider

Reverts to the original user this client was initially logged in as.

Specified by:

revertToOriginalUser in interface IBatonStateProvider

See Also:

• Jython.switchUser(String,String,String)

changeVisitID

public void changeVisitID(String visitID)

Description copied from interface: IBatonStateProvider

Switches the visit this client will collect data as when it holds the baton.

Specified by:

changeVisitID in interface IBatonStateProvider

Parameters:

visitID -

sendMessage

public void sendMessage(String message)

Description copied from interface: IBatonStateProvider

Broadcast a message to other users on this beamline. Such messages will be displayed in a special viewer.

Specified by:

sendMessage in interface IBatonStateProvider

Parameters:

message -

getMessageHistory

public List<UserMessage> getMessageHistory()

Description copied from interface: IBatonStateProvider

Returns previous messages sent during this visit.

Specified by:

getMessageHistory in interface IBatonStateProvider

switchUser

public boolean switchUser(String username,
 String password)

Specified by:

switchUser in interface IBatonStateProvider

Parameters:

username -

password -

Returns:

true if switch successful

See Also:

• Jython.switchUser(String,String,String)