Package net.shibboleth.idp.authn

Class AbstractExtractionAction

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ExtractKerberosTicketFromWSSToken, ExtractRemoteUser, ExtractUserAgentAddress, ExtractUserAgentIdentifier, ExtractUsernamePasswordFromBasicAuth, ExtractUsernamePasswordFromFormRequest, ExtractUsernamePasswordFromWSSToken, ExtractX509CertificateFromRequest

public abstract class AbstractExtractionAction
extends AbstractAuthenticationAction

A base class for authentication actions that extract usernames for subsequent use.

The base class adds a common mechanism for applying regular expression transforms to the username prior to being added to the context tree.

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 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
AbstractExtractionAction()	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.
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.authn.AbstractAuthenticationAction

doExecute, doExecute, doPreExecute, 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, 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.

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

AbstractExtractionAction

public AbstractExtractionAction()

Constructor.

Method Detail

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

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