Class AbstractContextProvider

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.osgi.AbstractContextProvider

All Implemented Interfaces:

AppProvider, LifeCycle

Direct Known Subclasses:

BundleContextProvider, BundleWebAppProvider

public abstract class AbstractContextProvider
extends AbstractLifeCycle
implements AppProvider

AbstractContextProvider

Base class for DeploymentManager Providers that can deploy ContextHandlers into Jetty that have been discovered via OSGI either as bundles or services.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
AbstractContextProvider(String environment, Server server, ContextFactory contextFactory)

Method Summary

Modifier and Type	Method	Description
ContextHandler	createContextHandler(App app)	Create a ContextHandler for an App
String[]	getConfigurationClasses()	This is equivalent to getting the Deployable.CONFIGURATION_CLASSES property.
String	getDefaultsDescriptor()	Get the defaultsDescriptor.
DeploymentManager	getDeploymentManager()
String	getEnvironmentName()
Map<String,String>	getProperties()
Server	getServer()
String	getTldBundles()
boolean	isDeployable(org.osgi.framework.Bundle bundle)
boolean	isDeployable(org.osgi.framework.ServiceReference service)
boolean	isExtractWars()	Get the extractWars.
boolean	isParentLoaderPriority()	Get the parentLoaderPriority.
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	setDeploymentManager(DeploymentManager deploymentManager)	Set the Deployment Manager
void	setExtractWars(boolean extractWars)	Set the extractWars.
void	setParentLoaderPriority(boolean parentLoaderPriority)	Set the parentLoaderPriority.
void	setTldBundles(String tldBundles)

Methods inherited from class AbstractLifeCycle

addEventListener, doStart, doStop, getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, setEventListeners, start, stop, toString

Methods inherited from class Object

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

Methods inherited from interface LifeCycle

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

Constructor Details

AbstractContextProvider

public AbstractContextProvider(String environment,
 Server server,
 ContextFactory contextFactory)

Method Details

getServer

public Server getServer()

getProperties

public Map<String,String> getProperties()

createContextHandler

public ContextHandler createContextHandler(App app)
                                    throws Exception

Description copied from interface: AppProvider

Create a ContextHandler for an App

Specified by:

createContextHandler in interface AppProvider

Parameters:

app - The App

Returns:

A ContextHandler

Throws:

Exception - if unable to create context

setDeploymentManager

public void setDeploymentManager(DeploymentManager deploymentManager)

Description copied from interface: AppProvider

Set the Deployment Manager

Specified by:

setDeploymentManager in interface AppProvider

Parameters:

deploymentManager - the deployment manager

getEnvironmentName

public String getEnvironmentName()

Specified by:

getEnvironmentName in interface AppProvider

Returns:

The name of the Environment this provider is for.

getDeploymentManager

public DeploymentManager getDeploymentManager()

isExtractWars

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

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

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

public String[] getConfigurationClasses()

This is equivalent to getting the Deployable.CONFIGURATION_CLASSES property.

Returns:

The configuration class names.

setTldBundles

public void setTldBundles(String tldBundles)

Parameters:

tldBundles - Comma separated list of bundles that contain tld jars that should be setup on the context instances created here.

getTldBundles

public String getTldBundles()

Returns:

The list of bundles that contain tld jars that should be setup on the contexts create here.

isDeployable

public boolean isDeployable(org.osgi.framework.Bundle bundle)

isDeployable

public boolean isDeployable(org.osgi.framework.ServiceReference service)