Apache CXF API

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

java.lang.Object
  extended by org.apache.cxf.phase.AbstractPhaseInterceptor<SoapMessage>
      extended by org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor
          extended by org.apache.cxf.ws.security.wss4j.CryptoCoverageChecker
              extended by org.apache.cxf.ws.security.wss4j.DefaultCryptoCoverageChecker
All Implemented Interfaces:
SoapInterceptor, Interceptor<SoapMessage>, PhaseInterceptor<SoapMessage>

public class DefaultCryptoCoverageChecker
extends CryptoCoverageChecker

This utility extends the CryptoCoverageChecker to provide an easy way to check to see if the SOAP (1.1 + 1.2) Body was signed and/or encrypted, if the Timestamp was signed, if the WS-Addressing ReplyTo and FaultTo headers were signed, and if the UsernameToken was encrypted. The default configuration is that the SOAP Body, Timestamp must be signed, WS-Addressing ReplyTo and FaultTo headers must be signed, and a WSS UsernameToken must be encrypted (if they exist in the message payload).


Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.cxf.ws.security.wss4j.CryptoCoverageChecker
CryptoCoverageChecker.XPathExpression
 
Field Summary
static String SOAP_NS
           
static String SOAP12_NS
           
static String WSA_NS
           
static String WSSE_NS
           
static String WSU_NS
           
 
Fields inherited from class org.apache.cxf.ws.security.wss4j.CryptoCoverageChecker
prefixMap, xPaths
 
Constructor Summary
DefaultCryptoCoverageChecker()
          Creates a new instance.
 
Method Summary
 boolean isEncryptBody()
           
 boolean isEncryptUsernameToken()
           
 boolean isSignAddressingHeaders()
           
 boolean isSignBody()
           
 boolean isSignTimestamp()
           
 boolean isSignUsernameToken()
           
 void setEncryptBody(boolean encryptBody)
           
 void setEncryptUsernameToken(boolean encryptUsernameToken)
           
 void setSignAddressingHeaders(boolean signAddressingHeaders)
           
 void setSignBody(boolean signBody)
           
 void setSignTimestamp(boolean signTimestamp)
           
 void setSignUsernameToken(boolean signUsernameToken)
           
 
Methods inherited from class org.apache.cxf.ws.security.wss4j.CryptoCoverageChecker
addPrefixes, addXPaths, handleMessage, isCheckFaults, setCheckFaults, setPrefixes, setXPaths
 
Methods inherited from class org.apache.cxf.binding.soap.interceptor.AbstractSoapInterceptor
getFaultCodePrefix, getRoles, getUnderstoodHeaders, 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
 

Field Detail

SOAP_NS

public static final String SOAP_NS
See Also:
Constant Field Values

SOAP12_NS

public static final String SOAP12_NS
See Also:
Constant Field Values

WSU_NS

public static final String WSU_NS
See Also:
Constant Field Values

WSSE_NS

public static final String WSSE_NS
See Also:
Constant Field Values

WSA_NS

public static final String WSA_NS
See Also:
Constant Field Values
Constructor Detail

DefaultCryptoCoverageChecker

public DefaultCryptoCoverageChecker()
Creates a new instance. Enforces that the SOAP Body, Timestamp, and WS-Addressing ReplyTo and FaultTo headers must be signed (if they exist in the message payload).

Method Detail

isSignBody

public boolean isSignBody()

setSignBody

public final void setSignBody(boolean signBody)

isSignTimestamp

public boolean isSignTimestamp()

setSignTimestamp

public final void setSignTimestamp(boolean signTimestamp)

isEncryptBody

public boolean isEncryptBody()

setEncryptBody

public final void setEncryptBody(boolean encryptBody)

isSignAddressingHeaders

public boolean isSignAddressingHeaders()

setSignAddressingHeaders

public final void setSignAddressingHeaders(boolean signAddressingHeaders)

isEncryptUsernameToken

public boolean isEncryptUsernameToken()

setEncryptUsernameToken

public void setEncryptUsernameToken(boolean encryptUsernameToken)

isSignUsernameToken

public boolean isSignUsernameToken()

setSignUsernameToken

public void setSignUsernameToken(boolean signUsernameToken)

Apache CXF API

Apache CXF