LibraryLink ToToggle FramesPrintFeedback
Prev   Next

Chapter 6. Using Message Interceptors

You can use low-level message interceptors to process messages before they are delivered to your endpoint's service implementation.

Overview

Interceptors are a low-level pieces of code that process messages as they are passed between the message channel and service's implementation. They have access to the raw message data and can be used to process SOAP action entries, process security tokens, or correlate messages. Interceptors are called in a chain and you can configure what interceptors are used at a number of points along the chain.

Configuring an endpoint's interceptor chain

A FUSE Services Framework service engine endpoint's interceptor chain has four points at which you can insert an interceptor:

An endpoint's interceptor chain is configured using children of its endpoint element. Table 6.1 lists the elements used to configure an endpoint's interceptor chain.

Table 6.1. Elements Used to Configure an Endpoint's Interceptor Chain

NameDescription
inInterceptors Specifies a list of interceptors that process incoming messages.
inFaultInterceptors Specifies a list of interceptors that process incoming fault messages.
outInterceptors Specifies a list of interceptors that process outgoing messages.
outFaultInterceptors Specifies a list of interceptors that process outgoing fault messages.

Example 6.1 shows an endpoint configured to use the FUSE Services Framework logging interceptors.

Example 6.1. Configuring an Interceptor Chain

<cxfse:endpoint>
  ...
  <cxfse:inInterceptors>
    <bean class="org.apache.cxf.interceptor.LoggingInInterceptor" />
  </cxfse:inInterceptors>
  <cxfse:outInterceptors>
    <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor" />
  </cxfse:outInterceptors>
  <cxfse:inFaultInterceptors>
    <bean class="org.apache.cxf.interceptor.LoggingInInterceptor" />
  </cxfse:inFaultInterceptors>
  <cxfse:outFaultInterceptors>
    <bean class="org.apache.cxf.interceptor.LoggingOutInterceptor" />
  </cxfse:outFaultInterceptors>
</cxfse:endpoint>

Implementing an interceptor

You can implement a custom interceptor by extending the org.apache.cxf.phase.AbstractPhaseInterceptor class or one of its sub-classes. Extending AbstractPhaseInterceptor provides you with access to the generic message handling APIs used by FUSE Services Framework. Extending one of the sub-classes provides you with more specific APIs. For example, extending the AbstractSoapInterceptor class allows your interceptor to work directly with the SOAP APIs.

More information

For more information about writing FUSE Services Framework interceptors see the Apache CXF documentation.

Prev   Next
 Home