Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

java.lang.Object
  extended by org.apache.cxf.ws.security.wss4j.AbstractWSS4JStaxInterceptor
All Implemented Interfaces:
SoapInterceptor, Interceptor<SoapMessage>, PhaseInterceptor<SoapMessage>
Direct Known Subclasses:
WSS4JStaxInInterceptor, WSS4JStaxOutInterceptor
public abstract class AbstractWSS4JStaxInterceptor
extends Object
implements SoapInterceptor, PhaseInterceptor<SoapMessage>

Constructor Summary
AbstractWSS4JStaxInterceptor()
           
AbstractWSS4JStaxInterceptor(Map<String,Object> properties)
           
AbstractWSS4JStaxInterceptor(org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
 
Method Summary
protected  void configureCallbackHandler(SoapMessage soapMessage, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
protected  org.apache.wss4j.stax.ext.WSSSecurityProperties createSecurityProperties()
           
 Collection<PhaseInterceptor<? extends Message>> getAdditionalInterceptors()
          Returns a collection of Interceptors that should be added to the chain whenever this interceptor is added.
 Set<String> getAfter()
          Returns a set containing the IDs of the interceptors that should be executed before this interceptor.
 Set<String> getBefore()
          Returns a set containing the IDs of the interceptors that should be executed after this interceptor.
protected  org.apache.wss4j.common.crypto.Crypto getEncryptionCrypto(Object e, SoapMessage message, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
protected  AssertionInfo getFirstAssertionByLocalname(AssertionInfoMap aim, String localname)
           
 String getId()
          Returns the ID of this interceptor.
 Object getOption(String key)
           
 String getPassword(Object msgContext)
           
protected  org.apache.wss4j.common.crypto.PasswordEncryptor getPasswordEncryptor(SoapMessage soapMessage, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
 String getPhase()
          Returns the phase in which this interceptor is excecuted.
 Map<String,Object> getProperties()
           
 Object getProperty(Object msgContext, String key)
           
 Set<URI> getRoles()
           
protected  org.apache.wss4j.common.crypto.Crypto getSignatureCrypto(Object s, SoapMessage message, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
 Set<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(SoapMessage message)
           
protected  org.apache.wss4j.common.crypto.Crypto loadCrypto(SoapMessage soapMessage, String cryptoPropertyFile, String cryptoPropertyRefId, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
          Load a Crypto instance.
protected  org.apache.wss4j.common.crypto.Crypto loadCryptoFromPropertiesFile(SoapMessage soapMessage, String propFilename, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
 void postHandleMessage(SoapMessage message)
           
 void setAfter(Set<String> after)
           
 void setBefore(Set<String> before)
           
 void setId(String id)
           
 void setPassword(Object msgContext, String password)
           
 void setPhase(String phase)
           
 void setProperty(Object msgContext, String key, Object value)
           
 void setProperty(String key, String value)
           
protected  void translateProperties(SoapMessage msg, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
           
 
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

AbstractWSS4JStaxInterceptor

public AbstractWSS4JStaxInterceptor(org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)

AbstractWSS4JStaxInterceptor

public AbstractWSS4JStaxInterceptor(Map<String,Object> properties)

AbstractWSS4JStaxInterceptor

public AbstractWSS4JStaxInterceptor()
Method Detail

createSecurityProperties

protected org.apache.wss4j.stax.ext.WSSSecurityProperties createSecurityProperties()

translateProperties

protected void translateProperties(SoapMessage msg,
                                   org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)

configureCallbackHandler

protected void configureCallbackHandler(SoapMessage soapMessage,
                                        org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                                 throws org.apache.wss4j.common.ext.WSSecurityException
Throws:
org.apache.wss4j.common.ext.WSSecurityException

getRoles

public Set<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

getAdditionalInterceptors

public Collection<PhaseInterceptor<? extends Message>> getAdditionalInterceptors()
Description copied from interface: PhaseInterceptor
Returns a collection of Interceptors that should be added to the chain whenever this interceptor is added. May return null.

Specified by:
getAdditionalInterceptors in interface PhaseInterceptor<SoapMessage>
Returns:
the collection of interceptors

getPhase

public 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(String phase)

getOption

public Object getOption(String key)

setProperty

public void setProperty(String key,
                        String value)

getPassword

public String getPassword(Object msgContext)

getProperty

public Object getProperty(Object msgContext,
                          String key)

setPassword

public void setPassword(Object msgContext,
                        String password)

setProperty

public void setProperty(Object msgContext,
                        String key,
                        Object value)

getId

public 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(String id)

getUnderstoodHeaders

public Set<QName> getUnderstoodHeaders()
Specified by:
getUnderstoodHeaders in interface SoapInterceptor

getProperties

public Map<String,Object> getProperties()

getAfter

public Set<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(Set<String> after)

getBefore

public Set<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(Set<String> before)

isRequestor

protected boolean isRequestor(SoapMessage message)

loadCrypto

protected org.apache.wss4j.common.crypto.Crypto loadCrypto(SoapMessage soapMessage,
                                                           String cryptoPropertyFile,
                                                           String cryptoPropertyRefId,
                                                           org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                                                    throws org.apache.wss4j.common.ext.WSSecurityException
Load a Crypto instance. Firstly, it tries to use the cryptoPropertyRefId tag to retrieve a Crypto object via a custom reference Id. Failing this, it tries to load the crypto instance via the cryptoPropertyFile tag.

Throws:
org.apache.wss4j.common.ext.WSSecurityException

loadCryptoFromPropertiesFile

protected org.apache.wss4j.common.crypto.Crypto loadCryptoFromPropertiesFile(SoapMessage soapMessage,
                                                                             String propFilename,
                                                                             org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                                                                      throws org.apache.wss4j.common.ext.WSSecurityException
Throws:
org.apache.wss4j.common.ext.WSSecurityException

getPasswordEncryptor

protected org.apache.wss4j.common.crypto.PasswordEncryptor getPasswordEncryptor(SoapMessage soapMessage,
                                                                                org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)

getFirstAssertionByLocalname

protected AssertionInfo getFirstAssertionByLocalname(AssertionInfoMap aim,
                                                     String localname)

getEncryptionCrypto

protected org.apache.wss4j.common.crypto.Crypto getEncryptionCrypto(Object e,
                                                                    SoapMessage message,
                                                                    org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                                                             throws org.apache.wss4j.common.ext.WSSecurityException
Throws:
org.apache.wss4j.common.ext.WSSecurityException

getSignatureCrypto

protected org.apache.wss4j.common.crypto.Crypto getSignatureCrypto(Object s,
                                                                   SoapMessage message,
                                                                   org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                                                            throws org.apache.wss4j.common.ext.WSSecurityException
Throws:
org.apache.wss4j.common.ext.WSSecurityException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Apache CXF API
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Apache CXF