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:

org.eclipse.jetty.server.Handler, org.eclipse.jetty.server.HandlerContainer, org.eclipse.jetty.util.Attributes, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Graceful, org.eclipse.jetty.util.component.LifeCycle, org.eclipse.jetty.webapp.WebAppClassLoader.Context

public class JettyWebAppContext
extends org.eclipse.jetty.webapp.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

org.eclipse.jetty.webapp.WebAppContext.Context

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

org.eclipse.jetty.servlet.ServletContextHandler.Decorator, org.eclipse.jetty.servlet.ServletContextHandler.JspConfig, org.eclipse.jetty.servlet.ServletContextHandler.JspPropertyGroup, org.eclipse.jetty.servlet.ServletContextHandler.ServletContainerInitializerCaller, org.eclipse.jetty.servlet.ServletContextHandler.TagLib

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

org.eclipse.jetty.server.handler.ContextHandler.AliasCheck, org.eclipse.jetty.server.handler.ContextHandler.ApproveAliases, org.eclipse.jetty.server.handler.ContextHandler.ApproveNonExistentDirectoryAliases, org.eclipse.jetty.server.handler.ContextHandler.ApprovePathPrefixAliases, org.eclipse.jetty.server.handler.ContextHandler.ApproveSameSuffixAliases, org.eclipse.jetty.server.handler.ContextHandler.Availability, org.eclipse.jetty.server.handler.ContextHandler.NoContext

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

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

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

org.eclipse.jetty.util.component.LifeCycle.Listener

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

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Field Summary

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

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

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

_decorators, _defaultSecurityHandlerClass, _jspConfig, _options, _securityHandler, _servletHandler, _sessionHandler, 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, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor and Description
JettyWebAppContext()

Method Summary

Modifier and Type	Method and Description
java.lang.String	addPattern(java.lang.String s, java.lang.String pattern)
void	doStart()
void	doStop()
boolean	getBaseAppFirst()
java.io.File	getClasses()
java.util.List<java.io.File>	getClassPathFiles()
java.lang.String	getContainerIncludeJarPattern()
java.lang.String	getJettyEnvXml()
java.util.List<Overlay>	getOverlays()
org.eclipse.jetty.util.resource.Resource	getResource(java.lang.String uriInContext)
java.util.Set<java.lang.String>	getResourcePaths(java.lang.String path)
java.io.File	getTestClasses()
java.lang.String	getWebInfIncludeJarPattern()
java.util.List<java.io.File>	getWebInfLib()
void	setBaseAppFirst(boolean value)
void	setClasses(java.io.File dir)
void	setContainerIncludeJarPattern(java.lang.String pattern)
void	setJettyEnvXml(java.lang.String jettyEnvXml)
void	setOverlays(java.util.List<Overlay> overlays) Ordered list of wars to overlay on top of the current project.
void	setResourceBases(java.lang.String[] resourceBases) This method is provided as a convenience for jetty maven plugin configuration
void	setTestClasses(java.io.File dir)
void	setWebInfIncludeJarPattern(java.lang.String pattern)
void	setWebInfLib(java.util.List<java.io.File> jars)

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

addEventListener, addOverrideDescriptor, addServerClass, addSystemClass, configure, destroy, getConfigurationClasses, getConfigurations, getCurrentWebAppContext, getDefaultConfigurationClasses, getDefaultsDescriptor, getDefaultServerClasses, getDefaultSystemClasses, getDescriptor, getExtraClasspath, getMetaData, getOverrideDescriptor, getOverrideDescriptors, getPermissions, getResourceAlias, getResourceAliases, getServerClasses, getSystemClasses, getTempDirectory, getUnavailableException, getWar, getWebInf, isAllowDuplicateFragmentNames, isConfigurationDiscovered, isCopyWebDir, isCopyWebInf, isDistributable, isExtractWAR, isLogUrlOnStart, isParentLoaderPriority, isPersistTempDirectory, isServerClass, isSystemClass, isThrowUnavailableOnStartupException, loadConfigurations, 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, startWebapp, toString

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

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

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

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

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

handle, never, 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

dumpThis, getServer

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

addBean, addBean, addBean, addEventListener, contains, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, 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

Constructor Detail

JettyWebAppContext

public JettyWebAppContext()
                   throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

setContainerIncludeJarPattern

public void setContainerIncludeJarPattern(java.lang.String pattern)

getContainerIncludeJarPattern

public java.lang.String getContainerIncludeJarPattern()

getWebInfIncludeJarPattern

public java.lang.String getWebInfIncludeJarPattern()

setWebInfIncludeJarPattern

public void setWebInfIncludeJarPattern(java.lang.String pattern)

getClassPathFiles

public java.util.List<java.io.File> getClassPathFiles()

setJettyEnvXml

public void setJettyEnvXml(java.lang.String jettyEnvXml)

getJettyEnvXml

public java.lang.String getJettyEnvXml()

setClasses

public void setClasses(java.io.File dir)

getClasses

public java.io.File getClasses()

setWebInfLib

public void setWebInfLib(java.util.List<java.io.File> jars)

setTestClasses

public void setTestClasses(java.io.File dir)

getTestClasses

public java.io.File getTestClasses()

setOverlays

public void setOverlays(java.util.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 -

getOverlays

public java.util.List<Overlay> getOverlays()

setBaseAppFirst

public void setBaseAppFirst(boolean value)

getBaseAppFirst

public boolean getBaseAppFirst()

setResourceBases

public void setResourceBases(java.lang.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 java.util.List<java.io.File> getWebInfLib()

doStart

public void doStart()
             throws java.lang.Exception

Overrides:

doStart in class org.eclipse.jetty.webapp.WebAppContext

Throws:

java.lang.Exception

doStop

public void doStop()
            throws java.lang.Exception

Overrides:

doStop in class org.eclipse.jetty.webapp.WebAppContext

Throws:

java.lang.Exception

getResource

public org.eclipse.jetty.util.resource.Resource getResource(java.lang.String uriInContext)
                                                     throws java.net.MalformedURLException

Overrides:

getResource in class org.eclipse.jetty.webapp.WebAppContext

Throws:

java.net.MalformedURLException

getResourcePaths

public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)

Overrides:

getResourcePaths in class org.eclipse.jetty.server.handler.ContextHandler

addPattern

public java.lang.String addPattern(java.lang.String s,
                                   java.lang.String pattern)