Package net.shibboleth.idp.authn.impl

Class SimpleSubjectCanonicalization

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.authn.impl.SimpleSubjectCanonicalization

All Implemented Interfaces:

net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.InitializableComponent, org.opensaml.profile.action.ProfileAction, Aware, MessageSource, MessageSourceAware, Action

public class SimpleSubjectCanonicalization
extends net.shibboleth.idp.authn.AbstractSubjectCanonicalizationAction

An action that operates on a SubjectCanonicalizationContext child of the current ProfileRequestContext, and transforms the input Subject into a principal name by searching for one and only one UsernamePrincipal custom principal.

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	SimpleSubjectCanonicalization.ActivationCondition	A predicate that determines if this action can run or not.

Field Summary

Fields

Modifier and Type	Field	Description
private SimpleSubjectCanonicalization.ActivationCondition	embeddedPredicate	Supplies logic for pre-execute test.
private net.shibboleth.idp.authn.principal.UsernamePrincipal	usernamePrincipal	The custom Principal to operate on.

Constructor Summary

Constructors

Constructor	Description
SimpleSubjectCanonicalization()	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, net.shibboleth.idp.authn.context.SubjectCanonicalizationContext c14nContext)
protected boolean	doPreExecute(org.opensaml.profile.context.ProfileRequestContext profileRequestContext, net.shibboleth.idp.authn.context.SubjectCanonicalizationContext c14nContext)

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

embeddedPredicate

@Nonnull
private final SimpleSubjectCanonicalization.ActivationCondition embeddedPredicate

Supplies logic for pre-execute test.

usernamePrincipal

@Nullable
private net.shibboleth.idp.authn.principal.UsernamePrincipal usernamePrincipal

The custom Principal to operate on.

Constructor Detail

SimpleSubjectCanonicalization

public SimpleSubjectCanonicalization()

Constructor.

Method Detail

doPreExecute

protected boolean doPreExecute(@Nonnull
                               org.opensaml.profile.context.ProfileRequestContext profileRequestContext,
                               @Nonnull
                               net.shibboleth.idp.authn.context.SubjectCanonicalizationContext c14nContext)

Overrides:

doPreExecute in class net.shibboleth.idp.authn.AbstractSubjectCanonicalizationAction

doExecute

protected void doExecute(@Nonnull
                         org.opensaml.profile.context.ProfileRequestContext profileRequestContext,
                         @Nonnull
                         net.shibboleth.idp.authn.context.SubjectCanonicalizationContext c14nContext)

Overrides:

doExecute in class net.shibboleth.idp.authn.AbstractSubjectCanonicalizationAction