org.eclipse.jetty.maven.plugin

Class JettyWebAppContext

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.handler.ScopedHandler

org.eclipse.jetty.server.handler.ContextHandler

org.eclipse.jetty.servlet.ServletContextHandler

org.eclipse.jetty.webapp.WebAppContext

org.eclipse.jetty.maven.plugin.JettyWebAppContext

All Implemented Interfaces:

Handler, HandlerContainer, Attributes, Container, Destroyable, Dumpable, Graceful, LifeCycle, WebAppClassLoader.Context

public class JettyWebAppContext
extends WebAppContext

JettyWebAppContext Extends the WebAppContext to specialize for the maven environment. We pass in the list of files that should form the classpath for the webapp when executing in the plugin, and any jetty-env.xml file that may have been configured.

Nested Class Summary

Nested classes/interfaces inherited from class org.eclipse.jetty.webapp.WebAppContext

WebAppContext.Context

Nested classes/interfaces inherited from class org.eclipse.jetty.servlet.ServletContextHandler

ServletContextHandler.Decorator, ServletContextHandler.JspConfig, ServletContextHandler.JspPropertyGroup, ServletContextHandler.ServletContainerInitializerCaller, ServletContextHandler.TagLib

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.ContextHandler

ContextHandler.AliasCheck, ContextHandler.ApproveAliases, ContextHandler.ApproveNonExistentDirectoryAliases, ContextHandler.Availability, ContextHandler.ContextScopeListener, ContextHandler.StaticContext

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

Container.InheritedListener, Container.Listener

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_CONFIGURATION_CLASSES

Fields inherited from class org.eclipse.jetty.webapp.WebAppContext

__dftServerClasses, __dftSystemClasses, __jvmlib, BASETEMPDIR, ERROR_PAGE, SERVER_SRV_CLASSES, SERVER_SYS_CLASSES, TEMPDIR, WEB_DEFAULTS_XML

Fields inherited from class org.eclipse.jetty.servlet.ServletContextHandler

_defaultSecurityHandlerClass, _gzipHandler, _jspConfig, _objFactory, _options, _securityHandler, _servletHandler, _sessionHandler, GZIP, NO_SECURITY, NO_SESSIONS, SECURITY, SESSIONS

Fields inherited from class org.eclipse.jetty.server.handler.ContextHandler

_scontext, DEFAULT_LISTENER_TYPE_INDEX, EXTENDED_LISTENER_TYPE_INDEX, MANAGED_ATTRIBUTES, SERVLET_LISTENER_TYPES, SERVLET_MAJOR_VERSION, SERVLET_MINOR_VERSION

Fields inherited from class org.eclipse.jetty.server.handler.ScopedHandler

_nextScope, _outerScope

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOP_ON_FAILURE, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
JettyWebAppContext()

Method Summary

Modifier and Type	Method and Description
String	addPattern(String s, String pattern)
void	doStart() Starts the managed lifecycle beans in the order they were added.
void	doStop() Stops the managed lifecycle beans in the reverse order they were added.
boolean	getBaseAppFirst()
File	getClasses()
List<File>	getClassPathFiles()
String	getContainerIncludeJarPattern()
String	getJettyEnvXml()
String	getOriginAttribute()
List<Overlay>	getOverlays()
Resource	getQuickStartWebDescriptor()
Resource	getResource(String uriInContext)
Set<String>	getResourcePaths(String path)
File	getTestClasses()
String	getWebInfIncludeJarPattern()
List<File>	getWebInfLib()
void	initCDI()
boolean	isGenerateOrigin()
boolean	isGenerateQuickStart()
protected void	loadConfigurations()
void	setBaseAppFirst(boolean value)
void	setClasses(File dir)
void	setContainerIncludeJarPattern(String pattern)
void	setGenerateOrigin(boolean generateOrigin)
void	setGenerateQuickStart(boolean quickStart)
void	setJettyEnvXml(String jettyEnvXml)
void	setOriginAttribute(String originAttribute)
void	setOverlays(List<Overlay> overlays) Ordered list of wars to overlay on top of the current project.
protected void	setQuickStartWebDescriptor(Resource quickStartWebXml)
void	setQuickStartWebDescriptor(String quickStartWebXml)
void	setResourceBases(String[] resourceBases) This method is provided as a convenience for jetty maven plugin configuration
void	setTestClasses(File dir)
void	setWebInfIncludeJarPattern(String pattern)
void	setWebInfLib(List<File> jars)
protected void	startWebapp()
protected void	stopWebapp()

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

