com.oakgrovesystems.reactor.requests
Class QueryRequest

java.lang.Object
  |
  +--com.oakgrovesystems.reactor.requests.ReactorRequest
        |
        +--com.oakgrovesystems.reactor.requests.QueryRequest
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
QueryAllObjects, QueryProcesses, QueryProcessTree

public abstract class QueryRequest
extends ReactorRequest

See Also:
Serialized Form

Field Summary
protected  com.oakgrovesystems.reactor.processMediation.xml.OperandBuilder operandBuilder
           
protected  com.oakgrovesystems.reactor.processMediation.xml.PolicyBuilder policyBuilder
           
protected  com.oakgrovesystems.reactor.processMediation.xml.ProcessBuilder processBuilder
           
protected  com.oakgrovesystems.reactor.processMediation.xml.StatusBuilder statusBuilder
           
protected  boolean useLabelPaths
           
 
Fields inherited from class com.oakgrovesystems.reactor.requests.ReactorRequest
operandOutputter, policyOutputter, processOutputter, statusOutputter
 
Constructor Summary
QueryRequest()
           
 
Method Summary
protected  void addObject(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addOperand(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addPolicy(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addProcess(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addReference(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
protected  void addStatus(com.oakgrovesystems.reactor.requests.QueryResponse response, org.jdom.Element e)
           
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.
protected  com.oakgrovesystems.reactor.LabelPath getLabelPathFromReference(org.jdom.Element refEl)
           
 boolean getUseLabelPaths()
           
protected  com.oakgrovesystems.reactor.ReactorResponse parseReturnValues(org.jdom.Element returnValues)
           
 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, paramsToXML, parseParameters, 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

processBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.ProcessBuilder processBuilder

operandBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.OperandBuilder operandBuilder

statusBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.StatusBuilder statusBuilder

policyBuilder

protected com.oakgrovesystems.reactor.processMediation.xml.PolicyBuilder policyBuilder

useLabelPaths

protected boolean useLabelPaths
Constructor Detail

QueryRequest

public QueryRequest()
Method Detail

setUseLabelPaths

public void setUseLabelPaths(boolean value)

getUseLabelPaths

public boolean getUseLabelPaths()

createRtnValXML

protected org.jdom.Element createRtnValXML(com.oakgrovesystems.reactor.ReactorResponse res,
                                           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:
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
Throws:
FailedRequestException - if the return values Element can't be created

addObject

protected void addObject(com.oakgrovesystems.reactor.requests.QueryResponse response,
                         org.jdom.Element e)
                  throws FailedRequestException
FailedRequestException

addProcess

protected void addProcess(com.oakgrovesystems.reactor.requests.QueryResponse response,
                          org.jdom.Element e)
                   throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addOperand

protected void addOperand(com.oakgrovesystems.reactor.requests.QueryResponse response,
                          org.jdom.Element e)
                   throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addStatus

protected void addStatus(com.oakgrovesystems.reactor.requests.QueryResponse response,
                         org.jdom.Element e)
                  throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addPolicy

protected void addPolicy(com.oakgrovesystems.reactor.requests.QueryResponse response,
                         org.jdom.Element e)
                  throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

addReference

protected void addReference(com.oakgrovesystems.reactor.requests.QueryResponse response,
                            org.jdom.Element e)
                     throws com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ProcessMediationObjectConstructionException

getLabelPathFromReference

protected com.oakgrovesystems.reactor.LabelPath getLabelPathFromReference(org.jdom.Element refEl)
                                                                   throws com.oakgrovesystems.reactor.processMediation.xml.ReactorObjectIdConstructionException
com.oakgrovesystems.reactor.processMediation.xml.ReactorObjectIdConstructionException

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.