Class ContextProvider

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.deploy.providers.ScanningAppProvider

org.eclipse.jetty.deploy.providers.ContextProvider

All Implemented Interfaces:

AppProvider, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

@ManagedObject("Provider for start-up deployment of webapps based on presence in directory")
public class ContextProvider
extends ScanningAppProvider

The webapps directory scanning provider.

This provider scans one or more directories (typically "webapps") for contexts to deploy, which may be:

• A standard WAR file (must end in ".war")
• A directory containing an expanded WAR file
• A directory containing static content
• An XML descriptor in XmlConfiguration format that configures a ContextHandler instance

To avoid double deployments and allow flexibility of the content of the scanned directories, the provider implements some heuristics to ignore some files found in the scans:

• Hidden files (starting with ".") are ignored
• Directories with names ending in ".d" are ignored
• Property files with names ending in ".properties" are not deployed.
• If a directory and a WAR file exist ( eg foo/ and foo.war) then the directory is assumed to be the unpacked WAR and only the WAR is deployed (which may reused the unpacked directory)
• If a directory and a matching XML file exist ( eg foo/ and foo.xml) then the directory is assumed to be an unpacked WAR and only the XML is deployed (which may used the directory in it's configuration)
• If a WAR file and a matching XML exist (eg foo.war and foo.xml) then the WAR is assumed to be configured by the XML and only the XML is deployed.

Only Apps discovered that report App.getEnvironmentName() matching this providers ScanningAppProvider.getEnvironmentName() will be deployed.

For XML configured contexts, the ID map will contain a reference to the Server instance called "Server" and properties for the webapp file such as "jetty.webapp" and directory as "jetty.webapps". The properties will be initialized with:

• The properties set on the application via App.getProperties(); otherwise:
• The properties set on this provider via getProperties()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	ContextProvider.Filter

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
ContextProvider()

Method Summary

Modifier and Type	Method	Description
protected Object	applyXml(Object context, Path xml, String environment, Map<String,String> properties)
ContextHandler	createContextHandler(App app)	Create a ContextHandler for an App
protected ClassLoader	findCoreContextClassLoader(Path path)
String[]	getConfigurationClasses()	This is equivalent to getting the Deployable.CONFIGURATION_CLASSES property.
String	getDefaultsDescriptor()	Get the defaultsDescriptor.
Map<String,String>	getProperties()
protected ContextHandler	initializeContextHandler(Object context, Path path, Map<String,String> properties)
protected void	initializeContextPath(ContextHandler context, Path path)
protected boolean	isDeployable(Path path)
boolean	isExtractWars()	Get the extractWars.
boolean	isParentLoaderPriority()	Get the parentLoaderPriority.
void	loadProperties(Resource resource)
void	loadPropertiesFromPath(Path path)
void	loadPropertiesFromString(String path)
protected void	pathAdded(Path path)
protected void	pathChanged(Path path)
void	setConfigurationClasses(String configurations)	This is equivalent to setting the Deployable.CONFIGURATION_CLASSES property.
void	setConfigurationClasses(String[] configurations)	This is equivalent to setting the Deployable.CONFIGURATION_CLASSES property.
void	setDefaultsDescriptor(String defaultsDescriptor)	Set the defaultsDescriptor.
void	setExtractWars(boolean extractWars)	Set the extractWars.
void	setParentLoaderPriority(boolean parentLoaderPriority)	Set the parentLoaderPriority.

Methods inherited from class ScanningAppProvider

addScannerListener, createApp, doStart, doStop, exists, getDeployedApps, getDeploymentManager, getEnvironmentName, getMonitoredDirName, getMonitoredDirResource, getMonitoredResources, getScanInterval, isDeferInitialScan, isUseRealPaths, pathRemoved, scan, setDeferInitialScan, setDeploymentManager, setEnvironmentName, setFilenameFilter, setMonitoredDirectories, setMonitoredDirName, setMonitoredDirResource, setMonitoredResources, setScanInterval, setUseRealPaths, toString

Methods inherited from class ContainerLifeCycle

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

Methods inherited from class AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop

Methods inherited from class Object

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

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface LifeCycle

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

Constructor Details

ContextProvider

public ContextProvider()

Method Details

getProperties

public Map<String,String> getProperties()

loadProperties

public void loadProperties(Resource resource)
                    throws IOException

Throws:

IOException

loadPropertiesFromPath

public void loadPropertiesFromPath(Path path)
                            throws IOException

Throws:

IOException

loadPropertiesFromString

public void loadPropertiesFromString(String path)
                              throws IOException

Throws:

IOException

isExtractWars

@ManagedAttribute("extract war files")
public boolean isExtractWars()

Get the extractWars. This is equivalent to getting the Deployable.EXTRACT_WARS property.

Returns:

the extractWars

setExtractWars

public void setExtractWars(boolean extractWars)

Set the extractWars. This is equivalent to setting the Deployable.EXTRACT_WARS property.

Parameters:

extractWars - the extractWars to set

isParentLoaderPriority

@ManagedAttribute("parent classloader has priority")
public boolean isParentLoaderPriority()

Get the parentLoaderPriority. This is equivalent to getting the Deployable.PARENT_LOADER_PRIORITY property.

Returns:

the parentLoaderPriority

setParentLoaderPriority

public void setParentLoaderPriority(boolean parentLoaderPriority)

Set the parentLoaderPriority. This is equivalent to setting the Deployable.PARENT_LOADER_PRIORITY property.

Parameters:

parentLoaderPriority - the parentLoaderPriority to set

getDefaultsDescriptor

@ManagedAttribute("default descriptor for webapps")
public String getDefaultsDescriptor()

Get the defaultsDescriptor. This is equivalent to getting the Deployable.DEFAULTS_DESCRIPTOR property.

Returns:

the defaultsDescriptor

setDefaultsDescriptor

public void setDefaultsDescriptor(String defaultsDescriptor)

Set the defaultsDescriptor. This is equivalent to setting the Deployable.DEFAULTS_DESCRIPTOR property.

Parameters:

defaultsDescriptor - the defaultsDescriptor to set

setConfigurationClasses

public void setConfigurationClasses(String configurations)

This is equivalent to setting the Deployable.CONFIGURATION_CLASSES property.

Parameters:

configurations - The configuration class names as a comma separated list

setConfigurationClasses

public void setConfigurationClasses(String[] configurations)

This is equivalent to setting the Deployable.CONFIGURATION_CLASSES property.

Parameters:

configurations - The configuration class names.

getConfigurationClasses

@ManagedAttribute("configuration classes for webapps to be processed through")
public String[] getConfigurationClasses()

This is equivalent to getting the Deployable.CONFIGURATION_CLASSES property.

Returns:

The configuration class names.

initializeContextHandler

protected ContextHandler initializeContextHandler(Object context,
 Path path,
 Map<String,String> properties)

createContextHandler

public ContextHandler createContextHandler(App app)
                                    throws Exception

Description copied from interface: AppProvider

Create a ContextHandler for an App

Parameters:

app - The App

Returns:

A ContextHandler

Throws:

Exception - if unable to create context

applyXml

protected Object applyXml(Object context,
 Path xml,
 String environment,
 Map<String,String> properties)
                   throws Exception

Throws:

Exception

findCoreContextClassLoader

protected ClassLoader findCoreContextClassLoader(Path path)
                                          throws IOException

Throws:

IOException

initializeContextPath

protected void initializeContextPath(ContextHandler context,
 Path path)

isDeployable

protected boolean isDeployable(Path path)

pathAdded

protected void pathAdded(Path path)
                  throws Exception

Overrides:

pathAdded in class ScanningAppProvider

Throws:

Exception

pathChanged

protected void pathChanged(Path path)
                    throws Exception

Overrides:

pathChanged in class ScanningAppProvider

Throws:

Exception