XmlSecInInterceptor (Apache CXF JavaDoc 3.0.0 API)

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.rs.security.xml
Class XmlSecInInterceptor

java.lang.Object
  org.apache.cxf.phase.AbstractPhaseInterceptor<Message>
      org.apache.cxf.rs.security.xml.XmlSecInInterceptor

All Implemented Interfaces:: Interceptor<Message>, PhaseInterceptor<Message>

public class XmlSecInInterceptor
extends AbstractPhaseInterceptor<Message>
extends AbstractPhaseInterceptor<Message>

A new StAX-based interceptor for processing messages with XML Signature + Encryption content.

Constructor Summary
`XmlSecInInterceptor()`

Method Summary
`protected org.apache.xml.security.stax.securityEvent.SecurityEventListener`	`configureSecurityEventListener(org.apache.wss4j.common.crypto.Crypto sigCrypto, Message msg, org.apache.xml.security.stax.ext.XMLSecurityProperties securityProperties)`
`String`	`getDecryptionAlias()`
`String`	`getSignatureVerificationAlias()`
`void`	`handleMessage(Message message)` Intercepts a message.
`boolean`	`isRequireEncryption()`
`boolean`	`isRequireSignature()`
`void`	`setDecryptionAlias(String decryptionAlias)`
`void`	`setEncryptionProperties(EncryptionProperties properties)`
`void`	`setPersistSignature(boolean persist)`
`void`	`setRequireEncryption(boolean requireEncryption)`
`void`	`setRequireSignature(boolean requireSignature)`
`void`	`setSignatureProperties(SignatureProperties properties)`
`void`	`setSignatureVerificationAlias(String signatureVerificationAlias)`
`protected void`	`throwFault(String error, Exception ex)`

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`

Constructor Detail

XmlSecInInterceptor

public XmlSecInInterceptor()

Method Detail

handleMessage

public void handleMessage(Message message)
                   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

configureSecurityEventListener

protected org.apache.xml.security.stax.securityEvent.SecurityEventListener configureSecurityEventListener(org.apache.wss4j.common.crypto.Crypto sigCrypto,
                                                                                                          Message msg,
                                                                                                          org.apache.xml.security.stax.ext.XMLSecurityProperties securityProperties)

throwFault

protected void throwFault(String error,
                          Exception ex)

setEncryptionProperties

public void setEncryptionProperties(EncryptionProperties properties)

setSignatureProperties

public void setSignatureProperties(SignatureProperties properties)

getDecryptionAlias

public String getDecryptionAlias()

setDecryptionAlias

public void setDecryptionAlias(String decryptionAlias)

getSignatureVerificationAlias

public String getSignatureVerificationAlias()

setSignatureVerificationAlias

public void setSignatureVerificationAlias(String signatureVerificationAlias)

setPersistSignature

public void setPersistSignature(boolean persist)

isRequireSignature

public boolean isRequireSignature()

setRequireSignature

public void setRequireSignature(boolean requireSignature)

isRequireEncryption

public boolean isRequireEncryption()

setRequireEncryption

public void setRequireEncryption(boolean requireEncryption)