Package org.codehaus.cargo.container.deployer

Interface Deployer

All Superinterfaces:

Loggable

All Known Implementing Classes:

AbstractCopyingInstalledLocalDeployer, AbstractDeployer, AbstractEmbeddedLocalDeployer, AbstractGlassFishInstalledLocalDeployer, AbstractInstalledLocalDeployer, AbstractJettyEmbeddedLocalDeployer, AbstractJonas4xRemoteDeployer, AbstractJonas5xRemoteDeployer, AbstractJonasRemoteDeployer, AbstractJsr88Deployer, AbstractLocalDeployer, AbstractRemoteDeployer, AbstractSwitchableLocalDeployer, AbstractTomcatManagerDeployer, AbstractTomcatManagerInstalledLocalDeployer, AbstractTomcatRemoteDeployer, AbstractTomeeRemoteDeployer, AbstractWildFlyRemoteDeployer, GeronimoInstalledLocalDeployer, GlassFish2xInstalledLocalDeployer, GlassFish3xInstalledLocalDeployer, GlassFish3xRemoteDeployer, GlassFish4xInstalledLocalDeployer, GlassFish4xRemoteDeployer, GlassFish5xInstalledLocalDeployer, GlassFish5xRemoteDeployer, GlassFish6xInstalledLocalDeployer, GlassFish7xInstalledLocalDeployer, GlassFish8xInstalledLocalDeployer, JBoss4xRemoteDeployer, JBoss51x6xRemoteDeployer, JBoss5xRemoteDeployer, JBoss7xInstalledLocalDeployer, JBoss7xRemoteDeployer, JBossInstalledLocalDeployer, Jetty12xInstalledLocalDeployer, Jetty5xEmbeddedLocalDeployer, Jetty6xEmbeddedLocalDeployer, Jetty6xInstalledLocalDeployer, Jetty7x8x9x10x11xEmbeddedLocalDeployer, Jetty7x8xInstalledLocalDeployer, Jetty9x10x11xInstalledLocalDeployer, JettyRemoteDeployer, Jo1xInstalledLocalDeployer, Jonas4xInstalledLocalDeployer, Jonas4xJsr160RemoteDeployer, Jonas4xMEJBRemoteDeployer, Jonas5xInstalledLocalDeployer, Jonas5xJsr160RemoteDeployer, Jonas5xMEJBRemoteDeployer, JRun4xInstalledLocalDeployer, LibertyInstalledLocalDeployer, PayaraInstalledLocalDeployer, PayaraRemoteDeployer, ResinInstalledLocalDeployer, Tomcat10xRemoteDeployer, Tomcat11xRemoteDeployer, Tomcat4xRemoteDeployer, Tomcat5xRemoteDeployer, Tomcat6xRemoteDeployer, Tomcat7xRemoteDeployer, Tomcat8xRemoteDeployer, Tomcat9xRemoteDeployer, TomcatCopyingInstalledLocalDeployer, TomcatEmbeddedLocalDeployer, TomcatManager4x5x6xInstalledLocalDeployer, TomcatManager7x8x9x10xInstalledLocalDeployer, Tomee10xRemoteDeployer, Tomee1xRemoteDeployer, Tomee7xRemoteDeployer, Tomee8xRemoteDeployer, Tomee9xRemoteDeployer, TomeeCopyingInstalledLocalDeployer, WebLogic8xConfigXmlInstalledLocalDeployer, WebLogic8xSwitchableLocalDeployer, WebLogic9x10x12x14xConfigXmlInstalledLocalDeployer, WebLogic9x10x12x14xCopyingInstalledLocalDeployer, WebLogicWlstOfflineInstalledLocalDeployer, WebLogicWlstRemoteDeployer, WebSphere85xInstalledLocalDeployer, WebSphere9xInstalledLocalDeployer, WildFly10xInstalledLocalDeployer, WildFly10xRemoteDeployer, WildFly11xInstalledLocalDeployer, WildFly11xRemoteDeployer, WildFly12xInstalledLocalDeployer, WildFly12xRemoteDeployer, WildFly13xInstalledLocalDeployer, WildFly13xRemoteDeployer, WildFly14xInstalledLocalDeployer, WildFly14xRemoteDeployer, WildFly15xInstalledLocalDeployer, WildFly15xRemoteDeployer, WildFly16xInstalledLocalDeployer, WildFly16xRemoteDeployer, WildFly17xInstalledLocalDeployer, WildFly17xRemoteDeployer, WildFly18xInstalledLocalDeployer, WildFly18xRemoteDeployer, WildFly19xInstalledLocalDeployer, WildFly19xRemoteDeployer, WildFly20xInstalledLocalDeployer, WildFly20xRemoteDeployer, WildFly21xInstalledLocalDeployer, WildFly21xRemoteDeployer, WildFly22xInstalledLocalDeployer, WildFly22xRemoteDeployer, WildFly23xInstalledLocalDeployer, WildFly23xRemoteDeployer, WildFly24xInstalledLocalDeployer, WildFly24xRemoteDeployer, WildFly25xInstalledLocalDeployer, WildFly25xRemoteDeployer, WildFly26xInstalledLocalDeployer, WildFly26xRemoteDeployer, WildFly27xInstalledLocalDeployer, WildFly27xRemoteDeployer, WildFly28xInstalledLocalDeployer, WildFly28xRemoteDeployer, WildFly29xInstalledLocalDeployer, WildFly29xRemoteDeployer, WildFly30xInstalledLocalDeployer, WildFly30xRemoteDeployer, WildFly31xInstalledLocalDeployer, WildFly31xRemoteDeployer, WildFly32xInstalledLocalDeployer, WildFly32xRemoteDeployer, WildFly33xInstalledLocalDeployer, WildFly33xRemoteDeployer, WildFly8xInstalledLocalDeployer, WildFly8xRemoteDeployer, WildFly9xInstalledLocalDeployer, WildFly9xRemoteDeployer

