|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.oakgrovesystems.reactor.requests.ReactorRequest | +--com.oakgrovesystems.reactor.requests.LockingBase
This base class handles parameters for the Lock and Unlock classes.
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 |
public static final java.lang.String OBJECT_ID_PARM_NAME
public static final java.lang.String OBJECT_LP_PARM_NAME
public static final java.lang.String LOCK_ACE_PARM_NAME
public static final java.lang.String ELIGIBLE_ROLE_PARM_NAME
public static final java.lang.String STANDBY_ROLE_PARM_NAME
public static final java.lang.String STATUS_ID_PARM_NAME
public static final java.lang.String STATUS_LP_PARM_NAME
Constructor Detail |
public LockingBase()
Method Detail |
public void setObjectId(com.oakgrovesystems.reactor.ReactorObjectId id)
public com.oakgrovesystems.reactor.ReactorObjectId getObjectId()
public void setObjectLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
lp
- The label path of the object with an ACE to be lockedpublic com.oakgrovesystems.reactor.LabelPath getObjectLabelPath()
public void setLockACE(com.oakgrovesystems.reactor.processMediation.ACE ace)
ace
- The ACE to lock.public com.oakgrovesystems.reactor.processMediation.ACE getLockACE()
public void setEligibleRole(java.lang.String role)
role
- The name of the role for eligible ACEs.public java.lang.String getEligibleRole()
public void setStandbyRole(java.lang.String role)
role
- The name of the role for standby ACEs.public java.lang.String getStandbyRole()
public void setStatusId(com.oakgrovesystems.reactor.ReactorObjectId statId)
public com.oakgrovesystems.reactor.ReactorObjectId getStatusId()
public void setStatusLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
lp
- the LabelPath of the Status to add.public com.oakgrovesystems.reactor.LabelPath getStatusLabelPath()
protected void parseParameters(org.jdom.Element params, com.oakgrovesystems.reactor.LabelPathToIdMapper mapper) throws FailedRequestException
ReactorRequest
parseParameters
in class ReactorRequest
params
- the 'parameters' Element of the request
FailedRequestException
- if the parameters can't be configured from the XML.protected java.util.List paramsToXML() throws FailedRequestException
ReactorRequest
paramsToXML
in class ReactorRequest
FailedRequestException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |