Class QuickStartConfiguration

java.lang.Object

org.eclipse.jetty.ee9.webapp.AbstractConfiguration

org.eclipse.jetty.ee9.quickstart.QuickStartConfiguration

All Implemented Interfaces:

Configuration

public class QuickStartConfiguration
extends AbstractConfiguration

QuickStartConfiguration

Prepare for quickstart generation, or usage.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	QuickStartConfiguration.Mode

Nested classes/interfaces inherited from interface Configuration

Configuration.Wrapper, Configuration.WrapperFunction

Field Summary

Fields

Modifier and Type	Field	Description
static final Set<Class<? extends Configuration>>	__replacedConfigurations
static final String	MODE
static final String	ORIGIN_ATTRIBUTE
static final String	QUICKSTART_WEB_XML

Fields inherited from interface 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, String mode)	Configure the server for the quickstart mode.
void	deconfigure(WebAppContext context)	DeConfigure WebApp.
static Path	getQuickStartWebXml(WebAppContext context)	Get the quickstart-web.xml Path from the webapp (from attributes if present, or built from the context's WebAppContext.getWebInf()).
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 AbstractConfiguration

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

Methods inherited from class Object

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

Methods inherited from interface Configuration

isAvailable, replaces

Field Details

__replacedConfigurations

public static final Set<Class<? extends Configuration>> __replacedConfigurations

ORIGIN_ATTRIBUTE

public static final String ORIGIN_ATTRIBUTE

See Also:

• Constant Field Values

QUICKSTART_WEB_XML

public static final String QUICKSTART_WEB_XML

See Also:

• Constant Field Values

MODE

public static final String MODE

See Also:

• Constant Field Values

Constructor Details

QuickStartConfiguration

public QuickStartConfiguration()

Method Details

configureMode

public static void configureMode(Server server,
 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 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:

Exception - if unable to pre configure

configure

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

Throws:

IOException

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

Overrides:

configure in class AbstractConfiguration

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

Overrides:

postConfigure in class AbstractConfiguration

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

Overrides:

deconfigure in class AbstractConfiguration

Parameters:

context - The context to configure

Throws:

Exception - if unable to deconfigure

quickStart

protected void quickStart(WebAppContext context)
                   throws Exception

Throws:

Exception

getQuickStartWebXml

public static Path getQuickStartWebXml(WebAppContext context)
                                throws IOException

Get the quickstart-web.xml Path from the webapp (from attributes if present, or built from the context's WebAppContext.getWebInf()).

Parameters:

context - the web app context

Returns:

the Path for the quickstart-web.xml

Throws:

IOException - if unable to build the quickstart xml