com.oakgrovesystems.reactor.requests
Class Get

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

public class Get
extends ReactorRequest

A request to retrieve a Process Mediation Object

See Also:
Serialized Form

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

ID_PARM_NAME

public static final java.lang.String ID_PARM_NAME
The name of the request parameter that is the id of the object to get

See Also:
Constant Field Values

LABEL_PATH_PARM_NAME

public static final java.lang.String LABEL_PATH_PARM_NAME
The name of the request parameter that is the label path of the object to get

See Also:
Constant Field Values

TYPE_PARM_NAME

public static final java.lang.String TYPE_PARM_NAME
The name of the request parameter that is the type of the object to get

See Also:
Constant Field Values

useLabelPaths

protected boolean useLabelPaths

REQUEST_TYPE

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

See Also:
Constant Field Values
Constructor Detail

Get

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


Get

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

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

setUseLabelPaths

public void setUseLabelPaths(boolean value)

getUseLabelPaths

public boolean getUseLabelPaths()

setId

public void setId(com.oakgrovesystems.reactor.ReactorObjectId id)
Specifies the id of the object to get. Calling this method with a non-null parameter has the side effect of calling setLabelPath with a null parameter.

Parameters:
id - the id of the object to get

getId

public com.oakgrovesystems.reactor.ReactorObjectId getId()
returns the id of the object to get

Returns:
the id of the object to get

setLabelPath

public void setLabelPath(com.oakgrovesystems.reactor.LabelPath lp)
Specifies the label path of the object to get. Calling this method with a non-null parameter has the side effect of calling setId with a null parameter.

Parameters:
lp - the label path of the object to get

getLabelPath

public com.oakgrovesystems.reactor.LabelPath getLabelPath()
returns the label path of the object to get

Returns:
the label path of the object to get

setType

public void setType(java.lang.Class type)
Specifies the Class of the object to get

Parameters:
type - the Class of the object to get

getType

public java.lang.Class getType()
returns the Class of the object to get

Returns:
the Class of the object to get

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 response,
                                           com.oakgrovesystems.reactor.IdToLabelPathMapper mapper)
                                    throws FailedRequestException
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:
response - 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
Throws:
FailedRequestException - if the return values Element can't be created

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.