com.nimbusds.openid.connect.provider.spi

Interface Lifecycle

All Known Subinterfaces:

ClaimsSource, ClientCredentialsGrantHandler, GrantHandler, PasswordGrantHandler

public interface Lifecycle

Service Provider Interface (SPI) lifecycle.

Method Summary

Methods

Modifier and Type	Method and Description
void	init(InitContext initContext) Initialises the SPI implementation after it is loaded by the Connect2id Server.
boolean	isEnabled() Checks if the SPI implementation is enabled and can handle requests.
void	shutdown() Shuts down the SPI implementation.

Method Detail

init

void init(InitContext initContext)
          throws java.lang.Exception

Initialises the SPI implementation after it is loaded by the Connect2id Server.

Parameters:

initContext - The initialisation context. Can be used to retrieve a configuration file required to set up the SPI implementation, e.g. the parameters to establish a database connection. Not null.

Throws:

java.lang.Exception - If initialisation failed.

isEnabled

boolean isEnabled()

Checks if the SPI implementation is enabled and can handle requests. This can be controlled by a configuration setting or otherwise.

Returns:

true if the SPI implementation is enabled, else false.

shutdown

void shutdown()
              throws java.lang.Exception

Shuts down the SPI implementation. This method is called on Connect2id Server shutdown.

Throws:

java.lang.Exception - If proper shutdown failed.