org.lsst.ccs.bus.data

Class AgentLockInfo

java.lang.Object

org.lsst.ccs.bus.data.AgentLockInfo

All Implemented Interfaces:

Serializable, AgentLock

public class AgentLockInfo
extends Object
implements AgentLock, Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AgentLockInfo.AgentLockInfoString Class that allows the serialization of the AgentLockInfo We use the PersistenceService to make sure the locks are stored at any given time.
static class	AgentLockInfo.Status

Constructor Summary

Constructors

Constructor and Description
AgentLockInfo(AgentLockInfo lock, AgentLockInfo.Status status, int level, String token)
AgentLockInfo(AgentLockInfo lock, AgentLockInfo.Status status, String token)
AgentLockInfo(String agentName, String owner, int maxLevel, AgentLockInfo.Status status, String token, AgentInfo originatingAgent)

Method Summary

Modifier and Type	Method and Description
static AgentLockInfo	createAcknowledge(AgentLockInfo request)
static AgentLockInfo	createAcknowledgeLegacy(AgentLockInfo request, int level)
static AgentLockInfo	createAttachRequest(AgentLockInfo attachRequest, AgentLockInfo originalLock)
static AgentLockInfo	createAttachRequest(String agentName, String userId, AgentInfo attachingAgent)
static AgentLockInfo	createDetach(String agentName, String userId, AgentInfo attachingAgent)
static AgentLockInfo	createInfo(AgentLockInfo lock)
static AgentLockInfo	createLockRequest(AgentLockInfo request, int maxLevel)
static AgentLockInfo	createLockRequest(String agentName, String userId, AgentInfo originatingAgent)
static AgentLockInfo	createLoginInvisble(AgentLockInfo lock)
static AgentLockInfo	createLoginVisble(AgentLockInfo lock)
static AgentLockInfo	createReject(AgentLockInfo request)
static AgentLockInfo	createRelease(String agentName, String userId)
static AgentLockInfo	createReminder(AgentLockInfo lock)
boolean	equals(Object obj)
String	getAgentName() The agent name this lock stands for.
String	getCurrentAgent()
int	getMaxLevel() The maximum level allowed by this lock.
String	getOriginatingAgent()
String	getOwner() The lock owner = userID.
AgentLockInfo.Status	getStatus()
org.lsst.ccs.utilities.taitime.CCSTimeStamp	getTimeStamp()
String	getToken()
int	hashCode()
boolean	isScriptingOriginator()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AgentLockInfo

public AgentLockInfo(String agentName,
                     String owner,
                     int maxLevel,
                     AgentLockInfo.Status status,
                     String token,
                     AgentInfo originatingAgent)

AgentLockInfo

public AgentLockInfo(AgentLockInfo lock,
                     AgentLockInfo.Status status,
                     String token)

AgentLockInfo

public AgentLockInfo(AgentLockInfo lock,
                     AgentLockInfo.Status status,
                     int level,
                     String token)

Method Detail

createLockRequest

public static AgentLockInfo createLockRequest(String agentName,
                                              String userId,
                                              AgentInfo originatingAgent)

createLockRequest

public static AgentLockInfo createLockRequest(AgentLockInfo request,
                                              int maxLevel)

createAttachRequest

public static AgentLockInfo createAttachRequest(String agentName,
                                                String userId,
                                                AgentInfo attachingAgent)

createAttachRequest

public static AgentLockInfo createAttachRequest(AgentLockInfo attachRequest,
                                                AgentLockInfo originalLock)

createReject

public static AgentLockInfo createReject(AgentLockInfo request)

createAcknowledge

public static AgentLockInfo createAcknowledge(AgentLockInfo request)

createAcknowledgeLegacy

public static AgentLockInfo createAcknowledgeLegacy(AgentLockInfo request,
                                                    int level)

createReminder

public static AgentLockInfo createReminder(AgentLockInfo lock)

createInfo

public static AgentLockInfo createInfo(AgentLockInfo lock)

createRelease

public static AgentLockInfo createRelease(String agentName,
                                          String userId)

createDetach

public static AgentLockInfo createDetach(String agentName,
                                         String userId,
                                         AgentInfo attachingAgent)

createLoginVisble

public static AgentLockInfo createLoginVisble(AgentLockInfo lock)

createLoginInvisble

public static AgentLockInfo createLoginInvisble(AgentLockInfo lock)

getAgentName

public String getAgentName()

Description copied from interface: AgentLock

The agent name this lock stands for.

Specified by:

getAgentName in interface AgentLock

Returns:

the agent name this lock stands for.

getOwner

public String getOwner()

Description copied from interface: AgentLock

The lock owner = userID.

Specified by:

getOwner in interface AgentLock

Returns:

getStatus

public AgentLockInfo.Status getStatus()

getMaxLevel

public int getMaxLevel()

Description copied from interface: AgentLock

The maximum level allowed by this lock.

Specified by:

getMaxLevel in interface AgentLock

Returns:

the maximum level allowed by this lock

getTimeStamp

public org.lsst.ccs.utilities.taitime.CCSTimeStamp getTimeStamp()

getToken

public String getToken()

Specified by:

getToken in interface AgentLock

getOriginatingAgent

public String getOriginatingAgent()

isScriptingOriginator

public boolean isScriptingOriginator()

getCurrentAgent

public String getCurrentAgent()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object