Package org.codehaus.cargo.container

Interface Container

All Superinterfaces:

Loggable

All Known Subinterfaces:

EmbeddedLocalContainer, InstalledLocalContainer, JBoss5xInstalledLocalContainer, JBossInstalledLocalContainer, LocalContainer, RemoteContainer, ScriptingCapableContainer, WebLogicLocalContainer, WebLogicLocalScriptingContainer, WebLogicRemoteScriptingContainer

All Known Implementing Classes:

AbstractCatalinaEmbeddedLocalContainer, AbstractCatalinaInstalledLocalContainer, AbstractContainer, AbstractEmbeddedLocalContainer, AbstractGlassFishInstalledLocalContainer, AbstractInstalledLocalContainer, AbstractJBoss5xInstalledLocalContainer, AbstractJBossInstalledLocalContainer, AbstractJettyEmbeddedLocalContainer, AbstractJettyRemoteContainer, AbstractJonasInstalledLocalContainer, AbstractJRunInstalledLocalContainer, AbstractLocalContainer, AbstractOc4j10xInstalledLocalContainer, AbstractOrionInstalledLocalContainer, AbstractRemoteContainer, AbstractResinInstalledLocalContainer, AbstractTomcatRemoteContainer, AbstractWebLogicInstalledLocalContainer, AbstractWebLogicRemoteContainer, AbstractWildFlyInstalledLocalContainer, AbstractWildFlySwarmInstalledLocalContainer, Geronimo1xInstalledLocalContainer, Geronimo2xInstalledLocalContainer, Geronimo3xInstalledLocalContainer, GlassFish2xInstalledLocalContainer, GlassFish3xInstalledLocalContainer, GlassFish3xRemoteContainer, GlassFish4xInstalledLocalContainer, GlassFish4xRemoteContainer, GlassFish5xInstalledLocalContainer, GlassFish5xRemoteContainer, GlassFish6xInstalledLocalContainer, GlassFish7xInstalledLocalContainer, GlassFish8xInstalledLocalContainer, JBoss3xInstalledLocalContainer, JBoss42xInstalledLocalContainer, JBoss42xRemoteContainer, JBoss4xInstalledLocalContainer, JBoss4xRemoteContainer, JBoss51xInstalledLocalContainer, JBoss51xRemoteContainer, JBoss5xInstalledLocalContainer, JBoss5xRemoteContainer, JBoss61xInstalledLocalContainer, JBoss61xRemoteContainer, JBoss6xInstalledLocalContainer, JBoss6xRemoteContainer, JBoss71xInstalledLocalContainer, JBoss71xRemoteContainer, JBoss72xInstalledLocalContainer, JBoss72xRemoteContainer, JBoss73xInstalledLocalContainer, JBoss73xRemoteContainer, JBoss74xInstalledLocalContainer, JBoss74xRemoteContainer, JBoss75xInstalledLocalContainer, JBoss75xRemoteContainer, JBoss7xInstalledLocalContainer, JBoss7xRemoteContainer, Jetty10xEmbeddedLocalContainer, Jetty10xInstalledLocalContainer, Jetty10xRemoteContainer, Jetty11xEmbeddedLocalContainer, Jetty11xInstalledLocalContainer, Jetty11xRemoteContainer, Jetty12xInstalledLocalContainer, Jetty5xEmbeddedLocalContainer, Jetty6xEmbeddedLocalContainer, Jetty6xInstalledLocalContainer, Jetty6xRemoteContainer, Jetty7xEmbeddedLocalContainer, Jetty7xInstalledLocalContainer, Jetty7xRemoteContainer, Jetty8xEmbeddedLocalContainer, Jetty8xInstalledLocalContainer, Jetty8xRemoteContainer, Jetty9xEmbeddedLocalContainer, Jetty9xInstalledLocalContainer, Jetty9xRemoteContainer, Jo1xInstalledLocalContainer, Jonas4xInstalledLocalContainer, Jonas4xRemoteContainer, Jonas5xInstalledLocalContainer, Jonas5xRemoteContainer, JRun4xInstalledLocalContainer, LibertyInstalledLocalContainer, Oc4j10xInstalledLocalContainer, Oc4j9xInstalledLocalContainer, PayaraInstalledLocalContainer, PayaraRemoteContainer, Resin31xInstalledLocalContainer, Resin3xInstalledLocalContainer, Resin4xInstalledLocalContainer, Tomcat10xEmbeddedLocalContainer, Tomcat10xInstalledLocalContainer, Tomcat10xRemoteContainer, Tomcat11xEmbeddedLocalContainer, Tomcat11xInstalledLocalContainer, Tomcat11xRemoteContainer, Tomcat4xInstalledLocalContainer, Tomcat4xRemoteContainer, Tomcat5xEmbeddedLocalContainer, Tomcat5xInstalledLocalContainer, Tomcat5xRemoteContainer, Tomcat6xEmbeddedLocalContainer, Tomcat6xInstalledLocalContainer, Tomcat6xRemoteContainer, Tomcat7xEmbeddedLocalContainer, Tomcat7xInstalledLocalContainer, Tomcat7xRemoteContainer, Tomcat8xEmbeddedLocalContainer, Tomcat8xInstalledLocalContainer, Tomcat8xRemoteContainer, Tomcat9xEmbeddedLocalContainer, Tomcat9xInstalledLocalContainer, Tomcat9xRemoteContainer, Tomee1xInstalledLocalContainer, Tomee1xRemoteContainer, Tomee7xInstalledLocalContainer, Tomee7xRemoteContainer, Tomee8xInstalledLocalContainer, Tomee8xRemoteContainer, Tomee9xInstalledLocalContainer, Tomee9xRemoteContainer, WebLogic103xInstalledLocalContainer, WebLogic103xRemoteContainer, WebLogic10xInstalledLocalContainer, WebLogic121xInstalledLocalContainer, WebLogic121xRemoteContainer, WebLogic122xInstalledLocalContainer, WebLogic122xRemoteContainer, WebLogic12xInstalledLocalContainer, WebLogic14xInstalledLocalContainer, WebLogic14xRemoteContainer, WebLogic8xInstalledLocalContainer, WebLogic9xInstalledLocalContainer, WebSphere85xInstalledLocalContainer, WebSphere9xInstalledLocalContainer, WildFly10xInstalledLocalContainer, WildFly10xRemoteContainer, WildFly11xInstalledLocalContainer, WildFly11xRemoteContainer, WildFly12xInstalledLocalContainer, WildFly12xRemoteContainer, WildFly13xInstalledLocalContainer, WildFly13xRemoteContainer, WildFly14xInstalledLocalContainer, WildFly14xRemoteContainer, WildFly15xInstalledLocalContainer, WildFly15xRemoteContainer, WildFly16xInstalledLocalContainer, WildFly16xRemoteContainer, WildFly17xInstalledLocalContainer, WildFly17xRemoteContainer, WildFly18xInstalledLocalContainer, WildFly18xRemoteContainer, WildFly19xInstalledLocalContainer, WildFly19xRemoteContainer, WildFly20xInstalledLocalContainer, WildFly20xRemoteContainer, WildFly21xInstalledLocalContainer, WildFly21xRemoteContainer, WildFly22xInstalledLocalContainer, WildFly22xRemoteContainer, WildFly23xInstalledLocalContainer, WildFly23xRemoteContainer, WildFly24xInstalledLocalContainer, WildFly24xRemoteContainer, WildFly25xInstalledLocalContainer, WildFly25xRemoteContainer, WildFly26xInstalledLocalContainer, WildFly26xRemoteContainer, WildFly27xInstalledLocalContainer, WildFly27xRemoteContainer, WildFly28xInstalledLocalContainer, WildFly28xRemoteContainer, WildFly29xInstalledLocalContainer, WildFly29xRemoteContainer, WildFly30xInstalledLocalContainer, WildFly30xRemoteContainer, WildFly31xInstalledLocalContainer, WildFly31xRemoteContainer, WildFly8xInstalledLocalContainer, WildFly8xRemoteContainer, WildFly9xInstalledLocalContainer, WildFly9xRemoteContainer, WildFlySwarm2017xInstalledLocalContainer

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.

Method Summary

Modifier and Type	Method	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)