org.opensaml.saml.common.binding.impl

Class SAMLAddAttributeConsumingServiceHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.saml.common.binding.impl.SAMLAddAttributeConsumingServiceHandler

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, MessageHandler

public class SAMLAddAttributeConsumingServiceHandler
extends AbstractMessageHandler

SAML MessageHandler that attaches an AttributeConsumingServiceContext to the SAMLMetadataContext based on the content of an AuthnRequest in the message context.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	SAMLAddAttributeConsumingServiceHandler.AuthnRequestIndexLookup Default lookup function that reads from a SAML 2 AuthnRequest.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.Integer	index AttributeConsumingService index.
private com.google.common.base.Function<MessageContext,java.lang.Integer>	indexLookupStrategy Lookup strategy for an AttributeConsumingService index.
private org.slf4j.Logger	log Logger.
private com.google.common.base.Function<MessageContext,SAMLMetadataContext>	metadataContextLookupStrategy Lookup strategy for SAMLMetadataContext.

Constructor Summary

Constructors

Constructor and Description
SAMLAddAttributeConsumingServiceHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doInvoke(MessageContext messageContext) Performs the handler logic.
protected boolean	doPreInvoke(MessageContext messageContext) Called prior to execution, handlers may override this method to perform pre-processing for a request.
void	setIndexLookupStrategy(com.google.common.base.Function<MessageContext,java.lang.Integer> strategy) Set the strategy to locate the AttributeConsumingService index from the MessageContext.
void	setMetadataContextLookupStrategy(com.google.common.base.Function<MessageContext,SAMLMetadataContext> strategy) Set the strategy to locate the SAMLMetadataContext from the MessageContext.

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

doPostInvoke, doPostInvoke, getLogPrefix, invoke

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

@Nonnull
private final org.slf4j.Logger log

Logger.

metadataContextLookupStrategy

@Nonnull
private com.google.common.base.Function<MessageContext,SAMLMetadataContext> metadataContextLookupStrategy

Lookup strategy for SAMLMetadataContext.

indexLookupStrategy

@Nullable
private com.google.common.base.Function<MessageContext,java.lang.Integer> indexLookupStrategy

Lookup strategy for an AttributeConsumingService index.

index

@Nullable
private java.lang.Integer index

AttributeConsumingService index.

Constructor Detail

SAMLAddAttributeConsumingServiceHandler

public SAMLAddAttributeConsumingServiceHandler()

Constructor.

Method Detail

setMetadataContextLookupStrategy

public void setMetadataContextLookupStrategy(@Nonnull
                                             com.google.common.base.Function<MessageContext,SAMLMetadataContext> strategy)

Set the strategy to locate the SAMLMetadataContext from the MessageContext.

Parameters:

strategy - lookup strategy

setIndexLookupStrategy

public void setIndexLookupStrategy(@Nullable
                                   com.google.common.base.Function<MessageContext,java.lang.Integer> strategy)

Set the strategy to locate the AttributeConsumingService index from the MessageContext.

Parameters:

strategy - lookup strategy

doPreInvoke

protected boolean doPreInvoke(@Nonnull
                              MessageContext messageContext)
                       throws MessageHandlerException

Called prior to execution, handlers may override this method to perform pre-processing for a request.

If false is returned, execution will not proceed.

If returning successfully, the last step should be to return the result of the superclass version of this method.

Overrides:

doPreInvoke in class AbstractMessageHandler

Parameters:

messageContext - the message context on which to invoke the handler

Returns:

true iff execution should proceed

Throws:

MessageHandlerException - if there is a problem executing the handler pre-routine

doInvoke

protected void doInvoke(@Nonnull
                        MessageContext messageContext)
                 throws MessageHandlerException

Performs the handler logic.

Specified by:

doInvoke in class AbstractMessageHandler

Parameters:

messageContext - the message context on which to invoke the handler

Throws:

MessageHandlerException - if there is an error invoking the handler on the message context