Petals Documentation > Petals ESB > Petals Components > Petals-BC-SOAP 4.x

Petals-BC-SOAP 4.x

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/) and Mortbay Jetty v6.1.9 (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.
If you want more details about SOAP, you can consult this W3C specification : http://www.w3.org/TR/soap/.

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

Exposing an external Web Service as a JBI service endpoint (SOAP over HTTP)

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

Usage

The petals-bc-soap component can expose an external Web Service as a JBI service endpoint by deploying a Service Unit on it:


Provides an external Web Service as a JBI service

When a message is received on a SOAP linked endpoint from the JBI environment, it is transformed into a SOAP message and sent to the Web Service. The address of the Web Service to send the SOAP message to is defined in the address extension of the deployed Service Unit.

The SOAP message is created like this:

  • The JBI message payload is wrapped in the SOAP body
  • The JBI message attachments are used to create SOAP ones
  • The JBI message exchange operation is used to create the SOAP action
  • The JBI MEP is used to determine the SOAP MEP

The external Web Service is called and the SOAP response is processed and returned to the JBI environment.

Configuration

Configuration of a Service Unit to provide a service (JBI)

Parameter Description
Default
Required
provides Describe the JBI service that will be exposed into the JBI bus. Interface (QName), Service (QName) and Endpoint (String) attributes are required. - Yes

Configuration of a Service Unit to provide a service (CDK)

Parameter Description
 Default
 Required
timeout Timeout in milliseconds of a synchronous send. This parameter is used by the method sendSync (Exchange exchange) proposes by the CDK Listeners classes.
Set it to 0 for an infinite timeout. 		30000 No
exchange-properties This sections defines the list of properties to set to the JBI exchange when processing a service. - No
message-properties This sections defines the list of properties to set to the JBI message when processing a service. - No
validate-wsdl Activate the validation of the WSDL when deploying a service unit. true No
wsdl
Path to the WSDL document describing services and operations exposed by the provided JBI endpoints defined in the SU.
The value of this parameter is :
  • an URL
  • a file relative to the root of the SU package
    If not specified, a basic WSDL description is automaticaly provided by the CDK.
- No
forward-attachments
Defines if attachment will be forwarded from IN message to OUT message.
false No
forward-message-properties
Defines if the message properties will be forwarded from IN message to OUT message. false No
forward-security-subject
Defines if the security subject will be forwarded from IN message to OUT message. false No


Service Unit attributes to provide services

Attribute Description Default value Required
soap-version The SOAP version used to create SOAP messages.

Possible values are 1.1 and 1.2.
1.1
Yes
address Address of the external Web Service to send JBI messages to.  
Yes
chunked-mode Activate the HTTP chunked mode on Web Service calls.

Possible values are: true, false.
false
Yes
synchronous-timeout The timeout value when invoking a external service.
Note
This value override the CDK value.


The value is expressed in milliseconds.

 
No
cleanup-transport Cleanup the transport after the call of the external Web Service.

Not cleaning up the transport can cause timeouts on large number of calls.

Possible values are: true, false.
true
Yes
mode The mode to be used to send SOAP message to the specified address.

Possible values are: SOAP for basic Web Service calls, JSON for JSON service calls and REST for REST service calls.
SOAP
Yes
enable-compatibility-for Enables the compatibility with a specified Web Service stack.

Possible values are: AXIS1 for Axis 1 Web Service stack. 		 
No
proxy-host The proxy host name.

If it is not set, the proxy mode will be disabled and all others proxy parameters are ignored. 		 
No
proxy-port The proxy host port.  
No
proxy-user The proxy user.  
No
proxy-password The proxy password.  
No
proxy-domain The proxy domain.  
No
rest-http-method The HTTP method to be used in REST mode.

Possible values are: GET for the HTTP method GET, POST for the HTTP method POST, PUT for the HTTP method PUT and DELETE for the HTTP method DELETE. 		 
No

Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
    xmlns:generatedNs="http://petals.ow2.org/"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:soap="http://petals.ow2.org/components/soap/version-4"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
    <jbi:services binding-component="true">

        <jbi:provides         
            interface-name="generatedNs:IntegrationService"
            service-name="generatedNs:IntegrationService"
            endpoint-name="IntegrationServiceSOAP">
    
            <!-- CDK specific elements -->
            <petalsCDK:timeout>1000</petalsCDK:timeout>
            <petalsCDK:validate-wsdl>true</petalsCDK:validate-wsdl>
            <petalsCDK:forward-security-subject>false</petalsCDK:forward-security-subject>
            <petalsCDK:forward-message-properties>false</petalsCDK:forward-message-properties>
            <petalsCDK:forward-attachments>false</petalsCDK:forward-attachments>
            <petalsCDK:wsdl>IntegrationService.wsdl</petalsCDK:wsdl>
        
            <!-- Component specific elements -->    
            <soap:address>http://localhost:8088/mockIntegrationServiceSOAP</soap:address>
            <soap:soap-version>1.1</soap:soap-version>
            <soap:chunked-mode>false</soap:chunked-mode>
            <soap:cleanup-transport>true</soap:cleanup-transport>
            <soap:mode>SOAP</soap:mode>            
        </jbi:provides>
    </jbi:services>
</jbi:jbi>

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

Exposing an internal JBI service endpoint as a Web Service (SOAP over HTTP)

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

Usage

The petals-bc-soap component can listen incoming SOAP messages and send messages to a JBI service endpoint by deploying a Service Unit on it. The component consumes the JBI service:


Consumes a JBI service on SOAP message

The service-name Service Unit extension value will be used as Axis 2 service name.

When a SOAP message is handled by the Axis 2 service, it is transformed into a JBI Message and sent to the JBI service endpoint configured in the Service Unit. The JBI message is created like this:

  • The JBI operation is created from the SOAP action.
  • Copy the SOAP body into the JBI one.
  • Put the SOAP attachments into JBI ones.
  • Put the SOAP headers into the "SOAP.HEADER" JBI message property.

By default, the component is configured to handle URI with the http://localhost:8084/petals/services/<service-name> pattern (this URI can be configured in the [SOAP component configuration]). It also handles ?wsdl calls; the WSDL description is retrieved from the endpoint and sent back to the consumer.

 
By default, the list of services is available at http://localhost:8084/petals/services/listServices URI (it can also be configured in the [SOAP component configuration]).

Configuration

Configuration of a Service Unit to consume a service (JBI)

Parameter Description Default Required
consumes Refer JBI service to invoke into the JBI bus.
You can define an explicit endpoint: interface (QName) / Service (QName) / Endpoint (String) attributes.
Or define implicit endpoint, to let the container routing according to QOS configurations (HA...):
-by Interface attribute (QName)
-by Service attribute (QName) 		- Yes


Configuration of a Service Unit to consume a service (CDK)

Parameter Description Default Required
mep Message exchange pattern abbreviation. This parameter can be used in conjunction with the method of the CDK Listeners: createMessageExchange(Extensions extensions).
This method returns a CDK Exchange corresponding to the type of the specified pattern. 		- Yes
operation Operation to call on a service. This parameter can be used in conjunction with the sending methods of the Listeners. If no operation is specified in the Message Exchange to send, this parameter will be used. - No
timeout Timeout in milliseconds of a synchronous send. This parameter can be used in conjunction with the sendSync(Exchange exchange) method of the Listeners. Set 0 for an infinite timeout. 30000 No


Service Unit attributes to consume services

Attribute Description Default value Required
service-name Web Service name to expose.  
No
soap-action The SOAP action QName to be used for the Web Service, will override the JBI message operation.  
No
synchronous-timeout The timeout value when inoking a service in the JBI bus.
Note
This value override the CDK value.

The value is expressed in milliseconds.

 
No
mode The mode to be used to receive messages.

Possible values are: SOAP for basic Web Service messages, JSON for JSON service messages and REST for REST service messages.
SOAP
Yes
enable-compatibility-for Enables the compatibility with a specified Web Service stack.

Possible values are: AXIS1 for Axis 1 Web Service stack. 		 
No
enable-http-transport Enable the HTTP transport layer to send or receive SOAP messages.

Possible values are: true, false.
true
No
enable-jms-transport Enable the JMS transport layer to receive SOAP messages.

Possible values are: true, false.
false
No
http-services-redirection HTTP redirection alias(es) for exposed Web Service.  
No
service-parameters Additional XML configuration for created Axis2 service as CDATA, same as the Axis 2 services.xml file one.  
No
modules A list of Axis2 modules names to engage (separated by comas).  
No
address Same as service-name.
Warning
This parameter must not be used any more. service-name must be used.

 
No
rest-add-namespace-uri The namespace URI to be used in the the generated JBI message payload.  
No
rest-add-namespace-prefix The namespace prefix to be used in the the generated JBI message payload (used when NS URI is defined).
soapbc
No
rest-remove-prefix-on-response A list of NS prefixes to remove from the JBI message response (Coma Separated Values)  
No

Service Unit descriptor

The service unit is configurable via its extensions in the jbi.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
    xmlns:generatedNs="http://petals.ow2.org/"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:soap="http://petals.ow2.org/components/soap/version-4"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
    <jbi:services binding-component="true">
    
        <jbi:consumes
            interface-name="generatedNs:IntegrationService"
            service-name="generatedNs:IntegrationService"
            endpoint-name="IntegrationServiceSOAP">
    
            <!-- CDK specific elements -->
            <petalsCDK:timeout>500</petalsCDK:timeout>
            <petalsCDK:mep xsi:nil="true" />
        
            <!-- Component specific elements -->    
            <soap:address>IntegrationServiceSOAPByPetals</soap:address>
            <soap:mode>SOAP</soap:mode>
            <soap:rest-add-namespace-prefix>soapbc</soap:rest-add-namespace-prefix>
            <soap:enable-http-transport>true</soap:enable-http-transport>
            <soap:enable-jms-transport>false</soap:enable-jms-transport>
        </jbi:consumes>
    </jbi:services>
</jbi:jbi>

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

SOAP over JMS

By configuring the SOAP component and a Service Unit, it is possible to consume an internal JBI service.

Warning
This feature is currently only supported in consumer mode with the operation MEP InOnly.

Usage

The petals-bc-soap component can listen incoming JMS messages containing SOAP envelopes in their bodies and send messages to a JBI service endpoint by deploying a Service Unit on it. The component consumes the JBI service:


Consumes a JBI service on JMS message (containing SOAP envelope)

The service-name Service Unit extension value will be used as Axis 2 service name.

When a JMS message is handled by the Axis 2 service, its body is extracted by Axis, is transformed into a JBI Message and sent to the JBI service endpoint configured in the Service Unit. The JBI message is created like this:

  • The JBI operation is created from the SOAP action.
  • Copy the SOAP body into the JBI one.
  • Put the SOAP attachments into JBI ones.
  • Put the SOAP headers into the "SOAP.HEADER" JBI message property.

Configuration

JMS server

A JMS server must be started before starting the BC SOAP component (if the JMS transport layer is configured). The compatible JMS servers are Joram and Apache ActiveMQ.

Shared library

A shared library corresponding to the JMS server (SL-JMS-Joram or SL-JMS-ActimeMQ) must be installed in Petals ESB before installing the BC SOAP component in Petals ESB.

Component descriptor

The JMS transport layer must be set in the component jbi.xml file (cf [SOAP component configuration]):

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0" xmlns:jbi="http://java.sun.com/xml/ns/jbi"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
	xmlns:soap="http://petals.ow2.org/components/soap/version-4">
	<jbi:component type="binding-component"
		bootstrap-class-loader-delegation="parent-first">
		<jbi:identification>
			<jbi:name>petals-bc-soap</jbi:name>
			<jbi:description>The SOAP Binding Component (based on Axis2 + Jetty)</jbi:description>
		</jbi:identification>
		...

		<!-- SOAP Component Parameters -->
		...
		<!-- JMS transport layer -->
		<soap:java-naming-factory-initial>org.apache.activemq.jndi.ActiveMQInitialContextFactory</soap:java-naming-factory-initial>
		<soap:java-naming-provider-url>tcp://localhost:61616</soap:java-naming-provider-url>
		<soap:jms-connection-factory-jndiname>QueueConnectionFactory</soap:jms-connection-factory-jndiname>
	</jbi:component>
</jbi:jbi>

Service Unit descriptor

The JMS transport must be enabled in the Service Unit jbi.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0"
    xmlns:generatedNs="http://petals.ow2.org/"
    xmlns:jbi="http://java.sun.com/xml/ns/jbi"
    xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
    xmlns:soap="http://petals.ow2.org/components/soap/version-4"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    
    <!-- Import a Service into Petals or Expose a Petals Service => use a BC. -->
    <jbi:services binding-component="true">
    
        <!-- Expose a Petals Service => consumes a Service. -->
        <jbi:consumes
            interface-name="generatedNs:JMSService"
            service-name="generatedNs:JMSService"
            endpoint-name="JMSServiceSOAP">
    
			...            
			<soap:enable-jms-transport>true</soap:enable-jms-transport>
        </jbi:consumes>
    </jbi:services>
</jbi:jbi>

Component Configuration

The following attributes can be set during the installation phase to configure the component, using the params element of the jbi-install-component ANT task:

Unable to render {include} Couldn't find a page to include called: 0 CDK Component Configuration Table


Specific configuration of the SOAP component

Attribute Description Default value Required
http-port Port of the embedded Jetty HTTP server.
8084
No
http-host Local Hostname to be used, can be hostname or host IP address.

If this parameter is not set, all interfaces are listen.
localhost
No
http-service-list Enables to display the available Web Service list on http://<http-host>:<http-port>/
<http-service-context>/<http-service-mapping>/listServices.

Possible values are: true, false.
true
No
http-service-context The URL context.
petals
No
http-service-mapping The URL service mapping.
services
No
http-thread-pool-size-min The minimum size of the HTTP thread pool.
2
No
http-thread-pool-size-max The maximum size of the HTTP thread pool.
255
No
http-acceptors Number of HTTP acceptors.
4
No
java-naming-factory-initial The initial context factory class needed to access the JNDI server where the JMS connection factory can be found.  
No
java-naming-provider-url The JNDI provider URL where the JMS connection factory can be found.  
No
jms-connection-factory-jndiname Name of the default JMS connection factory in the JNDI.  
No

Definition of CDK parameter scope :

  • Installation: The parameter can be set during the installation of the component, by using the installation MBean (see JBI specifications for details about the installation sequence). If the parameter is optional and has not been defined during the development of the component, it is not available at installation time.
  • Runtime: The paramater can be set during the installation of the component and during runtime. The runtime configuration can be changed using the CDK custom MBean named RuntimeConfiguration. If the parameter is optional and has not been defined during the development of the component, it is not available at installation and runtime times.

Component descriptor

The component is configurable via its extensions in the jbi.xml file:

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0" xmlns:jbi="http://java.sun.com/xml/ns/jbi"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
	xmlns:soap="http://petals.ow2.org/components/soap/version-4">
	<jbi:component type="binding-component"
		bootstrap-class-loader-delegation="parent-first">
		<jbi:identification>
			<jbi:name>petals-bc-soap</jbi:name>
			<jbi:description>The SOAP Binding Component (based on Axis2 + Jetty)</jbi:description>
		</jbi:identification>
		<jbi:component-class-name>org.ow2.petals.binding.soap.SoapComponent</jbi:component-class-name>
		<jbi:component-class-path><jbi:path-element/></jbi:component-class-path>
		<jbi:bootstrap-class-name>org.ow2.petals.binding.soap.SoapBootstrap</jbi:bootstrap-class-name>
		<jbi:bootstrap-class-path><jbi:path-element/></jbi:bootstrap-class-path>

		<!-- Component Development Kit Parameters -->
		<petalsCDK:acceptor-pool-size>5</petalsCDK:acceptor-pool-size>
		<petalsCDK:processor-pool-size>10</petalsCDK:processor-pool-size>
		<petalsCDK:ignored-status>DONE_AND_ERROR_IGNORED</petalsCDK:ignored-status>
		<petalsCDK:properties-file />
		<petalsCDK:notifications>false</petalsCDK:notifications>
		<petalsCDK:jbi-listener-class-name>org.ow2.petals.binding.soap.listener.outgoing.JBIListener</petalsCDK:jbi-listener-class-name>
		<petalsCDK:external-listener-class-name>org.ow2.petals.binding.soap.listener.incoming.SoapExternalListener</petalsCDK:external-listener-class-name>

		<!-- SOAP Component Parameters -->
		<soap:http-port>8084</soap:http-port>
		<soap:http-host>localhost</soap:http-host>
		<soap:http-services-list>true</soap:http-services-list>
		<soap:http-services-context>petals</soap:http-services-context>
		<soap:http-services-mapping>services</soap:http-services-mapping>
		<soap:http-thread-pool-size-min>2</soap:http-thread-pool-size-min>
		<soap:http-thread-pool-size-max>50</soap:http-thread-pool-size-max>
		<soap:http-acceptors>4</soap:http-acceptors>

		<!-- JMS transport layer, default JMS connection factory, uncommented to activate -->
		<!--<soap:java-naming-factory-initial>org.apache.activemq.jndi.ActiveMQInitialContextFactory</soap:java-naming-factory-initial> -->
		<!--<soap:java-naming-provider-url>tcp://localhost:61616</soap:java-naming-provider-url> -->
		<!--<soap:jms-connection-factory-jndiname>QueueConnectionFactory</soap:jms-connection-factory-jndiname> -->
	</jbi:component>
</jbi:jbi>
Table of contents
Contributors
No contributors found for: authors on selected page(s)
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.