Class AbstractConfiguration

    • Constructor Detail

      • AbstractConfiguration

        protected AbstractConfiguration()
      • AbstractConfiguration

        protected AbstractConfiguration​(boolean enabledByDefault)
    • Method Detail

      • addDependencies

        protected void addDependencies​(java.lang.String... classes)
        Add configuration classes that come before this configuration
        Parameters:
        classes - Classname or package name
      • addDependencies

        protected void addDependencies​(java.lang.Class<? extends Configuration>... classes)
        Add configuration classes that come before this configuration
        Parameters:
        classes - Classes
      • addDependents

        protected void addDependents​(java.lang.String... classes)
        Add configuration classes that come after this configuration
        Parameters:
        classes - Classname or package name
      • addDependents

        protected void addDependents​(java.lang.Class<?>... classes)
        Add configuration classes that come after this configuration
        Parameters:
        classes - Class
      • protect

        protected void protect​(java.lang.String... classes)
        Protect classes from modification by the web application by adding them to the getSystemClasses()
        Parameters:
        classes - classname or package pattern
      • hide

        protected void hide​(java.lang.String... classes)
        Hide classes from the web application by adding them to the getServerClasses()
        Parameters:
        classes - classname or package pattern
      • expose

        protected void expose​(java.lang.String... classes)
        Expose classes to the web application by adding them as exclusions to the getServerClasses()
        Parameters:
        classes - classname or package pattern
      • protectAndExpose

        protected void protectAndExpose​(java.lang.String... classes)
        Protect classes from modification by the web application by adding them to the getSystemClasses() and expose them to the web application by adding them as exclusions to the getServerClasses()
        Parameters:
        classes - classname or package pattern
      • getDependents

        public java.util.Collection<java.lang.String> getDependents()
        Description copied from interface: Configuration
        Get known Configuration Dependents.
        Specified by:
        getDependents in interface Configuration
        Returns:
        The names of Configurations that TopologicalSort must order after this configuration.
      • getDependencies

        public java.util.Collection<java.lang.String> getDependencies()
        Description copied from interface: Configuration
        Get known Configuration Dependencies.
        Specified by:
        getDependencies in interface Configuration
        Returns:
        The names of Configurations that TopologicalSort must order before this configuration.
      • preConfigure

        public void preConfigure​(WebAppContext context)
                          throws java.lang.Exception
        Description copied from interface: Configuration
        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.

        Specified by:
        preConfigure in interface Configuration
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to pre configure
      • configure

        public void configure​(WebAppContext context)
                       throws java.lang.Exception
        Description copied from interface: Configuration
        Configure WebApp.

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

        Specified by:
        configure in interface Configuration
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to configure
      • postConfigure

        public void postConfigure​(WebAppContext context)
                           throws java.lang.Exception
        Description copied from interface: Configuration
        Clear down after configuration.
        Specified by:
        postConfigure in interface Configuration
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to post configure
      • deconfigure

        public void deconfigure​(WebAppContext context)
                         throws java.lang.Exception
        Description copied from interface: Configuration
        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
        Specified by:
        deconfigure in interface Configuration
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to deconfigure
      • destroy

        public void destroy​(WebAppContext context)
                     throws java.lang.Exception
        Description copied from interface: Configuration
        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.
        Specified by:
        destroy in interface Configuration
        Parameters:
        context - The context to configure
        Throws:
        java.lang.Exception - if unable to destroy
      • isEnabledByDefault

        public boolean isEnabledByDefault()
        Specified by:
        isEnabledByDefault in interface Configuration
        Returns:
        true if configuration is enabled by default
      • abort

        public boolean abort​(WebAppContext context)
        Specified by:
        abort in interface Configuration
        Returns:
        true if configuration should be aborted
      • cloneConfigure

        public void cloneConfigure​(WebAppContext template,
                                   WebAppContext context)
                            throws java.lang.Exception
        Throws:
        java.lang.Exception