net.shibboleth.idp.admin.impl

Class InitializeAdministrativeProfileContextTree

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.admin.impl.InitializeAdministrativeProfileContextTree

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, org.springframework.beans.factory.Aware, org.springframework.context.MessageSource, org.springframework.context.MessageSourceAware, org.springframework.webflow.execution.Action

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

An action that processes settings from a supplied AdministrativeFlowDescriptor to prepare the profile context tree for subsequent use by an administrative profile flow.

This action finalizes settings like non-browser compatibility, and if instructed to do so, decorates the context tree with a mocked up RelyingPartyContext and RelyingPartyUIContext.

Event:

EventIds.PROCEED_EVENT_ID, IdPEventIds.INVALID_PROFILE_CONFIG

Precondition:

The injected AdministrativeFlowDescriptor's ID must match ProfileRequestContext.getProfileId()

Postcondition:

See above.

Field Summary

Fields

Modifier and Type	Field and Description
private List<String>	fallbackLanguages The system wide languages to inspect if there is no match between metadata and browser.
private AdministrativeFlowDescriptor	flowDescriptor Descriptor of the administrative flow being run.
private org.slf4j.Logger	log Class logger.

Constructor Summary

Constructors

Constructor and Description
InitializeAdministrativeProfileContextTree()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
private List<String>	getBrowserLanguages() Pluck the languages from the browser.
void	setAdministrativeFlowDescriptor(AdministrativeFlowDescriptor descriptor) Set the flow descriptor describing the administrative flow being run.
void	setFallbackLanguages(List<String> langs) Set the system wide default languages.

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

doExecute, execute, getMessage, getMessage, getMessage, getProfileContextLookupStrategy, getRequestContext, 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, 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

Class logger.

flowDescriptor

@Nullable
private AdministrativeFlowDescriptor flowDescriptor

Descriptor of the administrative flow being run.

fallbackLanguages

@Nullable
private List<String> fallbackLanguages

The system wide languages to inspect if there is no match between metadata and browser.

Constructor Detail

InitializeAdministrativeProfileContextTree

public InitializeAdministrativeProfileContextTree()

Method Detail

setAdministrativeFlowDescriptor

public void setAdministrativeFlowDescriptor(@Nullable
                                   AdministrativeFlowDescriptor descriptor)

Set the flow descriptor describing the administrative flow being run.

Parameters:

descriptor - the flow descriptor to base the action on

setFallbackLanguages

public void setFallbackLanguages(@Nonnull@NonnullElements
                        List<String> langs)

Set the system wide default languages.

Parameters:

langs - a semi-colon separated string.

doPreExecute

protected boolean doPreExecute(@Nonnull
                   ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doExecute

protected void doExecute(@Nonnull
             ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

getBrowserLanguages

@Nonnull
@NonnullElements
private List<String> getBrowserLanguages()

Pluck the languages from the browser.

Returns:

the two letter language