Interface Configuration

    • Method Detail

      • isAvailable

        default boolean isAvailable()
        Returns:
        True if the feature this configuration represents is available and has all its dependencies.
      • replaces

        default java.lang.Class<? extends Configuration> replaces()
        Get a class that this class replaces/extends. If this is added to Configurations collection that already contains a configuration of the replaced class or that reports to replace the same class, then it is replaced with this instance.
        Returns:
        The class this Configuration replaces/extends or null if it replaces no other configuration
      • getDependencies

        default java.util.Collection<java.lang.String> getDependencies()
        Get known Configuration Dependencies.
        Returns:
        The names of Configurations that TopologicalSort must order before this configuration.
      • getDependents

        default java.util.Collection<java.lang.String> getDependents()
        Get known Configuration Dependents.
        Returns:
        The names of Configurations that TopologicalSort must order after this configuration.
      • getSystemClasses

        default ClassMatcher getSystemClasses()
        Get the system classes associated with this Configuration.
        Returns:
        ClassMatcher of system classes.
      • getServerClasses

        default ClassMatcher getServerClasses()
        Get the system classes associated with this Configuration.
        Returns:
        ClassMatcher of server classes.
      • preConfigure

        void preConfigure​(WebAppContext context)
                   throws java.lang.Exception
        Set up for configuration.

        Typically this step discovers configuration resources. Calls to preConfigure may alter the Configurations configured on the WebAppContext, so long as configurations prior to this configuration are not altered.

        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to pre configure
      • configure

        void configure​(WebAppContext context)
                throws java.lang.Exception
        Configure WebApp.

        Typically this step applies the discovered configuration resources to either the WebAppContext or the associated MetaData.

        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to configure
      • postConfigure

        void postConfigure​(WebAppContext context)
                    throws java.lang.Exception
        Clear down after configuration.
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to post configure
      • deconfigure

        void deconfigure​(WebAppContext context)
                  throws java.lang.Exception
        DeConfigure WebApp. This method is called to undo all configuration done. This is called to allow the context to work correctly over a stop/start cycle
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to deconfigure
      • destroy

        void destroy​(WebAppContext context)
              throws java.lang.Exception
        Destroy WebApp. This method is called to destroy a webappcontext. It is typically called when a context is removed from a server handler hierarchy by the deployer.
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to destroy
      • isEnabledByDefault

        boolean isEnabledByDefault()
        Returns:
        true if configuration is enabled by default
      • abort

        boolean abort​(WebAppContext context)
        Returns:
        true if configuration should be aborted