org.apache.cxf.ws.security.wss4j
Class AbstractWSS4JInterceptor

java.lang.Object
  extended by org.apache.ws.security.handler.WSHandler
      extended by org.apache.cxf.ws.security.wss4j.AbstractWSS4JInterceptor
All Implemented Interfaces:
SoapInterceptor, Interceptor<SoapMessage>, PhaseInterceptor<SoapMessage>
Direct Known Subclasses:
WSS4JInInterceptor, WSS4JOutInterceptor

public abstract class AbstractWSS4JInterceptor
extends org.apache.ws.security.handler.WSHandler
implements SoapInterceptor, PhaseInterceptor<SoapMessage>


Field Summary
 
Fields inherited from class org.apache.ws.security.handler.WSHandler
cryptos, DONE, secEngine
 
Constructor Summary
AbstractWSS4JInterceptor()
           
 
Method Summary
protected  boolean decodeEnableSignatureConfirmation(org.apache.ws.security.handler.RequestData reqData)
           
 java.util.Set<java.lang.String> getAfter()
          Returns a set containing the IDs of the interceptors that should be executed before this interceptor.
 java.util.Set<java.lang.String> getBefore()
          Returns a set containing the IDs of the interceptors that should be executed after this interceptor.
 java.lang.String getId()
          Returns the ID of this interceptor.
 java.lang.Object getOption(java.lang.String key)
           
 java.lang.String getPassword(java.lang.Object msgContext)
           
 java.lang.String getPhase()
          Returns the phase in which this interceptor is excecuted.
 java.util.Map<java.lang.String,java.lang.Object> getProperties()
           
 java.lang.Object getProperty(java.lang.Object msgContext, java.lang.String key)
           
 java.util.Set<java.net.URI> getRoles()
           
 java.util.Set<javax.xml.namespace.QName> getUnderstoodHeaders()
           
 void handleFault(SoapMessage message)
          Called for all interceptors (in reverse order) on which handleMessage had been successfully invoked, when normal execution of the chain was aborted for some reason.
protected  boolean isRequestor(Message message)
           
protected  org.apache.ws.security.components.crypto.Crypto loadDecryptionCrypto(org.apache.ws.security.handler.RequestData reqData)
           
protected  org.apache.ws.security.components.crypto.Crypto loadEncryptionCrypto(org.apache.ws.security.handler.RequestData reqData)
           
 org.apache.ws.security.components.crypto.Crypto loadSignatureCrypto(org.apache.ws.security.handler.RequestData reqData)
           
 void postHandleMessage(SoapMessage message)
           
 void setAfter(java.util.Set<java.lang.String> after)
           
 void setBefore(java.util.Set<java.lang.String> before)
           
 void setId(java.lang.String id)
           
 void setPassword(java.lang.Object msgContext, java.lang.String password)
           
 void setPhase(java.lang.String phase)
           
 void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)
           
 void setProperty(java.lang.Object msgContext, java.lang.String key, java.lang.Object value)
           
 void setProperty(java.lang.String key, java.lang.String value)
           
 
Methods inherited from class org.apache.ws.security.handler.WSHandler
checkReceiverResults, checkReceiverResultsAnyOrder, checkSignatureConfirmation, decodeCustomPasswordTypes, decodeDecryptionParameter, decodeEncryptionParameter, decodeMustUnderstand, decodeNamespaceQualifiedPasswordTypes, decodeSignatureParameter, decodeSignatureParameter2, decodeTimestampPrecision, decodeTimestampStrict, decodeTimeToLive, decodeUTParameter, doReceiverAction, doSenderAction, getClassLoader, getPassword, getPasswordCB, getString, getStringOption, verifyTimestamp, verifyTrust
 
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
handleMessage
 

Constructor Detail

AbstractWSS4JInterceptor

public AbstractWSS4JInterceptor()
Method Detail

getRoles

public java.util.Set<java.net.URI> getRoles()
Specified by:
getRoles in interface SoapInterceptor

handleFault

public void handleFault(SoapMessage message)
Description copied from interface: Interceptor
Called for all interceptors (in reverse order) on which handleMessage had been successfully invoked, when normal execution of the chain was aborted for some reason.

Specified by:
handleFault in interface Interceptor<SoapMessage>

postHandleMessage

public void postHandleMessage(SoapMessage message)
                       throws Fault
