Apache CXF API

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

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

public class WSS4JOutInterceptor
extends AbstractWSS4JInterceptor


Field Summary
static String WSS4J_ACTION_MAP
          Property name for a map of action IDs (Integer) to action class names.
 
Fields inherited from class org.apache.wss4j.dom.handler.WSHandler
cryptos, secEngine
 
Constructor Summary
WSS4JOutInterceptor()
           
WSS4JOutInterceptor(Map<String,Object> props)
           
 
Method Summary
 org.apache.cxf.ws.security.wss4j.WSS4JOutInterceptor.WSS4JOutInterceptorInternal createEndingInterceptor()
           
 Object getProperty(Object msgContext, String key)
           
 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 handleMessage(SoapMessage mc)
          Intercepts a message.
protected  void handleSecureMTOM(SoapMessage mc, List<org.apache.wss4j.dom.handler.HandlerAction> actions)
           
 boolean isAllowMTOM()
           
 void setAllowMTOM(boolean allowMTOM)
          Enable or disable mtom with WS-Security.
 
Methods inherited from class org.apache.cxf.ws.security.wss4j.AbstractWSS4JInterceptor
getAdditionalInterceptors, getAfter, getBefore, getId, getOption, getPassword, getPhase, getProperties, getRoles, getUnderstoodHeaders, isRequestor, loadCryptoFromPropertiesFile, postHandleMessage, setAfter, setBefore, setId, setPassword, setPhase, setProperties, setProperty, setProperty, translateProperties
 
Methods inherited from class org.apache.wss4j.dom.handler.WSHandler
checkReceiverResults, checkReceiverResultsAnyOrder, checkSignatureConfirmation, decodeAddInclusivePrefixes, decodeAlgorithmSuite, decodeAllowUsernameTokenNoPassword, decodeBooleanConfigValue, decodeBSPCompliance, decodeCustomPasswordTypes, decodeDecryptionParameter, decodeEnableSignatureConfirmation, decodeEncryptionParameter, decodeFutureTimeToLive, decodeIncludeEncryptionToken, decodeIncludeSignatureToken, decodeMustUnderstand, decodeNamespaceQualifiedPasswordTypes, decodePasswordType, decodeRequireSignedEncryptedDataElements, decodeSamlSubjectConfirmationValidation, decodeSignatureParameter, decodeSignatureParameter2, decodeTimestampPrecision, decodeTimestampStrict, decodeTimeToLive, decodeUse200512Namespace, decodeUseEncodedPasswords, decodeUseSingleCertificate, decodeUTParameter, doReceiverAction, doSenderAction, getCallbackHandler, getClassLoader, getPasswordCallbackHandler, getPasswordCB, getPasswordEncryptor, getString, getStringOption, loadCrypto, loadDecryptionCrypto, loadEncryptionCrypto, loadSignatureCrypto, loadSignatureVerificationCrypto
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

WSS4J_ACTION_MAP

public static final String WSS4J_ACTION_MAP
Property name for a map of action IDs (Integer) to action class names. Values can be either Class) or Objects - * implementing Action.

See Also:
Constant Field Values
Constructor Detail

WSS4JOutInterceptor

public WSS4JOutInterceptor()

WSS4JOutInterceptor

public WSS4JOutInterceptor(Map<String,Object> props)
Method Detail

isAllowMTOM

public boolean isAllowMTOM()

setAllowMTOM

public void setAllowMTOM(boolean allowMTOM)
Enable or disable mtom with WS-Security. MTOM is disabled if we are signing or encrypting the message Body, as otherwise attachments would not get encrypted or be part of the signature.

Parameters:
mtomEnabled -

handleSecureMTOM

protected void handleSecureMTOM(SoapMessage mc,
                                List<org.apache.wss4j.dom.handler.HandlerAction> actions)

getProperty

public Object getProperty(Object msgContext,
                          String key)
Overrides:
getProperty in class AbstractWSS4JInterceptor

handleMessage

public void handleMessage(SoapMessage mc)
                   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

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>
Overrides:
handleFault in class AbstractWSS4JInterceptor

createEndingInterceptor

public final org.apache.cxf.ws.security.wss4j.WSS4JOutInterceptor.WSS4JOutInterceptorInternal createEndingInterceptor()

Apache CXF API

Apache CXF