com.ibm.datapower.wamt.amp
Interface SOAPHelper


public interface SOAPHelper

A list of high-level commands that a SOAPHelperImpl class should implement. The purpose of this interface is to provide for the unique runtime platform requirements of users of the IBM WebSphere Appliance Management Toolkit.


Field Summary
static java.lang.String COPYRIGHT_2009_2010
           
static java.lang.String SCM_REVISION
           
 
Method Summary
 org.w3c.dom.Node call(DeviceContext device, byte[] header, byte[] footer, java.io.InputStream requestDocument)
          Given a requestDocument (as an combination of header bytes, an InputStream containing the blob, and footer bytes), this method provides a high-level API to wrap the SOAP envelope, create an SSL connection, send the SOAP request, get the SOAP response, and return the response XML (without the SOAP envelope).
 org.w3c.dom.Node call(DeviceContext device, java.lang.StringBuffer requestDocument)
          Given a requestDocument (as an StringBuffer), this method provides a high-level API to wrap the SOAP envelope, create an SSL connection, send the SOAP request, get the SOAP response, and return the response XML (without the SOAP envelope)
 org.apache.xmlbeans.XmlOptions getOptions()
          Creates an XmlOptions object that enables the XML outputted by XMLBeans to be pretty-printed, and to have the correct namespace prefix for the AMP WSDL.
 

Field Detail

COPYRIGHT_2009_2010

static final java.lang.String COPYRIGHT_2009_2010
See Also:
Constant Field Values

SCM_REVISION

static final java.lang.String SCM_REVISION
See Also:
Constant Field Values
Method Detail

getOptions

org.apache.xmlbeans.XmlOptions getOptions()
Creates an XmlOptions object that enables the XML outputted by XMLBeans to be pretty-printed, and to have the correct namespace prefix for the AMP WSDL.

Returns:
an XmlOptions object with pretty print enabled and the AMP prefix defined.

call

org.w3c.dom.Node call(DeviceContext device,
                      java.lang.StringBuffer requestDocument)
                      throws AMPIOException,
                             InvalidCredentialsException,
                             AMPException
Given a requestDocument (as an StringBuffer), this method provides a high-level API to wrap the SOAP envelope, create an SSL connection, send the SOAP request, get the SOAP response, and return the response XML (without the SOAP envelope)

Parameters:
device - the remote device information contained in a DeviceContext object (username, password, hostname, and AMP port number)
requestDocument - a StringBuffer containing the XML request. It will be translated into an XML document for the SOAP request.
Returns:
a String containing the XML document returned by the SOAP response.

call

org.w3c.dom.Node call(DeviceContext device,
                      byte[] header,
                      byte[] footer,
                      java.io.InputStream requestDocument)
                      throws AMPIOException,
                             InvalidCredentialsException,
                             AMPException
Given a requestDocument (as an combination of header bytes, an InputStream containing the blob, and footer bytes), this method provides a high-level API to wrap the SOAP envelope, create an SSL connection, send the SOAP request, get the SOAP response, and return the response XML (without the SOAP envelope).

The inputStream must represent base64 encoded bytes!!!

Parameters:
device - the remote device information contained in a DeviceContext object (username, password, hostname, and AMP port number)
header - the bytes before the blob in the message
footer - the bytes after the blob in the message
requestDocument - an InputStream containing the XML request. It will be translated into an XML document for the SOAP request. This method will close the InputStream.
Returns:
a Node containing the XML document returned by the SOAP response.


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.