Package com.nimbusds.openid.connect.provider.spi

Interface Lifecycle

All Known Subinterfaces:
AccessTokenIssueEventListener, AdvancedClaimsSource, AuthorizationRequestValidator, CIBARequestHandler, ClaimsSource, ClientAuthenticationInterceptor, ClientCredentialsGrantHandler, CommonClaimsSource, CustomTokenResponseComposer, DeviceSSOHandler, FinalMetadataValidator, GrantHandler, IdentifierAccessTokenCodec, IDTokenIssueEventListener, JWTGrantHandler, LoginHintResolver, PARValidator, PasswordGrantHandler, PrivateKeyJWTCertificateVerifier, RegistrationInterceptor, SAML2GrantHandler, SelfContainedAccessTokenClaimsCodec, SelfIssuedJWTGrantHandler, SelfIssuedSAML2GrantHandler, SubjectAuthAndConsentEventListener, ThirdPartyJWTGrantHandler, ThirdPartySAML2GrantHandler, TokenExchangeGrantHandler, TokenIntrospectionResponseComposer
All Known Implementing Classes:
BaseSelfContainedAccessTokenClaimsCodec, BaseTokenIntrospectionResponseComposer, DefaultTokenIntrospectionResponseComposer
public interface Lifecycle
Service Provider Interface (SPI) lifecycle.

  • Method Summary

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

  • Method Details

    • init

      default void init(InitContext initContext) throws Exception
      Initialises the SPI implementation after it is loaded by the Connect2id Server.
      Parameters:
      initContext - The initialisation context. Can be used to configure and set up the SPI implementation. Not null.
      Throws:
      Exception - If initialisation failed.

    • isEnabled

      default 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

      default void shutdown() throws Exception
      Shuts down the SPI implementation. This method is called on Connect2id Server shutdown.
      Throws:
      Exception - If proper shutdown failed.