Package org.apache.cxf.ws.security.wss4j

Class AbstractTokenInterceptor

java.lang.Object

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

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

org.apache.cxf.ws.security.wss4j.AbstractTokenInterceptor

All Implemented Interfaces:

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

Direct Known Subclasses:

BinarySecurityTokenInterceptor, SamlTokenInterceptor, UsernameTokenInterceptor

public abstract class AbstractTokenInterceptor
extends org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor

An abstract interceptor that can be used to form the basis of an interceptor to add and process a specific type of security token.

Constructor Summary

Constructors

Constructor	Description
AbstractTokenInterceptor()

Method Summary

Modifier and Type	Method	Description
protected abstract void	addToken(org.apache.cxf.binding.soap.SoapMessage message)
protected abstract AbstractToken	assertTokens(org.apache.cxf.binding.soap.SoapMessage message)
protected AbstractToken	assertTokens(org.apache.cxf.binding.soap.SoapMessage message, String localname, boolean signed)
protected Header	findSecurityHeader(org.apache.cxf.binding.soap.SoapMessage message, boolean create)
protected String	getPassword(String userName, AbstractToken info, int usage, org.apache.cxf.binding.soap.SoapMessage message)
protected TokenStore	getTokenStore(org.apache.cxf.binding.soap.SoapMessage message)
Set<QName>	getUnderstoodHeaders()
void	handleMessage(org.apache.cxf.binding.soap.SoapMessage message)	Intercepts a message.
protected boolean	isTLSInUse(org.apache.cxf.binding.soap.SoapMessage message)
protected void	policyNotAsserted(AbstractToken assertion, Exception reason, org.apache.cxf.binding.soap.SoapMessage message)
protected void	policyNotAsserted(AbstractToken assertion, String reason, org.apache.cxf.binding.soap.SoapMessage message)
protected abstract void	processToken(org.apache.cxf.binding.soap.SoapMessage message)

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

getFaultCodePrefix, getRoles, 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

Constructor Detail

AbstractTokenInterceptor

public AbstractTokenInterceptor()

Method Detail

getUnderstoodHeaders

public Set<QName> getUnderstoodHeaders()

Specified by:

getUnderstoodHeaders in interface org.apache.cxf.binding.soap.interceptor.SoapInterceptor

Overrides:

getUnderstoodHeaders in class org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor

handleMessage

public void handleMessage(org.apache.cxf.binding.soap.SoapMessage message)
                   throws Fault

Description copied from interface: Interceptor

Intercepts a message. Interceptors should NOT invoke handleMessage or handleFault on the next interceptor - the interceptor chain will take care of this.

Throws:

Fault

processToken

protected abstract void processToken(org.apache.cxf.binding.soap.SoapMessage message)

addToken

protected abstract void addToken(org.apache.cxf.binding.soap.SoapMessage message)

assertTokens

protected abstract AbstractToken assertTokens(org.apache.cxf.binding.soap.SoapMessage message)

assertTokens

protected AbstractToken assertTokens(org.apache.cxf.binding.soap.SoapMessage message,
                                     String localname,
                                     boolean signed)

isTLSInUse

protected boolean isTLSInUse(org.apache.cxf.binding.soap.SoapMessage message)

getTokenStore

protected TokenStore getTokenStore(org.apache.cxf.binding.soap.SoapMessage message)

findSecurityHeader

protected Header findSecurityHeader(org.apache.cxf.binding.soap.SoapMessage message,
                                    boolean create)

getPassword

protected String getPassword(String userName,
                             AbstractToken info,
                             int usage,
                             org.apache.cxf.binding.soap.SoapMessage message)

policyNotAsserted

protected void policyNotAsserted(AbstractToken assertion,
                                 String reason,
                                 org.apache.cxf.binding.soap.SoapMessage message)

policyNotAsserted

protected void policyNotAsserted(AbstractToken assertion,
                                 Exception reason,
                                 org.apache.cxf.binding.soap.SoapMessage message)