net.shibboleth.idp.authn

Class SubjectCanonicalizationFlowDescriptor

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.idp.authn.SubjectCanonicalizationFlowDescriptor

All Implemented Interfaces:

com.google.common.base.Predicate<ProfileRequestContext>, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

public class SubjectCanonicalizationFlowDescriptor
extends AbstractIdentifiableInitializableComponent
implements com.google.common.base.Predicate<ProfileRequestContext>

A descriptor for a subject canonicalization flow.

A flow models a sequence of profile actions that performs canonicalization of a Subject into a string-form principal name. Flows can do essentially anything, including interact with the subject, but must include an activation predicate to indicate their suitability based on the content of the ProfileRequestContext, particularly the required SubjectCanonicalizationContext child context.

Field Summary

Fields

Modifier and Type	Field and Description
private com.google.common.base.Predicate<ProfileRequestContext>	activationCondition Predicate that must be true for this flow to be usable for a given request.

Constructor Summary

Constructors

Constructor and Description
SubjectCanonicalizationFlowDescriptor() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	apply(ProfileRequestContext input)
boolean	equals(Object obj)
int	hashCode()
void	setActivationCondition(com.google.common.base.Predicate<ProfileRequestContext> condition) Set the activation condition in the form of a Predicate such that iff the condition evaluates to true should the corresponding flow be allowed/possible.
String	toString()

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

doInitialize, getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, doDestroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

activationCondition

@Nonnull
private com.google.common.base.Predicate<ProfileRequestContext> activationCondition

Predicate that must be true for this flow to be usable for a given request.

Constructor Detail

SubjectCanonicalizationFlowDescriptor

public SubjectCanonicalizationFlowDescriptor()

Constructor.

Method Detail

setActivationCondition

public void setActivationCondition(@Nonnull
                          com.google.common.base.Predicate<ProfileRequestContext> condition)

Set the activation condition in the form of a Predicate such that iff the condition evaluates to true should the corresponding flow be allowed/possible.

Parameters:

condition - predicate that controls activation of the flow

apply

public boolean apply(ProfileRequestContext input)

Specified by:

apply in interface com.google.common.base.Predicate<ProfileRequestContext>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.common.base.Predicate<ProfileRequestContext>

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object