Package net.shibboleth.sp

Class BasicProtocolSupportService

java.lang.Object
net.shibboleth.shared.component.AbstractInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiedInitializableComponent
net.shibboleth.shared.component.AbstractIdentifiableInitializableComponent
net.shibboleth.sp.BasicProtocolSupportService
All Implemented Interfaces:
Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, ProtocolSupportService, Ordered
public class BasicProtocolSupportService extends AbstractIdentifiableInitializableComponent implements ProtocolSupportService, Ordered
This is a simple implementation of the ProtocolSupportService interface for use by plugins that need to implement it.

  • Field Details

    • order

      private int order
      Spring auto-wiring order.

    • sessionInitiators

      @Nonnull private List<String> sessionInitiators
      Session Initiator flow IDs.

    • tokenConsumers

      @Nonnull private List<String> tokenConsumers
      Token Consumer flow IDs.

    • logoutInitiators

      @Nonnull private List<String> logoutInitiators
      Logout Initiator flow IDs.

    • logoutConsumers

      @Nonnull private List<String> logoutConsumers
      Logout Consumer flow IDs.

    • profileConfigurations

      @Nonnull private Collection<ProfileConfiguration> profileConfigurations
      Non-metadata-driven verified configurations.

    • metadataDrivenProfileConfigurations

      @Nonnull private Collection<ProfileConfiguration> metadataDrivenProfileConfigurations
      Metadata-driven verified configurations.

    • unverifiedProfileConfigurations

      @Nonnull private Collection<ProfileConfiguration> unverifiedProfileConfigurations
      Non-metadata-driven unverified configurations.

    • metadataDrivenUnverifiedProfileConfigurations

      @Nonnull private Collection<ProfileConfiguration> metadataDrivenUnverifiedProfileConfigurations
      Metadata-driven unverified configurations.

  • Constructor Details

    • BasicProtocolSupportService

      public BasicProtocolSupportService()
      Constructor.

  • Method Details

    • getOrder

      public int getOrder()
      Specified by:
      getOrder in interface Ordered

    • setOrder

      public void setOrder(int priority)
      Set the order/priority value for the bean.
      Parameters:
      priority - priority value

    • getSessionInitiators

      @Nonnull @Unmodifiable @NotLive public List<String> getSessionInitiators()
      Gets a default-ordered list of session initiator flows supported by this protocol plugin.

      The default order should reflect what "most" deployers would expect to use when adding support for this plugin to their system.

      Specified by:
      getSessionInitiators in interface ProtocolSupportService
      Returns:
      ordered list of unprefixed flow IDs

    • setSessionInitiators

      public void setSessionInitiators(@Nullable List<String> flows)
      Sets the ordered list of session initiator flow IDs to install.
      Parameters:
      flows - ordered list of unprefixed initiator flow IDs

    • getTokenConsumers

      @Nonnull @Unmodifiable @NotLive public List<String> getTokenConsumers()
      Gets a default-ordered list of token consumer flows supported by this protocol plugin.

      The default order should reflect what "most" deployers would expect to use when adding support for this plugin to their system.

      Specified by:
      getTokenConsumers in interface ProtocolSupportService
      Returns:
      ordered list of unprefixed flow IDs

    • setTokenConsumers

      public void setTokenConsumers(@Nullable List<String> flows)
      Sets the ordered list of token consumer flow IDs to install.
      Parameters:
      flows - ordered list of unprefixed token consumer flow IDs

    • getLogoutInitiators

      @Nonnull @Unmodifiable @NotLive public List<String> getLogoutInitiators()
      Gets a default-ordered list of logout initiator flows supported by this protocol plugin.

      The default order should reflect what "most" deployers would expect to use when adding support for this plugin to their system.

      Specified by:
      getLogoutInitiators in interface ProtocolSupportService
      Returns:
      ordered list of unprefixed flow IDs

    • setLogoutInitiators

      public void setLogoutInitiators(@Nullable List<String> flows)
      Sets the ordered list of logout initiator flow IDs to install.
      Parameters:
      flows - ordered list of unprefixed initiator flow IDs

    • getLogoutConsumers

      @Nonnull @Unmodifiable @NotLive public List<String> getLogoutConsumers()
      Gets a default-ordered list of logout consumer flows supported by this protocol plugin.

      The default order should reflect what "most" deployers would expect to use when adding support for this plugin to their system.

      Specified by:
      getLogoutConsumers in interface ProtocolSupportService
      Returns:
      ordered list of unprefixed flow IDs

    • setLogoutConsumers

      public void setLogoutConsumers(@Nullable List<String> flows)
      Sets the ordered list of logout consumer flow IDs to install.
      Parameters:
      flows - ordered list of unprefixed logout consumer flow IDs

    • getDefaultProfileConfigurations

      @Nonnull @Unmodifiable @NotLive public Collection<ProfileConfiguration> getDefaultProfileConfigurations(boolean metadataDriven)
      Gets the collection of default ProfileConfiguration objects supplied by this protocol plugin.

      This collectuon should include only profiles intended for "verified" use by default.

      Specified by:
      getDefaultProfileConfigurations in interface ProtocolSupportService
      Parameters:
      metadataDriven - true iff the metadata-driven variant of these objects should be returned
      Returns:
      the relevant available profile configurations

    • setDefaultProfileConfigurations

      public void setDefaultProfileConfigurations(@Nullable Collection<ProfileConfiguration> configs)
      Sets the collection of available non-metadata-driven ProfileConfiguration objects to install for "verified" use.
      Parameters:
      configs - profile configurations

    • setMetadataDrivenDefaultProfileConfigurations

      public void setMetadataDrivenDefaultProfileConfigurations(@Nullable Collection<ProfileConfiguration> configs)
      Sets the collection of available metadata-driven ProfileConfiguration objects to install for "verified" use.
      Parameters:
      configs - profile configurations

    • getUnverifiedProfileConfigurations

      @Nonnull @Unmodifiable @NotLive public Collection<ProfileConfiguration> getUnverifiedProfileConfigurations(boolean metadataDriven)
      Gets the collection of default ProfileConfiguration objects supplied by this protocol plugin.

      This collectuon should include only profiles intended for "unverified" use by default.

      Specified by:
      getUnverifiedProfileConfigurations in interface ProtocolSupportService
      Parameters:
      metadataDriven - true iff the metadata-driven variant of these objects should be returned
      Returns:
      the relevant available profile configurations

    • setUnverifiedProfileConfigurations

      public void setUnverifiedProfileConfigurations(@Nullable Collection<ProfileConfiguration> configs)
      Sets the collection of available non-metadata-driven ProfileConfiguration objects to install for "unverified" use.
      Parameters:
      configs - profile configurations

    • setMetadataDrivenUnverifiedDefaultProfileConfigurations

      public void setMetadataDrivenUnverifiedDefaultProfileConfigurations(@Nullable Collection<ProfileConfiguration> configs)
      Sets the collection of available metadata-driven ProfileConfiguration objects to install for "unverified" use.
      Parameters:
      configs - profile configurations