Package net.shibboleth.sp.authn.impl

Class InitializeAgentRequestContext

java.lang.Object

net.shibboleth.shared.component.AbstractInitializableComponent

org.opensaml.profile.action.AbstractProfileAction

org.opensaml.profile.action.AbstractConditionalProfileAction

net.shibboleth.idp.profile.AbstractProfileAction

net.shibboleth.idp.authn.AbstractAuthenticationAction

net.shibboleth.sp.authn.impl.InitializeAgentRequestContext

All Implemented Interfaces:

Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class InitializeAgentRequestContext
extends AbstractAuthenticationAction

An authentication action that relies on extracted HTTP authentication credentials to resolve the appropriate Agent and create an AgentRequestContext.

Event:

EventIds.PROCEED_EVENT_ID, EventIds.INVALID_PROFILE_CTX, EventIds.IO_ERROR, AuthnEventIds.UNKNOWN_USERNAME

Precondition:

ProfileRequestContext.getSubcontext(AuthenticationContext.class) != null

Postcondition:

ProfileRequestContext.ensureSubcontext(AgentRequestContext.class).getAgent() != null

,

An MDC logging attribute is created with the successfully resolved ID.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AGENT_ID_MDC_ATTRIBUTE	MDC attribute name for agent ID.
private String	agentCredentialID	Cached agent credential ID from "username".
private Function<ProfileRequestContext,AgentRequestContext>	agentRequestContextCreationStrategy	Creation strategy for AgentRequestContext.
private ReloadableService<AgentResolver>	agentResolver	The agent resolver.
private final org.slf4j.Logger	log	Class logger.
private boolean	populateMDC	Whether to populate the MDC.
private Function<ProfileRequestContext,UsernamePasswordContext>	usernamePasswordContextLookupStrategy	Lookup strategy for UsernamePasswordContext.

Constructor Summary

Constructors

Constructor	Description
InitializeAgentRequestContext()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)
void	setAgentRequestContextCreationStrategy(Function<ProfileRequestContext,AgentRequestContext> strategy)	Sets the creation strategy for the AgentRequestContext.
void	setAgentResolver(ReloadableService<AgentResolver> service)	Sets the AgentResolver service to use.
void	setPopulateMDC(boolean flag)	Sets whether to populate the agent ID into the logging MDC.
void	setUsernamePasswordContextLookupStrategy(Function<ProfileRequestContext,UsernamePasswordContext> strategy)	Sets the lookup strategy for the UsernamePasswordContext.

Methods inherited from class net.shibboleth.idp.authn.AbstractAuthenticationAction

doExecute, doPreExecute, setAuthenticationContextLookupStrategy

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

doExecute, execute, getBean, getBean, getMessage, getMessage, getMessage, getParameter, getParameter, 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, ensureHttpServletRequest, ensureHttpServletResponse, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, isPreExecuteCalled, setHttpServletRequestSupplier, setHttpServletResponseSupplier

Methods inherited from class net.shibboleth.shared.component.AbstractInitializableComponent

checkComponentActive, checkSetterPreconditions, destroy, doDestroy, ifDestroyedThrowDestroyedComponentException, ifInitializedThrowUnmodifiabledComponentException, ifNotInitializedThrowUninitializedComponentException, 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.shared.component.InitializableComponent

initialize, isInitialized

Field Details

AGENT_ID_MDC_ATTRIBUTE

@Nonnull
@NotEmpty
public static final String AGENT_ID_MDC_ATTRIBUTE

MDC attribute name for agent ID.

See Also:

• Constant Field Values

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

usernamePasswordContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,UsernamePasswordContext> usernamePasswordContextLookupStrategy

Lookup strategy for UsernamePasswordContext.

agentRequestContextCreationStrategy

@Nonnull
private Function<ProfileRequestContext,AgentRequestContext> agentRequestContextCreationStrategy

Creation strategy for AgentRequestContext.

agentResolver

@NonnullAfterInit
private ReloadableService<AgentResolver> agentResolver

The agent resolver.

populateMDC

private boolean populateMDC

Whether to populate the MDC.

agentCredentialID

@NonnullBeforeExec
private String agentCredentialID

Cached agent credential ID from "username".

Constructor Details

InitializeAgentRequestContext

public InitializeAgentRequestContext()

Constructor.

Method Details

setUsernamePasswordContextLookupStrategy

public void setUsernamePasswordContextLookupStrategy(@Nonnull
 Function<ProfileRequestContext,UsernamePasswordContext> strategy)

Sets the lookup strategy for the UsernamePasswordContext.

Parameters:

strategy - lookup strategy

setAgentRequestContextCreationStrategy

public void setAgentRequestContextCreationStrategy(@Nonnull
 Function<ProfileRequestContext,AgentRequestContext> strategy)

Sets the creation strategy for the AgentRequestContext.

Parameters:

strategy - creation strategy

setAgentResolver

public void setAgentResolver(@Nonnull
 ReloadableService<AgentResolver> service)

Sets the AgentResolver service to use.

Parameters:

service - the AgentResolver service

setPopulateMDC

public void setPopulateMDC(boolean flag)

Sets whether to populate the agent ID into the logging MDC.

Defaults to true.

Parameters:

flag - flag to set

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

protected boolean doPreExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 AuthenticationContext authenticationContext)

Overrides:

doPreExecute in class AbstractAuthenticationAction

doExecute

protected void doExecute(@Nonnull
 ProfileRequestContext profileRequestContext,
 @Nonnull
 AuthenticationContext authenticationContext)

Overrides:

doExecute in class AbstractAuthenticationAction