|
|||||||||||
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.Login
A request for a Reactor authentication token to be used for future requests.
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 |
public static final java.lang.String LOGIN_PARM_NAME
public static final java.lang.String REQUEST_TYPE
Constructor Detail |
public Login()
Method Detail |
public void setUsername(java.lang.String username)
username
- The username to authenticatepublic java.lang.String getUsername()
public void setPassword(java.lang.String password)
password
- The password to authenticatepublic java.lang.String getPassword()
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 org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res, com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
ReactorRequest
createRtnValXML
in class ReactorRequest
res
- the ReactorResponse to translate to XML.mapper
- object to convert IDs to label paths in return values
public java.util.List paramsToXML() throws FailedRequestException
ReactorRequest
paramsToXML
in class ReactorRequest
FailedRequestException
protected com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues) throws FailedRequestException
parseReturnValues
in class ReactorRequest
FailedRequestException
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |