com.oakgrovesystems.reactor.requests
Class Logout

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

public class Logout
extends ReactorRequest

A request to expire an authentication token, effectively logging out that user from the Reactor system.

See Also:
Serialized Form

Field Summary
static java.lang.String REQUEST_TYPE
          The request type of logout requests.
static java.lang.String TOKEN_PARM_NAME
          The name of the request parameter that is the token to expire.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
Logout()
          Creates a Logout request without specifying the authentication token to use to make the request or the authentication token to log out.
Logout(java.lang.String authToken)
          Creates a Logout request that will use the specified authentication token and cause it to expire.
Logout(java.lang.String authToken, java.lang.String tokenToExpire)
          Creates a Logout request that will use the first authentication token to make the request and cause the second authentication token to expire.
 
Method Summary
 java.lang.String getTokenToExpire()
          returns the token which is to expire as a result of this request.
 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
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
 void setTokenToExpire(java.lang.String tokenParam)
          Specifies the token that should expire as a result of this request.
 
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

TOKEN_PARM_NAME

public static final java.lang.String TOKEN_PARM_NAME
The name of the request parameter that is the token to expire.

See Also:
Constant Field Values

REQUEST_TYPE

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

See Also:
Constant Field Values
Constructor Detail

Logout

public Logout()
Creates a Logout request without specifying the authentication token to use to make the request or the authentication token to log out. These values must be specified by calls to setAuthToken() and setTokenToExpire() before the request can be sent.


Logout

public Logout(java.lang.String authToken)
Creates a Logout request that will use the specified authentication token and cause it to expire.

Parameters:
authToken - the authentication token to use to make the request and the authentication token which is to expire.

Logout

public Logout(java.lang.String authToken,
              java.lang.String tokenToExpire)
Creates a Logout request that will use the first authentication token to make the request and cause the second authentication token to expire.

Parameters:
authToken - the authentication token to use to make the request.
tokenToExpire - the authentication token which is to expire as a result of this request.
Method Detail

setTokenToExpire

public void setTokenToExpire(java.lang.String tokenParam)
Specifies the token that should expire as a result of this request. If this method is not called before the request is sent, the token that is used to issue the request will be expired.

Parameters:
tokenParam - The token that should expire as a result of this request.

getTokenToExpire

public java.lang.String getTokenToExpire()
returns the token which is to expire as a result of this request.

Returns:
the token which is to expire as a result of this request

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

public 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

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.