org.codehaus.cargo.container

Interface Container

All Superinterfaces:

Loggable

All Known Subinterfaces:

EmbeddedLocalContainer, InstalledLocalContainer, LocalContainer, RemoteContainer

All Known Implementing Classes:

AbstractContainer, AbstractEmbeddedLocalContainer, AbstractInstalledLocalContainer, AbstractLocalContainer, AbstractRemoteContainer

public interface Container
extends Loggable

Common container API to wrap a physical container. There can be specialized types of containers such as LocalContainer or RemoteContainer.

Version:

$Id: Container.java 2760 2011-03-19 17:33:47Z alitokmen $

Method Summary

Methods

Modifier and Type	Method and Description
ContainerCapability	getCapability()
String	getId()
String	getName()
State	getState()
ContainerType	getType()

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

getLogger, setLogger

Method Detail

getId

String getId()

Returns:

the short name of the container. Note: this is not a unique id. It is simply the name in a computer-usable format.

getName

String getName()

Returns:

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

getCapability

ContainerCapability getCapability()

Returns:

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

getState

State getState()

Returns:

the container state (Valid states are Container.STOPPED, Container.STARTED, Container.STARTING and Container.STOPPING)

getType

ContainerType getType()

Returns:

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