org.opensaml.saml.common.binding.impl

Class SAMLProtocolAndRoleHandler

java.lang.Object

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

org.opensaml.messaging.handler.AbstractMessageHandler

org.opensaml.saml.common.binding.impl.SAMLProtocolAndRoleHandler

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

SAML MessageHandler that attaches protocol and role information to a message context via SAMLProtocolContext and SAMLPeerEntityContext objects.

A profile flow would typically run this handler after message decoding occurs, to bootstrap subsequent handlers.

Constructor Summary

Constructors

Constructor and Description
SAMLProtocolAndRoleHandler()

Method Summary

Modifier and Type	Method and Description
protected void	doInitialize()
protected void	doInvoke(MessageContext messageContext) Performs the handler logic.
void	setProtocol(String protocol) Set the protocol constant to attach.
void	setRole(QName role) Set the operational role to attach.

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

Constructor Detail

SAMLProtocolAndRoleHandler

public SAMLProtocolAndRoleHandler()

Method Detail

setProtocol

public void setProtocol(@Nonnull @NotEmpty
                        String protocol)

Set the protocol constant to attach.

Parameters:

protocol - the protocol constant to set

setRole

public void setRole(@Nonnull
                    QName role)

Set the operational role to attach.

Parameters:

role - the operational role to set

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