Interface IdPModule

    • Method Detail

      • getName

        @Nonnull
        @NotEmpty
        String getName​(@Nullable
                       ModuleContext moduleContext)
        Gets module name.
        Parameters:
        moduleContext - optional context for supplying i18n input
        Returns:
        a human-readable name for the module
      • getDescription

        @Nullable
        @NotEmpty
        String getDescription​(@Nullable
                              ModuleContext moduleContext)
        Gets module description.
        Parameters:
        moduleContext - optional context for supplying i18n input
        Returns:
        a human-readable description for the module
      • getURL

        @Nullable
        @NotEmpty
        String getURL()
        Gets module URL.
        Returns:
        a URL for obtaining additional information about the module
      • getOwnerId

        @Nullable
        @NotEmpty
        String getOwnerId()
        Gets the plugin name of the module's owner, if the module is provided by a plugin.
        Returns:
        plugin ID, if any
      • isHttpClientRequired

        boolean isHttpClientRequired()
        Gets whether module enablement requires access to an HttpClient.
        Returns:
        true iff enabling the module requires HTTP client
      • isEnabled

        boolean isEnabled​(@Nonnull
                          ModuleContext moduleContext)
        Gets whether the module is enabled.

        The status of "enabled" is meant to reflect whether a deployer has previously or implicitly enabled the module, not necessarily whether the module is fully or properly configured or in use.

        Parameters:
        moduleContext - module context
        Returns:
        true iff the module is enabled