org.opensaml.soap.wsaddressing.messaging.impl

Class AddMessageIDHandler

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

org.opensaml.messaging.handler.AbstractMessageHandler<MessageType>

org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler

org.opensaml.soap.wsaddressing.messaging.impl.AddMessageIDHandler

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.messaging.handler.MessageHandler

public class AddMessageIDHandler
extends AbstractHeaderGeneratingMessageHandler

Handler implementation that adds a wsa:MessageID header to the outbound SOAP envelope.

The value from WSAddressingContext.getMessageIDURI() will be used, if present. If not, then the value generated via the locally-configured strategy getIdentifierGenerationStrategy() will be used. If neither of those sources are available, then a random "urn:uuid:..." URI value will be generated internally using UUID.

Field Summary

Fields

Modifier and Type	Field and Description
private net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy	identifierGenerationStrategy Strategy for generating identifiers.
private Logger	log Logger.

Constructor Summary

Constructors

Constructor and Description
AddMessageIDHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy	getIdentifierGenerationStrategy() Get the identifier generation strategy.
protected String	getMessageID(org.opensaml.messaging.context.MessageContext messageContext) Get the effective message ID value to issue in the outbound message.
void	setIdentifierGenerationStrategy(net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy strategy) Set the identifier generation strategy.

Methods inherited from class org.opensaml.soap.messaging.AbstractHeaderGeneratingMessageHandler

decorateGeneratedHeader, doPreInvoke, getEffectiveTargetNode, isEffectiveMustUnderstand, setMustUnderstand, setMustUnderstandStrategy, setTargetNode, setTargetNodeStrategy

Methods inherited from class org.opensaml.messaging.handler.AbstractMessageHandler

doPostInvoke, doPostInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, doInitialize, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Field Detail

log

private Logger log

Logger.

identifierGenerationStrategy

private net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy identifierGenerationStrategy

Strategy for generating identifiers.

Constructor Detail

AddMessageIDHandler

public AddMessageIDHandler()

Method Detail

getIdentifierGenerationStrategy

@Nullable
public net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy getIdentifierGenerationStrategy()

Get the identifier generation strategy.

Returns:

the strategy, or null

setIdentifierGenerationStrategy

public void setIdentifierGenerationStrategy(@Nullable
                                   net.shibboleth.utilities.java.support.security.IdentifierGenerationStrategy strategy)

Set the identifier generation strategy.

Parameters:

strategy - the new strategy

doInvoke

protected void doInvoke(@Nonnull
            org.opensaml.messaging.context.MessageContext messageContext)
                 throws org.opensaml.messaging.handler.MessageHandlerException

Specified by:

doInvoke in class org.opensaml.messaging.handler.AbstractMessageHandler

Throws:

org.opensaml.messaging.handler.MessageHandlerException

getMessageID

@Nonnull
protected String getMessageID(org.opensaml.messaging.context.MessageContext messageContext)

Get the effective message ID value to issue in the outbound message.

Parameters:

messageContext - the current message context

Returns:

the retrieved or generated message ID