Throws:
Fault

getPhase

public java.lang.String getPhase()
Description copied from interface: PhaseInterceptor
Returns the phase in which this interceptor is excecuted.

Specified by:
getPhase in interface PhaseInterceptor<SoapMessage>
Returns:
the phase

setPhase

public void setPhase(java.lang.String phase)

getOption

public java.lang.Object getOption(java.lang.String key)
Specified by:
getOption in class org.apache.ws.security.handler.WSHandler

setProperty

public void setProperty(java.lang.String key,
                        java.lang.String value)

getPassword

public java.lang.String getPassword(java.lang.Object msgContext)
Specified by:
getPassword in class org.apache.ws.security.handler.WSHandler

getProperty

public java.lang.Object getProperty(java.lang.Object msgContext,
                                    java.lang.String key)
Specified by:
getProperty in class org.apache.ws.security.handler.WSHandler

setPassword

public void setPassword(java.lang.Object msgContext,
                        java.lang.String password)
Specified by:
setPassword in class org.apache.ws.security.handler.WSHandler

setProperty

public void setProperty(java.lang.Object msgContext,
                        java.lang.String key,
                        java.lang.Object value)
Specified by:
setProperty in class org.apache.ws.security.handler.WSHandler

getId

public java.lang.String getId()
Description copied from interface: PhaseInterceptor
Returns the ID of this interceptor.

Specified by:
getId in interface PhaseInterceptor<SoapMessage>
Returns:
the ID

setId

public void setId(java.lang.String id)

getUnderstoodHeaders

public java.util.Set<javax.xml.namespace.QName> getUnderstoodHeaders()
Specified by:
getUnderstoodHeaders in interface SoapInterceptor

getProperties

public java.util.Map<java.lang.String,java.lang.Object> getProperties()

setProperties

public void setProperties(java.util.Map<java.lang.String,java.lang.Object> properties)

getAfter

public java.util.Set<java.lang.String> getAfter()
Description copied from interface: PhaseInterceptor
Returns a set containing the IDs of the interceptors that should be executed before this interceptor. This interceptor will be placed in the chain after the interceptors in the set.

Specified by:
getAfter in interface PhaseInterceptor<SoapMessage>
Returns:
the IDs of the interceptors

setAfter

public void setAfter(java.util.Set<java.lang.String> after)

getBefore

public java.util.Set<java.lang.String> getBefore()
Description copied from interface: PhaseInterceptor
Returns a set containing the IDs of the interceptors that should be executed after this interceptor. This interceptor will be placed in the inteceptor chain before the interceptors in the set.

Specified by:
getBefore in interface PhaseInterceptor<SoapMessage>
Returns:
the ids of the interceptors

setBefore

public void setBefore(java.util.Set<java.lang.String> before)

isRequestor

protected boolean isRequestor(Message message)

decodeEnableSignatureConfirmation

protected boolean decodeEnableSignatureConfirmation(org.apache.ws.security.handler.RequestData reqData)
                                             throws org.apache.ws.security.WSSecurityException
Overrides:
decodeEnableSignatureConfirmation in class org.apache.ws.security.handler.WSHandler
Throws:
org.apache.ws.security.WSSecurityException

loadSignatureCrypto

public org.apache.ws.security.components.crypto.Crypto loadSignatureCrypto(org.apache.ws.security.handler.RequestData reqData)
                                                                    throws org.apache.ws.security.WSSecurityException
Overrides:
loadSignatureCrypto in class org.apache.ws.security.handler.WSHandler
Throws:
org.apache.ws.security.WSSecurityException

loadDecryptionCrypto

protected org.apache.ws.security.components.crypto.Crypto loadDecryptionCrypto(org.apache.ws.security.handler.RequestData reqData)
                                                                        throws org.apache.ws.security.WSSecurityException
Overrides:
loadDecryptionCrypto in class org.apache.ws.security.handler.WSHandler
Throws:
org.apache.ws.security.WSSecurityException

loadEncryptionCrypto

protected org.apache.ws.security.components.crypto.Crypto loadEncryptionCrypto(org.apache.ws.security.handler.RequestData reqData)
                                                                        throws org.apache.ws.security.WSSecurityException
Overrides:
loadEncryptionCrypto in class org.apache.ws.security.handler.WSHandler
Throws:
org.apache.ws.security.WSSecurityException


Apache CXF