net.shibboleth.idp.session.impl

Class PopulateMultiRPContextFromLogoutContext

java.lang.Object

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

org.opensaml.profile.action.AbstractProfileAction<InboundMessageType,OutboundMessageType>

org.opensaml.profile.action.AbstractConditionalProfileAction<InboundMessageType,OutboundMessageType>

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.session.impl.PopulateMultiRPContextFromLogoutContext

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.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, org.springframework.webflow.execution.Action

public class PopulateMultiRPContextFromLogoutContext
extends net.shibboleth.idp.profile.AbstractProfileAction

Profile action that populates a MultiRelyingPartyContext with the relying party information from a LogoutContext, and extends each RelyingPartyContext created with a SAMLMetadataContext based on metadata lookup.

Any existing MultiRelyingPartyContext will be replaced.

Event:

EventIds.PROCEED_EVENT_ID

Postcondition:

If (ProfileRequestContext.getSubcontext(LogoutContext.class) != null, then ProfileRequestContext.getSubcontext(MultiRelyingPartyContext.class) != null

Field Summary

Fields

Modifier and Type	Field and Description
private static String	LABEL Label for MultiRelyingPartyContext entries.
private Logger	log Class logger.
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext>	logoutContextLookupStrategy Lookup function for LogoutContext.
private LogoutContext	logoutCtx LogoutContext to process.
private org.opensaml.saml.metadata.resolver.RoleDescriptorResolver	metadataResolver Resolver used to look up SAML metadata.
private QName	role Role to resolve metadata for.
private Map<Class<? extends SPSession>,String>	sessionTypeProtocolMap Map of SPSession subtypes to SAML metadata protocol constants.

Constructor Summary

Constructors

Constructor and Description
PopulateMultiRPContextFromLogoutContext() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected void	doInitialize()
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
void	setLogoutContextLookupStrategy(com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext> strategy) Set the lookup strategy for the LogoutContext to process.
void	setRole(QName theRole) Set the metadata role to lookup.
void	setRoleDescriptorResolver(org.opensaml.saml.metadata.resolver.RoleDescriptorResolver resolver) Set the RoleDescriptorResolver to use.
void	setSessionTypeProtocolMap(Map<Class<? extends SPSession>,String> map) Set the map of SPSession subtypes to SAML metadata protocol constants.

Methods inherited from class net.shibboleth.idp.profile.AbstractProfileAction

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getResult, setMessageSource, setProfileContextLookupStrategy

Methods inherited from class org.opensaml.profile.action.AbstractConditionalProfileAction

getActivationCondition, setActivationCondition

Methods inherited from class org.opensaml.profile.action.AbstractProfileAction

doPostExecute, doPostExecute, execute, getHttpServletRequest, getHttpServletResponse, getLogPrefix, setHttpServletRequest, setHttpServletResponse

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

LABEL

@Nonnull
 @NotEmpty
private static final String LABEL

Label for MultiRelyingPartyContext entries.

See Also:

Constant Field Values

log

@Nonnull
private final Logger log

Class logger.

metadataResolver

@NonnullAfterInit
private org.opensaml.saml.metadata.resolver.RoleDescriptorResolver metadataResolver

Resolver used to look up SAML metadata.

logoutContextLookupStrategy

@Nonnull
private com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext> logoutContextLookupStrategy

Lookup function for LogoutContext.

sessionTypeProtocolMap

@Nonnull
private Map<Class<? extends SPSession>,String> sessionTypeProtocolMap

Map of SPSession subtypes to SAML metadata protocol constants.

role

@NonnullAfterInit
private QName role

Role to resolve metadata for.

logoutCtx

@Nullable
private LogoutContext logoutCtx

LogoutContext to process.

Constructor Detail

PopulateMultiRPContextFromLogoutContext

public PopulateMultiRPContextFromLogoutContext()

Constructor.

Method Detail

setRoleDescriptorResolver

public void setRoleDescriptorResolver(@Nonnull
                                      org.opensaml.saml.metadata.resolver.RoleDescriptorResolver resolver)

Set the RoleDescriptorResolver to use.

Parameters:

resolver - the resolver to use

setLogoutContextLookupStrategy

public void setLogoutContextLookupStrategy(@Nonnull
                                           com.google.common.base.Function<org.opensaml.profile.context.ProfileRequestContext,LogoutContext> strategy)

Set the lookup strategy for the LogoutContext to process.

Parameters:

strategy - lookup strategy

setSessionTypeProtocolMap

public void setSessionTypeProtocolMap(@Nonnull
                                      Map<Class<? extends SPSession>,String> map)

Set the map of SPSession subtypes to SAML metadata protocol constants.

Parameters:

map - map to set

setRole

public void setRole(@Nonnull
                    QName theRole)

Set the metadata role to lookup.

Defaults to SPSSODescriptor.DEFAULT_ELEMENT_NAME.

Parameters:

theRole - the role element or type

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

doPreExecute

protected boolean doPreExecute(@Nonnull
                               org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class org.opensaml.profile.action.AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
                         org.opensaml.profile.context.ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class org.opensaml.profile.action.AbstractProfileAction