This version must be installed on Petals ESB 5.1.0+ Features Main goals The component SE Mapping provides a way to implement services using the design pattern Facade as following: the incoming request is transformed before to be be sent to another service, it's reply is transformed before to be returned to the service consumer, several transformation engines are available. Full Size Concurrency Several instances of the component can be deployed concurrently on Petals ESB. So, you are able to deploy each service 'Facade' on several component instances to get high availability.

Table of contents 1 Features 2 Introduction 3 Creating a service-unit 3.1 Creating the service contract 3.2 Annotating the WSDL 3.2.1 Defining input transformations 3.2.1.1 Defining an XSL input transformation 3.2.2 Defining output transformations 3.2.2.1 Defining an XSL output transformation 3.2.2.2 Selecting response nature through XPath 3.3 Defining the 3PP service provider 4 Configuring the component 4.1 CDK parameters 4.1.1.1 Interceptor 5 Monitoring the component 5.1 Using metrics 5.1.1 Common metrics 5.1.2 Dedicated metrics 5.2 Receiving alerts 5.2.1 Common alerts 5.2.2 Dedicated alerts 6 Unit testing 6.1 Checking the compliance of the WSDL 6.2 Unit-testing your XSLs Contributors No contributors found for: authors on selected page(s)

Introduction

The version 1.0.x of the component provides the following transformation engines:

• XSL transformation based on Saxon HE 9.7.0-11.

Creating a service-unit

A service-unit associated to a service 'Facade' contains:

• the WSDL of your service, the one implemented by the service 'Facade',
• WSDL annotations defining:
  • the transformations to apply,
  • the operation of the 3PP service provider to invoke,
• the 3PP service provider to invoke, defined in the service-unit JBI descriptor as consumer section.

Creating the service contract

Write your WSDL according to your needs. No requirement about the WSDL is expected.

A best practice is to explode your WSDL in two parts:

• an abstract part containing data definition (XSD) and the service interface (port type),
• a concrete part containing the binding of the port type, and the service definition.

Annotating the WSDL

Annotations take place in each operation of the binding definition:

<binding name="FactureServicePortBinding" type="tns:FactureService">
   <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document" />
   <operation name="stocker">
      <soap:operation soapAction="" />
      <mapping:service-provider-operation>ged:stocker</mapping:service-provider-operation>
      <mapping:input-transformation xsl="input-stocker.xsl" />
      <mapping:output-transformation xsl="output-stocker.xsl">
         <mapping:should-return-fault as-xpath-expr="true">false()</mapping:should-return-fault>
      </mapping:output-transformation>
      <input>
         <soap:body use="literal" />
      </input>
      <output>
         <soap:body use="literal" />
      </output>
   </operation>
</binding>

All annotations are member of the namespace "http://petals.ow2.org/se/mapping/annotations/1.0":

• service-provider-operation defines the qualified name of the 3PP service provider operation to invoke when the current operation is invoked,
• input-transformation defines the transformation to apply on incoming requests on the current operation,
• output-transformation defines the transformation to apply on response for the current operation,

Defining input transformations

The input transformation is defined by the annotation 'input-transformation'.

Now, only XSL transformations are available.

Defining an XSL input transformation

To define an input transformation as an XSL transformation, just define the XSL style-sheet to use by the attribute 'xsl' of the annotation 'input-transformation'. The XSL style-sheet is provided as a file located in the root directory of the service unit.

<binding name="FactureServicePortBinding" type="tns:FactureService">
   ...
   <operation name="stocker">
      ...
      <mapping:input-transformation xsl="input-stocker.xsl" />
      ...
   </operation>
</binding>

