PolicyBasedWSS4JStaxInInterceptor (Apache CXF JavaDoc 3.1.0 API)

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

All Implemented Interfaces:

SoapInterceptor, Interceptor<SoapMessage>, PhaseInterceptor<SoapMessage>
```
public class PolicyBasedWSS4JStaxInInterceptor
extends WSS4JStaxInInterceptor
```

Field Summary

Fields
Modifier and Type Field and Description

static PolicyBasedWSS4JStaxInInterceptor INSTANCE
- Fields inherited from class org.apache.cxf.ws.security.wss4j.WSS4JStaxInInterceptor
  SECURITY_PROCESSED

Fields
Modifier and Type	Field and Description
`static PolicyBasedWSS4JStaxInInterceptor`	`INSTANCE`

Constructor Summary

Constructors
Constructor and Description

PolicyBasedWSS4JStaxInInterceptor()

Constructors
Constructor and Description
`PolicyBasedWSS4JStaxInInterceptor()`

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)`
`protected org.apache.wss4j.stax.ext.WSSSecurityProperties`	`createSecurityProperties()`
`void`	`handleMessage(SoapMessage msg)` Intercepts a 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.WSS4JStaxInInterceptor
isGET

Methods inherited from class org.apache.cxf.ws.security.wss4j.AbstractWSS4JStaxInterceptor
configureCallbackHandler, 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

INSTANCE

public static final PolicyBasedWSS4JStaxInInterceptor INSTANCE

Constructor Detail
- PolicyBasedWSS4JStaxInInterceptor
```
public PolicyBasedWSS4JStaxInInterceptor()
```

Method Detail

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

Specified by:

handleMessage in interface Interceptor<SoapMessage>

Overrides:

handleMessage in class WSS4JStaxInInterceptor

Throws:

Fault

createSecurityProperties
```
protected org.apache.wss4j.stax.ext.WSSSecurityProperties createSecurityProperties()
```
Overrides:

createSecurityProperties in class AbstractWSS4JStaxInterceptor

configureProperties

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

Overrides:: configureProperties in class WSS4JStaxInInterceptor
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

Overrides:: isNonceCacheRequired in class WSS4JStaxInInterceptor

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

Overrides:: isTimestampCacheRequired in class WSS4JStaxInInterceptor

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

Overrides:: isSamlCacheRequired in class WSS4JStaxInInterceptor

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

Overrides:: configureSecurityEventListeners in class WSS4JStaxInInterceptor
Throws:: org.apache.wss4j.common.WSSPolicyException

Class PolicyBasedWSS4JStaxInInterceptor

Field Summary

Fields inherited from class org.apache.cxf.ws.security.wss4j.WSS4JStaxInInterceptor

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

INSTANCE

Constructor Detail

PolicyBasedWSS4JStaxInInterceptor

Method Detail

handleMessage

createSecurityProperties

configureProperties

isNonceCacheRequired

isTimestampCacheRequired

isSamlCacheRequired

configureSecurityEventListeners