org.openehealth.ipf.commons.ihe.ws.cxf.audit

Class AbstractAuditInterceptor<T extends WsAuditDataset>

java.lang.Object

org.apache.cxf.phase.AbstractPhaseInterceptor<org.apache.cxf.binding.soap.SoapMessage>

org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor

org.openehealth.ipf.commons.ihe.ws.cxf.AbstractSafeInterceptor

org.openehealth.ipf.commons.ihe.ws.cxf.audit.AbstractAuditInterceptor<T>

All Implemented Interfaces:

org.apache.cxf.binding.soap.interceptor.SoapInterceptor, org.apache.cxf.interceptor.Interceptor<org.apache.cxf.binding.soap.SoapMessage>, org.apache.cxf.phase.PhaseInterceptor<org.apache.cxf.binding.soap.SoapMessage>

Direct Known Subclasses:

AuditInRequestInterceptor, AuditOutRequestInterceptor, AuditResponseInterceptor

public abstract class AbstractAuditInterceptor<T extends WsAuditDataset>
extends AbstractSafeInterceptor

Base class for all ATNA audit-related CXF interceptors.

Author:

Dmytro Rud

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATASET_CONTEXT_KEY Key used to store audit datasets in Web Service contexts.
static String	WSSE_NS_URI XML Namespace URI of WS-Security Extensions 1.1.
static String	XUA_SAML_ASSERTION If a SAML assertion is stored under this key in the Web Service context, IPF will use it instead of parsing the WS-Security header by itself.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractAuditInterceptor(String phase, AuditStrategy<T> auditStrategy) Constructor which sets a strategy.

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	extractAddressesFromServletRequest(org.apache.cxf.binding.soap.SoapMessage message, WsAuditDataset auditDataset) Extracts service URI and client IP address from the servlet request.
protected static Object	extractPojo(org.apache.cxf.message.Message message) Extracts POJO from the given CXF message.
protected static void	extractUserIdFromWSAddressing(org.apache.cxf.binding.soap.SoapMessage message, boolean isInbound, boolean inverseWsaDirection, WsAuditDataset auditDataset) Extracts user ID from an WS-Addressing SOAP header and stores it in the given audit dataset.
protected static void	extractXuaUserNameFromSaml2Assertion(org.apache.cxf.binding.soap.SoapMessage message, org.apache.cxf.headers.Header.Direction headerDirection, WsAuditDataset auditDataset) Extracts ITI-40 XUA user name from the SAML2 assertion contained in the given CXF message, and stores it in the ATNA audit dataset.
protected T	getAuditDataset(org.apache.cxf.binding.soap.SoapMessage message) Returns an audit dataset instance which corresponds to the given message.
protected AuditStrategy<T>	getAuditStrategy() Returns the audit strategy associated with this interceptor.

Methods inherited from class org.openehealth.ipf.commons.ihe.ws.cxf.AbstractSafeInterceptor

handleMessage, process

Methods inherited from class org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor

getFaultCodePrefix, getRoles, getUnderstoodHeaders, prepareStackTrace

Methods inherited from class org.apache.cxf.phase.AbstractPhaseInterceptor

addAfter, addAfter, addBefore, addBefore, getAdditionalInterceptors, getAfter, getBefore, getId, getPhase, handleFault, isGET, isRequestor, setAfter, setBefore

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.cxf.interceptor.Interceptor

handleFault

Field Detail

DATASET_CONTEXT_KEY

public static final String DATASET_CONTEXT_KEY

Key used to store audit datasets in Web Service contexts.

XUA_SAML_ASSERTION

public static final String XUA_SAML_ASSERTION

If a SAML assertion is stored under this key in the Web Service context, IPF will use it instead of parsing the WS-Security header by itself. If there are no Web Service context element under this key, or if this element does not contain a SAML assertion, IPF will parse the WS-Security header and store the assertion extracted from there (if any) under this key.

WSSE_NS_URI

public static final String WSSE_NS_URI

XML Namespace URI of WS-Security Extensions 1.1.

See Also:

Constant Field Values

Constructor Detail

AbstractAuditInterceptor

protected AbstractAuditInterceptor(String phase,
                        AuditStrategy<T> auditStrategy)

Constructor which sets a strategy.

Parameters:

phase - the phase in which to use this interceptor.

auditStrategy - an audit strategy instance.

null values are explicitly prohibited.

Method Detail

getAuditDataset

protected T getAuditDataset(org.apache.cxf.binding.soap.SoapMessage message)

Returns an audit dataset instance which corresponds to the given message.

When no such instance is currently associated with the message, a new one will be created by means of the corresponding AuditStrategy and registered in the message's exchange.

Parameters:

message - CXF message currently handled by this interceptor.

Returns:

an audit dataset instance, or null when this instance could be neither obtained nor created from scratch.

getAuditStrategy

protected AuditStrategy<T> getAuditStrategy()

Returns the audit strategy associated with this interceptor.

Returns:

an audit strategy instance or null when none configured.

extractUserIdFromWSAddressing

protected static void extractUserIdFromWSAddressing(org.apache.cxf.binding.soap.SoapMessage message,
                                 boolean isInbound,
                                 boolean inverseWsaDirection,
                                 WsAuditDataset auditDataset)

Extracts user ID from an WS-Addressing SOAP header and stores it in the given audit dataset.

Parameters:

message - CXF message.

isInbound - true when the CXF message is an inbound one, false otherwise.

inverseWsaDirection - true when direction is actually inversed, i.e. when the user ID should be taken not from the "ReplyTo:" WS-Addressing header, but from "To:" --- useful for asynchronous responses, where the endpoint which receives the response is not the endpoint which sent the request.

auditDataset - target audit dataset.

extractXuaUserNameFromSaml2Assertion

protected static void extractXuaUserNameFromSaml2Assertion(org.apache.cxf.binding.soap.SoapMessage message,
                                        org.apache.cxf.headers.Header.Direction headerDirection,
                                        WsAuditDataset auditDataset)

Extracts ITI-40 XUA user name from the SAML2 assertion contained in the given CXF message, and stores it in the ATNA audit dataset.

Parameters:

message - source CXF message.

headerDirection - direction of the header containing the SAML2 assertion.

auditDataset - target ATNA audit dataset.

extractAddressesFromServletRequest

protected static void extractAddressesFromServletRequest(org.apache.cxf.binding.soap.SoapMessage message,
                                      WsAuditDataset auditDataset)

Extracts service URI and client IP address from the servlet request.

extractPojo

protected static Object extractPojo(org.apache.cxf.message.Message message)

Extracts POJO from the given CXF message.

Returns:

POJO or null when none found.