Package com.inet.plugin

Interface ServerPlugin

  • public interface ServerPlugin
    This interface must be implemented by server plugin entry points. Its methods are called during server start and initialize the plugin's server components.
    Since:
    inetcore 1.0

    • Field Detail

      • CORE_VERSION

        static final java.lang.String CORE_VERSION
        The version of the core.
        Since:
        inetcore 2.0
        See Also:
        Constant Field Values

    • Method Detail

      • registerHelp

        default void registerHelp​(com.inet.plugin.HelpProviderContainer container)
        Register all help providers. This is call before the registerExtension phase. In a the help center mode it is call also for inactive plugins.
        Parameters:
        container - the container for the HelpProviders
        Since:
        inetcore 3.0

      • registerExtension

        void registerExtension​(ServerPluginManager spm)
        Registers all instances of extensions in the ServerPluginManager. If this method is failing with an exception then this plugin is ignored and the error message can be see in the configuration manager web interface.
        Parameters:
        spm - the plugin manager to register the plugins.
        Since:
        inetcore 1.0
        See Also:
        ServerPluginManager.register(Class, Object)

      • init

        void init​(ServerPluginManager spm)
        Initializes the server part of the current plugin.
        Parameters:
        spm - the plugin manager to query e.g. all extension of a specific interface.
        Since:
        inetcore 1.0

      • reset

        void reset()
        Is called if the server was stopped. All background threads should be interrupted, file and socket handles closed.
        Since:
        inetcore 1.0

      • restart

        void restart()
        Is called after a restart of the server within the same Java VM instance. All needed threads can be restarted.
        Since:
        inetcore 1.0

      • uninstall

        default void uninstall​(boolean isFullUninstall)
        Is called by ServerPluginManager during execution of uninstall tasks of available plugins. By default does nothing.
        Parameters:
        isFullUninstall - whether a full uninstall must be performed.
        Since:
        inetcore 2.2