Class QuickStartDescriptorGenerator

java.lang.Object

org.eclipse.jetty.quickstart.QuickStartDescriptorGenerator

public class QuickStartDescriptorGenerator
extends Object

QuickStartDescriptorGenerator

Generate an effective web.xml from a WebAppContext, including all components from web.xml, web-fragment.xmls annotations etc.

If generating quickstart for a different java platform than the current running platform, then the org.eclipse.jetty.annotations.javaTargetPlatform attribute should be set on the Context with the platform number of the target JVM (eg 8).

Field Summary

Fields

Modifier and Type	Field	Description
protected int	_count
protected String	_extraXML
protected boolean	_generateOrigin
protected String	_originAttribute
protected WebAppContext	_webApp
static final String	DEFAULT_ORIGIN_ATTRIBUTE_NAME
static final String	DEFAULT_QUICKSTART_DESCRIPTOR_NAME
private static final Logger	LOG
static final String	ORIGIN

Constructor Summary

Constructors

Constructor	Description
QuickStartDescriptorGenerator(WebAppContext w, String extraXML, String originAttribute, boolean generateOrigin)

Method Summary

Modifier and Type	Method	Description
private void	addContextParamFromAttribute(XmlAppendable out, String attribute)	Turn attribute into context-param to store.
private void	addContextParamFromAttribute(XmlAppendable out, String attribute, AttributeNormalizer normalizer)	Turn context attribute into context-param to store.
void	generateQuickStartWebXml(OutputStream stream)	Perform the generation of the xml file
Map<String,String>	origin(MetaData md, String name)	Find the origin (web.xml, fragment, annotation etc) of a web artifact from MetaData.
private void	outholder(XmlAppendable out, MetaData md, FilterHolder holder)	Generate xml for a Holder (Filter/Servlet)
private void	outholder(XmlAppendable out, MetaData md, ServletHolder holder)

Methods inherited from class Object

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

Field Details

LOG

private static final Logger LOG

ORIGIN

public static final String ORIGIN

See Also:

• Constant Field Values

DEFAULT_QUICKSTART_DESCRIPTOR_NAME

public static final String DEFAULT_QUICKSTART_DESCRIPTOR_NAME

See Also:

• Constant Field Values

DEFAULT_ORIGIN_ATTRIBUTE_NAME

public static final String DEFAULT_ORIGIN_ATTRIBUTE_NAME

See Also:

• Constant Field Values

_webApp

protected WebAppContext _webApp

_extraXML

protected String _extraXML

_originAttribute

protected String _originAttribute

_generateOrigin

protected boolean _generateOrigin

_count

protected int _count

Constructor Details

QuickStartDescriptorGenerator

public QuickStartDescriptorGenerator(WebAppContext w,
 String extraXML,
 String originAttribute,
 boolean generateOrigin)

Parameters:

w - the source WebAppContext

extraXML - any extra xml snippet to append

originAttribute - param value to use for the context param origin attribute

generateOrigin - true to generate the origin attribute

Method Details

generateQuickStartWebXml

public void generateQuickStartWebXml(OutputStream stream)
                              throws FileNotFoundException,
IOException

Perform the generation of the xml file

Parameters:

stream - the stream to generate the quickstart-web.xml to

Throws:

IOException - if unable to generate the quickstart-web.xml

FileNotFoundException - if unable to find the file

addContextParamFromAttribute

private void addContextParamFromAttribute(XmlAppendable out,
 String attribute)
                                   throws IOException

Turn attribute into context-param to store.

Throws:

IOException

addContextParamFromAttribute

private void addContextParamFromAttribute(XmlAppendable out,
 String attribute,
 AttributeNormalizer normalizer)
                                   throws IOException

Turn context attribute into context-param to store.

Throws:

IOException

outholder

private void outholder(XmlAppendable out,
 MetaData md,
 FilterHolder holder)
                throws IOException

Generate xml for a Holder (Filter/Servlet)

Throws:

IOException

outholder

private void outholder(XmlAppendable out,
 MetaData md,
 ServletHolder holder)
                throws IOException

Throws:

IOException

origin

public Map<String,String> origin(MetaData md,
 String name)

Find the origin (web.xml, fragment, annotation etc) of a web artifact from MetaData.

Parameters:

md - the metadata

name - the name

Returns:

the origin map