Interface Lifecycle

    • Method Summary

      All Methods Instance Methods Default Methods 
      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 Detail

      • 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 setup 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.