Module org.eclipse.jetty.deploy

Package org.eclipse.jetty.deploy

Class App

java.lang.Object

org.eclipse.jetty.deploy.App

public class App
extends Object

The information about an App that is managed by the DeploymentManager.

Constructor Summary

Constructors

Constructor	Description
App(DeploymentManager manager, AppProvider provider, Path path)	Create an App with specified Origin ID and archivePath

Method Summary

Modifier and Type	Method	Description
AppProvider	getAppProvider()
org.eclipse.jetty.server.handler.ContextHandler	getContextHandler()	Get ContextHandler for the App.
String	getContextPath()	The context path App relating to how it is installed on the jetty server side.
DeploymentManager	getDeploymentManager()
String	getEnvironmentName()	Get the environment name.
Path	getPath()	The origin of this App as specified by the AppProvider
Map<String,String>	getProperties()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

App

public App(DeploymentManager manager,
 AppProvider provider,
 Path path)

Create an App with specified Origin ID and archivePath

Any properties file that exists with the same FileID.getBasename(Path) as the filename passed will be used to initialize the properties returned by getProperties().

Parameters:

manager - the deployment manager

provider - the app provider

path - the path to the application directory, war file or XML descriptor

See Also:

• getContextPath()

Method Details

getDeploymentManager

public DeploymentManager getDeploymentManager()

Returns:

The deployment manager

getAppProvider

public AppProvider getAppProvider()

Returns:

The AppProvider

getProperties

public Map<String,String> getProperties()

getContextHandler

public org.eclipse.jetty.server.handler.ContextHandler getContextHandler()
                                                                  throws Exception

Get ContextHandler for the App. Create it if needed.

Returns:

the ContextHandler to use for the App when fully started. (Portions of which might be ignored when App is not yet AppLifeCycle.DEPLOYED or AppLifeCycle.STARTED)

Throws:

Exception - if unable to get the context handler

getContextPath

public String getContextPath()

The context path App relating to how it is installed on the jetty server side.

Returns:

the contextPath for the App

getEnvironmentName

public String getEnvironmentName()

Get the environment name.

Returns:

The Environment name for the application if set with the Deployable.ENVIRONMENT property, else null.

getPath

public Path getPath()

The origin of this App as specified by the AppProvider

Returns:

String representing the origin of this app.

toString

public String toString()

Overrides:

toString in class Object