Package net.shibboleth.sp.profile

Class BasicTokenConsumerFlowDescriptor

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
net.shibboleth.sp.profile.BasicTokenConsumerFlowDescriptor
All Implemented Interfaces:
FlowDescriptor, Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, TokenConsumerFlowDescriptor
public class BasicTokenConsumerFlowDescriptor extends AbstractIdentifiableInitializableComponent implements TokenConsumerFlowDescriptor
Basic implementation of a descriptor for a token consumer flow.

  • Field Details

  • Constructor Details

    • BasicTokenConsumerFlowDescriptor

      public BasicTokenConsumerFlowDescriptor()
      Constructor.

  • Method Details

    • getActivationCondition

      @Nonnull public Predicate<ProfileRequestContext> getActivationCondition()
      Gets the activation condition to run to determine whether this flow can handle the request.
      Specified by:
      getActivationCondition in interface TokenConsumerFlowDescriptor
      Returns:
      a condition governing use of this flow

    • setActivationCondition

      public void setActivationCondition(@Nonnull Predicate<ProfileRequestContext> condition)
      Set activation condition to determine whether this flow supports a request.

      Defaults to false.

      Parameters:
      condition - condition to use

    • setPolicyCondition

      public void setPolicyCondition(@Nonnull Predicate<ProfileRequestContext> condition)
      Set policy condition to determine whether to run this flow.

      This is a separately defined activation condition that simplifies the installation of a condition that operates independently of the specifics of the flow but focuses on the ability to regulate the content of the message being processed by a particular Agent, such as limitaing the URL(s) an Agent is "allowed" to process requests for.

      Defaults to true/off and is ignored.

      Parameters:
      condition - condition to use

    • doInitialize

      protected void doInitialize() throws ComponentInitializationException
      Overrides:
      doInitialize in class AbstractIdentifiedInitializableComponent
      Throws:
      ComponentInitializationException

    • 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