org.codehaus.cargo.container
Interface Container

All Superinterfaces:

Loggable

All Known Subinterfaces:

EmbeddedLocalContainer, InstalledLocalContainer, JBoss5xInstalledLocalContainer, JBossInstalledLocalContainer, LocalContainer, RemoteContainer, WebLogicLocalContainer

All Known Implementing Classes:

AbstractCatalinaInstalledLocalContainer, AbstractContainer, AbstractEmbeddedLocalContainer, AbstractInstalledLocalContainer, AbstractJBoss5xInstalledLocalContainer, AbstractJBossInstalledLocalContainer, AbstractJBossRemoteContainer, AbstractJetty4x5xEmbeddedLocalContainer, AbstractJettyEmbeddedLocalContainer, AbstractJettyRemoteContainer, AbstractJRunInstalledLocalContainer, AbstractLocalContainer, AbstractOc4j10xInstalledLocalContainer, AbstractOrionInstalledLocalContainer, AbstractRemoteContainer, AbstractResinInstalledLocalContainer, AbstractTomcatRemoteContainer, AbstractWebLogicInstalledLocalContainer, Geronimo1xInstalledLocalContainer, JBoss3xInstalledLocalContainer, JBoss42xInstalledLocalContainer, JBoss42xRemoteContainer, JBoss4xInstalledLocalContainer, JBoss4xRemoteContainer, JBoss5xInstalledLocalContainer, JBoss5xRemoteContainer, Jetty4xEmbeddedLocalContainer, Jetty5xEmbeddedLocalContainer, Jetty6xEmbeddedLocalContainer, Jetty6xInstalledLocalContainer, Jetty6xRemoteContainer, Jetty7xEmbeddedLocalContainer, Jetty7xInstalledLocalContainer, Jetty7xRemoteContainer, Jo1xInstalledLocalContainer, JRun4xInstalledLocalContainer, Oc4j10xInstalledLocalContainer, Oc4j9xInstalledLocalContainer, Resin2xInstalledLocalContainer, Resin3xInstalledLocalContainer, Tomcat4xInstalledLocalContainer, Tomcat4xRemoteContainer, Tomcat5xEmbeddedLocalContainer, Tomcat5xInstalledLocalContainer, Tomcat5xRemoteContainer, Tomcat6xInstalledLocalContainer, Tomcat6xRemoteContainer, WebLogic103xInstalledLocalContainer, WebLogic10xInstalledLocalContainer, WebLogic8xInstalledLocalContainer, WebLogic9xInstalledLocalContainer

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 1705 2008-09-02 13:14:55Z adriana $

Method Summary

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)