org.opensaml.saml.common.binding.impl

Class SAMLMetadataLookupHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.saml.common.binding.impl.SAMLMetadataLookupHandler

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 SAMLMetadataLookupHandler
extends AbstractMessageHandler

Handler for inbound SAML protocol messages that attempts to locate SAML metadata for the message issuer, and attaches it with a SAMLMetadataContext as a child of the pre-existing SAMLPeerEntityContext.

The handler will no-op in the absence of a populated SAMLPeerEntityContext for the message with an entityID and role to look up. A protocol from a SAMLProtocolContext will be added to the lookup, if available.

Field Summary

Fields

Modifier and Type	Field and Description
private org.slf4j.Logger	log Logger.
private RoleDescriptorResolver	metadataResolver Resolver used to look up SAML metadata.

Constructor Summary

Constructors

Constructor and Description
SAMLMetadataLookupHandler()

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext) Performs the handler logic.
void	setRoleDescriptorResolver(RoleDescriptorResolver resolver) Set the RoleDescriptorResolver to use.

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

doPostInvoke, doPostInvoke, doPreInvoke, getLogPrefix, invoke

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

destroy, doDestroy, 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.

metadataResolver

@NonnullAfterInit
private RoleDescriptorResolver metadataResolver

Resolver used to look up SAML metadata.

Constructor Detail

SAMLMetadataLookupHandler

public SAMLMetadataLookupHandler()

Method Detail

setRoleDescriptorResolver

public void setRoleDescriptorResolver(@Nonnull
                                      RoleDescriptorResolver resolver)

Set the RoleDescriptorResolver to use.

Parameters:

resolver - the resolver to use

doInitialize

protected void doInitialize()
                     throws net.shibboleth.utilities.java.support.component.ComponentInitializationException

Overrides:

doInitialize in class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

Throws:

net.shibboleth.utilities.java.support.component.ComponentInitializationException

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