This version must be installed on [Petals ESB 5.3.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 Service provider configuration 3.3.1 CDK parameters defining service provider implementation 3.3.2 CDK parameters driving interceptors 3.3.3 Dedicated configuration 3.4 Defining the 3PP service provider 3.4.1 CDK parameters defining service consumer implementation 3.4.2 CDK parameters driving interceptors 3.4.3 Dedicated configuration 3.5 Example 4 Configuring the component 4.1 CDK parameters 4.2 Interception configuration 4.3 Dedicated configuration 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 Business monitoring 6.1 MONIT traces 6.2 Flow tracing activation 6.3 Flow tracing propagation 7 Unit testing 7.1 Checking the compliance of the WSDL 7.2 Unit-testing your XSLs Contributors No contributors found for: authors on selected page(s)

Introduction

The version 1.1.0+ 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 service provider 'Facade' configuration located in the service unit JBI descriptor as provider section, with:
  • 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.

service-unit.zip
  + META-INF
    - jbi.xml (as defined above)
  - service.wsdl (recommended)
  - request.xsl
  - response.xsl

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".

Service provider configuration

All needed information must be defined in the service-unit JBI descriptor. This JBI descriptor is configured through parameters divided in following groups:

• JBI parameters that defines the service provider identification,
• CDK parameters that are parameters driving the service provider implementation at CDK layer,
• CDK interceptor parameters that are parameters driving interceptors at CDK layer,
• Dedicated parameters that are parameters driving the service provider implementation at component layer.

CDK parameters defining service provider implementation

The following parameters correspond to the CDK configuration of the service provider implementation.

The service provider is defined into the section 'provides' of the JBI descriptor, containing:

CDK parameters driving interceptors

The following parameters drive interceptors at CDK layer.

Interceptors can be defined to inject some post or pre-processing in the service provider processing or service consumer processing.

Using interceptor is very sensitive and must be manipulated only by power users. A 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"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5">
   <jbi:services>
      <jbi:provides|consumes>
         <!--...-->
         <petalsCDK:su-interceptors>
            <petalsCDK:send>
               <petalsCDK:interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
                  <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
               </petalsCDK:interceptor>
            </petalsCDK:send>
            <petalsCDK:accept>
               <petalsCDK:interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:interceptor>
            </petalsCDK:accept>
            <petalsCDK:send-response>
               <petalsCDK:Interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:Interceptor>
            </petalsCDK:send-response>
            <petalsCDK:accept-response>
               <petalsCDK:Interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:Interceptor>
            </petalsCDK:accept-response>
         </petalsCDK:su-interceptors>
         <!--...-->
      </jbi:provides|consumes>
      <!--...-->
   </jbi:services>
</jbi:jbi>

Dedicated configuration

No specific configuration exists.

Defining the 3PP service provider

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

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

All needed information must be defined in the service-unit JBI descriptor. This JBI descriptor is configured through parameters divided in following groups:

• JBI parameters that defines the service provider identification,
• CDK parameters that are parameters driving the service provider implementation at CDK layer,
• CDK interceptor parameters that are parameters driving interceptors at CDK layer,
• Dedicated parameters that are parameters driving the service provider implementation at component layer.

CDK parameters defining service consumer implementation

The following parameters correspond to the CDK configuration of the service provider implementation.

A service consumer is defined into the section 'consumes' of the JBI descriptor, containing:

CDK parameters driving interceptors

The following parameters drive interceptors at CDK layer.

Interceptors can be defined to inject some post or pre-processing in the service provider processing or service consumer processing.

Using interceptor is very sensitive and must be manipulated only by power users. A 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"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5">
   <jbi:services>
      <jbi:provides|consumes>
         <!--...-->
         <petalsCDK:su-interceptors>
            <petalsCDK:send>
               <petalsCDK:interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
                  <petalsCDK:param name="myParamName2">myParamValue2</petalsCDK:param>
               </petalsCDK:interceptor>
            </petalsCDK:send>
            <petalsCDK:accept>
               <petalsCDK:interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:interceptor>
            </petalsCDK:accept>
            <petalsCDK:send-response>
               <petalsCDK:Interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:Interceptor>
            </petalsCDK:send-response>
            <petalsCDK:accept-response>
               <petalsCDK:Interceptor name="myInterceptorName">
                  <petalsCDK:param name="myParamName">myParamValue</petalsCDK:param>
               </petalsCDK:Interceptor>
            </petalsCDK:accept-response>
         </petalsCDK:su-interceptors>
         <!--...-->
      </jbi:provides|consumes>
      <!--...-->
   </jbi:services>
</jbi:jbi>

Dedicated configuration

Following parameters have specific processing:

• 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 WSDL annotation 'service-provider-operation'. A warning will appear in log traces if this field is set.

Example

An example of a Service Unit descriptor to provide a mapping service:

<jbi:jbi version="1.0"
         xmlns:facture="http://facture.mapping.samples.petals.ow2.org/"
         xmlns:ged="http://service.server.ged.mapping.samples.petals.ow2.org/"
         xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5"
         xmlns:jbi="http://java.sun.com/xml/ns/jbi"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	
   <jbi:services binding-component="false">
	
      <jbi:provides
              interface-name="facture:FactureService"
              service-name="facture:FactureService"
              endpoint-name="autogenerate">
	
         <petalsCDK:wsdl>factureService.wsdl</petalsCDK:wsdl>

      </jbi:provides>
      
      <!-- 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>
   </jbi:services>
</jbi:jbi>

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,
• Dedicated parameters that are parameters specific to this component.

CDK parameters

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

• 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.

Interception configuration

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 manipulated only by power users. A 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"?>
<jbi:jbi xmlns:jbi="http://java.sun.com/xml/ns/jbi" xmlns:petalsCDK="http://petals.ow2.org/components/extensions/version-5" ...>
   <jbi:component>
      <!--...-->
      <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>
      <!--...-->
   </jbi:component>
</jbi:jbi>

Dedicated configuration

No dedicated configuration parameter is available.

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.

Business monitoring

MONIT traces

Each service provider implemented is able to log MONIT traces with following information:

• on service provider invocation, when receiving an incoming request, with following attributes:
  • traceCode set to provideFlowStepBegin,
  • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
  • flowStepId set to an UUID value,
  • flowStepInterfaceName set to the service provider interface name,
  • flowStepServiceName set to the service provider service name,
  • flowStepOperationName set to the operation of the invoked service provider,
  • flowStepEndpointName set to the service provider endpoint name,
  • flowPreviousStepId set to the step identifier of the previous step, retrieved from the incoming request.
• on service provider termination, when returning the outgoing response, with following attributes:
  • traceCode set to provideFlowStepEnd or provideFlowStepFailure,
  • flowInstanceId set to the flow instance identifier retrieved from the incoming request,
  • flowStepId set to the flow step identifier defined on incoming request receipt.

Flow tracing activation

The flow tracing (ie. MONIT traces generation) is defined according to the property 'org.ow2.petals.monitoring.business.activate-flow-tracing' of the incoming JBI request. If the property does not exist, the parameter activate-flow-tracing of the service provider definition will be inspected. If no parameter is defined at service provider level, the component configuration parameter 'activate-flow-tracing' is used. Finally, by default, the flow tracing is enabled.

Flow tracing propagation

The flow tracing propagation from a service provider implemented with this component to another service provider is driven by the parameter propagate-flow-tracing-activation of the service consumer definition. If no parameter is defined at service consumer level, the component configuration parameter 'propagate-flow-tracing-activation' is used. Finally, by default, the flow tracing propagation is enabled.

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.1.0</version>
         <scope>test</scope>
      </dependency>
      ...
   </dependencies>
   ...
</project>

See the Compatibility Matrix to known the version of the SE Mapping Junit framework compliant with your version of the SE Mapping.

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.