InitializablePlugin (OpenAM Server Only 7.3.1 Documentation)

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 String`	`HOSTED_ENTITY_ID`	Constants for hosted entity id parameter
`static String`	`REALM`	Constants for the realm of the hosted entity parameter.

Method Summary

All Methods Instance Methods Default Methods Deprecated Methods
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 Detail
  - HOSTED_ENTITY_ID
```
static final String HOSTED_ENTITY_ID
```
    Constants for hosted entity id parameter
    
    See Also:
    
    Constant Field Values
  - REALM
```
static final String REALM
```
    Constants for the realm of the hosted entity parameter.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - 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