com.raritantechnologies.webServices
Class CustomRequestMapper

java.lang.Object
  com.raritantechnologies.webServices.WebServiceMapper
      com.raritantechnologies.webServices.CustomRequestMapper

All Implemented Interfaces:

IConfigurable

public class CustomRequestMapper

extends WebServiceMapper

Maps a SOAP Request to a specific ICustomTag or IServletHandler implementation.

WSDL Template:

    <ns1:CustomRequest>
      <Session>
        <SessionID>[ the session ID ]</SessionID>
      </Session>
      <Command>[ name of the custom tag or servlet handler ]</Command>
      <FieldDelimiter>[ optional field delimiter (default is '|' )</FieldDelimiter>
      <ValueDelimiter>[ optional value delimiter (default is '=' )</ValueDelimiter>
      <Request>[ name=value|name2=value2 set of name/value pairs ]</Request>
    </ns1:CustomRequest>

    <ns1:CustomRequestResponse>
      <Response>[ value of the response - encoded as CData section (optionally) ]</Response>
    </ns1:CustomRequestResponse>

    <ns1:CustomRequestFormats>
    </ns1:CustomRequestFormats>

    <ns1:CustomRequestFormatsResponse>
      <CustomRequest>
        <Command>[ name of custom tag or servlet handler ]</Command>
        <FieldDelimiter>[ optional field delimiter (default is '|' )</FieldDelimiter>
        <ValueDelimiter>[ optional value delimiter (default is '=' )</ValueDelimiter>
        <Fields>
          <DataField name="[ name of field ]" type="[ type of field ]" />
        </Fields>
      </CustomRequest>
    </ns1:CustomRequestFormatsResponse>
 

XML Configuration Template:

   <WebServiceMap methodName="CustomRequest"
                     mapperClass="com.raritantechnologies.webServices.CustomRequestMapper" >

     <!-- One or more Command tags that map a request Command to an ICustomTag or IServletHandler -->
     <Command requestName="[ name of command in the SOAP Request ]" 
                   objectName="[name of configured object ]" 
                 sysObjectType="[ CUSTOM_TAG|SERVLET_HANDLER ]" >

       <!-- Parameter mapping?? -->

     </Command>

     <!-- etc... -->

   </WebService>
 

Constructor Summary

CustomRequestMapper()

Method Summary

void	executeService(SOAPEnvelope request, SOAPEnvelope response)
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.

Methods inherited from class com.raritantechnologies.webServices.WebServiceMapper

executeService, getCharacterEncoding, getRequestParam, setCharacterEncoding

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomRequestMapper

public CustomRequestMapper()

Method Detail

executeService

public void executeService(SOAPEnvelope request,
                           SOAPEnvelope response)

Specified by:

executeService in class WebServiceMapper

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 IConfigurable

Specified by:

initialize in class WebServiceMapper