Package org.eclipse.jetty.webapp

Class AbstractConfiguration

java.lang.Object
org.eclipse.jetty.webapp.AbstractConfiguration
All Implemented Interfaces:
Configuration
Direct Known Subclasses:
AnnotationConfiguration, CdiConfiguration, EnvConfiguration, FragmentConfiguration, JaasConfiguration, JakartaWebSocketConfiguration, JaspiConfiguration, JettyWebSocketClientConfiguration, JettyWebSocketConfiguration, JettyWebXmlConfiguration, JmxConfiguration, JndiConfiguration, JspConfiguration, MetaInfConfiguration, PlusConfiguration, QuickStartConfiguration, QuickStartGeneratorConfiguration, ServletsConfiguration, WebAppConfiguration, WebInfConfiguration, WebXmlConfiguration
public class AbstractConfiguration extends Object implements Configuration

  • Constructor Details

    • AbstractConfiguration

      protected AbstractConfiguration()

    • AbstractConfiguration

      protected AbstractConfiguration(boolean enabledByDefault)

  • Method Details

    • addDependencies

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

    • addDependencies

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

    • addDependents

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

    • addDependents

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

    • protect

      protected void protect(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(String... classes)
      Hide classes from the web application by adding them to the getServerClasses()
      Parameters:
      classes - classname or package pattern

    • expose

      protected void expose(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(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 Collection<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 Collection<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.

    • getSystemClasses

      public ClassMatcher getSystemClasses()
      Description copied from interface: Configuration
      Get the system classes associated with this Configuration.
      Specified by:
      getSystemClasses in interface Configuration
      Returns:
      ClassMatcher of system classes.

    • getServerClasses

      public ClassMatcher getServerClasses()
      Description copied from interface: Configuration
      Get the system classes associated with this Configuration.
      Specified by:
      getServerClasses in interface Configuration
      Returns:
      ClassMatcher of server classes.

    • preConfigure

      public void preConfigure(WebAppContext context) throws 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:
      Exception - if unable to pre configure

    • configure

      public void configure(WebAppContext context) throws 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:
      Exception - if unable to configure

    • postConfigure

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

    • deconfigure

      public void deconfigure(WebAppContext context) throws 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:
      Exception - if unable to deconfigure

    • destroy

      public void destroy(WebAppContext context) throws 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:
      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 Exception
      Throws:
      Exception