Module org.eclipse.jetty.ee9.webapp

Package org.eclipse.jetty.ee9.webapp

Class AbstractConfiguration

java.lang.Object

org.eclipse.jetty.ee9.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/interfaces inherited from interface org.eclipse.jetty.ee9.webapp.Configuration

Configuration.Wrapper, Configuration.WrapperFunction

Field Summary

Fields inherited from interface org.eclipse.jetty.ee9.webapp.Configuration

ATTR

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractConfiguration()
protected	AbstractConfiguration(boolean enabledByDefault)

Method Summary

Modifier and Type	Method	Description
boolean	abort(WebAppContext context)
protected void	addDependencies(Class<? extends Configuration>... classes)	Add configuration classes that come before this configuration
protected void	addDependencies(String... classes)	Add configuration classes that come before this configuration
protected void	addDependents(Class<?>... classes)	Add configuration classes that come after this configuration
protected void	addDependents(String... classes)	Add configuration classes that come after this configuration
void	cloneConfigure(WebAppContext template, WebAppContext context)
void	configure(WebAppContext context)	Configure WebApp.
void	deconfigure(WebAppContext context)	DeConfigure WebApp.
void	destroy(WebAppContext context)	Destroy WebApp.
protected void	expose(String... classes)	Expose classes to the web application by adding them as exclusions to the getServerClasses()
Collection<String>	getDependencies()	Get known Configuration Dependencies.
Collection<String>	getDependents()	Get known Configuration Dependents.
ClassMatcher	getServerClasses()	Get the server classes associated with this Configuration.
ClassMatcher	getSystemClasses()	Get the system classes associated with this Configuration.
protected void	hide(String... classes)	Hide classes from the web application by adding them to the getServerClasses()
boolean	isEnabledByDefault()
void	postConfigure(WebAppContext context)	Clear down after configuration.
void	preConfigure(WebAppContext context)	Set up for configuration.
protected void	protect(String... classes)	Protect classes from modification by the web application by adding them to the getSystemClasses()
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()

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.ee9.webapp.Configuration

isAvailable, replaces

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 server 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