Package net.shibboleth.sp.authn.impl

Class ValidateAgentCredentials

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.idp.authn.AbstractValidationAction

net.shibboleth.idp.authn.impl.AbstractAuditingValidationAction

net.shibboleth.idp.authn.impl.ValidateCredentials

net.shibboleth.sp.authn.impl.ValidateAgentCredentials

All Implemented Interfaces:

CredentialValidator.ErrorHandler, CredentialValidator.WarningHandler, PrincipalSupportingComponent, Component, DestructableComponent, InitializableComponent, ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class ValidateAgentCredentials
extends ValidateCredentials

Subclass of validation action from IdP that sidesteps all the unneeded machinery outside of building the Subject and verifying the result.

If configured to do so, the result of the authentication is also cached in the container session.

Nested Class Summary

Nested classes/interfaces inherited from class net.shibboleth.idp.authn.impl.ValidateCredentials

ValidateCredentials.UsernamePasswordCleanupHook

Field Summary

Fields

Modifier and Type	Field	Description
private Function<ProfileRequestContext,AgentRequestContext>	agentRequestContextLookupStrategy	Lookup strategy for AgentRequestContext.
private Duration	cacheDuration	Duration for cached authentication record.
private org.slf4j.Logger	log	Class logger.

Constructor Summary

Constructors

Constructor	Description
ValidateAgentCredentials()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	buildAuthenticationResult(ProfileRequestContext profileRequestContext, AuthenticationContext authenticationContext)
void	setAgentRequestContextLookupStrategy(Function<ProfileRequestContext,AgentRequestContext> strategy)	Sets the lookup strategy for the AgentRequestContext.
void	setCacheDuration(Duration duration)	Sets the duration for which authentication should be cached.

Methods inherited from class net.shibboleth.idp.authn.impl.ValidateCredentials

doExecute, getAuditFields, getMetricName, handleError, handleError, handleWarning, populateSubject, recordSuccess, setLockoutManager, setRequireAll, setValidators

Methods inherited from class net.shibboleth.idp.authn.impl.AbstractAuditingValidationAction

doAudit, doExecute, getAuditContext, recordFailure, setAuditContextCreationStrategy, setPopulateAuditContextAction, setWriteAuditLogAction

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

addDefaultPrincipals, doPreExecute, getClassifiedErrors, getCleanupHook, getRequesterLookupStrategy, getResponderLookupStrategy, getResultCachingPredicate, getSubject, getSupportedPrincipals, setAddDefaultPrincipals, setClassifiedMessages, setCleanupHook, setMetricName, setRequesterLookupStrategy, setResponderLookupStrategy, setResultCachingPredicate, setSupportedPrincipals

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

doExecute, doPreExecute, setAuthenticationContextLookupStrategy

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

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, doInitialize, 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

log

@Nonnull
private org.slf4j.Logger log

Class logger.

agentRequestContextLookupStrategy

@Nonnull
private Function<ProfileRequestContext,AgentRequestContext> agentRequestContextLookupStrategy

Lookup strategy for AgentRequestContext.

cacheDuration

@Nonnull
private Duration cacheDuration

Duration for cached authentication record.

Constructor Details

ValidateAgentCredentials

public ValidateAgentCredentials()

Constructor.

Method Details

setAgentRequestContextLookupStrategy

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

Sets the lookup strategy for the AgentRequestContext.

Parameters:

strategy - lookup strategy

setCacheDuration

public void setCacheDuration(@Nonnull
 Duration duration)

Sets the duration for which authentication should be cached.

Defaults to an hour.

Parameters:

duration - cache duration

buildAuthenticationResult

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

Overrides:

buildAuthenticationResult in class AbstractValidationAction