com.raritantechnologies.quickstart.userInterface
Class SOAPDocumentContentHandler

java.lang.Object
  com.raritantechnologies.quickstart.userInterface.SOAPDocumentContentHandler

All Implemented Interfaces:

IConfigurable, IDocumentContentHandler, ISOAPContext

public class SOAPDocumentContentHandler

extends java.lang.Object

implements IDocumentContentHandler, ISOAPContext

Uses SOAP source to retrieve a document.

XML Configuration Template:

    <ContentHandler 
           contentType="[Quickstart content type]" 
           class="com.raritantechnologies.quickstart.userInterface.SOAPDocumentContentHandler" >

      <SOAPMethodSequence >
        <method name="[a method name  - links to SOAPMethod tag]" >
           <!-- selection parameters for this method - input parameters must match all -->
           <parameter name="[ input parameter to select this method ]" value="[ parameter value ]" />
        </method>
        <method name="[another method - links to SOAPMethod tag]" />
      </SOAPMethodSequence>

      <SOAPMethod methodName="[ from WSDL message tag, name attribute ]" 
                     namespace="ns1" 
                     SOAPAction="[ from WSDL binding/operation/soap:operation tag, soapAction attribute ]"
                     requestXMLType="[ same as WSDL request message/part tag, type attribute]" 
                     responseXMLType="[ from WSDL response message/part tag, type attribute]"
                     namespaceHost="http://soap.amazon.com" >

        <!-- One or more parameter elements -->
        <parameter name="[ name or parameter in SOAP request ]"
                      type="[ xsd type: e.g. xsd:string or xsd:int ]"
                      field="[ field in request ]" 
                      value="[ fixed value ]"
                      computeFrom="[ formula used by IntegerCalculator e.g.: (START_REC / 10) + 1) ]"
                      nil="true|false  send empty field ]"
                      inputFrom="[ value previously extracted by a ResponseProcess ]" >

          <StringFilter class="[ class of com.raritantechnologies.utils.filter.IStringFilter ]" >

          </StringFilter>

        </parameter>

        <!-- etc. . . -->

        <!-- Complex SOAP parameters:  contain nested SOAP structures -->


        <!-- handles intermediate result parameters: saves them to a context so that subsequent methods can use them -->
        <ResponseProcess>
          <!-- One or more ResponseParameter elements -->
          <ResponseParameter path="[ path in SOAP Response with data ]"
                                outputTo="[ name of temporary variable in Context ]" />
          <!-- etc. . . -->

        </ResponseProcess>
          
    </SOAPMethod>

    </ContentHandler>
  

Developed by Raritan Technologies Inc..

Author:

Ted Sullivan

Constructor Summary

SOAPDocumentContentHandler()

Method Summary

java.lang.String	getErrorPage(HttpServletRequest pReq)
java.lang.String	getHandlerName() Returns the name of document handler
java.lang.String	getLastContentType()
java.lang.String	getLastDocumentName()
java.util.Map	getLastDocumentParamMap() Returns Map of param=value
java.lang.String	getProperty(java.lang.String propName)
java.util.Iterator	getPropertyNames()
java.util.List	getRequestParameters() returns the list of parameters needed in the HTTP request.
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	sendDocumentContent(ILoginInfo userInfo, HttpServletRequest pReq, HttpServletResponse pRes) Sends the document content to the HttpServletResponse using parameters in the HttpServletRequest.
byte[]	sendDocumentContent(java.util.Map handlerInfo) Sends the document content to the whatever class calls it using parameters defined in a Map.
void	setProperty(java.lang.String propName, java.lang.String propVal)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SOAPDocumentContentHandler

public SOAPDocumentContentHandler()

Method Detail

sendDocumentContent

public void sendDocumentContent(ILoginInfo userInfo,
                                HttpServletRequest pReq,
                                HttpServletResponse pRes)
                         throws ServletException

Description copied from interface: IDocumentContentHandler

Sends the document content to the HttpServletResponse using parameters in the HttpServletRequest.

Specified by:

sendDocumentContent in interface IDocumentContentHandler

Parameters:

userInfo - User information for this session user. May be used to restrict access to content.

pReq - The HttpServletRequest for the requested content.

pRes - The HttpServletResponse. The content handler will obtain a ServletOutputStream from this object and write the content to this stream.

Throws:

ServletException

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IDocumentContentHandler

getErrorPage

public java.lang.String getErrorPage(HttpServletRequest pReq)

Specified by:

getErrorPage in interface IDocumentContentHandler

getLastDocumentName

public java.lang.String getLastDocumentName()

Specified by:

getLastDocumentName in interface IDocumentContentHandler

getHandlerName

public java.lang.String getHandlerName()

Returns the name of document handler

Specified by:

getHandlerName in interface IDocumentContentHandler

getLastDocumentParamMap

public java.util.Map getLastDocumentParamMap()

Returns Map of param=value

Specified by:

getLastDocumentParamMap in interface IDocumentContentHandler

getLastContentType

public java.lang.String getLastContentType()

Specified by:

getLastContentType in interface IDocumentContentHandler

setProperty

public void setProperty(java.lang.String propName,
                        java.lang.String propVal)

Specified by:

setProperty in interface ISOAPContext

getProperty

public java.lang.String getProperty(java.lang.String propName)

Specified by:

getProperty in interface ISOAPContext

getPropertyNames

public java.util.Iterator getPropertyNames()

Specified by:

getPropertyNames in interface ISOAPContext

getRequestParameters

public java.util.List getRequestParameters()

Description copied from interface: IDocumentContentHandler

returns the list of parameters needed in the HTTP request.

Specified by:

getRequestParameters in interface IDocumentContentHandler

sendDocumentContent

public byte[] sendDocumentContent(java.util.Map handlerInfo)

Description copied from interface: IDocumentContentHandler

Sends the document content to the whatever class calls it using parameters defined in a Map.

Specified by:

sendDocumentContent in interface IDocumentContentHandler

Parameters:

handlerInfo - Information needed by the implementing class to retrieve and send content.