net.shibboleth.idp.ui.impl

Class SetRPUIInformation

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.ui.impl.SetRPUIInformation

All Implemented Interfaces:

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

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

Action to populate the ProfileRequestContext with a RelyingPartyUIContext. The contents are populated by accessing a SAMLMetadataContext via lookup function and using it to copy data over to the UI context.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX

Postcondition:

If a lookup function returns a SAMLMetadataContext, then a RelyingPartyUIContext is created and data copied into it.

Field Summary

Fields

Modifier and Type	Field and Description
private org.opensaml.saml.saml2.metadata.AttributeConsumingService	acsDesriptor The ACS context.
private org.opensaml.saml.saml2.metadata.EntityDescriptor	entityDescriptor The EntityDescriptor.
private List<String>	fallbackLanguages The system wide languages to inspect if there is no match between metadata and browser.
private org.slf4j.Logger	log Class logger.
private Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLMetadataContext>	metadataContextLookupStrategy Strategy function for access to SAMLMetadataContext.
private RelyingPartyUIContext	rpUIContext The RPUI context - we always create this in doPreExecute(ProfileRequestContext).
private Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyUIContext>	rpUIContextCreateStrategy Strategy function to create the RelyingPartyUIContext.
private org.opensaml.saml.saml2.metadata.SPSSODescriptor	spSSODescriptor The SPSSODescriptor.

Constructor Summary

Constructors

Constructor and Description
SetRPUIInformation() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext)
protected List<String>	getBrowserLanguages() Pluck the languages from the browser.
Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLMetadataContext>	getMetadataContextLookupStrategy() Get the mechanism to go from the ProfileRequestContext to the SAMLMetadataContext.
Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyUIContext>	getRPUIContextCreateStrategy() Get the mechanism to create/get the RelyingPartyUIContext from the ProfileRequestContext.
protected org.opensaml.saml.ext.saml2mdui.UIInfo	getRPUInfo() Get the RP UIInfo, caching the value and consulting if needed.
void	setFallbackLanguages(List<String> langs) Set the system wide default languages.
void	setMetadataContextLookupStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLMetadataContext> strgy) Set the mechanism to go from the ProfileRequestContext to the SAMLMetadataContext.
void	setRPUIContextCreateStrategy(Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyUIContext> strategy) Set the mechanism to create/get the RelyingPartyUIContext from the ProfileRequestContext.

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.

metadataContextLookupStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLMetadataContext> metadataContextLookupStrategy

Strategy function for access to SAMLMetadataContext.

rpUIContextCreateStrategy

@Nonnull
private Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyUIContext> rpUIContextCreateStrategy

Strategy function to create the RelyingPartyUIContext.

fallbackLanguages

@Nullable
private List<String> fallbackLanguages

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

entityDescriptor

@Nullable
private org.opensaml.saml.saml2.metadata.EntityDescriptor entityDescriptor

The EntityDescriptor. If we cannot find this we short cut the doExecute(ProfileRequestContext) stage.

spSSODescriptor

@Nullable
private org.opensaml.saml.saml2.metadata.SPSSODescriptor spSSODescriptor

The SPSSODescriptor. Not finding this is not fatal

rpUIContext

private RelyingPartyUIContext rpUIContext

The RPUI context - we always create this in doPreExecute(ProfileRequestContext).

acsDesriptor

private org.opensaml.saml.saml2.metadata.AttributeConsumingService acsDesriptor

The ACS context.

Constructor Detail

SetRPUIInformation

public SetRPUIInformation()

Constructor.

Method Detail

getMetadataContextLookupStrategy

@Nonnull
public Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLMetadataContext> getMetadataContextLookupStrategy()

Get the mechanism to go from the ProfileRequestContext to the SAMLMetadataContext.

Returns:

lookup strategy

setMetadataContextLookupStrategy

public void setMetadataContextLookupStrategy(@Nonnull
                                    Function<org.opensaml.profile.context.ProfileRequestContext,org.opensaml.saml.common.messaging.context.SAMLMetadataContext> strgy)

Set the mechanism to go from the ProfileRequestContext to the SAMLMetadataContext.

Parameters:

strgy - what to set.

getRPUIContextCreateStrategy

public Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyUIContext> getRPUIContextCreateStrategy()

Get the mechanism to create/get the RelyingPartyUIContext from the ProfileRequestContext.

Returns:

lookup/creation strategy

setRPUIContextCreateStrategy

public void setRPUIContextCreateStrategy(@Nonnull
                                Function<org.opensaml.profile.context.ProfileRequestContext,RelyingPartyUIContext> strategy)

Set the mechanism to create/get the RelyingPartyUIContext from the ProfileRequestContext.

Parameters:

strategy - what to set.

setFallbackLanguages

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

Set the system wide default languages.

Parameters:

langs - a semi-colon separated string.

getRPUInfo

@Nullable
protected org.opensaml.saml.ext.saml2mdui.UIInfo getRPUInfo()

Get the RP UIInfo, caching the value and consulting if needed.

Returns:

the value or null if there is none.

getBrowserLanguages

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

Pluck the languages from the browser.

Returns:

the two letter language

doPreExecute

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

Overrides:

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

doExecute

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

Overrides:

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