public interface Deployer
extends Loggable

API to manage all deployment aspects of Deployable: deploy, undeploy, start, stop and restart.

Method Summary

Modifier and Type	Method	Description
void	deploy(Deployable deployable)	Deploy a Deployable to the running container and make it available for requests.
void	deploy(Deployable deployable, DeployableMonitor monitor)	Deploy a Deployable to the running container and make it available for requests.
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	start(Deployable deployable, DeployableMonitor monitor)	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.
void	stop(Deployable deployable, DeployableMonitor monitor)	Stop a Deployable that is already deployed in the running container in order to prevent it from servicing requests.
void	undeploy(Deployable deployable)	Undeploy a Deployable from the running container.
void	undeploy(Deployable deployable, DeployableMonitor monitor)	Undeploy a Deployable to the running container.

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

getLogger, setLogger

Method Detail

deploy

void deploy(Deployable deployable)

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

Parameters:

deployable - the Deployable to deploy

deploy

void deploy(Deployable deployable,
            DeployableMonitor monitor)

Deploy a Deployable to the running container and make it available for requests. Waits for the Deployable to be fully deployed before returning.

Parameters:

deployable - the Deployable to deploy

monitor - the monitor that checks for deployment status

undeploy

void undeploy(Deployable deployable)

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

Parameters:

deployable - the Deployable to undeploy

undeploy

void undeploy(Deployable deployable,
              DeployableMonitor monitor)

Undeploy a Deployable to the running container. Waits for the Deployable to be fully undeployed before returning.

Parameters:

deployable - the Deployable to deploy

monitor - the monitor that checks for deployment status

redeploy

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.

Parameters:

deployable - the Deployable to redeploy

See Also:

deploy(Deployable), undeploy(Deployable)

redeploy

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.

Parameters:

deployable - the Deployable to redeploy

monitor - the monitor that checks for deployment status

See Also:

deploy(Deployable), undeploy(Deployable)

start

void start(Deployable deployable)

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

Parameters:

deployable - the Deployable to start

start

void start(Deployable deployable,
           DeployableMonitor monitor)

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

Parameters:

deployable - the Deployable to start

monitor - the monitor that checks for start status

stop

void stop(Deployable deployable)

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

Parameters:

deployable - the Deployable to stop

stop

void stop(Deployable deployable,
          DeployableMonitor monitor)

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

Parameters:

deployable - the Deployable to stop

monitor - the monitor that checks for stop status

getType

DeployerType getType()

Returns:

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