A property defined at component level (through the component configuration parameter 'properties-file' can be accessed into the XSL through a global XSL parameter defined by the qualified name: '<property-name>' of namespace 'http://petals.ow2.org/se/mapping/xsl/param/1.0'.

For a unit test purpose, an extension of JUnit is available to test your XSL. See chapter "Unit testing".

Defining output transformations

The output transformation is defined by the annotation 'output-transformation'.

The result of the transformation can be returned to the service consumer as a normal response or as a fault according to the result of the expression defined by the sub-annotation 'should-return-fault'. If the expression returns 'true', a fault will be returned to the service consumer, otherwise a normal response will be returned:

<binding name="FactureServicePortBinding" type="tns:FactureService">
   ...
   <operation name="stocker">
      ...
      <mapping:output-transformation xsl="output-stocker.xsl">
         <mapping:should-return-fault as-xpath-expr="true">false()</mapping:should-return-fault>
      </mapping:output-transformation>
      ...
   </operation>
</binding>

Now, only XSL transformations and XPath expression are available.

Defining an XSL output transformation

To define an output transformation as an XSL transformation, just define the XSL style-sheet to use by the attribute 'xsl' of the annotation 'output-transformation'. The XSL style-sheet is provided as a file located in the root directory of the service unit.

<binding name="FactureServicePortBinding" type="tns:FactureService">
   ...
   <operation name="stocker">
      ...
      <mapping:output-transformation xsl="output-stocker.xsl">
         ...
      </mapping:output-transformation>
      ...
   </operation>
</binding>

The incoming request can be accessed into the XSL through a global XSL parameter defined by the qualified name: 'incoming-request' of namespace 'http://petals.ow2.org/se/mapping/xsl/param/output/1.0'.

A property defined at component level (through the component configuration parameter 'properties-file' can be accessed into the XSL through a global XSL parameter defined by the qualified name: '<property-name>' of namespace 'http://petals.ow2.org/se/mapping/xsl/param/1.0'.

For a unit test purpose, an extension of JUnit is available to test your XSL. See chapter "Unit testing".

Selecting response nature through XPath

The expression to select the response nature to return (fault or normal response) can be expressed as an XPath expression using the attribute 'as-xpath-expr' set to 'true', and giving the XPath expression as value of the annotation 'should-return-fault':

<mapping:output-transformation xsl="output-stocker.xsl">
   <mapping:should-return-fault as-xpath-expr="true">false()</mapping:should-return-fault>
</mapping:output-transformation>

For a unit test purpose, an extension of JUnit is available to verify your XPath expression syntax when checking your WSDL. See chapter "Unit testing".

Defining the 3PP service provider

The 3PP service provider is defined in the service unit JBI descriptor as a service consumer:

<!-- The service invoked -->
<jbi:consumes interface-name="ged:GedService" service-name="ged:GedService">
   <petalsCDK:timeout>15000</petalsCDK:timeout>
   <petalsCDK:mep>InOut</petalsCDK:mep>
</jbi:consumes>

Supported parameters of the section 'consumes' are:

• timeout, to set on the message exchange used for the service provider invocation,
• mep, is not used because we reuse the one of the incoming exchange,
• operation, is not used. As we can have a service 'Facade' providing several operations, it was needed to define the annotation 'service-provider-operation'. A warning will appear in log traces if this field is set.
• exchange-properties, the properties to set on the message exchange used to invoke the service provider,
• message-properties, the properties to set on the message of message exchange used to invoke the service provider.

No specific configuration exists

Configuring the component

The component can be configured through the parameters of its JBI descriptor file. These parameters are divided in following groups:

• JBI parameters that have not to be changed otherwise the component will not work,
• CDK parameters that are parameters driving the processing of the CDK layer.

CDK parameters

The component configuration includes the configuration of the CDK. The following parameters correspond to the CDK configuration.

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.

Interceptor

Interceptors can be defined to inject some post or pre processing in the component during service processing.

Using interceptor is very sensitive and must be manipulate only by power users. An non properly coded interceptor engaged in a component can lead to uncontrolled behaviors, out of the standard process.

Example of an interceptor configuration:

<?xml version="1.0" encoding="UTF-8"?>
<!--...-->
<petalsCDK:component-interceptors>
  <petalsCDK:interceptor active="true" class="org.ow2.petals.myInterceptor" name="myInterceptorName">
    <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
    <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
  </petalsCDK:interceptor>
</petalsCDK:component-interceptors>
<!--...-->

Monitoring the component

Using metrics

Several probes providing metrics are included in the component, and are available through the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

Common metrics

The following metrics are provided through the Petals CDK, and are common to all components:

Dedicated metrics

No dedicated metric is available.

Receiving alerts

Several alerts are notified by the component through notification of the JMX MBean 'org.ow2.petals:type=custom,name=monitoring_<component-id>', where <component-id> is the unique JBI identifier of the component.

To integrate these alerts with Nagios, see Receiving Petals ESB defects in Nagios.

Common alerts

Dedicated alerts

No dedicated alert is available.

Unit testing

The unit testing can occur at several levels in your Mapping service unit:

• to check the annotation compliance of the WSDL with the attendees of the component,
• to unit test your XSL transformations.

A dedicated framework is available as an extension of JUnit providing facilities:

• to validate your WSDL:
  • in a WSDL point of view,
  • checking the compliance of the WSDL with the attendees of the component,
  • checking syntax of the XPath expressions,
• to verify easily the XSL style-sheets.

This dedicated framework is provided by the Maven artifact org.ow2.petals:petals-se-mapping-junit:

<project>
   ...
   <dependencies>
      ...
      <dependency>
         <groupId>org.ow2.petals</groupId>
         <artifactId>petals-se-mapping-junit</artifactId>
         <version>1.0.0</version>
         <scope>test</scope>
      </dependency>
      ...
   </dependencies>
   ...
</project>

The version 1.0.0+ of the framework is compliant with the Petals SE Mapping 1.0.0+.

Checking the compliance of the WSDL

The unit test framework contains an assertion 'assertWsdlCompliance' to verify easily the compliance of your WSDL with the attendees of the mode 'service':

import static org.ow2.petals.se.mapping.junit.Assert.assertWsdlCompliance;

import javax.xml.namespace.QName;
import org.junit.Test;

public class WsdlComplianceTest {

    private static final String TARGET_NAMESPACE = "http://facture.mapping.samples.petals.ow2.org/";

    @Test
    public void validate() throws Exception {
        assertWsdlCompliance(
                new QName[] { new QName(TARGET_NAMESPACE, "stocker"), new QName(TARGET_NAMESPACE, "consulter") });
    }

}

See the Javadoc for more details on parameters.

Unit-testing your XSLs

The unit test framework contains an assertion 'assertXslTransformation' to verify easily the result of your XSL transformations:

import static org.ow2.petals.se.mapping.junit.Assert.assertXslTransformation;
...
import org.junit.Test;

public class XslTest {

    private static final String XML_DIR = "xml-to-transform/";
    private static final String XML_RESULT_DIR = "xml-result/";
    private static final String INPUT_CONSULTER_DIR = "input-consulter/";
    private static final String INPUT_CONSULTER_XML_DIR = XML_DIR + INPUT_CONSULTER_DIR;
    private static final String INPUT_CONSULTER_RESULT_DIR = XML_RESULT_DIR + INPUT_CONSULTER_DIR;
    private static final String XSL_INPUT_CONSULTER = "input-consulter.xsl";

    @Test
    public void inputConsulter_Nominal() throws IOException, TransformerException, SAXException {
        assertXslTransformation(INPUT_CONSULTER_RESULT_DIR + "nominal.xml", INPUT_CONSULTER_XML_DIR + "nominal.xml",
                XSL_INPUT_CONSULTER);
    }
}

See the Javadoc for more details on parameters.