Package org.eclipse.jetty.webapp

Interface Configuration

All Known Implementing Classes:

AbstractConfiguration, AnnotationConfiguration, AnnotationConfiguration, AntWebInfConfiguration, AntWebXmlConfiguration, CloneConfiguration, Configuration.Wrapper, EnvConfiguration, FragmentConfiguration, JettyWebXmlConfiguration, MavenQuickStartConfiguration, MavenWebInfConfiguration, MetaInfConfiguration, OSGiWebInfConfiguration, PlusConfiguration, QuickStartConfiguration, WebInfConfiguration, WebXmlConfiguration

public interface Configuration

Base Class for WebApplicationContext Configuration. This class can be extended to customize or extend the configuration of the WebApplicationContext.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Configuration.ClassList
static class	Configuration.Wrapper
static interface	Configuration.WrapperFunction	Experimental Wrapper mechanism for WebApp Configuration components.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATTR

Method Summary

Modifier and Type	Method	Description
void	cloneConfigure(WebAppContext template, WebAppContext context)	Clone configuration instance.
void	configure(WebAppContext context)	Configure WebApp.
void	deconfigure(WebAppContext context)	DeConfigure WebApp.
void	destroy(WebAppContext context)	Destroy WebApp.
void	postConfigure(WebAppContext context)	Clear down after configuration.
void	preConfigure(WebAppContext context)	Set up for configuration.

Field Detail

ATTR

static final java.lang.String ATTR

See Also:

Constant Field Values

Method Detail

preConfigure

void preConfigure(WebAppContext context)
           throws java.lang.Exception

Set up for configuration.

Typically this step discovers configuration resources

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

cloneConfigure

void cloneConfigure(WebAppContext template,
                    WebAppContext context)
             throws java.lang.Exception

Clone configuration instance.

Configure an instance of a WebAppContext, based on a template WebAppContext that has previously been configured by this Configuration.

Parameters:

template - The template context

context - The context to configure

Throws:

java.lang.Exception - if unable to clone