Package org.codehaus.cargo.container.glassfish.internal

Class AbstractGlassFishInstalledLocalDeployer

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.glassfish.internal.AbstractGlassFishInstalledLocalDeployer

All Implemented Interfaces:

Deployer, Loggable

Direct Known Subclasses:

GlassFish2xInstalledLocalDeployer, GlassFish3xInstalledLocalDeployer

public abstract class AbstractGlassFishInstalledLocalDeployer
extends AbstractLocalDeployer

GlassFish installed local deployer, which uses the GlassFish asadmin to deploy and undeploy applications.

Constructor Summary

Constructors

Constructor	Description
AbstractGlassFishInstalledLocalDeployer(InstalledLocalContainer localContainer)	Calls parent constructor, which saves the container.

Method Summary

Modifier and Type	Method	Description
abstract void	activateDefaultPrincipalToRoleMapping()	Activates the default principal to role mapping.
protected void	addConnectOptions(List<String> args)	Adds connection options.
protected void	addDeploymentArguments(List<String> args)	Adds deployment arguments defined by GlassFishPropertySet.DEPLOY_ARG_PREFIX.
protected void	addUndeploymentArguments(List<String> args)	Adds undeployment arguments defined by GlassFishPropertySet.UNDEPLOY_ARG_PREFIX.
abstract void	createFileUser(User user)	Calls create-file-user via asadmin to register a user.
void	deploy(Deployable deployable)	Deploy a Deployable to the running container and make it available for requests.
abstract void	deployDatasource(DataSource dataSource)	Deploy a datasource.
abstract void	deployResource(Resource resource)	Deploy a resource.
protected abstract void	doDeploy(Deployable deployable, boolean overwrite)	Does the actual deployment.
protected String	getDeployableName(Deployable deployable)	Get deployable name.
protected AbstractGlassFishInstalledLocalContainer	getLocalContainer()	Casts the container and returns.
DeployerType	getType()
void	redeploy(Deployable deployable)	Redeploy a Deployable already deployed to the running container.
void	redeploy(Deployable deployable, DeployableMonitor monitor)	Redeploy a Deployable already deployed to the running container.
void	start(Deployable deployable)	Starts a Deployable that is already deployed in the running container but that is not servicing requests.
void	stop(Deployable deployable)	Stop a Deployable that is already deployed in the running container in order to prevent it from servicing requests.
abstract void	undeployDatasource(String poolName, String jdbcName)	Undeploy a datasource.

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

getContainer, getFileHandler

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

deploy, deploy, redeploy, start, stop, undeploy, 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

AbstractGlassFishInstalledLocalDeployer

public AbstractGlassFishInstalledLocalDeployer(InstalledLocalContainer localContainer)

Calls parent constructor, which saves the container.

Parameters:

localContainer - Container.

Method Detail

getLocalContainer

protected AbstractGlassFishInstalledLocalContainer getLocalContainer()

Casts the container and returns.

Returns:

Cast container.

getType

public DeployerType getType()

Returns:

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

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

redeploy

public void redeploy(Deployable deployable)

Redeploy a Deployable already deployed to the running container. The service becomes available for requests.

Note that this method will be unsupported by the Deployers based on the AbstractCopyingInstalledLocalDeployer.

Specified by:

redeploy in interface Deployer

Overrides:

redeploy in class AbstractDeployer

Parameters:

deployable - the Deployable to redeploy

See Also:

Deployer.deploy(Deployable), Deployer.undeploy(Deployable)

redeploy

public void redeploy(Deployable deployable,
                     DeployableMonitor monitor)

Redeploy a Deployable already deployed to the running container. The service becomes available for requests.

Note that this method will be unsupported by the Deployers based on the AbstractCopyingInstalledLocalDeployer.

Specified by:

redeploy in interface Deployer

Overrides:

redeploy in class AbstractDeployer

Parameters:

deployable - the Deployable to redeploy

monitor - the monitor that checks for deployment status

See Also:

Deployer.deploy(Deployable), Deployer.undeploy(Deployable)

doDeploy

protected abstract void doDeploy(Deployable deployable,
                                 boolean overwrite)

Does the actual deployment.

Parameters:

deployable - Deployable to deploy.

overwrite - Whether to overwrite.

deployDatasource

public abstract void deployDatasource(DataSource dataSource)

Deploy a datasource.

Parameters:

dataSource - Datasource to deploy.

undeployDatasource

public abstract void undeployDatasource(String poolName,
                                        String jdbcName)

Undeploy a datasource.

Parameters:

poolName - Pool name of datasource to undeploy.

jdbcName - JNDI name of datasource to undeploy.

deployResource

public abstract void deployResource(Resource resource)

Deploy a resource. There is no undeployResource inverse function.

Parameters:

resource - resource to deploy.

start

public void start(Deployable deployable)

Starts a Deployable that is already deployed in the running container but that is not servicing requests.

Specified by:

start in interface Deployer

Overrides:

start in class AbstractDeployer

Parameters:

deployable - the Deployable to start

stop

public void stop(Deployable deployable)

Stop a Deployable that is already deployed in the running container in order to prevent it from servicing requests.

Specified by:

stop in interface Deployer

Overrides:

stop in class AbstractDeployer

Parameters:

deployable - the Deployable to stop

addConnectOptions

protected void addConnectOptions(List<String> args)

Adds connection options.

Parameters:

args - List to add to.

addDeploymentArguments

protected void addDeploymentArguments(List<String> args)

Adds deployment arguments defined by GlassFishPropertySet.DEPLOY_ARG_PREFIX.

Parameters:

args - args to populate

addUndeploymentArguments

protected void addUndeploymentArguments(List<String> args)

Adds undeployment arguments defined by GlassFishPropertySet.UNDEPLOY_ARG_PREFIX.

Parameters:

args - args to populate

getDeployableName

protected String getDeployableName(Deployable deployable)

Get deployable name.

Parameters:

deployable - Deployable to get the name of.

Returns:

Deployable name, either based on file name or deployable name.

createFileUser

public abstract void createFileUser(User user)

Calls create-file-user via asadmin to register a user.

Parameters:

user - user to register

activateDefaultPrincipalToRoleMapping

public abstract void activateDefaultPrincipalToRoleMapping()

Activates the default principal to role mapping. This allows groups defined in cargo.servlet.users to be used as the roles for the application.