Package gda.jython.batoncontrol

Class BatonManager

java.lang.Object

gda.jython.batoncontrol.BatonManager

All Implemented Interfaces:

IBatonManager

public class BatonManager
extends Object
implements IBatonManager

Component used by JythonServer to manage the list of clients registered to that server. If enabled, there is a baton which can be 'requested' by one of the client which prevents the other clients from operating equipment. The baton can be passed from the holder to another client, or taken from a client by a higher level user, or released by the holder. If no one holds the baton then any client can operate equipment.

09 Oct 2015

invalid @link

{@link <a href="http://jira.diamond.ac.uk/browse/DATAACQTEAM-154">DATAACQTEAM-154</a>

}

Changes made to stop accessing the fields of ClientInfo directly as this causes IllegalAccessExceptions under OSGI due to the split package problem. Instead the (already present) mutators are now used

Constructor Summary

Constructors

Constructor	Description
BatonManager()

Method Summary

Modifier and Type	Method	Description
void	addFacade(String uniqueID, ClientDetails info)	Register a new facade to this class
boolean	amIBatonHolder(String myJSFIdentifier)
void	assignBaton(String myJSFIdentifier, int indexOfReciever, int indexOfPasser)
int	effectiveAuthorisationLevelOf(String uniqueID)	Determines the current authorisation level of the given client.
List<ClientDetailsAndLeaseState>	getAllClients()	Returns details of all connected clients.
ClientDetails	getClientInformation(String myJSFIdentifier)
int	getNewFacadeIndex()
ClientDetails[]	getOtherClientInformation(String myJSFIdentifier)
boolean	isBatonHeld()
boolean	isDisableControlOverVisitMetadataEntry()
boolean	isJSFRegistered(String myJSFIdentifier)
void	removeFacade(String uniqueID)	Remove a facade registered in this class
boolean	requestBaton(String uniqueIdentifier)
void	returnBaton(String uniqueIdentifier)
void	setDisableControlOverVisitMetadataEntry(boolean disableControlOverVisitMetadataEntry)
void	switchUser(String uniqueFacadeName, String username, int accessLevel, String visitID)	Switches the user of the given facade.

Methods inherited from class java.lang.Object

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

Constructor Details

BatonManager

public BatonManager()

Method Details

effectiveAuthorisationLevelOf

public int effectiveAuthorisationLevelOf(String uniqueID)

Description copied from interface: IBatonManager

Determines the current authorisation level of the given client. If this server has RBAC enabled and another client holds the baton then the effective level is 0.

Specified by:

effectiveAuthorisationLevelOf in interface IBatonManager

Parameters:

uniqueID - The UUID of the client facade

Returns:

the effective authorisation level

addFacade

public void addFacade(String uniqueID,
 ClientDetails info)

Description copied from interface: IBatonManager

Register a new facade to this class

Specified by:

addFacade in interface IBatonManager

Parameters:

uniqueID -

info -

switchUser

public void switchUser(String uniqueFacadeName,
 String username,
 int accessLevel,
 String visitID)

Description copied from interface: IBatonManager

Switches the user of the given facade.

Specified by:

switchUser in interface IBatonManager

Parameters:

uniqueFacadeName -

username -

accessLevel -

visitID -

removeFacade

public void removeFacade(String uniqueID)

Description copied from interface: IBatonManager

Remove a facade registered in this class

Specified by:

removeFacade in interface IBatonManager

Parameters:

uniqueID -

getNewFacadeIndex

public int getNewFacadeIndex()

Specified by:

getNewFacadeIndex in interface IBatonManager

amIBatonHolder

public boolean amIBatonHolder(String myJSFIdentifier)

Specified by:

amIBatonHolder in interface IBatonManager

Parameters:

myJSFIdentifier -

Returns:

boolean

See Also:

• Jython.amIBatonHolder(java.lang.String)

assignBaton

public void assignBaton(String myJSFIdentifier,
 int indexOfReciever,
 int indexOfPasser)

Specified by:

assignBaton in interface IBatonManager

Parameters:

myJSFIdentifier -

indexOfReciever -

indexOfPasser -

See Also:

• Jython.assignBaton(String, int, int)

getClientInformation

public ClientDetails getClientInformation(String myJSFIdentifier)

Specified by:

getClientInformation in interface IBatonManager

Parameters:

myJSFIdentifier -

Returns:

ClientDetails

getOtherClientInformation

public ClientDetails[] getOtherClientInformation(String myJSFIdentifier)

Specified by:

getOtherClientInformation in interface IBatonManager

Parameters:

myJSFIdentifier -

Returns:

ClientDetails[]

See Also:

• Jython.getOtherClientInformation(String)

requestBaton

public boolean requestBaton(String uniqueIdentifier)

Specified by:

requestBaton in interface IBatonManager

Parameters:

uniqueIdentifier -

Returns:

boolean

See Also:

• Jython.requestBaton(String)

returnBaton

public void returnBaton(String uniqueIdentifier)

Specified by:

returnBaton in interface IBatonManager

Parameters:

uniqueIdentifier -

See Also:

• Jython.returnBaton(String)

isJSFRegistered

public boolean isJSFRegistered(String myJSFIdentifier)

Specified by:

isJSFRegistered in interface IBatonManager

Parameters:

myJSFIdentifier -

Returns:

true if the given id string matches one registered by this class

isBatonHeld

public boolean isBatonHeld()

Specified by:

isBatonHeld in interface IBatonManager

Returns:

boolean

See Also:

• Jython.isBatonHeld()

isDisableControlOverVisitMetadataEntry

public boolean isDisableControlOverVisitMetadataEntry()

Specified by:

isDisableControlOverVisitMetadataEntry in interface IBatonManager

setDisableControlOverVisitMetadataEntry

public void setDisableControlOverVisitMetadataEntry(boolean disableControlOverVisitMetadataEntry)

Specified by:

setDisableControlOverVisitMetadataEntry in interface IBatonManager

getAllClients

public List<ClientDetailsAndLeaseState> getAllClients()

Description copied from interface: IBatonManager

Returns details of all connected clients.

Specified by:

getAllClients in interface IBatonManager