Sending implicit SOAP headers with JAX-RPC

You can enable an existing Java API for XML-based RPC (JAX-RPC) Web services client to send values in implicit SOAP headers. By modifying your client code to send implicit SOAP headers, you can send specific information within an outgoing Web service request.

Before you begin

To complete this task, you need a Web services client that you can enable to send implicit SOAP headers.
An implicit SOAP header is a SOAP header that fits one of the following descriptions:
  • A message part that is declared as a SOAP header in the binding in the Web Services Description Language (WSDL) file, but the message definition is not referenced by a portType element within a WSDL file.
  • An element that is not contained in the WSDL file.

Handlers and service endpoints can manipulate implicit or explicit SOAP headers using the SOAP with Attachments API for Java (SAAJ) data model.

You cannot manipulate protected SOAP headers. A SOAP header that is declared protected by its owning component, for example, Web Services Security, is not accessible to client applications. An exception occurs if you try to manipulate protected SOAP headers.

About this task

The client application sets properties on the Stub or Call object to send and receive implicit SOAP headers.

Procedure

  1. Create a java.util.HashMap object.
  2. Add an entry to the HashMap object for each implicit SOAP header that the client wants to send. The HashMap entry key is the QName of the SOAP header. The HashMap entry value is either an SAAJ SOAPElement object or a String that contains the XML text of the entire SOAP header element.
  3. Set the HashMap object as a property on the Stub or Call object. The property name is com.ibm.websphere.webservices.Constants.REQUEST_SOAP_HEADERS. The value of the property is the HashMap.
  4. Issue the remote method calls using the Stub or Call object. The headers within the HashMap object are sent in the outgoing message.
    A JAXRPCException error can occur if any of the following are true:
    • The HashMap object contains a key that is not a QName object or if the HashMap object contains a value that is not a String or a SOAPElement object.
    • The HashMap object contains a key that represents a SOAP header that is declared protected by the owning component.

Results

You have a JAX-RPC Web services client that is configured to send implicit SOAP headers.




In this information ...


IBM Redbooks, demos, education, and more

(Index)

Use IBM Suggests to retrieve related content from ibm.com and beyond, identified for your convenience.

This feature requires Internet access.

Task topic Task topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Jun 11, 2013 8:40:09 AM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=v701sca&product=was-nd-mp&topic=twbs_reqsoaphead
File name: twbs_reqsoaphead.html