Package net.shibboleth.idp.saml.nameid.impl

Class NameIdentifierCanonicalization

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

net.shibboleth.idp.saml.nameid.impl.NameIdentifierCanonicalization

All Implemented Interfaces:

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

public class NameIdentifierCanonicalization
extends AbstractSubjectCanonicalizationAction

Action to perform subject canonicalization, transforming the input Subject into a principal name by searching for one and only one NameIdentifierPrincipal custom principal, using an injected NameIdentifierDecoder to carry out the process.

Event:

EventIds.PROCEED_EVENT_ID, AuthnEventIds.INVALID_SUBJECT

Precondition:

 ProfileRequestContext.getSubcontext(SubjectCanonicalizationContext.class, false) != null
 

Postcondition:

 SubjectCanonicalizationContext.getPrincipalName() != null || SubjectCanonicalizationContext.getException() != null
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NameIdentifierCanonicalization.ActivationCondition	A predicate that determines if this action can run or not.

Field Summary

Fields

Modifier and Type	Field	Description
private NameIdentifierDecoder	decoder	Supplies logic for decoding the NameIdentifier into a principal.
private NameIdentifierCanonicalization.ActivationCondition	embeddedPredicate	Supplies logic for pre-execute test.

Constructor Summary

Constructors

Constructor	Description
NameIdentifierCanonicalization()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(ProfileRequestContext profileRequestContext, SubjectCanonicalizationContext c14nContext)
protected void	doInitialize()
protected boolean	doPreExecute(ProfileRequestContext profileRequestContext, SubjectCanonicalizationContext c14nContext)
NameIdentifierDecoder	getDecoder()	Get the class responsible for decoding the NameIdentifier into a principal.
void	setDecoder(NameIdentifierDecoder theDecoder)	Set the class responsible for decoding the NameIdentifier into a principal.

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

applyTransforms, doExecute, doPreExecute, setLookupStrategy, setLowercase, setTransforms, setTrim, setUppercase

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

embeddedPredicate

@Nonnull
private final NameIdentifierCanonicalization.ActivationCondition embeddedPredicate

Supplies logic for pre-execute test.

decoder

@NonnullAfterInit
private NameIdentifierDecoder decoder

Supplies logic for decoding the NameIdentifier into a principal.

Constructor Detail

NameIdentifierCanonicalization

public NameIdentifierCanonicalization()

Constructor.

Method Detail

getDecoder

@NonnullAfterInit
public NameIdentifierDecoder getDecoder()

Get the class responsible for decoding the NameIdentifier into a principal.

Returns:

the decoder

setDecoder

public void setDecoder(@Nonnull
                       NameIdentifierDecoder theDecoder)

Set the class responsible for decoding the NameIdentifier into a principal.

Parameters:

theDecoder - the decoder

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

Overrides:

doInitialize in class AbstractInitializableComponent

Throws:

ComponentInitializationException

doPreExecute

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

Overrides:

doPreExecute in class AbstractSubjectCanonicalizationAction

doExecute

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

Overrides:

doExecute in class AbstractSubjectCanonicalizationAction