Package org.forgerock.openam.saml2.plugins

Interface InitializablePlugin

All Superinterfaces:
SAMLPlugin
All Known Subinterfaces:
FedletAdapter, IDPAdapter, SAML2IdentityProviderAdapter, SPAdapter
All Known Implementing Classes:
FedletAdapter, SAML2ServiceProviderAdapter
@EvolvingAll public interface InitializablePlugin extends SAMLPlugin
All the SAML federation plugins that need to be initialized should extend this.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    HOSTED_ENTITY_ID
    Constants for hosted entity id parameter
    static final String
    REALM
    Constants for the realm of the hosted entity parameter.

  • Method Summary

    Modifier and Type
    Method
    Description
    default void
    initialize(String hostedEntityID, String realm)
    Deprecated, for removal: This API element is subject to removal in a future version.
    since 7.3.0 use initialize(Map).
    default void
    initialize(Map initParams)
    Initializes the federation plugin, this method will only be executed once after creation of the plugin instance.

  • Field Details

  • Method Details

    • initialize

      default void initialize(Map initParams)
      Initializes the federation plugin, this method will only be executed once after creation of the plugin instance.
      Parameters:
      initParams - initial set of parameters configured in the service provider for this plugin. One of the parameters named HOSTED_ENTITY_ID refers to the ID of this hosted service provider entity, one of the parameters named REALM refers to the realm of the hosted entity

    • initialize

      @Deprecated(forRemoval=true, since="7.3.0") default void initialize(String hostedEntityID, String realm)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 7.3.0 use initialize(Map).
      Initializes the federation plugin, this method will only be executed once after creation of the plugin instance.
      Parameters:
      hostedEntityID - the hosted entity ID
      realm - realm of the hosted entity