Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

To do this, a class that implements org.fabric3.spi.binding.handler.BindingHandler must be provided as a Fabric3 extension componentscomponent:

Code Block
java
java
public interface BindingHandler<T> {

    /**
     * The fully qualified binding name corresponding to the SCA architected binding name scheme binding.xxxx.
     *
     * @return the fully qualified binding name
     */
    QName getType();

    /**
     * Handles an outbound (reference-side) message.
     *
     * @param context the binding-specific transport context
     * @param message the current message
     */
    void handleOutbound(Message message, T context);

    /**
     * Handles an inbound (service-side) message.
     *
     * @param context the binding-specific transport context
     * @param message the current message
     */
    void handleInbound(T context, Message message);

}

BindingHandler implementations that require access Web Service SOAP messages must use javax.xml.soap.SOAPMessage as the parameterized type. Below is an example handler:

Code Block
java
java
@EagerInit@Scope("COMPOSITE")
public class SOAPHandlerTestHandler implements BindingHandler<SOAPMessage> {
    private static final QName BINDING = new QName(Constants.SCA_NS, "binding.ws");

    privatepublic BindingHandlerRegistry registry;

    public SOAPHandler(@Reference BindingHandlerRegistry registryQName getType() {
        this.registry = registryreturn BINDING;
    }


   @Init
    public void inithandleOutbound()Message {message,         registry.register(this);
    }

    @Destroy
    public void destroy(SOAPMessage context) {
       // registry.unregister(this);...
    }

    public QNamevoid getTypehandleInbound() {
        return BINDING;
    }

    public void handleOutbound(Message message, SOAPMessage contextSOAPMessage context, Message message) {
     }

    public void handleInbound(SOAPMessage soapMessage, Message message) {  //.. 
      }
}

Note the component handler is eager-initialized and registers with the BindingHandlerRegistry. Fabric3 extension components are configured using the implementation.system type as shown belowcomposite-scoped. Although this is not necessary, most handlers are threadsafe and making them composite-scoped will avoid the overhead associated with stateless-scoped implementations. The handler configuration is shown below. Note the component may be contained in the same contribution as the services or references it applies to or in a different contribution if used for more than one application:

Code Block
xml
xml
<composite<component xmlnsname="http://docs.oasis-open.org/ns/opencsa/sca/200912"TestHandler">
           xmlns:sca="http://docs.oasis-open.org/ns/opencsa/sca/200912"
 <implementation.java class="org.fabric3.tests.binding.metro.handler.TestHandler"/>
</component>

The manifest (sca-contribution.xml) of the contribution containing the handler must contain the following imports:

Code Block
xml
xml

<contribution ...>
         xmlns:f3="urn:fabric3.org"
           targetNamespace="urn:fabric3.org"<import.java package="org.fabric3.spi.*" version="1.9.6"/>
           name="TestWsHandlerExtensionComposite">

    <import.java package="javax.xml.ws.*"/>
</contribution>

Finally, the handler may be used on a binding as follows:

Code Block
xml
xml

<component name="SOAPHandlerHandlerService">
        <f3:implementation.system<implementation.java class="org.fabric3.tests.binding.metro.handler.SOAPHandlerHandlerServiceImpl"/>
    </component>

</composite>

Finally, the component and its configuration must be packaged as an extension contribution with a manifest (sca-contribution.xml) similar to the following:

Code Block
xmlxml

<contribution xmlns="http://docs.oasis-open.org/ns/opencsa/sca/200912"<service name="HandlerService">
              xmlns:f3="urn:fabric3.org"<binding.ws uri="/handlerService">
              f3:extension<f3:handler target="trueTestHandler"/>
    <import.java package="org.fabric3.spi.*"/>  </binding.ws>
    <deployable composite="f3:TestWsHandlerExtensionComposite"/></service>
</contribution>

...

component>