FeaturesThe SOAP component is a Binding Component (BC) which enables to interact with external SOAP Web Services and to expose JBI services as SOAP 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, it is 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:
|
Table of contents
Contributors
No contributors found for: authors on selected page(s)
|
Provide a Web Service access in the ESB (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 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
Service Unit descriptor
An example of a Service Unit descriptor that provides a Web Service:
<?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>
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 |
Parameter | Description | Default | 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 an external service.
|
30000 | 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 | Enable the compatibility with a specified Web Service stack. Possible values are: AXIS1 for Axis1 Web Service stack. Possible values are: true, false. |
- | No | ||
enable-wsa |
Enable the WSA-Addressing. Set the WSA headers in the outcoming SOAP messages. |
false |
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 | ||
https-truststore-file |
The file path of the truststore file. |
- |
No |
||
https-truststore-password |
The password of the truststore. |
- |
No | ||
https-keystore-file |
The file path of the keystore file. | - |
No | ||
https-keystore-password |
The password of the keystore
|
- |
No | ||
basic-auth-username |
the username for HTTP Basic authentication. | - |
No | ||
basic-auth-password | the password for HTTP Basic authentication. |
- |
No |
Service Unit content
The Service Unit has to contain the following elements, packaged in an archive:
- The META-INF/jbi.xml descriptor file as 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 a SOAP message
The service-name Service Unit extension value will be used as Axis2 service name.
When a SOAP message is handled by the component, 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 protocol 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 HTTP services is available at http://localhost:8084/petals/services/listServices URI (it can also be configured in the [SOAP component configuration]).
If you plan tests with JAX-WS Reference Implementation, please use the JDK one (not the JRE one), otherwise MTOM attachments will not be handled properly. |
Configuration
Service Unit descriptor
An example of a Service Unit descriptor that consumes a Web Service:
<?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:enable-http-transport>true</soap:enable-http-transport> <soap:enable-jms-transport>false</soap:enable-jms-transport> </jbi:consumes> </jbi:services> </jbi: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 |
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 |
Parameter | Description | Default | 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 invoking a service in the JBI bus.
|
- | 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 | Enable the compatibility with a specified Web Service stack. Possible values are: AXIS1 for Axis1 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-https-transport |
Enable the HTTPS transport layer to send or receive SOAP messages. Possible values are: true, false. |
false |
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 | ||
address | Same as service-name.
|
- | No |
Service Unit content
The Service Unit has to contain the following elements, packaged in an archive:
- The META-INF/jbi.xml descriptor file as described above
Provide a HTTPS Web Service access in the ESB (SOAP over HTTPS)
In provide mode, the component exposes an external Web Service in the JBI environment to send SOAP requests to the external HTTPS Web Service.
Usage
The 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 HTTPS Web Service. The address of the HTTPS 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 HTTPS Web Service is called and the SOAP response is processed and returned to the JBI environment.
Configuration
Service Unit descriptor
An example of a Service Unit descriptor that provides a Web Service:
<?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> <soap:https-truststore-file>../https/clientTruststore.jks</soap:https-truststore-file> <soap:https-truststore-password>passwordClientTruststore</soap:https-truststore-password> <soap:https-keystore-file>../https/clientKeystore.jks</soap:https-keystore-file> <soap:https-keystore-password>passwordClientKeystore</soap:https-keystore-password> </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 as described above,
- An optional imported WSDL file describing the partner service
Exposing an internal JBI service endpoint as a HTTPS Web Service (SOAP over HTTPS)
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 on a HTTPS port 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 a SOAP message
The service-name Service Unit extension value will be used as Axis2 service name.
When a SOAP message is handled by the component, 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 protocol header JBI message property.
By default, the component is configured to handle URI with the https://localhost:8083/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 HTTPS services is available at https://localhost:8083/petals/services/listServices URI (it can also be configured in the [SOAP component configuration]).
If you plan tests with JAX-WS Reference Implementation, please use the JDK one (not the JRE one), otherwise MTOM attachments will not be handled properly. |
Configuration
Service Unit descriptor
An example of a Service Unit descriptor that consumes a Web Service:
<?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:enable-http-transport>true</soap:enable-http-transport> <soap:enable-https-transport>true</soap:enable-https-transport> <soap:enable-jms-transport>false</soap:enable-jms-transport> </jbi:consumes> </jbi:services> </jbi:jbi>
Component configuration
The HTTPS configuration must be done at [the component level].
Service Unit content
The Service Unit has to contain the following elements, packaged in an archive:
- The META-INF/jbi.xml descriptor file as described above
Provide a REST Service access in the ESB
In provide mode, the component exposes an external Web Service in the JBI environment to send REST requests to the external Web Service.
Warning This feature is currently only supported with the MEP InOut. |
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 REST linked endpoint from the JBI environment, it is transformed into a REST message and sent to the Web Service. The address of the Web Service to send the REST message to is defined in the address extension of the deployed Service Unit.
The REST message is created like this:
- The JBI message payload and the exchange operation are used to create the HTTP body
- The address extension is used to create the REST URI
- The rest-http-method extension is used to choose the HTTP method (if it is not defined, the method POST is used)
The external Web Service is called and the REST response is processed and returned to the JBI environment.
The address extension can be configured with placeholders. The placeholder will be replaced by the result of the XPath expression defined inside of the placeholder. The XPath expression is performed on the content of the incoming JBI message. The placeholders will be replaced in the address extension to build the final URI according to the result of the XPath expression.
For example the following JBI message:
<weat:getWeather xmlns:weat="http://petals.ow2.org/services/weather"> <citycode>FRXX0099</citycode> <unit>c</unit> </weat:getWeather>
is associated with the address parameter value:
http://weather.yahooapis.com/forecastrss?p={/*[localname()='getWeather'][1]/*[local-name()='citycode']
[1]}&u={/*[local-name()='getWeather'][1]/*[local-name()='unit'][1]}
and produces the URI http://weather.yahooapis.com/forecastrss?p=FRXX0099&u=c.
The JBI message response returned by the Yahoo Weather REST service corresponding to the previous URI is:
<rss version="2.0" xmlns:yweather="http://xml.weather.yahoo.com/ns/rss/1.0" xmlns:geo="http://www.w3.org/2003/01/geo/wgs84_pos#"> <channel> <title>Yahoo! Weather - Toulouse, FR</title> <link>http://us.rd.yahoo.com/dailynews/rss/weather/Toulouse__FR/*http://weather.yahoo.com/forecast/ FRXX0099_c.html</link> <description>Yahoo! Weather for Toulouse, FR</description> <language>en-us</language> <lastBuildDate>Thu, 06 Mar 2008 3:00 pm CET</lastBuildDate> <ttl>60</ttl> <yweather:location city="Toulouse" country="FR" region=""/> <yweather:units distance="km" pressure="mb" speed="kph" temperature="C"/> <yweather:wind chill="3" direction="310" speed="37"/> <yweather:atmosphere humidity="37" pressure="0" rising="0" visibility="999"/> <yweather:astronomy sunrise="7:22 am" sunset="6:50 pm"/> <image> <title>Yahoo! Weather</title> <width>142</width> <height>18</height> <link>http://weather.yahoo.com/</link> <url>http://l.yimg.com/us.yimg.com/i/us/nws/th/main_142b.gif</url> </image> <item> <title>Conditions for Toulouse, FR at 3:00 pm CET</title> <geo:lat>43.61</geo:lat> <geo:long>1.45</geo:long> <link>http://us.rd.yahoo.com/dailynews/rss/weather/Toulouse__FR/*http://weather.yahoo.com/forecast/ FRXX0099_c.html</link> <pubDate>Thu, 06 Mar 2008 3:00 pm CET</pubDate> <yweather:condition code="28" date="Thu, 06 Mar 2008 3:00 pm CET" temp="8" text="Mostly Cloudy"/> <description> <![CDATA[<img src="http://l.yimg.com/us.yimg.com/i/us/we/52/28.gif" /><br /> <b>Current Conditions:</b><br /> Mostly Cloudy, 8 C<BR /><BR /> <b>Forecast:</b><BR /> Thu - Mostly Cloudy. High: 10 Low: 4<br /> Fri - Cloudy. High: 10 Low: 4<br /> <br /> <a href="http://us.rd.yahoo.com/dailynews/rss/weather/Toulouse__FR/*http://weather.yahoo.com/forecast/ FRXX0099_c.html">Full Forecast at Yahoo! Weather</a><BR/> (provided by The Weather Channel)<br/>]]> </description> <yweather:forecast code="27" date="06 Mar 2008" day="Thu" high="10" low="4" text="Mostly Cloudy"/> <yweather:forecast code="26" date="07 Mar 2008" day="Fri" high="10" low="4" text="Cloudy"/> <guid isPermaLink="false">FRXX0099_2008_03_06_15_0_CET</guid> </item> </channel> </rss>
Configuration
Service Unit descriptor
An example of a Service Unit descriptor that provides a REST service:
<?xml version="1.0" encoding="UTF-8"?> <jbi:jbi version="1.0" xmlns:generatedNs="http://petals.ow2.org/GenericREST/" 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:RestInterface" service-name="generatedNs:YahooWeather" endpoint-name="YahooWeatherEndpoint"> <!-- CDK specific elements --> <petalsCDK:timeout>30000</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>RestService.wsdl</petalsCDK:wsdl> <!-- Component specific elements --> <soap:address>http://weather.yahooapis.com/forecastrss?p={/*[local-name()='getWeather'][1]/*[local-name()='citycode'][1]}&u={/*[local-name()='getWeather'][1]/*[local-name()='unit'][1]}</soap:address> <soap:mode>REST</soap:mode> </jbi:provides> </jbi:services> </jbi: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 |
Parameter | Description | Default | Required | ||
---|---|---|---|---|---|
address | Address of the external Web Service to send JBI messages to. | - | Yes | ||
synchronous-timeout | The timeout value when invoking an external service.
The value is expressed in milliseconds. It must be provided in multiples of 100. |
30000 | No | ||
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 | ||
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. |
POST | No |
Service Unit content
The Service Unit has to contain the following elements, packaged in an archive:
- The META-INF/jbi.xml descriptor file as described above
- A "generic" WSDL:
<?xml version="1.0" encoding="UTF-8"?> <wsdl:definitions name="RestService" targetNamespace="http://petals.ow2.org/GenericREST/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:tns="http://petals.ow2.org/GenericREST/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"> <wsdl:types> <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns:tns="http://petals.ow2.org/GenericREST/" elementFormDefault="qualified" targetNamespace="http://petals.ow2.org/GenericREST/" version="1.0"> <xs:element name="delete" type="tns:delete" /> <xs:element name="deleteResponse" type="tns:deleteResponse" /> <xs:element name="get" type="tns:get" /> <xs:element name="getResponse" type="tns:getResponse" /> <xs:element name="post" type="tns:post" /> <xs:element name="postResponse" type="tns:postResponse" /> <xs:element name="put" type="tns:put" /> <xs:element name="putResponse" type="tns:putResponse" /> <xs:complexType name="delete"> <xs:sequence /> </xs:complexType> <xs:complexType name="deleteResponse"> <xs:sequence> <xs:element minOccurs="0" name="DeleteOutParam" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:complexType name="get"> <xs:sequence /> </xs:complexType> <xs:complexType name="getResponse"> <xs:sequence> <xs:element minOccurs="0" name="GetOutParam" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:complexType name="put"> <xs:sequence> <xs:element minOccurs="0" name="PutInParam" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:complexType name="putResponse"> <xs:sequence> <xs:element minOccurs="0" name="PutOutParam" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:complexType name="post"> <xs:sequence> <xs:element minOccurs="0" name="PostInParam" type="xs:anyType" /> </xs:sequence> </xs:complexType> <xs:complexType name="postResponse"> <xs:sequence> <xs:element minOccurs="0" name="PostOutParam" type="xs:anyType" /> </xs:sequence> </xs:complexType> </xs:schema> </wsdl:types> <wsdl:message name="get"> <wsdl:part name="parameters" element="tns:get" /> </wsdl:message> <wsdl:message name="putResponse"> <wsdl:part name="parameters" element="tns:putResponse" /> </wsdl:message> <wsdl:message name="deleteResponse"> <wsdl:part name="parameters" element="tns:deleteResponse" /> </wsdl:message> <wsdl:message name="post"> <wsdl:part name="parameters" element="tns:post" /> </wsdl:message> <wsdl:message name="put"> <wsdl:part name="parameters" element="tns:put" /> </wsdl:message> <wsdl:message name="postResponse"> <wsdl:part name="parameters" element="tns:postResponse" /> </wsdl:message> <wsdl:message name="delete"> <wsdl:part name="parameters" element="tns:delete" /> </wsdl:message> <wsdl:message name="getResponse"> <wsdl:part name="parameters" element="tns:getResponse" /> </wsdl:message> <wsdl:portType name="RestInterface"> <wsdl:operation name="delete"> <wsdl:input name="delete" message="tns:delete" /> <wsdl:output name="deleteResponse" message="tns:deleteResponse" /> </wsdl:operation> <wsdl:operation name="get"> <wsdl:input name="get" message="tns:get" /> <wsdl:output name="getResponse" message="tns:getResponse" /> </wsdl:operation> <wsdl:operation name="put"> <wsdl:input name="put" message="tns:put" /> <wsdl:output name="putResponse" message="tns:putResponse" /> </wsdl:operation> <wsdl:operation name="post"> <wsdl:input name="post" message="tns:post" /> <wsdl:output name="postResponse" message="tns:postResponse" /> </wsdl:operation> </wsdl:portType> <wsdl:binding name="GenericRestServiceSoapBinding" type="tns:RestInterface"> <soap:binding style="document" transport="http://schemas.xmlsoap.org/soap/http" /> <wsdl:operation name="delete"> <soap:operation soapAction="" style="document" /> <wsdl:input name="delete"> <soap:body use="literal" /> </wsdl:input> <wsdl:output name="deleteResponse"> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="get"> <soap:operation soapAction="" style="document" /> <wsdl:input name="get"> <soap:body use="literal" /> </wsdl:input> <wsdl:output name="getResponse"> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="put"> <soap:operation soapAction="" style="document" /> <wsdl:input name="put"> <soap:body use="literal" /> </wsdl:input> <wsdl:output name="putResponse"> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> <wsdl:operation name="post"> <soap:operation soapAction="" style="document" /> <wsdl:input name="post"> <soap:body use="literal" /> </wsdl:input> <wsdl:output name="postResponse"> <soap:body use="literal" /> </wsdl:output> </wsdl:operation> </wsdl:binding> <wsdl:service name="YahooWeather"> <wsdl:port name="YahooWeatherEndpoint" binding="tns:GenericRestServiceSoapBinding"> <soap:address location="http://localhost:9090/GenericRestEndpoint" /> </wsdl:port> </wsdl:service> </wsdl:definitions>
Exposing an internal JBI service endpoint as a REST Service
In consumer mode, the component exposes an internal JBI service outside the bus to transfer incoming REST requests to the internal service.
Usage
The petals-bc-soap component can listen incoming REST 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 a REST message
The service-name Service Unit extension value will be used as Axis2 service name.
When a REST message is handled by the component, 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 incoming REST query. A URL like http://<host>:<port>/petals/services/<service-name>/operation?param1=value1¶m2=value2 produces the 'operation' JBI operation.
- The JBI payload depends on the HTTP method used in the incoming request:
- GET: The JBI message is created from the URL parameters
- POST/PUT/DELETE: The JBI message is copied from the HTTP body (only XML contents are supported)
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.
Configuration
Service Unit descriptor
An example of a Service Unit descriptor that consumes a REST service:
<?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>30000</petalsCDK:timeout> <petalsCDK:mep xsi:nil="true" /> <!-- Component specific elements --> <soap:address>RESTService</soap:address> <soap:mode>REST</soap:mode> <soap:rest-add-namespace-uri>http://petals.ow2.org/</soap:rest-add-namespace-uri> <soap:rest-add-namespace-prefix>ns1</soap:rest-add-namespace-prefix> </jbi:consumes> </jbi:services> </jbi: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 |
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 content
The Service Unit has to contain the following elements, packaged in an archive:
- The META-INF/jbi.xml descriptor file as 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 with the MEP InOnly. |
Usage
The petals-bc-soap component can receive JMS messages from a JMS queue and send SOAP messages (contained in the JMS body message) to a JBI service endpoint by deploying a Service Unit on it. The component consumes the JBI service.
It enables to support the following scenario: A JMS publisher sends a message to a JMS server and the SOAP component consumes the JMS message which contains a SOAP envelope in its body:
Consumes a JBI service on JMS message (containing SOAP envelope)
The service-name Service Unit extension value will be used as Axis2 service name.
When a JMS message is handled by the component, the SOAP envelope (in 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 protocol 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>
When the SU is started, a queue is created on the JMS server by the SOAP component if it does not exist. The name of the queue is the value of the parameter soap:address or soap:service-name.
When a message is sent to the JMS queue, it is received and treated by the SOAP component.
Component Configuration
Component descriptor
Example of a Component descriptor:
<?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>
Parameter | Description | Default | Required | Scope |
---|---|---|---|---|
acceptor-pool-size | The size of the thread pool used to accept Message Exchanges from the NMR. Once a message is accepted, its processing is delegated to the processor pool thread. | 3 |
Yes |
Runtime |
processor-pool-size | The size of the thread pool used to process Message Exchanges. Once a message is accepted, its processing is delegated to one of the thread of this pool. | 10 | Yes |
Runtime |
processor-max-pool-size | The maximum size of the thread pool used to process Message Exchanges. The difference between this size and the processorpool-size represents the dynamic threads that can be created and destroyed during overhead processing time. |
50 |
No | Runtime |
notifications | Enable the notifications mode. The component produces and consumes generic notifications when receiving and sending messages. See the Petals View documentation for further details. |
false |
No |
Installation |
notif-retry-policy-min | The notification retry policy is triggered if the notification component is not reachable at the starting of the component. Delay before the first notification retry is attempted, in second. |
1 | bounds to notifications | Installation |
notif-retry-policy-max | The notification retry policy is triggered if the notification component is not reachable at the starting of the component. The maximum delay value authorized, in second. |
60 | bounds to notifications | Installation |
notif-retry-policy-factor | The notification retry policy is triggered if the notification component is not reachable at the starting of the component. The factor applies on the previous attempt, for each new attempt. |
2 |
bounds to notifications | Installation |
notif-retry-policy-nb | The notification retry policy is triggered if the notification component is not reachable at the starting of the component. Number of retry once the maximum delay value is reached. |
1000 |
bounds to notifications | Installation |
properties-file | Name of the file containing properties used as reference by other parameters. Parameters of service-units and other parameters of the component reference the property name in the following pattern ${myPropertyName}. At runtime, the expression is replaced by the value of the property. The value of this parameter is:
|
- | No | Installation |
Parameter | Description | Default | Required |
---|---|---|---|
http-port | HTTP port of the Jetty embedded 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 |
https-enabled |
Enable the HTTPS support. Possible values are: true, false. |
false |
No |
https-port |
HTTPS port of the Jetty embedded server | 8083 |
No |
https-keystore-type |
Type of the keystore. Possible values are: JKS, PKCS12. |
JKS |
No |
https-keystore-file | File path of the keystore. |
- |
No |
https-keystore-password |
Password of the keystore. |
- |
No |
https-key-password |
Password of the key. |
- |
No |
https-truststore-type |
Type of the truststore. Possible values are: JKS, PKCS12. |
JKS |
No |
https-truststore-file |
File path of the truststore. | - |
No |
https-truststore-password |
Password of the truststore. | - |
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.