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, org.opensaml.messaging.handler.MessageHandler

public class SAMLMetadataLookupHandler
extends org.opensaml.messaging.handler.AbstractMessageHandler

Handler for inbound SAML protocol messages that attempts to locate SAML metadata for a SAML entity, and attaches it with a SAMLMetadataContext as a child of a pre-existing concrete instance of AbstractSAMLEntityContext. The entity context class is configurable and defaults to SAMLPeerEntityContext.

The handler will no-op in the absence of a populated AbstractSAMLEntityContext instance 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 Class<? extends AbstractSAMLEntityContext>	entityContextClass The context class representing the SAML entity whose data is to be resolved.
private Logger	log Logger.
private RoleDescriptorResolver	metadataResolver Resolver used to look up SAML metadata.

Constructor Summary

Constructors

Constructor and Description
SAMLMetadataLookupHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(org.opensaml.messaging.context.MessageContext messageContext)
void	setEntityContextClass(Class<? extends AbstractSAMLEntityContext> clazz) Set the class type holding the SAML entity data.
void	setRoleDescriptorResolver(RoleDescriptorResolver resolver) Set the RoleDescriptorResolver to use.

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

doPostInvoke, doPostInvoke, doPreInvoke, getActivationCondition, getLogPrefix, invoke, setActivationCondition

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 Logger log

Logger.

metadataResolver

@NonnullAfterInit
private RoleDescriptorResolver metadataResolver

Resolver used to look up SAML metadata.

entityContextClass

@Nonnull
private Class<? extends AbstractSAMLEntityContext> entityContextClass

The context class representing the SAML entity whose data is to be resolved. Defaults to: SAMLPeerEntityContext.

Constructor Detail

SAMLMetadataLookupHandler

public SAMLMetadataLookupHandler()

Method Detail

setEntityContextClass

public void setEntityContextClass(@Nonnull
                         Class<? extends AbstractSAMLEntityContext> clazz)

Set the class type holding the SAML entity data.

Defaults to: SAMLPeerEntityContext.

Parameters:

clazz - the entity context class type

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
            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