Apache CXF API

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
 java.util.Set<java.lang.String> getAfter()
          Returns a set of IDs specifying the interceptors that should be run after this interceptor.
 java.util.Set<java.lang.String> getBefore()
          Returns a set of IDs specifying the interceptors that should be run before this interceptor.
 java.lang.String getId()
          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()
          The phase of this interceptor.
 java.util.Map 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.
 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, checkSignatureConfirmation, decodeDecryptionParameter, decodeEnableSignatureConfirmation, decodeEncryptionParameter, decodeMustUnderstand, decodeSignatureParameter, decodeSignatureParameter2, decodeTimestampPrecision, decodeTimestampStrict, decodeTimeToLive, decodeUTParameter, doReceiverAction, doSenderAction, getClassLoader, getPassword, getPasswordCB, getString, getStringOption, loadDecryptionCrypto, loadEncryptionCrypto, loadSignatureCrypto, 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
 
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
The phase of this interceptor.

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
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 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 of IDs specifying the interceptors that should be run after this interceptor.

Specified by:
getAfter in interface PhaseInterceptor<SoapMessage>
Returns:
the ids of the interceptors to be run after

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 of IDs specifying the interceptors that should be run before this interceptor.

Specified by:
getBefore in interface PhaseInterceptor<SoapMessage>
Returns:
the ids of the interceptors to be run before

setBefore

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

Apache CXF API

Apache CXF is an effort undergoing incubation at the Apache Software Foundation(ASF) and sponsored by the Apache Incubator PMC.