WSS4JStaxInInterceptor (Apache CXF JavaDoc 3.1.0 API)

java.lang.Object
- org.apache.cxf.ws.security.wss4j.AbstractWSS4JStaxInterceptor
- - org.apache.cxf.ws.security.wss4j.WSS4JStaxInInterceptor

All Implemented Interfaces:

SoapInterceptor, Interceptor<SoapMessage>, PhaseInterceptor<SoapMessage>

Direct Known Subclasses:

PolicyBasedWSS4JStaxInInterceptor
```
public class WSS4JStaxInInterceptor
extends AbstractWSS4JStaxInterceptor
```

Field Summary

Fields
Modifier and Type Field and Description

static String SECURITY_PROCESSED

Fields
Modifier and Type	Field and Description
`static String`	`SECURITY_PROCESSED`

Constructor Summary

Constructors
Constructor and Description
`WSS4JStaxInInterceptor()`
`WSS4JStaxInInterceptor(Map<String,Object> props)`
`WSS4JStaxInInterceptor(org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`configureProperties(SoapMessage msg, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)`
`protected List<org.apache.xml.security.stax.securityEvent.SecurityEventListener>`	`configureSecurityEventListeners(SoapMessage msg, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)`
`void`	`handleMessage(SoapMessage soapMessage)` Intercepts a message.
`boolean`	`isGET(SoapMessage message)`
`protected boolean`	`isNonceCacheRequired(SoapMessage msg, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)` Is a Nonce Cache required, i.e.
`protected boolean`	`isSamlCacheRequired(SoapMessage msg, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)` Is a SAML Cache required, i.e.
`protected boolean`	`isTimestampCacheRequired(SoapMessage msg, org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)` Is a Timestamp cache required, i.e.

Methods inherited from class org.apache.cxf.ws.security.wss4j.AbstractWSS4JStaxInterceptor
configureCallbackHandler, createSecurityProperties, getAdditionalInterceptors, getAfter, getBefore, getEncryptionCrypto, getId, getOption, getPassword, getPasswordEncryptor, getPhase, getProperties, getProperty, getRoles, getSignatureCrypto, getUnderstoodHeaders, handleFault, isRequestor, loadCrypto, loadCryptoFromPropertiesFile, postHandleMessage, setId, setPassword, setPhase, setProperty, translateProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SECURITY_PROCESSED

public static final String SECURITY_PROCESSED

Constructor Detail

WSS4JStaxInInterceptor

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

WSS4JStaxInInterceptor

public WSS4JStaxInInterceptor(Map<String,Object> props)

WSS4JStaxInInterceptor
```
public WSS4JStaxInInterceptor()
```

Method Detail

isGET

public final boolean isGET(SoapMessage message)

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

configureSecurityEventListeners

protected List<org.apache.xml.security.stax.securityEvent.SecurityEventListener> configureSecurityEventListeners(SoapMessage msg,
                                                                                                     org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                                                                                                          throws org.apache.wss4j.common.WSSPolicyException

Throws:: org.apache.wss4j.common.WSSPolicyException

configureProperties

protected void configureProperties(SoapMessage msg,
                       org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)
                            throws org.apache.xml.security.exceptions.XMLSecurityException

Throws:: org.apache.xml.security.exceptions.XMLSecurityException

isNonceCacheRequired

protected boolean isNonceCacheRequired(SoapMessage msg,
                           org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)

Is a Nonce Cache required, i.e. are we expecting a UsernameToken

isTimestampCacheRequired

protected boolean isTimestampCacheRequired(SoapMessage msg,
                               org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)

Is a Timestamp cache required, i.e. are we expecting a Timestamp

isSamlCacheRequired

protected boolean isSamlCacheRequired(SoapMessage msg,
                          org.apache.wss4j.stax.ext.WSSSecurityProperties securityProperties)

Is a SAML Cache required, i.e. are we expecting a SAML Token

Class WSS4JStaxInInterceptor

Field Summary

Constructor Summary

Method Summary

Methods inherited from class org.apache.cxf.ws.security.wss4j.AbstractWSS4JStaxInterceptor

Methods inherited from class java.lang.Object

Field Detail

SECURITY_PROCESSED

Constructor Detail

WSS4JStaxInInterceptor

WSS4JStaxInInterceptor

WSS4JStaxInInterceptor

Method Detail

isGET

handleMessage

configureSecurityEventListeners

configureProperties

isNonceCacheRequired

isTimestampCacheRequired

isSamlCacheRequired