Module org.eclipse.jetty.quickstart

Package org.eclipse.jetty.quickstart

Class QuickStartConfiguration

java.lang.Object

org.eclipse.jetty.webapp.AbstractConfiguration

org.eclipse.jetty.quickstart.QuickStartConfiguration

All Implemented Interfaces:

Configuration

Direct Known Subclasses:

MavenQuickStartConfiguration

public class QuickStartConfiguration
extends AbstractConfiguration

QuickStartConfiguration

Prepare for quickstart generation, or usage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuickStartConfiguration.Mode

Field Summary

Fields

Modifier and Type	Field	Description
static java.util.Set<java.lang.Class<? extends Configuration>>	__replacedConfigurations
static java.lang.String	MODE
static java.lang.String	ORIGIN_ATTRIBUTE
static java.lang.String	QUICKSTART_WEB_XML

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

ATTR

Constructor Summary

Constructors

Constructor	Description
QuickStartConfiguration()

Method Summary

Modifier and Type	Method	Description
protected void	configure(QuickStartGeneratorConfiguration generator, WebAppContext context)
void	configure(WebAppContext context)	Configure WebApp.
static void	configureMode(Server server, java.lang.String mode)	Configure the server for the quickstart mode.
Resource	getQuickStartWebXml(WebAppContext context)	Get the quickstart-web.xml file as a Resource.
void	postConfigure(WebAppContext context)	Clear down after configuration.
void	preConfigure(WebAppContext context)	Set up for configuration.
protected void	quickStart(WebAppContext context)

Methods inherited from class org.eclipse.jetty.webapp.AbstractConfiguration

abort, addDependencies, addDependencies, addDependents, addDependents, cloneConfigure, deconfigure, destroy, expose, getDependencies, getDependents, getServerClasses, getSystemClasses, hide, isEnabledByDefault, protect, protectAndExpose

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

isAvailable, replaces

Field Detail

__replacedConfigurations

public static final java.util.Set<java.lang.Class<? extends Configuration>> __replacedConfigurations

ORIGIN_ATTRIBUTE

public static final java.lang.String ORIGIN_ATTRIBUTE

See Also:

Constant Field Values

QUICKSTART_WEB_XML

public static final java.lang.String QUICKSTART_WEB_XML

See Also:

Constant Field Values

MODE

public static final java.lang.String MODE

See Also:

Constant Field Values

Constructor Detail

QuickStartConfiguration

public QuickStartConfiguration()

Method Detail

configureMode

public static void configureMode(Server server,
                                 java.lang.String mode)

Configure the server for the quickstart mode.

In practise this means calling server.setDryRun(true) for GENERATE mode

Parameters:

server - The server to configure

mode - The quickstart mode

See Also:

Server.setDryRun(boolean)

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

Overrides:

preConfigure in class AbstractConfiguration

Parameters:

context - The context to configure

Throws:

java.lang.Exception - if unable to pre configure

configure

protected void configure(QuickStartGeneratorConfiguration generator,
                         WebAppContext context)
                  throws java.io.IOException

Throws:

java.io.IOException

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

Overrides:

configure in class AbstractConfiguration

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

Overrides:

postConfigure in class AbstractConfiguration

Parameters:

context - The context to configure

Throws:

java.lang.Exception - if unable to post configure

quickStart

protected void quickStart(WebAppContext context)
                   throws java.lang.Exception

Throws:

java.lang.Exception

getQuickStartWebXml

public Resource getQuickStartWebXml(WebAppContext context)
                             throws java.lang.Exception

Get the quickstart-web.xml file as a Resource.

Parameters:

context - the web app context

Returns:

the Resource for the quickstart-web.xml

Throws:

java.lang.Exception - if unable to find the quickstart xml