Module org.eclipse.jetty.ee10.webapp

Package org.eclipse.jetty.ee10.webapp

Class AbstractConfiguration

java.lang.Object

org.eclipse.jetty.ee10.webapp.AbstractConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

FragmentConfiguration, JaasConfiguration, JaspiConfiguration, JettyWebXmlConfiguration, JmxConfiguration, JndiConfiguration, JspConfiguration, MetaInfConfiguration, ServletsConfiguration, WebAppConfiguration, WebInfConfiguration, WebXmlConfiguration

public class AbstractConfiguration
extends Object
implements Configuration

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractConfiguration.Builder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfiguration(AbstractConfiguration.Builder builder)

Method Summary

Modifier and Type	Method	Description
boolean	abort(WebAppContext context)
void	configure(WebAppContext context)	Configure WebApp.
void	deconfigure(WebAppContext context)	DeConfigure WebApp.
void	destroy(WebAppContext context)	Destroy WebApp.
Collection<String>	getDependencies()	Get known Configuration Dependencies.
Collection<String>	getDependents()	Get known Configuration Dependents.
org.eclipse.jetty.util.ClassMatcher	getHiddenClasses()	Get the server (hidden) classes associated with this Configuration.
org.eclipse.jetty.util.ClassMatcher	getProtectedClasses()	Get the system (protected) classes associated with this Configuration.
boolean	isEnabledByDefault()
void	postConfigure(WebAppContext context)	Clear down after configuration.
void	preConfigure(WebAppContext context)	Set up for configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.jetty.ee10.webapp.Configuration

getServerClasses, getSystemClasses, isAvailable, replaces

Constructor Details

AbstractConfiguration

protected AbstractConfiguration(AbstractConfiguration.Builder builder)

Method Details

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.

getProtectedClasses

public org.eclipse.jetty.util.ClassMatcher getProtectedClasses()

Description copied from interface: Configuration

Get the system (protected) classes associated with this Configuration.

Specified by:

getProtectedClasses in interface Configuration

Returns:

ClassMatcher of system classes.

getHiddenClasses

public org.eclipse.jetty.util.ClassMatcher getHiddenClasses()

Description copied from interface: Configuration

Get the server (hidden) classes associated with this Configuration.

Specified by:

getHiddenClasses 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