Package org.opensaml.saml.common.binding

Class BindingDescriptor

  • All Implemented Interfaces:
    Predicate<org.opensaml.profile.context.ProfileRequestContext>, net.shibboleth.utilities.java.support.component.Component, net.shibboleth.utilities.java.support.component.DestructableComponent, net.shibboleth.utilities.java.support.component.IdentifiableComponent, net.shibboleth.utilities.java.support.component.IdentifiedComponent, net.shibboleth.utilities.java.support.component.InitializableComponent
    public class BindingDescriptor
extends net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent
implements Predicate<org.opensaml.profile.context.ProfileRequestContext>
    A class that describes a SAML binding and encapsulates information required for profile actions to interact with them.

    Configuration logic should expose the usable bindings to profile actions through instances of this class.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private Predicate<org.opensaml.profile.context.ProfileRequestContext> activationCondition
      Predicate that must be true for this flow to be usable for a given request.
      private boolean artifact
      Identifies a binding that relies on SAML artifacts.
      private String shortName
      A short name for the binding.
      private boolean signatureCapable
      Indicates whether the binding provides a built-in signing mechanism.
      private boolean synchronous
      Identifies a binding that is direct request/response between two parties (i.e., SOAP).

    • Constructor Summary

      Constructors 
      Constructor Description
      BindingDescriptor()
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(Object obj)
      String getShortName()
      Get a short/concise name for the binding.
      int hashCode()
      boolean isArtifact()
      Get whether the binding is artifact-based.
      boolean isSignatureCapable()
      Get whether the binding provides a message signature capability.
      boolean isSynchronous()
      Get whether the binding is synchronous (direct request/response, typically SOAP).
      void setActivationCondition​(Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)
      Set the activation condition in the form of a Predicate such that iff the condition evaluates to true should the corresponding binding be allowed/possible.
      void setArtifact​(boolean flag)
      Set whether the binding is artifact-based.
      void setShortName​(String name)
      Set a short/concise name for the binding.
      void setSignatureCapable​(boolean flag)
      Set whether the binding provides a message signature capability.
      void setSynchronous​(boolean flag)
      Set whether the binding is synchronous (direct request/response, typically SOAP).
      boolean test​(org.opensaml.profile.context.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 interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

        getId

    • Field Detail

      • activationCondition

        @Nonnull
private Predicate<org.opensaml.profile.context.ProfileRequestContext> activationCondition
        Predicate that must be true for this flow to be usable for a given request.

      • synchronous

        private boolean synchronous
        Identifies a binding that is direct request/response between two parties (i.e., SOAP).

      • artifact

        private boolean artifact
        Identifies a binding that relies on SAML artifacts.

      • signatureCapable

        private boolean signatureCapable
        Indicates whether the binding provides a built-in signing mechanism.

      • shortName

        @Nullable
@NotEmpty
private String shortName
        A short name for the binding.

    • Constructor Detail

      • BindingDescriptor

        public BindingDescriptor()
        Constructor.

    • Method Detail

      • setActivationCondition

        public void setActivationCondition​(@Nonnull
                                   Predicate<org.opensaml.profile.context.ProfileRequestContext> condition)
        Set the activation condition in the form of a Predicate such that iff the condition evaluates to true should the corresponding binding be allowed/possible.
        Parameters:
        condition - predicate that controls activation of the binding

      • isSynchronous

        public boolean isSynchronous()
        Get whether the binding is synchronous (direct request/response, typically SOAP).
        Returns:
        true iff the binding is synchronous

      • setSynchronous

        public void setSynchronous​(boolean flag)
        Set whether the binding is synchronous (direct request/response, typically SOAP).
        Parameters:
        flag - flag to set

      • isArtifact

        public boolean isArtifact()
        Get whether the binding is artifact-based.
        Returns:
        true iff the binding is artifact-based

      • setArtifact

        public void setArtifact​(boolean flag)
        Set whether the binding is artifact-based.
        Parameters:
        flag - flag to set

      • isSignatureCapable

        public boolean isSignatureCapable()
        Get whether the binding provides a message signature capability.
        Returns:
        true iff the binding provides a message signature capability

      • setSignatureCapable

        public void setSignatureCapable​(boolean flag)
        Set whether the binding provides a message signature capability.
        Parameters:
        flag - flag to set

      • getShortName

        @Nullable
@NotEmpty
public String getShortName()
        Get a short/concise name for the binding.
        Returns:
        the short name

      • setShortName

        public void setShortName​(@Nullable @NotEmpty
                         String name)
        Set a short/concise name for the binding.
        Parameters:
        name - name to set

      • test

        public boolean test​(@Nullable
                    org.opensaml.profile.context.ProfileRequestContext input)
        Specified by:
        test in interface Predicate<org.opensaml.profile.context.ProfileRequestContext>

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object