com.raritantechnologies.federated.SOAP
Class SOAPMethod

java.lang.Object
  extended bycom.raritantechnologies.federated.SOAP.SOAPMethod
Direct Known Subclasses:
ExplicitSOAPMethod

public class SOAPMethod
extends java.lang.Object

Represents a SOAP Method used for SOAP messaging. Builds the SOAP Body element from its XML configuration and executes the SOAP call using the Apache Axis API.


Developed by Raritan Technologies Inc..

Author:
Ted Sullivan

Field Summary
static java.lang.String MULTI_REF
           
 
Constructor Summary
SOAPMethod()
           
 
Method Summary
 void addParameter(SOAPParam parameter)
           
protected  void addResponseProcesses(org.w3c.dom.Element methodElem)
           
 void addSoapResponseProcess(SOAPResponseProcess soapRespProc)
           
 org.w3c.dom.Document doSOAPCall(java.util.Map queryParams, ILoginInfo userInfo, java.lang.Integer pageSize, java.lang.Integer startRec, ISOAPContext soapContext)
           
protected  org.w3c.dom.Document getDocumentFrom(java.lang.Object resp)
           
 java.lang.String getMethodName()
           
 java.lang.String getNamespace()
           
 java.lang.String getNamespaceHost()
           
 java.lang.String getRequestXMLType()
           
 java.lang.String getResponseXMLType()
           
 java.lang.String getSOAPActionURI()
           
 SOAPBodyElement getSoapBodyElement(ISOAPContext context, ILoginInfo userInfo)
           
 void initialize(SOAPSearchSourceFactory soapSSFac, SOAPSearchSource soapSS, ISearchFieldMapFactory factory, org.w3c.dom.Element methodElem)
           
protected  void initializeBasic(org.w3c.dom.Element methodElem)
           
 boolean isCaptureResults()
           
 void setCaptureResults(boolean captureResults)
           
 void setMethodName(java.lang.String methodName)
           
 void setNamespace(java.lang.String namespace)
           
 void setNamespaceHost(java.lang.String namespaceHost)
           
 void setParameterValues(java.util.Map queryParams, ISOAPContext soapContext, java.lang.Integer pageSize, java.lang.Integer startRec)
           
 void setRemoveNamespaceFromOutput(boolean pRemoveNamespaceFromOutput)
           
 void setRequestXMLType(java.lang.String requestXMLType)
           
 void setResponseXMLType(java.lang.String responseXMLType)
           
 void setSearchSource(SOAPSearchSource theSOAPSource)
           
 void setSOAPActionURI(java.lang.String soapActionURI)
           
 void setSOAPEnvNamespace(java.lang.String soapEnvNamespace)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MULTI_REF

public static final java.lang.String MULTI_REF
See Also:
Constant Field Values
Constructor Detail

SOAPMethod

public SOAPMethod()
Method Detail

setMethodName

public void setMethodName(java.lang.String methodName)

getMethodName

public java.lang.String getMethodName()

setSearchSource

public void setSearchSource(SOAPSearchSource theSOAPSource)

setSOAPEnvNamespace

public void setSOAPEnvNamespace(java.lang.String soapEnvNamespace)

setCaptureResults

public void setCaptureResults(boolean captureResults)

isCaptureResults

public boolean isCaptureResults()

addParameter

public void addParameter(SOAPParam parameter)

setParameterValues

public void setParameterValues(java.util.Map queryParams,
                               ISOAPContext soapContext,
                               java.lang.Integer pageSize,
                               java.lang.Integer startRec)

getSoapBodyElement

public SOAPBodyElement getSoapBodyElement(ISOAPContext context,
                                          ILoginInfo userInfo)

setNamespace

public void setNamespace(java.lang.String namespace)

getNamespace

public java.lang.String getNamespace()

setNamespaceHost

public void setNamespaceHost(java.lang.String namespaceHost)

getNamespaceHost

public java.lang.String getNamespaceHost()

setRemoveNamespaceFromOutput

public void setRemoveNamespaceFromOutput(boolean pRemoveNamespaceFromOutput)

setRequestXMLType

public void setRequestXMLType(java.lang.String requestXMLType)

getRequestXMLType

public java.lang.String getRequestXMLType()

setResponseXMLType

public void setResponseXMLType(java.lang.String responseXMLType)

getResponseXMLType

public java.lang.String getResponseXMLType()

setSOAPActionURI

public void setSOAPActionURI(java.lang.String soapActionURI)

getSOAPActionURI

public java.lang.String getSOAPActionURI()

doSOAPCall

public org.w3c.dom.Document doSOAPCall(java.util.Map queryParams,
                                       ILoginInfo userInfo,
                                       java.lang.Integer pageSize,
                                       java.lang.Integer startRec,
                                       ISOAPContext soapContext)

getDocumentFrom

protected org.w3c.dom.Document getDocumentFrom(java.lang.Object resp)

addSoapResponseProcess

public void addSoapResponseProcess(SOAPResponseProcess soapRespProc)

initialize

public void initialize(SOAPSearchSourceFactory soapSSFac,
                       SOAPSearchSource soapSS,
                       ISearchFieldMapFactory factory,
                       org.w3c.dom.Element methodElem)

initializeBasic

protected void initializeBasic(org.w3c.dom.Element methodElem)

addResponseProcesses

protected void addResponseProcesses(org.w3c.dom.Element methodElem)