Package org.eclipse.jetty.deploy

Class DeploymentManager

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.deploy.DeploymentManager

All Implemented Interfaces:

Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

@ManagedObject("Deployment Manager")
public class DeploymentManager
extends ContainerLifeCycle

The Deployment Manager.

Responsibilities:

1. Tracking Apps and their LifeCycle Location
2. Managing AppProviders and the Apps that they provide.
3. Executing AppLifeCycle on App based on current and desired LifeCycle Location.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	DeploymentManager.AppEntry	Represents a single tracked app within the deployment manager.

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.component.Container

Container.InheritedListener, Container.Listener

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

Dumpable.DumpableContainer

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

LifeCycle.Listener

Field Summary

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

FAILED, STARTED, STARTING, STOPPED, STOPPING

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

KEY

Constructor Summary

Constructors

Constructor	Description
DeploymentManager()

Method Summary

Modifier and Type	Method	Description
void	addApp(App app)	Receive an app for processing.
void	addAppProvider(AppProvider provider)
void	addLifeCycleBinding(AppLifeCycle.Binding binding)
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.
App	getAppByOriginId(String originId)
Collection<DeploymentManager.AppEntry>	getAppEntries()
Collection<AppProvider>	getAppProviders()
Collection<App>	getApps()
Collection<App>	getApps(String nodeName)
Collection<App>	getApps(Node node)	Get Set of Apps by Node
List<App>	getAppsWithSameContext(App app)
Object	getContextAttribute(String name)	Get a contextAttribute that will be set for every Context deployed by this provider.
AttributesMap	getContextAttributes()
ContextHandlerCollection	getContexts()
String	getDefaultLifeCycleGoal()
AppLifeCycle	getLifeCycle()
Collection<AppLifeCycle.Binding>	getLifeCycleBindings()
Collection<Node>	getNodes()
Server	getServer()
void	insertLifeCycleNode(String existingFromNodeName, String existingToNodeName, String insertedNodeName)	Convenience method to allow for insertion of nodes into the lifecycle.
boolean	isUseStandardBindings()
void	removeApp(App app)	Remove the app from the tracking of the DeploymentManager
void	removeAppProvider(AppProvider provider)
void	removeContextAttribute(String name)	Remove a contextAttribute that will be set for every Context deployed by this provider.
void	requestAppGoal(String appId, String nodeName)	Move an App through the AppLifeCycle to the desired Node, executing each lifecycle step in the process to reach the desired state.
void	requestAppGoal(App app, String nodeName)	Move an App through the AppLifeCycle to the desired Node, executing each lifecycle step in the process to reach the desired state.
void	scope(XmlConfiguration xmlc, Resource webapp)
void	setAppProviders(Collection<AppProvider> providers)	Set the AppProviders.
void	setContextAttribute(String name, Object value)	Set a contextAttribute that will be set for every Context deployed by this provider.
void	setContextAttributes(AttributesMap contextAttributes)
void	setContexts(ContextHandlerCollection contexts)
void	setDefaultLifeCycleGoal(String defaultLifeCycleState)
void	setLifeCycleBindings(Collection<AppLifeCycle.Binding> bindings)
void	setUseStandardBindings(boolean useStandardBindings)
void	undeployAll()

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

addBean, addBean, addEventListener, addManaged, contains, destroy, dump, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, 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, toString

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.component.Container

getCachedBeans, getEventListeners

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

dumpSelf

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

isDumpable

Constructor Details

DeploymentManager

public DeploymentManager()

Method Details

addApp

public void addApp(App app)

Receive an app for processing. Most commonly used by the various AppProvider implementations.

Parameters:

app - the app

setAppProviders

public void setAppProviders(Collection<AppProvider> providers)

Set the AppProviders. The providers passed are added via ContainerLifeCycle.addBean(Object) so that their lifecycles may be managed as a ContainerLifeCycle.

Parameters:

providers - the app provider list

getAppProviders

public Collection<AppProvider> getAppProviders()

addAppProvider

public void addAppProvider(AppProvider provider)

setLifeCycleBindings

public void setLifeCycleBindings(Collection<AppLifeCycle.Binding> bindings)

getLifeCycleBindings

public Collection<AppLifeCycle.Binding> getLifeCycleBindings()

addLifeCycleBinding

public void addLifeCycleBinding(AppLifeCycle.Binding binding)

insertLifeCycleNode

public void insertLifeCycleNode(String existingFromNodeName,
 String existingToNodeName,
 String insertedNodeName)

Convenience method to allow for insertion of nodes into the lifecycle.

Parameters:

existingFromNodeName - the existing node start

existingToNodeName - the existing node end

insertedNodeName - the new node to create between the existing nodes

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 ContainerLifeCycle

Throws:

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 ContainerLifeCycle

Throws:

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

getAppByOriginId

public App getAppByOriginId(String originId)

getAppEntries

public Collection<DeploymentManager.AppEntry> getAppEntries()

getApps

public Collection<App> getApps()

getApps

public Collection<App> getApps(Node node)

Get Set of Apps by Node

Parameters:

node - the node to look for.

Returns:

the collection of apps for the node

getApps

public Collection<App> getApps(String nodeName)

getAppsWithSameContext

public List<App> getAppsWithSameContext(App app)

getContextAttribute

public Object getContextAttribute(String name)

Get a contextAttribute that will be set for every Context deployed by this provider.

Parameters:

name - context attribute name

Returns:

the context attribute value

getContextAttributes

public AttributesMap getContextAttributes()

getContexts

@ManagedAttribute("Deployed Contexts")
public ContextHandlerCollection getContexts()

getDefaultLifeCycleGoal

public String getDefaultLifeCycleGoal()

getLifeCycle

public AppLifeCycle getLifeCycle()

getServer

public Server getServer()

removeApp

public void removeApp(App app)

Remove the app from the tracking of the DeploymentManager

Parameters:

app - if the app is Unavailable remove it from the deployment manager.

removeAppProvider

public void removeAppProvider(AppProvider provider)

removeContextAttribute

public void removeContextAttribute(String name)

Remove a contextAttribute that will be set for every Context deployed by this provider.

Parameters:

name - the context attribute name

requestAppGoal

public void requestAppGoal(App app,
 String nodeName)

Move an App through the AppLifeCycle to the desired Node, executing each lifecycle step in the process to reach the desired state.

Parameters:

app - the app to move through the process

nodeName - the name of the node to attain

requestAppGoal

@ManagedOperation(value="request the app to be moved to the specified lifecycle node",
                  impact="ACTION")
public void requestAppGoal(@Name("appId")
 String appId,
 @Name("nodeName")
 String nodeName)

Move an App through the AppLifeCycle to the desired Node, executing each lifecycle step in the process to reach the desired state.

Parameters:

appId - the id of the app to move through the process

nodeName - the name of the node to attain

setContextAttribute

public void setContextAttribute(String name,
 Object value)

Set a contextAttribute that will be set for every Context deployed by this provider.

Parameters:

name - the context attribute name

value - the context attribute value

setContextAttributes

public void setContextAttributes(AttributesMap contextAttributes)

setContexts

public void setContexts(ContextHandlerCollection contexts)

setDefaultLifeCycleGoal

public void setDefaultLifeCycleGoal(String defaultLifeCycleState)

undeployAll

public void undeployAll()

isUseStandardBindings

public boolean isUseStandardBindings()

setUseStandardBindings

public void setUseStandardBindings(boolean useStandardBindings)

getNodes

public Collection<Node> getNodes()

scope

public void scope(XmlConfiguration xmlc,
 Resource webapp)
           throws IOException

Throws:

IOException