Package net.shibboleth.idp.authn

Class AbstractSubjectCanonicalizationAction

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.AbstractSubjectCanonicalizationAction

All Implemented Interfaces:

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

Direct Known Subclasses:

AttributeSourcedSubjectCanonicalization, LegacyCanonicalization, NameIDCanonicalization, NameIdentifierCanonicalization, PopulateSubjectCanonicalizationContext, SelectSubjectCanonicalizationFlow, SimpleSubjectCanonicalization, X500SubjectCanonicalization

public abstract class AbstractSubjectCanonicalizationAction
extends AbstractProfileAction

A base class for subject canonicalization actions. In addition to the work performed by AbstractProfileAction, this action also looks up and makes available the SubjectCanonicalizationContext. Authentication action implementations should override doExecute(ProfileRequestContext, SubjectCanonicalizationContext)

Event:

AuthnEventIds.INVALID_SUBJECT_C14N_CTX

Field Summary

Fields

Modifier and Type	Field	Description
private org.slf4j.Logger	log	Class logger.
private boolean	lowercase	Convert to lowercase prior to transforms?
private SubjectCanonicalizationContext	scContext	SubjectCanonicalizationContext to operate on.
private Function<ProfileRequestContext,SubjectCanonicalizationContext>	scCtxLookupStrategy	Strategy used to find the SubjectCanonicalizationContext from the ProfileRequestContext.
private List<Pair<Pattern,String>>	transforms	Match patterns and replacement strings to apply.
private boolean	trim	Trim prior to transforms?
private boolean	uppercase	Convert to uppercase prior to transforms?

Constructor Summary

Constructors

Constructor	Description
AbstractSubjectCanonicalizationAction()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected String	applyTransforms(String input)	Apply any configured regular expression replacements to an input value and return the result.
protected void	doExecute(ProfileRequestContext profileRequestContext)
protected void	doExecute(ProfileRequestContext profileRequestContext, SubjectCanonicalizationContext c14nContext)	Performs this authentication action.
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext)
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext, SubjectCanonicalizationContext c14nContext)	Performs this c14n action's pre-execute step.
void	setLookupStrategy(Function<ProfileRequestContext,SubjectCanonicalizationContext> strategy)	Set the context lookup strategy.
void	setLowercase(boolean flag)	Controls conversion to lowercase prior to applying any transforms.
void	setTransforms(Collection<Pair<String,String>> newTransforms)	A collection of regular expression and replacement pairs.
void	setTrim(boolean flag)	Controls whitespace trimming prior to applying any transforms.
void	setUppercase(boolean flag)	Controls conversion to uppercase prior to applying any transforms.

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, execute, getHttpServletRequest, getHttpServletRequestSupplier, getHttpServletResponse, getHttpServletResponseSupplier, getLogPrefix, setHttpServletRequest, setHttpServletRequestSupplier, setHttpServletResponse, setHttpServletResponseSupplier

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.

scCtxLookupStrategy

@Nonnull
private Function<ProfileRequestContext,SubjectCanonicalizationContext> scCtxLookupStrategy

Strategy used to find the SubjectCanonicalizationContext from the ProfileRequestContext.

scContext

@Nullable
private SubjectCanonicalizationContext scContext

SubjectCanonicalizationContext to operate on.

transforms

@Nonnull
@NonnullElements
private List<Pair<Pattern,String>> transforms

Match patterns and replacement strings to apply.

uppercase

private boolean uppercase

Convert to uppercase prior to transforms?

lowercase

private boolean lowercase

Convert to lowercase prior to transforms?

trim

private boolean trim

Trim prior to transforms?

Constructor Detail

AbstractSubjectCanonicalizationAction

public AbstractSubjectCanonicalizationAction()

Constructor.

Method Detail

setLookupStrategy

public void setLookupStrategy(@Nonnull
                              Function<ProfileRequestContext,SubjectCanonicalizationContext> strategy)

Set the context lookup strategy.

Parameters:

strategy - lookup strategy function for SubjectCanonicalizationContext.

setTransforms

public void setTransforms(@Nullable @NonnullElements
                          Collection<Pair<String,String>> newTransforms)

A collection of regular expression and replacement pairs.

Parameters:

newTransforms - collection of replacement transforms

setUppercase

public void setUppercase(boolean flag)

Controls conversion to uppercase prior to applying any transforms.

Parameters:

flag - uppercase flag

setLowercase

public void setLowercase(boolean flag)

Controls conversion to lowercase prior to applying any transforms.

Parameters:

flag - lowercase flag

setTrim

public void setTrim(boolean flag)

Controls whitespace trimming prior to applying any transforms.

Parameters:

flag - trim flag

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)

Overrides:

doPreExecute in class AbstractConditionalProfileAction

doPreExecute

protected boolean doPreExecute(@Nonnull
                               ProfileRequestContext profileRequestContext,
                               @Nonnull
                               SubjectCanonicalizationContext c14nContext)

Performs this c14n action's pre-execute step. Default implementation just returns true iff a subject is set.

Parameters:

profileRequestContext - the current IdP profile request context

c14nContext - the current subject canonicalization context

Returns:

true iff execution should continue

doExecute

protected final void doExecute(@Nonnull
                               ProfileRequestContext profileRequestContext)

Overrides:

doExecute in class AbstractProfileAction

doExecute

protected void doExecute(@Nonnull
                         ProfileRequestContext profileRequestContext,
                         @Nonnull
                         SubjectCanonicalizationContext c14nContext)

Performs this authentication action. Default implementation throws an exception.

Parameters:

profileRequestContext - the current IdP profile request context

c14nContext - the current subject canonicalization context

applyTransforms

@Nonnull
@NotEmpty
protected String applyTransforms(@Nonnull @NotEmpty
                                 String input)

Apply any configured regular expression replacements to an input value and return the result.

Parameters:

input - the input string

Returns:

the result of applying the expressions