Package org.eclipse.jetty.coreapp

Class CoreAppContext

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.Handler.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.ContextHandler

org.eclipse.jetty.coreapp.CoreAppContext

All Implemented Interfaces:

AliasCheck, Deployable, Handler, Handler.Container, Handler.Singleton, Request.Handler, Attributes, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable

public class CoreAppContext
extends ContextHandler
implements Deployable

A Core WebApp.

The Base Resource represents the metadata base that defines this CoreContextHandler.

The metadata base can be a directory on disk, or an archive file (supporting jar, zip, and war) with the following contents.

• <metadata>/lib/*.jar - the jar files for the classloader of this webapp
• <metadata>/classes/ - the raw class files for this webapp
• <metadata>/static/ - the static content to serve for this webapp

Note: if using the archive file as your metadata base, the existence of <metadata>/lib/*.jar files means the archive will be unpacked into the temp directory defined by this core webapp.

Nested Class Summary

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

ContextHandler.Availability, ContextHandler.ContextScopeListener, ContextHandler.ScopedContext

Nested classes/interfaces inherited from class org.eclipse.jetty.server.Handler.Abstract

Handler.Abstract.NonBlocking

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

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

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

Attributes.Layer, Attributes.Lazy, Attributes.Mapped, Attributes.Synthetic, Attributes.Wrapper

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

Container.InheritedListener, Container.Listener

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

Dumpable.DumpableContainer, Dumpable.DumpAppendable

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Handler

Handler.Abstract, Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

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

LifeCycle.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request.Handler

Request.Handler.AbortException

Field Summary

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

CROSS_CONTEXT_ATTRIBUTE, MANAGED_ATTRIBUTES

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.Attributes

NULL

Fields inherited from interface org.eclipse.jetty.server.Deployable

ATTRIBUTE_PREFIX, BASE_RESOURCE, CONFIGURATION_CLASSES, CONTAINER_SCAN_JARS, CONTEXT_HANDLER_CLASS, CONTEXT_PATH, DEFAULT_CONTEXT_PATH, DEFAULTS_DESCRIPTOR, DIR_ALLOWED, ENVIRONMENT, ENVIRONMENT_XML, EXTRACT_WARS, MAIN_PATH, OTHER_PATHS, PARENT_LOADER_PRIORITY, SCI_EXCLUSION_PATTERN, SCI_ORDER, TEMP_DIR, WAR, WEBINF_SCAN_JARS

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

LEGEND

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
CoreAppContext()
CoreAppContext(String contextPath)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
List<Resource>	getExtraClassPath()
ResourceFactory	getResourceFactory()
protected void	initializeDefault(String keyName, Object value)	Called for each attribute key encountered during the Deployable.initializeDefaults(Attributes) processing.
protected void	initializeDefaultsComplete()	Called after all attributes are processed via Deployable.initializeDefaults(Attributes), to allow any kind of extra processing of the configuration.
protected void	initWebApp()
void	setBaseResource(Resource baseResource)	Set the base resource to serve content from for this context, which must exist and be readable when the context is started.
void	setExtraClassPath(String extraClasspath)	Set the Extra class path via delimited String.
void	setExtraClassPath(String... extraClasspath)	Set Extra class path entries.
void	setExtraClassPath(List<Resource> extraClasspath)	Set Extra class path entries.
protected Resource	unpack(Resource dir)

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

addAliasCheck, addEncodings, addEventListener, addMimeTypes, addVirtualHosts, checkAlias, checkVirtualHost, cleanupAfterStop, clearAliasChecks, clearAttributes, createTempDirectory, destroy, dump, enterScope, exitScope, getAliasChecks, getAllowNullPathInContext, getAttribute, getAttributeNameSet, getBaseName, getBaseResource, getCanonicalNameForTmpDir, getClassLoader, getClassPath, getContext, getContextHandler, getContextPath, getCrossContextHandler, getCurrentContext, getCurrentContext, getCurrentContextHandler, getDisplayName, getErrorHandler, getMimeTypes, getProtectedTargets, getResourceForTempDirName, getTempDirectory, getVirtualHosts, handle, handleByContextHandler, handleMovedPermanently, handleUnavailable, initializeDefaults, isAvailable, isContextPathDefault, isCrossContextDispatchSupported, isProtectedTarget, isTempDirectoryPersistent, makeTempDirectory, newContext, notifyEnterScope, notifyExitScope, removeAttribute, removeEventListener, removeVirtualHosts, setAliasChecks, setAllowNullPathInContext, setAttribute, setAvailable, setBaseResourceAsPath, setBaseResourceAsString, setClassLoader, setContextPath, setCrossContextDispatchSupported, setDefaultContextPath, setDisplayName, setEncodings, setErrorHandler, setMimeTypes, setProtectedTargets, setServer, setTempDirectory, setTempDirectoryPersistent, setVirtualHosts, toString, wrapRequest, wrapResponse

Methods inherited from class org.eclipse.jetty.server.Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class org.eclipse.jetty.server.Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic

Methods inherited from class org.eclipse.jetty.server.Handler.Abstract

getServer

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

addBean, addBean, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

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

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, 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.util.Attributes

asAttributeMap, equals, hashCode

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

getCachedBeans, getEventListeners

Methods inherited from interface org.eclipse.jetty.server.Deployable

initializeDefaults

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

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

Methods inherited from interface org.eclipse.jetty.server.Handler

getServer

Methods inherited from interface org.eclipse.jetty.server.Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface org.eclipse.jetty.server.Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

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

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

Constructor Details

CoreAppContext

public CoreAppContext()

CoreAppContext

public CoreAppContext(String contextPath)

Method Details

getExtraClassPath

@ManagedAttribute(value="extra classpath for context classloader",
                  readonly=true)
public List<Resource> getExtraClassPath()

Returns:

List of Resources that each will represent a new classpath entry

initializeDefault

protected void initializeDefault(String keyName,
 Object value)

Description copied from class: ContextHandler

Called for each attribute key encountered during the Deployable.initializeDefaults(Attributes) processing.

Overrides:

initializeDefault in class ContextHandler

Parameters:

keyName - the key name

value - the value

initializeDefaultsComplete

protected void initializeDefaultsComplete()

Description copied from class: ContextHandler

Called after all attributes are processed via Deployable.initializeDefaults(Attributes), to allow any kind of extra processing of the configuration.

Overrides:

initializeDefaultsComplete in class ContextHandler

setExtraClassPath

public void setExtraClassPath(String extraClasspath)

Set the Extra class path via delimited String.

Parameters:

extraClasspath - delimited path of filenames or URLs pointing to directories or jar files. (see ResourceFactory.split(String) for behavior.)

See Also:

• setExtraClassPath(List)
• ResourceFactory.split(String)

setExtraClassPath

public void setExtraClassPath(String... extraClasspath)

Set Extra class path entries.

Parameters:

extraClasspath - the entries to add

See Also:

• setExtraClassPath(List)

setExtraClassPath

public void setExtraClassPath(List<Resource> extraClasspath)

Set Extra class path entries.

Parameters:

extraClasspath - the entries to add

See Also:

• setExtraClassPath(List)

getResourceFactory

public ResourceFactory getResourceFactory()

setBaseResource

public void setBaseResource(Resource baseResource)

Description copied from class: ContextHandler

Set the base resource to serve content from for this context, which must exist and be readable when the context is started.

Overrides:

setBaseResource in class ContextHandler

Parameters:

baseResource - The base resource for the context.

unpack

protected Resource unpack(Resource dir)
                   throws IOException

Throws:

IOException

initWebApp

protected void initWebApp()
                   throws IOException

Throws:

IOException

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

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

Overrides:

doStart in class ContextHandler

Throws:

AbstractLifeCycle.StopException - If thrown, the lifecycle will immediately be stopped.

Exception - If there was a problem starting. Will cause a transition to FAILED state

doStop

protected 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 ContextHandler

Throws:

Exception - If there was a problem stopping. Will cause a transition to FAILED state