Package org.codehaus.cargo.container.wildfly.swarm.internal

Class AbstractWildFlySwarmInstalledLocalContainer

java.lang.Object

org.codehaus.cargo.util.log.LoggedObject

org.codehaus.cargo.container.spi.AbstractContainer

org.codehaus.cargo.container.spi.AbstractLocalContainer

org.codehaus.cargo.container.spi.AbstractInstalledLocalContainer

org.codehaus.cargo.container.wildfly.swarm.internal.AbstractWildFlySwarmInstalledLocalContainer

All Implemented Interfaces:

Container, InstalledLocalContainer, RunnableContainer, SpawnedContainer, LocalContainer, Loggable

Direct Known Subclasses:

WildFlySwarm2017xInstalledLocalContainer

public abstract class AbstractWildFlySwarmInstalledLocalContainer
extends AbstractInstalledLocalContainer

WildFly Swarm container common implementation.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractWildFlySwarmInstalledLocalContainer(LocalConfiguration configuration)

Method Summary

Modifier and Type	Method	Description
protected void	addDeployables()	Adds deployments on startup arg line.
protected void	doStart(JvmLauncher java)	Implementation of RunnableContainer.start() that all containers extending this class must implement.
protected void	doStop(JvmLauncher java)	Implementation of RunnableContainer.stop() that all containers extending this class must implement.
ContainerCapability	getCapability()
String	getName()
protected abstract String	getVersion()	Container version.
protected boolean	isHollowSwarm()	Tells whether WildFly Swarm operates in Hollow Swarm mode.
protected void	startInternal()	Installed and Embedded containers do not have the same signature for their doStart method.
protected void	stopInternal()	Installed and Embedded containers do not have the same signature for their doStop method.
protected void	verify()	Verify required properties have been set before executing any action.
protected void	waitForCompletion(boolean waitForStarting)	Ping the WAR CPC to verify if the container is started or stopped.

Methods inherited from class org.codehaus.cargo.container.spi.AbstractInstalledLocalContainer

addExtraClasspath, addExtraClasspath, addMemoryArguments, addRuntimeArgs, addSharedClasspath, addToolsJarToClasspath, createJvmLauncher, forceStopInternal, getExtraClasspath, getHome, getHttpUtils, getJavaHome, getJvmLauncherFactory, getResourceUtils, getSharedClasspath, getSystemProperties, getType, ifPresentAddPathToList, setExtraClasspath, setHome, setJvmLauncherFactory, setJvmToLaunchContainerIn, setLogger, setSharedClasspath, setSystemProperties

Methods inherited from class org.codehaus.cargo.container.spi.AbstractLocalContainer

executePostStartTasks, getConfiguration, getFileHandler, getOutput, getState, getTimeout, isAppend, restart, setAppend, setConfiguration, setFileHandler, setOutput, setState, setTimeout, start, stop, waitForPortShutdown, waitForStarting

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

getLogger

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

getId, getState

Methods inherited from interface org.codehaus.cargo.container.LocalContainer

getConfiguration, getFileHandler, setConfiguration, setFileHandler

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

getLogger

Methods inherited from interface org.codehaus.cargo.container.internal.RunnableContainer

getOutput, getTimeout, isAppend, restart, setAppend, setOutput, setTimeout, start, stop

Constructor Detail

AbstractWildFlySwarmInstalledLocalContainer

protected AbstractWildFlySwarmInstalledLocalContainer(LocalConfiguration configuration)

See Also:

AbstractInstalledLocalContainer(LocalConfiguration)

Method Detail

getName

public String getName()

Returns:

the human readable name of the Container (ex: "Resin 3.x", "JBoss 3.0.8", etc).

getVersion

protected abstract String getVersion()

Container version.

Returns:

version string.

verify

protected void verify()

Verify required properties have been set before executing any action.

Overrides:

verify in class AbstractInstalledLocalContainer

getCapability

public ContainerCapability getCapability()

Returns:

the ContainerCapability of the container in term of ability to deploy such and such type of Deployables (eg WAR, EAR, etc).

startInternal

protected void startInternal()
                      throws Exception

Description copied from class: AbstractInstalledLocalContainer

Installed and Embedded containers do not have the same signature for their doStart method. Thus we need to abstract it.

Overrides:

startInternal in class AbstractInstalledLocalContainer

Throws:

Exception - if any error is raised during the container start

stopInternal

protected void stopInternal()
                     throws Exception

Installed and Embedded containers do not have the same signature for their doStop method. Thus we need to abstract it.

Overrides:

stopInternal in class AbstractInstalledLocalContainer

Throws:

Exception - if any error is raised during the container stop

doStart

protected void doStart(JvmLauncher java)
                throws Exception

Implementation of RunnableContainer.start() that all containers extending this class must implement.

Specified by:

doStart in class AbstractInstalledLocalContainer

Parameters:

java - the predefined JVM launcher to use to start the container

Throws:

Exception - if any error is raised during the container start

isHollowSwarm

protected boolean isHollowSwarm()

Tells whether WildFly Swarm operates in Hollow Swarm mode.

Returns:

true if WildFly Swarm operates in Hollow Swarm mode, otherwise false.

addDeployables

protected void addDeployables()

Adds deployments on startup arg line. Only available in the Hollow Swarm mode.

doStop

protected void doStop(JvmLauncher java)
               throws Exception

Implementation of RunnableContainer.stop() that all containers extending this class must implement.

Specified by:

doStop in class AbstractInstalledLocalContainer

Parameters:

java - the predefined JVM launcher to use to stop the container

Throws:

Exception - if any error is raised during the container stop

waitForCompletion

protected void waitForCompletion(boolean waitForStarting)
                          throws InterruptedException

Ping the WAR CPC to verify if the container is started or stopped.

Overrides:

waitForCompletion in class AbstractLocalContainer

Parameters:

waitForStarting - if true then wait for container start, if false wait for container stop

Throws:

InterruptedException - if the thread sleep is interrupted