com.oakgrovesystems.reactor.requests
Class LockingBase

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.requests.ReactorRequest
        |
        +--com.oakgrovesystems.reactor.requests.LockingBase
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
Lock, Unlock

public abstract class LockingBase
extends ReactorRequest

This base class handles parameters for the Lock and Unlock classes.

See Also:
Serialized Form

Field Summary
static java.lang.String ELIGIBLE_ROLE_PARM_NAME
          The name of the request parameter that is the eligible ACE role.
static java.lang.String LOCK_ACE_PARM_NAME
          The name of the request parameter that is the ACE to lock.
static java.lang.String OBJECT_ID_PARM_NAME
          The name of the request parameter that is the ID of the object with an ACE to be locked.
static java.lang.String OBJECT_LP_PARM_NAME
          The name of the request parameter that is the label path of the object with an ACE to be locked.
static java.lang.String STANDBY_ROLE_PARM_NAME
          The name of the request parameter that is the standby ACE role.
static java.lang.String STATUS_ID_PARM_NAME
          The name of the request parameter that is ID of the Status to add.
static java.lang.String STATUS_LP_PARM_NAME
          The name of the request parameter that is the label path of the Status to add.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
LockingBase()
           
 
Method Summary
 java.lang.String getEligibleRole()
          returns the name of the role for eligible ACEs.
 com.oakgrovesystems.reactor.processMediation.ACE getLockACE()
          returns the ACE to lock.
 com.oakgrovesystems.reactor.ReactorObjectId getObjectId()
          returns the ID of the object with an ACE to be locked
 com.oakgrovesystems.reactor.LabelPath getObjectLabelPath()
          returns the label path of the object with an ACE to be locked.
 java.lang.String getStandbyRole()
          returns the name of the role for standby ACEs.
 com.oakgrovesystems.reactor.ReactorObjectId getStatusId()
          returns the id of the Status to add.
 com.oakgrovesystems.reactor.LabelPath getStatusLabelPath()
          returns the LabelPath of the Status to add.
protected  java.util.List paramsToXML()
          Returns a List of Elements representing the parameters of the request
protected  void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
          Configures the parameters from the XML representation
 void setEligibleRole(java.lang.String role)
          Specifies the name of the role for eligible ACEs.
 void setLockACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
          Specifies the ACE to lock.
 void setObjectId(com.oakgrovesystems.reactor.ReactorObjectId id)
          Specifies the ID of the object with an ACE to be locked.
 void setObjectLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
          Specifies the label path of the object with an ACE to be locked.
 void setStandbyRole(java.lang.String role)
          Specifies the name of the role for standby ACEs.
 void setStatusId(com.oakgrovesystems.reactor.ReactorObjectId statId)
          Specifies the id of the Status to add.
 void setStatusLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
          Specifies the LabelPath of the Status to add.
 
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, createRtnValXML, getAuthToken, getLabelPath, getObjectId, getParameter, getParameter, getParameterNames, getRequestType, makeAuthTokenXML, makeObjectElement, makeOperandElement, makePolicyElement, makeProcessElement, makeReferenceElement, makeStatusElement, parseResponse, parseReturnValues, send, sendAsXML, sendViaHttp, setAuthToken, setParameter, setRequestType, toString, toXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

OBJECT_ID_PARM_NAME

public static final java.lang.String OBJECT_ID_PARM_NAME
The name of the request parameter that is the ID of the object with an ACE to be locked.

See Also:
Constant Field Values

OBJECT_LP_PARM_NAME

public static final java.lang.String OBJECT_LP_PARM_NAME
The name of the request parameter that is the label path of the object with an ACE to be locked.

See Also:
Constant Field Values

LOCK_ACE_PARM_NAME

public static final java.lang.String LOCK_ACE_PARM_NAME
The name of the request parameter that is the ACE to lock.

See Also:
Constant Field Values

ELIGIBLE_ROLE_PARM_NAME

public static final java.lang.String ELIGIBLE_ROLE_PARM_NAME
The name of the request parameter that is the eligible ACE role.

See Also:
Constant Field Values

