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

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

Usage

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      
address      
chunked-mode      
synchronous-timeout      
cleanup-transport      
mode      
enable-compatibility-for      
proxy-host      
proxy-port      
proxy-user      
proxy-password      
proxy-domain      
rest-http-method      

Service Unit descriptor

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






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



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





Usage




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 
 
 
 




 soap-action 
 
 
 




 synchronous-timeout 
 
 
 




 mode 
 
 
 




 enable-compatibility-for 
 
 
 




 enable-http-transport 
 
 
 




 enable-jms-transport 
 
 
 




 http-services-redirection 
 
 
 




 service-parameters 
 
 
 




 modules 
 
 
 




 rest-add-namespace-uri 
 
 
 




 rest-add-namespace-prefix 
 
 
 




 rest-remove-prefix-on-response 
 
 
 











Service Unit descriptor



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









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
    • 


         


         

                      
    






    

        
            


    

        

                    


        
        

            

                

                
Enter labels to add to this page:

                

                    
                    
                    
                

                

                    Please wait 
                    
                

                

                

                    

                    Looking for a label? Just start typing.