Package net.shibboleth.idp.authn.impl
Class InitializeRequestedPrincipalContext
- java.lang.Object
-
- net.shibboleth.utilities.java.support.component.AbstractInitializableComponent
-
- org.opensaml.profile.action.AbstractProfileAction
-
- org.opensaml.profile.action.AbstractConditionalProfileAction
-
- net.shibboleth.idp.profile.AbstractProfileAction
-
- net.shibboleth.idp.authn.AbstractAuthenticationAction
-
- net.shibboleth.idp.authn.impl.InitializeRequestedPrincipalContext
-
- All Implemented Interfaces:
Component,DestructableComponent,InitializableComponent,ProfileAction,Aware,MessageSource,MessageSourceAware,Action
public class InitializeRequestedPrincipalContext extends AbstractAuthenticationAction
An action that creates anRequestedPrincipalContextand attaches it to the currentAuthenticationContext, if the profile request context contains aRelyingPartyContextwith anAuthenticationProfileConfigurationcontaining one or more default authentication methods.If such a context already exists, it is left in place unless
setReplaceExistingContext(boolean)is set.- Event:
EventIds.PROCEED_EVENT_ID,IdPEventIds.INVALID_RELYING_PARTY_CTX,IdPEventIds.INVALID_PROFILE_CONFIG- Postcondition:
- See above.
-
-
Field Summary
Fields Modifier and Type Field Description private AuthenticationProfileConfigurationauthenticationProfileConfigProfile configuration source for requested principals.private org.slf4j.LoggerlogClass logger.private Function<ProfileRequestContext,RelyingPartyContext>relyingPartyContextLookupStrategyStrategy used to locate theRelyingPartyContextassociated with a givenProfileRequestContext.private booleanreplaceExistingContextWhether to replace an existing subcontext, if any.
-
Constructor Summary
Constructors Constructor Description InitializeRequestedPrincipalContext()Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected voiddoExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)protected booleandoPreExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)voidsetRelyingPartyContextLookupStrategy(Function<ProfileRequestContext,RelyingPartyContext> strategy)Set the strategy used to locate theRelyingPartyContextassociated with a givenProfileRequestContext.voidsetReplaceExistingContext(boolean flag)Whether any existingRequestedPrincipalContextshould be replaced, defaults to "false".-
Methods inherited from class net.shibboleth.idp.authn.AbstractAuthenticationAction
doExecute, doPreExecute, setAuthenticationContextLookupStrategy
-
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.
-
replaceExistingContext
private boolean replaceExistingContext
Whether to replace an existing subcontext, if any.
-
relyingPartyContextLookupStrategy
@Nonnull private Function<ProfileRequestContext,RelyingPartyContext> relyingPartyContextLookupStrategy
Strategy used to locate theRelyingPartyContextassociated with a givenProfileRequestContext.
-
authenticationProfileConfig
@Nullable private AuthenticationProfileConfiguration authenticationProfileConfig
Profile configuration source for requested principals.
-
-
Method Detail
-
setReplaceExistingContext
public void setReplaceExistingContext(boolean flag)
Whether any existingRequestedPrincipalContextshould be replaced, defaults to "false".Normally an existing context would indicate requirements that shouldn't be circumvented to comply with expected profile behavior.
- Parameters:
flag- flag to set
-
setRelyingPartyContextLookupStrategy
public void setRelyingPartyContextLookupStrategy(@Nonnull Function<ProfileRequestContext,RelyingPartyContext> strategy)Set the strategy used to locate theRelyingPartyContextassociated with a givenProfileRequestContext.- Parameters:
strategy- strategy used to locate theRelyingPartyContextassociated with a givenProfileRequestContext
-
doPreExecute
protected boolean doPreExecute(@Nonnull ProfileRequestContext profileRequestContext, @Nonnull AuthenticationContext authenticationContext)- Overrides:
doPreExecutein classAbstractAuthenticationAction
-
doExecute
protected void doExecute(@Nonnull ProfileRequestContext profileRequestContext, @Nonnull AuthenticationContext authenticationContext)- Overrides:
doExecutein classAbstractAuthenticationAction
-
-