STANDBY_ROLE_PARM_NAME

public static final java.lang.String STANDBY_ROLE_PARM_NAME
The name of the request parameter that is the standby ACE role.

See Also:
Constant Field Values

STATUS_ID_PARM_NAME

public static final java.lang.String STATUS_ID_PARM_NAME
The name of the request parameter that is ID of the Status to add.

See Also:
Constant Field Values

STATUS_LP_PARM_NAME

public static final java.lang.String STATUS_LP_PARM_NAME
The name of the request parameter that is the label path of the Status to add.

See Also:
Constant Field Values
Constructor Detail

LockingBase

public LockingBase()
Method Detail

setObjectId

public void setObjectId(com.oakgrovesystems.reactor.ReactorObjectId id)
Specifies the ID of the object with an ACE to be locked. Calling this method with a non-null parameter has the side effect of calling setObjectLabelPath with a null parameter.


getObjectId

public com.oakgrovesystems.reactor.ReactorObjectId getObjectId()
returns the ID of the object with an ACE to be locked

Returns:
the ID of the object with an ACE to be locked

setObjectLabelPath

public void setObjectLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the object with an ACE to be locked. Calling this method with a non-null parameter has the side effect of calling setObjectId with a null parameter.

Parameters:
lp - The label path of the object with an ACE to be locked

getObjectLabelPath

public com.oakgrovesystems.reactor.LabelPath getObjectLabelPath()
returns the label path of the object with an ACE to be locked.

Returns:
the label path of the object with an ACE to be locked.

setLockACE

public void setLockACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
Specifies the ACE to lock.

Parameters:
ace - The ACE to lock.

getLockACE

public com.oakgrovesystems.reactor.processMediation.ACE getLockACE()
returns the ACE to lock.

Returns:
the ACE to lock.

setEligibleRole

public void setEligibleRole(java.lang.String role)
Specifies the name of the role for eligible ACEs.

Parameters:
role - The name of the role for eligible ACEs.

getEligibleRole

public java.lang.String getEligibleRole()
returns the name of the role for eligible ACEs.

Returns:
the name of the role for eligible ACEs.

setStandbyRole

public void setStandbyRole(java.lang.String role)
Specifies the name of the role for standby ACEs.

Parameters:
role - The name of the role for standby ACEs.

getStandbyRole

public java.lang.String getStandbyRole()
returns the name of the role for standby ACEs.

Returns:
the name of the role for standby ACEs.

setStatusId

public void setStatusId(com.oakgrovesystems.reactor.ReactorObjectId statId)
Specifies the id of the Status to add. Calling this method with a non-null parameter has the side effect of calling setStatusLabelPath with a null parameter.


getStatusId

public com.oakgrovesystems.reactor.ReactorObjectId getStatusId()
returns the id of the Status to add.

Returns:
the id of the Status to add.

setStatusLabelPath

public void setStatusLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the LabelPath of the Status to add. Calling this method with a non-null parameter has the side effect of calling setStatusId with a null parameter.

Parameters:
lp - the LabelPath of the Status to add.

getStatusLabelPath

public com.oakgrovesystems.reactor.LabelPath getStatusLabelPath()
returns the LabelPath of the Status to add.

Returns:
the LabelPath of the Status to add.

parseParameters

protected void parseParameters(org.jdom.Element params,
                               com.oakgrovesystems.reactor.LabelPathToIdMapper mapper)
                        throws FailedRequestException
Description copied from class: ReactorRequest
Configures the parameters from the XML representation

Specified by:
parseParameters in class ReactorRequest
Parameters:
params - the 'parameters' Element of the request
Throws:
FailedRequestException - if the parameters can't be configured from the XML.

paramsToXML

protected java.util.List paramsToXML()
                              throws FailedRequestException
Description copied from class: ReactorRequest
Returns a List of Elements representing the parameters of the request

Specified by:
paramsToXML in class ReactorRequest
Returns:
a List of Elements representing the parameters of the request
FailedRequestException


Copyright (c) 1999-2004 Oak Grove Systems. All Rights Reserved.