SubjectCanonicalizationFlowDescriptor (Shibboleth Identity Provider 4.3.3-SNAPSHOT API)

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:

Predicate<ProfileRequestContext>, FlowDescriptor, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent

Direct Known Subclasses:

NameIDCanonicalizationFlowDescriptor
```
public class SubjectCanonicalizationFlowDescriptor
extends AbstractIdentifiableInitializableComponent
implements FlowDescriptor, 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 Description

private Predicate<ProfileRequestContext> activationCondition
Predicate that must be true for this flow to be usable for a given request.

Constructor Summary

Constructors
Constructor Description

SubjectCanonicalizationFlowDescriptor()
Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`void`	`setActivationCondition(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.
`boolean`	`test(ProfileRequestContext input)`
`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.DestructableComponent
destroy, isDestroyed

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiableComponent
setId

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

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent
initialize, isInitialized

Methods inherited from interface java.util.function.Predicate
and, negate, or

- Field Detail
  - activationCondition
```
@Nonnull
private 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
                                   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
  - test
```
public boolean test(ProfileRequestContext input)
```
    Specified by:
    
    test in interface Predicate<ProfileRequestContext>
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object