com.oakgrovesystems.reactor.requests
Class Unlock

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

public class Unlock
extends LockingBase

This request reverses the action of a previous Lock request.

Both Lock and Unlock handle parameters by extending the LockingBase class.

See Also:
Serialized Form

Field Summary
static java.lang.String REQUEST_TYPE
          The request type of Unlock requests.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.LockingBase
ELIGIBLE_ROLE_PARM_NAME, LOCK_ACE_PARM_NAME, OBJECT_ID_PARM_NAME, OBJECT_LP_PARM_NAME, STANDBY_ROLE_PARM_NAME, STATUS_ID_PARM_NAME, STATUS_LP_PARM_NAME
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
Unlock()
          Creates a Unlock request without specifying the authentication token to use to make the request.
Unlock(java.lang.String authToken)
          Creates a Unlock request that will use the specified authentication token
 
Method Summary
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
 
Methods inherited from class com.oakgrovesystems.reactor.requests.LockingBase
getEligibleRole, getLockACE, getObjectId, getObjectLabelPath, getStandbyRole, getStatusId, getStatusLabelPath, paramsToXML, parseParameters, setEligibleRole, setLockACE, setObjectId, setObjectLabelPath, setStandbyRole, setStatusId, setStatusLabelPath
 
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, 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

REQUEST_TYPE

public static final java.lang.String REQUEST_TYPE
The request type of Unlock requests. Used as a parameter to setRequestType() in the instance initializer.

See Also:
Constant Field Values
Constructor Detail

Unlock

public Unlock()
Creates a Unlock request without specifying the authentication token to use to make the request. setAuthToken() must be called before the request can be sent successfully.


Unlock

public Unlock(java.lang.String authToken)
Creates a Unlock request that will use the specified authentication token

Parameters:
authToken - the authentication token to use to make the request
Method Detail

parseReturnValues

protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
                                                                 throws FailedRequestException
Specified by:
parseReturnValues in class ReactorRequest
FailedRequestException


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