addEventListener, addOverrideDescriptor, addServerClass, addServerClasses, addSystemClass, addSystemClasses, configure, destroy, dump, getConfigurationClasses, getConfigurations, getCurrentWebAppContext, getDefaultConfigurationClasses, getDefaultsDescriptor, getDefaultServerClasses, getDefaultSystemClasses, getDescriptor, getExtraClasspath, getMetaData, getOverrideDescriptor, getOverrideDescriptors, getPermissions, getResourceAlias, getResourceAliases, getServerClasses, getServerClasspathPattern, getSystemClasses, getSystemClasspathPattern, getTempDirectory, getUnavailableException, getWar, getWebInf, isAllowDuplicateFragmentNames, isConfigurationDiscovered, isCopyWebDir, isCopyWebInf, isDistributable, isExtractWAR, isLogUrlOnStart, isParentLoaderPriority, isPersistTempDirectory, isServerClass, isServerClass, isServerResource, isSystemClass, isSystemClass, isSystemResource, isThrowUnavailableOnStartupException, loadServerClasses, loadSystemClasses, postConfigure, preConfigure, prependServerClass, prependSystemClass, removeEventListener, removeResourceAlias, setAllowDuplicateFragmentNames, setClassLoader, setConfigurationClasses, setConfigurationClasses, setConfigurationDiscovered, setConfigurations, setContextWhiteList, setCopyWebDir, setCopyWebInf, setDefaultsDescriptor, setDescriptor, setDisplayName, setDistributable, setEventListeners, setExtraClasspath, setExtractWAR, setLogUrlOnStart, setOverrideDescriptor, setOverrideDescriptors, setParentLoaderPriority, setPermissions, setPersistTempDirectory, setResourceAlias, setResourceAliases, setServer, setServerClasses, setServletSecurity, setSystemClasses, setTempDirectory, setThrowUnavailableOnStartupException, setWar, startContext, stopContext, toString

Methods inherited from class org.eclipse.jetty.servlet.ServletContextHandler

addDecorator, addFilter, addFilter, addFilter, addRoles, addServlet, addServlet, addServlet, callContextDestroyed, callContextInitialized, dynamicHolderAdded, getDecorators, getDefaultSecurityHandlerClass, getGzipHandler, getObjectFactory, getSecurityHandler, getServletHandler, getSessionHandler, insertHandler, newSecurityHandler, newServletHandler, newSessionHandler, setDecorators, setDefaultSecurityHandlerClass, setGzipHandler, setHandler, setSecurityHandler, setServletHandler, setSessionHandler

Methods inherited from class org.eclipse.jetty.server.handler.ContextHandler

addAliasCheck, addLocaleEncoding, addProgrammaticListener, addVirtualHosts, checkAlias, checkContext, checkContextPath, checkVirtualHost, clearAliasChecks, clearAttributes, doHandle, doScope, enterScope, exitScope, getAliasChecks, getAllowNullPathInfo, getAttribute, getAttributeNames, getAttributes, getBaseResource, getClassLoader, getClassPath, getContextHandler, getContextPath, getContextPathEncoded, getCurrentContext, getDisplayName, getErrorHandler, getEventListeners, getInitParameter, getInitParameterNames, getInitParams, getLocaleEncoding, getLocaleEncoding, getLocaleEncodings, getLogger, getMaxFormContentSize, getMaxFormKeys, getMimeTypes, getProtectedTargets, getResourceBase, getServerInfo, getServletContext, getVirtualHosts, getWelcomeFiles, handle, handle, isAvailable, isCompactPath, isProgrammaticListener, isProtectedTarget, isShutdown, isUsingSecurityManager, loadClass, newResource, newResource, newResource, removeAttribute, removeVirtualHosts, requestDestroyed, requestInitialized, setAliasChecks, setAllowNullPathInfo, setAttribute, setAttributes, setAvailable, setBaseResource, setCompactPath, setContextPath, setErrorHandler, setInitParameter, setLogger, setManagedAttribute, setMaxFormContentSize, setMaxFormKeys, setMimeTypes, setProtectedTargets, setResourceBase, setServerInfo, setUsingSecurityManager, setVirtualHosts, setWelcomeFiles, shutdown

