View Source

{section}
{column}

h1. Feature

The SOAP component is a Binding Component (BC) which enables to interact with external Web Services and to expose JBI services as Web Services.

In provider role, when a JBI MessageExchange is sent to a ServiceEndpoint (mapped to a Web Service), it is transformed into a SOAP message and sent to the linked external web service. In consumer role, when a SOAP message is received on an exposed web service, transformed into a JBI MessageExchange and sent to the corresponding JBI ServiceEndpoint.

The SOAP component is based on Apache Axis2 v1.4.1 ([http://ws.apache.org/axis2/|http://ws.apache.org/axis2/]) and Mortbay Jetty v6.1.9 ([http://jetty.codehaus.org/jetty/|http://jetty.codehaus.org/jetty/]). It provides the following features :
* Expose JBI Services as Web Services
* Expose Web Services as JBI Services
* Handle SOAP attachments. The attachments of the incoming SOAP message are placed into the JBI message as attachments; the JBI attachments are placed in the outgoing SOAP message as attachments.

{info}
All attachment are processed by using XOP rules.(XML-binary Optimized Packaging : [http://www.w3.org/TR/xop10/] ){info}

h1. Exposing an external web service as a JBI service endpoint

In provide mode, the component exposes an external web service in the JBI environment to send SOAP requests to the external web service.



h2. Usage


h2. Configuration

{include:0 CDK SU Provide Configuration}

  *Service Unit attributes to provide services*
{table-plus}






















|| Attribute || Description || Default value || Required ||
| soap-version | | | {center}No{center} |
| address | | | {center}No{center} |
| chunked-mode | | | {center}No{center} |
| synchronous-timeout | | | {center}No{center} |
| cleanup-transport | | | {center}No{center} |
| mode | | | {center}No{center} |
| enable-compatibility-for | | | {center}No{center} |
| proxy-host | | | {center}No{center} |
| proxy-port | | | {center}No{center} |
| proxy-user | | | {center}No{center} |
| proxy-password | | | {center}No{center} |
| proxy-domain | | | {center}No{center} |
| rest-http-method | | | {center}No{center} |
{table-plus}

h3. Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file:
{code:lang=xml}

{code}

h3. Service Unit content

The Service Unit has to contain the following elements, packaged in an archive:
* The META-INF/jbi.xml descriptor file, has described above,
* An optional imported WSDL file describing the partner service


h1. Exposing an internal JBI service endpoint as a web service

In consumer mode, the component exposes an internal JBI service outside the bus to transfer incoming SOAP requests to the internal service.



h2. Usage


h2. Configuration

{include:0 CDK SU Consume Configuration}
  *Service Unit attributes to consume services*
{table-plus}






















|| Attribute || Description || Default value || Required ||
| service-name | | | {center}No{center} |
| soap-action | | | {center}No{center} |
| synchronous-timeout | | | {center}No{center} |
| mode | | | {center}No{center} |
| enable-compatibility-for | | | {center}No{center} |
| enable-http-transport | | | {center}No{center} |
| enable-jms-transport | | | {center}No{center} |
| http-services-redirection | | | {center}No{center} |
| service-parameters | | | {center}No{center} |
| modules | | | {center}No{center} |
| rest-add-namespace-uri | | | {center}No{center} |
| rest-add-namespace-prefix | | | {center}No{center} |
| rest-remove-prefix-on-response | | | {center}No{center} |
{table-plus}

h3. Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file:
{code:lang=xml}

{code}

h3. Service Unit content

The Service Unit has to contain the following elements, packaged in an archive:
* The META-INF/jbi.xml descriptor file, has described above