com.xebialabs.deployit.plugin.tomcat.ci
Class TomcatServer

java.lang.Object
  com.xebialabs.deployit.BaseConfigurationItem
      com.xebialabs.deployit.plugin.tomcat.ci.TomcatServer

All Implemented Interfaces:

java.io.Serializable

@ConfigurationItem(description="Tomcat Server instance",
                   targetForMappingTypes=com.xebialabs.deployit.ci.artifact.mapping.WarMapping.class)
public class TomcatServer
extends com.xebialabs.deployit.BaseConfigurationItem

A Apache Tomcat server

See Also:

Serialized Form

Field Summary

private AccessMethod	accessMethod
private java.lang.String	appBase
static int	DEPLOYMENT_COMPLETION_WAIT_TIME_MILLIS
private com.xebialabs.deployit.ci.Host	host
private java.lang.String	managerAppContext
private java.lang.String	managerPassword
private java.lang.String	managerUsername
private int	port
private java.lang.String	startCommand
private java.lang.String	stopCommand
private java.lang.String	tomcatHome

Fields inherited from class com.xebialabs.deployit.BaseConfigurationItem

label

Constructor Summary

TomcatServer()

Method Summary

com.xebialabs.deployit.hostsession.HostSession	connectToAdminHost()
AccessMethod	getAccessMethod()
java.lang.String	getAppBase()
java.lang.String	getContextWithoutVirtualHostDirPath()
java.lang.String	getContextWithVirtualHostDirPath(java.lang.String virtualHostName)
java.lang.String	getDeployDirPath()
com.xebialabs.deployit.ci.Host	getHost()
java.lang.String	getManagerAppContext()
java.lang.String	getManagerPassword()
java.lang.String	getManagerUsername()
int	getPort()
java.lang.String	getStartCommand()
java.lang.String	getStopCommand()
java.lang.String	getTomcatHome()
boolean	isManagerAppAvailable()
boolean	isReachable()
boolean	isStartStopCommandAvailable()
void	setAccessMethod(AccessMethod accessMethod)
void	setAppBase(java.lang.String appBase)
void	setHost(com.xebialabs.deployit.ci.Host host)
void	setManagerAppContext(java.lang.String managerAppContext)
void	setManagerPassword(java.lang.String managerPassword)
void	setManagerUsername(java.lang.String managerUsername)
void	setPort(int port)
void	setStartCommand(java.lang.String startCommand)
void	setStopCommand(java.lang.String stopCommand)
void	setTomcatHome(java.lang.String tomcatHome)

Methods inherited from class com.xebialabs.deployit.BaseConfigurationItem

equals, getLabel, hashCode, setLabel, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEPLOYMENT_COMPLETION_WAIT_TIME_MILLIS

public static final int DEPLOYMENT_COMPLETION_WAIT_TIME_MILLIS

See Also:

Constant Field Values

host

@ConfigurationItemProperty(required=true,
                           label="Tomcat server host",
                           description="Host on which the Tomcat server is running.")
private com.xebialabs.deployit.ci.Host host

port

@ConfigurationItemProperty(required=true,
                           description="Port for the Tomcat Server, default is 8080")
private int port

accessMethod

@ConfigurationItemProperty(required=true,
                           description="Protocol to be used for accessing the tomcat server")
private AccessMethod accessMethod

tomcatHome

@ConfigurationItemProperty(required=true,
                           label="Tomcat installation location",
                           description="Place where Tomcat is installed such as /opt/apache-tomcat-6.0.24.",
                           size=LARGE)
private java.lang.String tomcatHome

stopCommand

@ConfigurationItemProperty(required=false,
                           label="Tomcat stop command",
                           description="Command that should be executed to stop the Tomcat server, e.g. /opt/tomat/bin/catalina.sh stop",
                           size=LARGE)
private java.lang.String stopCommand

startCommand

@ConfigurationItemProperty(required=false,
                           label="Tomcat start command",
                           description="Command that should be executed to start the Tomcat server, e.g./opt/tomcat/bin/catalina.sh start.",
                           size=LARGE)
private java.lang.String startCommand

managerAppContext

@ConfigurationItemProperty(required=false,
                           label="Manager application context",
                           description="relative context path for tomcat manager application, e.g. /manager",
                           size=DEFAULT)
private java.lang.String managerAppContext

managerUsername

@ConfigurationItemProperty(required=false,
                           label="Tomcat manager username",
                           description="Username to be used for the manager application deployed on tomcat",
                           size=DEFAULT)
private java.lang.String managerUsername

managerPassword

@ConfigurationItemProperty(required=false,
                           label="Tomcat manager password",
                           description="Password to be used for the manager application deployed on tomcat",
                           size=DEFAULT,
                           password=true)
private java.lang.String managerPassword

appBase

@ConfigurationItemProperty(required=false,
                           description="absolute path of the directory where wars are deployed",
                           size=DEFAULT)
private java.lang.String appBase

Constructor Detail

TomcatServer

public TomcatServer()

Method Detail

connectToAdminHost

public com.xebialabs.deployit.hostsession.HostSession connectToAdminHost()

getDeployDirPath

public java.lang.String getDeployDirPath()

getContextWithoutVirtualHostDirPath

public java.lang.String getContextWithoutVirtualHostDirPath()

getContextWithVirtualHostDirPath

public java.lang.String getContextWithVirtualHostDirPath(java.lang.String virtualHostName)

getHost

public com.xebialabs.deployit.ci.Host getHost()

setHost

public void setHost(com.xebialabs.deployit.ci.Host host)

getStopCommand

public java.lang.String getStopCommand()

setStopCommand

public void setStopCommand(java.lang.String stopCommand)

getStartCommand

public java.lang.String getStartCommand()

isReachable

public boolean isReachable()

isStartStopCommandAvailable

public boolean isStartStopCommandAvailable()

isManagerAppAvailable

public boolean isManagerAppAvailable()

setStartCommand

public void setStartCommand(java.lang.String startCommand)

getTomcatHome

public java.lang.String getTomcatHome()

setTomcatHome

public void setTomcatHome(java.lang.String tomcatHome)

getPort

public int getPort()

setPort

public void setPort(int port)

getManagerUsername

public java.lang.String getManagerUsername()

setManagerUsername

public void setManagerUsername(java.lang.String managerUsername)

getManagerPassword

public java.lang.String getManagerPassword()

setManagerPassword

public void setManagerPassword(java.lang.String managerPassword)

getAccessMethod

public AccessMethod getAccessMethod()

setAccessMethod

public void setAccessMethod(AccessMethod accessMethod)

getManagerAppContext

public java.lang.String getManagerAppContext()

setManagerAppContext

public void setManagerAppContext(java.lang.String managerAppContext)

getAppBase

public java.lang.String getAppBase()

setAppBase

public void setAppBase(java.lang.String appBase)