com.oakgrovesystems.reactor.requests
Class Login

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

public class Login
extends ReactorRequest

A request for a Reactor authentication token to be used for future requests.

See Also:
Serialized Form

Field Summary
static java.lang.String LOGIN_PARM_NAME
          The name of the request parameter that is the login attempt
static java.lang.String REQUEST_TYPE
          The request type of Login requests.
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
Login()
          Creates a Login request without specifying the authentication token to use to make the request.
 
Method Summary
protected  org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res, com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
          This (superclass) implementation simply returns null, which is perfect for requests that don't have return values.
 java.lang.String getPassword()
          returns the password to authenticate.
 java.lang.String getUsername()
          returns the username to authenticate.
 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 setPassword(java.lang.String password)
          Specifies the password to authenticate.
 void setUsername(java.lang.String username)
          Specifies the username to authenticate.
 
Methods inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
configureFromXML, configureFromXML, createResponseXML, createResponseXML, createReturnValuesElem, 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

LOGIN_PARM_NAME

public static final java.lang.String LOGIN_PARM_NAME
The name of the request parameter that is the login attempt

See Also:
Constant Field Values

REQUEST_TYPE

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

See Also:
Constant Field Values
Constructor Detail

Login

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

Method Detail

setUsername

public void setUsername(java.lang.String username)
Specifies the username to authenticate.

Parameters:
username - The username to authenticate

getUsername

public java.lang.String getUsername()
returns the username to authenticate.

Returns:
the username to authenticate.

setPassword

public void setPassword(java.lang.String password)
Specifies the password to authenticate.

Parameters:
password - The password to authenticate

getPassword

public java.lang.String getPassword()
returns the password to authenticate.

Returns:
the password to authenticate.

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.

createRtnValXML

protected org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res,
                                           com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
Description copied from class: ReactorRequest
This (superclass) implementation simply returns null, which is perfect for requests that don't have return values. Subclass implementations should override this method if they have return values. This method should return a 'return_values' Element or null if there are no return values. A precondition of this method is that the ReactorResponse parameter is not a failure.

Overrides:
createRtnValXML in class ReactorRequest
Parameters:
res - the ReactorResponse to translate to XML.
mapper - object to convert IDs to label paths in return values
Returns:
the XML representation of the return values

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.