Methods inherited from class org.eclipse.jetty.server.handler.ScopedHandler

handle, nextHandle, nextScope

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

expandChildren, getHandler, getHandlers

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, dumpThis, getServer

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.webapp.WebAppClassLoader.Context

newResource

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop

Field Detail

DEFAULT_CONFIGURATION_CLASSES

public static final String[] DEFAULT_CONFIGURATION_CLASSES

Constructor Detail

JettyWebAppContext

public JettyWebAppContext()
                   throws Exception

Throws:

Exception

Method Detail

setContainerIncludeJarPattern

public void setContainerIncludeJarPattern(String pattern)

getContainerIncludeJarPattern

public String getContainerIncludeJarPattern()

getWebInfIncludeJarPattern

public String getWebInfIncludeJarPattern()

setWebInfIncludeJarPattern

public void setWebInfIncludeJarPattern(String pattern)

getClassPathFiles

public List<File> getClassPathFiles()

setJettyEnvXml

public void setJettyEnvXml(String jettyEnvXml)

getJettyEnvXml

public String getJettyEnvXml()

setClasses

public void setClasses(File dir)

getClasses

public File getClasses()

setWebInfLib

public void setWebInfLib(List<File> jars)

setTestClasses

public void setTestClasses(File dir)

getTestClasses

public File getTestClasses()

setOverlays

public void setOverlays(List<Overlay> overlays)

Ordered list of wars to overlay on top of the current project. The list may contain an overlay that represents the current project.

Parameters:

overlays - the list of overlays

getOriginAttribute

public String getOriginAttribute()

Returns:

the originAttribute

setOriginAttribute

public void setOriginAttribute(String originAttribute)

Parameters:

originAttribute - the originAttribute to set

isGenerateOrigin

public boolean isGenerateOrigin()

Returns:

the generateOrigin

setGenerateOrigin

public void setGenerateOrigin(boolean generateOrigin)

Parameters:

generateOrigin - the generateOrigin to set

getOverlays

public List<Overlay> getOverlays()

setBaseAppFirst

public void setBaseAppFirst(boolean value)

getBaseAppFirst

public boolean getBaseAppFirst()

setQuickStartWebDescriptor

public void setQuickStartWebDescriptor(String quickStartWebXml)
                                throws Exception

Throws:

Exception

setQuickStartWebDescriptor

protected void setQuickStartWebDescriptor(Resource quickStartWebXml)

getQuickStartWebDescriptor

public Resource getQuickStartWebDescriptor()

setResourceBases

public void setResourceBases(String[] resourceBases)

This method is provided as a convenience for jetty maven plugin configuration

Parameters:

resourceBases - Array of resources strings to set as a ResourceCollection. Each resource string may be a comma separated list of resources

See Also:

Resource

getWebInfLib

public List<File> getWebInfLib()

setGenerateQuickStart

public void setGenerateQuickStart(boolean quickStart)

isGenerateQuickStart

public boolean isGenerateQuickStart()

startWebapp

protected void startWebapp()
                    throws Exception

Overrides:

startWebapp in class WebAppContext

Throws:

Exception

stopWebapp

protected void stopWebapp()
                   throws Exception

Overrides:

stopWebapp in class WebAppContext

Throws:

Exception

doStart

public void doStart()
             throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class WebAppContext

Throws:

Exception

See Also:

AbstractHandler.doStart()

loadConfigurations

protected void loadConfigurations()
                           throws Exception

Overrides:

loadConfigurations in class WebAppContext

Throws:

Exception

doStop

public void doStop()
            throws Exception

Description copied from class: ContainerLifeCycle

Stops the managed lifecycle beans in the reverse order they were added.

Overrides:

doStop in class WebAppContext

Throws:

Exception

See Also:

ContextHandler.doStop()

getResource

public Resource getResource(String uriInContext)
                     throws MalformedURLException

Overrides:

getResource in class WebAppContext

Throws:

MalformedURLException

getResourcePaths

public Set<String> getResourcePaths(String path)

Overrides:

getResourcePaths in class ContextHandler

addPattern

public String addPattern(String s,
                         String pattern)

initCDI

public void initCDI()