org.codehaus.cargo.container.jetty.internal
Class AbstractJettyEmbeddedLocalDeployer

java.lang.Object
  org.codehaus.cargo.util.log.LoggedObject
      org.codehaus.cargo.container.spi.deployer.AbstractDeployer
          org.codehaus.cargo.container.spi.deployer.AbstractLocalDeployer
              org.codehaus.cargo.container.spi.deployer.AbstractEmbeddedLocalDeployer
                  org.codehaus.cargo.container.jetty.internal.AbstractJettyEmbeddedLocalDeployer

All Implemented Interfaces:

Deployer, Loggable

Direct Known Subclasses:

Jetty4xEmbeddedLocalDeployer, Jetty5xEmbeddedLocalDeployer, Jetty6xEmbeddedLocalDeployer, Jetty7xEmbeddedLocalDeployer

public abstract class AbstractJettyEmbeddedLocalDeployer
extends AbstractEmbeddedLocalDeployer

Base class for all Jetty deployers.

Version:

$Id: AbstractJettyEmbeddedLocalDeployer.java 1264 2007-01-11 14:09:07Z janb $

Constructor Summary

AbstractJettyEmbeddedLocalDeployer(EmbeddedLocalContainer container)

Method Summary

protected static void	addDeployedWebAppContext(String context, Object deployedWebApp) Add a new entry to the context path:deployable map.
void	deploy(Deployable deployable) Deploy a Deployable to the running container and make it available for requests.
abstract Object	deployWebApp(Deployable deployable) Implement to perform the work of the deploy.
static String	getContext(Deployable deployable) Get the context path for the webapp.
Boolean	getCopyWebApp()
protected static Object	getDeployedWebAppContext(Deployable deployable) Get the deployable that matches the context path.
Boolean	getExtractWar()
Boolean	getParentLoaderPriority()
DeployerType	getType()
String[]	getVirtualHosts()
protected static void	removeDeployedWebAppContext(String context) Take a map entry away using the key.
void	setCopyWebApp(Boolean copy) copy webapp.
void	setExtractWar(Boolean extract) If true, all wars deployed by this deployer will be extracted before being deployed.
void	setParentLoaderPriority(Boolean java2compliant) This is called java2classloadercompliance setting in jetty5 and the parentloaderpriority in jetty6.
void	setVirtualHosts(String[] hosts) Set a list of virtual hosts corresponding to the webapps deployed via this deployer.
void	undeploy(Deployable deployable) Undeploy a Deployable from the running container.
abstract void	undeployWebApp(Deployable deployable) Implement to perform the work of the undeploy.

Methods inherited from class org.codehaus.cargo.container.spi.deployer.AbstractLocalDeployer

getContainer, getFileHandler, setFileHandler

Methods inherited from class org.codehaus.cargo.container.spi.deployer.AbstractDeployer

deploy, deploy, redeploy, start, stop, undeploy

Methods inherited from class org.codehaus.cargo.util.log.LoggedObject

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codehaus.cargo.util.log.Loggable

getLogger, setLogger

Constructor Detail

AbstractJettyEmbeddedLocalDeployer

public AbstractJettyEmbeddedLocalDeployer(EmbeddedLocalContainer container)

See Also:

AbstractEmbeddedLocalDeployer.AbstractEmbeddedLocalDeployer(org.codehaus.cargo.container.EmbeddedLocalContainer)

Method Detail

deployWebApp

public abstract Object deployWebApp(Deployable deployable)

Implement to perform the work of the deploy.

Parameters:

deployable - the deployable

Returns:

the webapp object that was deployed

undeployWebApp

public abstract void undeployWebApp(Deployable deployable)

Implement to perform the work of the undeploy.

Parameters:

deployable - the webapp to undeploy

deploy

public void deploy(Deployable deployable)

Deploy a Deployable to the running container and make it available for requests.

Specified by:

deploy in interface Deployer

Overrides:

deploy in class AbstractDeployer

Parameters:

deployable - the Deployable to deploy

See Also:

Deployer.deploy(org.codehaus.cargo.container.deployable.Deployable)

undeploy

public void undeploy(Deployable deployable)

Undeploy a Deployable from the running container. The service becomes unavailable for requests.

Specified by:

undeploy in interface Deployer

Overrides:

undeploy in class AbstractDeployer

Parameters:

deployable - the Deployable to undeploy

See Also:

Deployer.undeploy(org.codehaus.cargo.container.deployable.Deployable)

getType

public DeployerType getType()

Specified by:

getType in interface Deployer

Overrides:

getType in class AbstractEmbeddedLocalDeployer

Returns:

the deployer's type (local, remote, etc)

See Also:

Deployer.getType()

setVirtualHosts

public void setVirtualHosts(String[] hosts)

Set a list of virtual hosts corresponding to the webapps deployed via this deployer.

Parameters:

hosts - list of virtual host names

getVirtualHosts

public String[] getVirtualHosts()

Returns:

the virtual hosts

setExtractWar

public void setExtractWar(Boolean extract)

If true, all wars deployed by this deployer will be extracted before being deployed. If false, they won't be extracted first. If null, jetty will do the default.

Parameters:

extract - true=extract; false=don't extract, null=do container default

getExtractWar

public Boolean getExtractWar()

Returns:

whether to extract or not

setCopyWebApp

public void setCopyWebApp(Boolean copy)

copy webapp. If true, unpacked wars will be copied to a tmp location so their jars can be replaced at runtime

Parameters:

copy - if true, webapps are copied to tmp dir

getCopyWebApp

public Boolean getCopyWebApp()

Returns:

wether to copy unpacked war or not

setParentLoaderPriority

public void setParentLoaderPriority(Boolean java2compliant)

This is called java2classloadercompliance setting in jetty5 and the parentloaderpriority in jetty6. If true, the webapp classloader will try the parent. classloader first.

Parameters:

java2compliant - true=inverted loading, false=servlet spec, null=do the container default

getParentLoaderPriority

public Boolean getParentLoaderPriority()

Returns:

the class loader priority

getDeployedWebAppContext

protected static Object getDeployedWebAppContext(Deployable deployable)

Get the deployable that matches the context path.

Parameters:

deployable - the deployable object

Returns:

the webapp object

addDeployedWebAppContext

protected static void addDeployedWebAppContext(String context,
                                               Object deployedWebApp)

Add a new entry to the context path:deployable map.

Parameters:

context - the contextpath for the webapp

deployedWebApp - the jetty webapp object

removeDeployedWebAppContext

protected static void removeDeployedWebAppContext(String context)

Take a map entry away using the key.

Parameters:

context - the context path

getContext

public static String getContext(Deployable deployable)

Get the context path for the webapp.

Parameters:

deployable - the deployable

Returns:

the context path