Features

The petals-bc-soap is based on the petals-cdk v4.x, Apache Axis2 v1.4.1 (http://ws.apache.org/axis2/) and Mortbay Jetty v6.1.4 (http://jetty.codehaus.org/jetty/). It provides the following features :

• Expose JBI Services as Web Services
• Expose JBI Services as REST Services
• Expose Web Services as JBI Services
• Expose REST 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.
• WS-notification. The component can send/receive web service notifications to/from external subscribers/producers.
• WS-Security, WS-SecureConversation and WS-Policy via the addition of the Rampart's Axis2 module.

Component Configuration

The component can be configured through its JBI descriptor file like this :

<?xml version="1.0" encoding="UTF-8"?>
<jbi:jbi version="1.0" 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-3.2">
    <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:component-class-path>
        <jbi:bootstrap-class-name>org.ow2.petals.binding.soap.SoapBootstrap</jbi:bootstrap-class-name>
        <jbi:bootstrap-class-path>...</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:performance-notifications>false</petalsCDK:performance-notifications>
        <petalsCDK:jbi-listener-class-name>
            org.ow2.petals.binding.soap.listener.outgoing.JBIListener
        </petalsCDK:jbi-listener-class-name>
        <petalsCDK:external-listener-classname>
            org.ow2.petals.binding.soap.listener.incoming.SoapExternalListener
        </petalsCDK:externallistener-class-name>
        
        <!-- SOAP Component Parameters -->
        <soap:http-port>8084</soap:http-port>
        <soap:http-host>148.39.34.45</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>
    </jbi:component>
</jbi:jbi>

Warning Only the last part of this file can be modified.

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.

Configuration of the component (SOAP)

The SOAP component specific parameters can be also set through JMX during its installation phase.
More information about Jetty tunning can be found on the Jetty documentation.

Service Configuration

todo

Send a JBI message to an external Web Service

todo

Service Unit descriptor

todo

Send a JBI message from an incoming SOAP message

todo

Service Unit descriptor

todo

REST Services

todo

Introduction

todo

Configuration

todo

Provide mode : Provide access to external REST Service

todo

Consume mode : Expose JBI Service as as REST Service

todo

Samples

todo

Provide mode

todo

Consume mode

todo

Web Service Notifications

todo

Intoduction

todo

Create a WS-N topic

todo

Subscribe to WS-N producer

todo

Send a WS notification from a JBI message

When the petals-bc-soap component receives a JBI message on a topic-activated endpoint, it is transformed into a WS-notification message and published on the linked topic.

As an example of SOAP notification message, if the JBI message payload is :

<text>This is a sample of JBI message payload...</text>

and if it is published on the 'TopicSample' topic, the SOAP body payload of the notification message will be :

<wsnt:Notify>
    <wsnt:NotificationMessage>
        <wsnt:SubscriptionReference>
            <wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">
                http://127.0.0.1:8084/wsn-consumer/services/consumer
            </wsa:Address>
        </wsnt:SubscriptionReference>
        <wsnt:Topic Dialect="xsd:anyURI">TopicSample</wsnt:Topic>
        <wsnt:ProducerReference>
            <wsa:Address xmlns:wsa="http://www.w3.org/2005/08/addressing">
                http://127.0.0.1:8084/wsn-producer/services/producer
            </wsa:Address>
        </wsnt:ProducerReference>
        <wsnt:Message>
            <text>This is a sample of JBI message payload...</text>
        </wsnt:Message>
    </wsnt:NotificationMessage>
</wsnt:Notify>

Security

Introduction

The SOAP binding component provides WS security features through the Axis2 rampart module (http://ws.apache.org/rampart/).

This module is based on Apache WSS4J (http://ws.apache.org/wss4j/), an implementation of the OASIS WS-security specification (http://www.oasis-open.org/committees/wss).

This module is natively provided by the binding component since the 3.0 release.

Securing JBI Services

Configuration

todo

Client side

todo

Using WS-Policy

The Apache Rampart module is used to apply policies when calling an external Web Service (ie in consumer mode). The current section explains how to configure the component to use this feature.

Configuration

todo

Usage

Once the Service Unit is deployed on the SOAP Binding Component, all the JBI messages sent to the new activated endpoint are transformed into SOAP messages and the Web Service client will use the Service Unit defined policy to call the Web Service. The Web Service client behaviour is exactly the same as a policy-enabled Axis2 based Web Service client.

An example of WS policy with PEtALS is provided in the PEtALS SOAP usecases at : http://websvn.ow2.org/listing.php?repname=petals&path=/trunk/configurations/petals-soap/petals-soap-policy/.

Samples

The SOAP binding component samples are available as packaged use cases. You can find them on trunk/configurations/petals-soap directory of the Petals ESB forge.

Know problems

"Transport out has not been set"

If the exception message "Transport out has not been set" occurs when invoking an external web-service, using the petals-bc-soap, it can be due to a wrong URL of the external web-service. Please check it and retry your test.