|
|||||||||||
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.Get
A request to retrieve a Process Mediation Object
Field Summary | |
static java.lang.String |
ID_PARM_NAME
The name of the request parameter that is the id of the object to get |
static java.lang.String |
LABEL_PATH_PARM_NAME
The name of the request parameter that is the label path of the object to get |
static java.lang.String |
REQUEST_TYPE
The request type of Get requests. |
static java.lang.String |
TYPE_PARM_NAME
The name of the request parameter that is the type of the object to get |
protected boolean |
useLabelPaths
|
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest |
operandOutputter, policyOutputter, processOutputter, statusOutputter |
Constructor Summary | |
Get()
Creates a Get request without specifying the authentication token to use to make the request. |
|
Get(java.lang.String authToken)
Creates a Get request that will use the specified authentication token |
Method Summary | |
protected org.jdom.Element |
createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse response,
com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
This (superclass) implementation simply returns null, which is perfect for requests that don't have return values. |
com.oakgrovesystems.reactor.ReactorObjectId |
getId()
returns the id of the object to get |
com.oakgrovesystems.reactor.LabelPath |
getLabelPath()
returns the label path of the object to get |
java.lang.Class |
getType()
returns the Class of the object to get |
boolean |
getUseLabelPaths()
|
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 |
setId(com.oakgrovesystems.reactor.ReactorObjectId id)
Specifies the id of the object to get. |
void |
setLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the object to get. |
void |
setType(java.lang.Class type)
Specifies the Class of the object to get |
void |
setUseLabelPaths(boolean value)
|
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 ID_PARM_NAME
public static final java.lang.String LABEL_PATH_PARM_NAME
public static final java.lang.String TYPE_PARM_NAME
protected boolean useLabelPaths
public static final java.lang.String REQUEST_TYPE
Constructor Detail |
public Get()
public Get(java.lang.String authToken)
authToken
- the authentication token to use to make the requestMethod Detail |
public void setUseLabelPaths(boolean value)
public boolean getUseLabelPaths()
public void setId(com.oakgrovesystems.reactor.ReactorObjectId id)
id
- the id of the object to getpublic com.oakgrovesystems.reactor.ReactorObjectId getId()
public void setLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
lp
- the label path of the object to getpublic com.oakgrovesystems.reactor.LabelPath getLabelPath()
public void setType(java.lang.Class type)
type
- the Class of the object to getpublic java.lang.Class getType()
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 response, com.oakgrovesystems.reactor.IdToLabelPathMapper mapper) throws FailedRequestException
ReactorRequest
createRtnValXML
in class ReactorRequest
response
- the ReactorResponse to translate to XML.mapper
- object to convert IDs to label paths in return values
FailedRequestException
- if the return values Element can't be createdpublic 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 |