org.apache.brooklyn.entity.webapp.tomcat

Interface TomcatServer

All Superinterfaces:

BrooklynObject, Configurable, Entity, HasShortName, Identifiable, JavaWebAppService, JavaWebAppService.CanDeployAndUndeploy, JavaWebAppSoftwareProcess, SoftwareProcess, Startable, UsesJava, UsesJmx, WebAppService, WebAppServiceConstants, WebAppServiceMetrics

All Known Subinterfaces:

Tomcat8Server

All Known Implementing Classes:

Tomcat8ServerImpl, TomcatServerImpl

public interface TomcatServer
extends JavaWebAppSoftwareProcess, UsesJmx, HasShortName

An Entity that represents a single Tomcat instance.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, SoftwareProcess.StopSoftwareParameters

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.webapp.JavaWebAppService

JavaWebAppService.CanDeployAndUndeploy, JavaWebAppService.CanRedeployAll

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.webapp.WebAppServiceMetrics

WebAppServiceMetrics.Initializer

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Entity.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.java.UsesJmx

UsesJmx.JmxAgentModes

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<java.lang.String>	ARCHIVE_DIRECTORY_NAME_FORMAT
static AttributeSensor<java.lang.String>	CONNECTOR_STATUS
static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>	DOWNLOAD_URL
static AttributeSensor<java.lang.String>	JMX_SERVICE_URL
static ConfigKey<java.lang.String>	ROOT_WAR
static ConfigKey<java.lang.String>	SERVER_XML_RESOURCE
static PortAttributeSensorAndConfigKey	SHUTDOWN_PORT Tomcat insists on having a port you can connect to for the sole purpose of shutting it down.
static ConfigKey<Duration>	START_TIMEOUT
static ConfigKey<java.lang.String>	SUGGESTED_VERSION
static ConfigKey<java.lang.String>	WEB_XML_RESOURCE

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

ADD_OPEN_INBOUND_PORTS_EFFECTOR, ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INBOUND_PORTS_AUTO_INFER, INBOUND_PORTS_CONFIG_REGEX, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, LIFECYCLE_EFFECTOR_TASKS, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, OPEN_IPTABLES, PID_FILE, POST_CUSTOMIZE_COMMAND, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_CUSTOMIZE_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RETRIEVE_USAGE_METRICS, RUN_DIR, RUNTIME_FILES, RUNTIME_RESOURCES_LATCH, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_PROCESS_IS_RUNNING_POLL_PERIOD, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, STOP_IPTABLES, STOP_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, TEMPLATE_SUBSTITUTIONS

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

RESTART, SERVICE_UP, START, STOP

Fields inherited from interface org.apache.brooklyn.entity.webapp.JavaWebAppService

NAMED_WARS, WARS_BY_CONTEXT

Fields inherited from interface org.apache.brooklyn.entity.webapp.WebAppServiceConstants

ENABLED_PROTOCOLS, HTTP_PORT, HTTPS_PORT, HTTPS_SSL_CONFIG, ROOT_URL

Fields inherited from interface org.apache.brooklyn.entity.webapp.WebAppServiceMetrics

BYTES_RECEIVED, BYTES_SENT, ERROR_COUNT, MAX_PROCESSING_TIME, PROCESSING_TIME_FRACTION_IN_WINDOW, PROCESSING_TIME_FRACTION_LAST, REQUEST_COUNT, REQUESTS_PER_SECOND_IN_WINDOW, REQUESTS_PER_SECOND_LAST, TOTAL_PROCESSING_TIME

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava

CHECK_JAVA_HOSTNAME_BUG, JAVA_OPTS, JAVA_SYSPROPS, JAVA_VERSION_REQUIRED

Fields inherited from interface org.apache.brooklyn.entity.webapp.JavaWebAppService.CanDeployAndUndeploy

DEPLOY, DEPLOYED_WARS, UNDEPLOY

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJmx

DEFAULT_JMX_PORT, JMX_AGENT_LOCAL_PATH, JMX_AGENT_MODE, JMX_CONTEXT, JMX_PASSWORD, JMX_PORT, JMX_PORT_LEGACY, JMX_SSL_ACCESS_CERT, JMX_SSL_ACCESS_KEY, JMX_SSL_ENABLED, JMX_URL, JMX_USER, RMI_REGISTRY_PORT, USE_JMX

Method Summary

Methods inherited from interface org.apache.brooklyn.entity.webapp.JavaWebAppSoftwareProcess

getHttpPort, getHttpsPort, getHttpsSslKeyAlias, getHttpsSslKeystorePassword, isHttpEnabled, isHttpsEnabled

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

populateServiceNotUpDiagnostics

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

restart, start, stop

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

addChild, addChild, addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig

Methods inherited from interface org.apache.brooklyn.entity.webapp.JavaWebAppService.CanDeployAndUndeploy

deploy, undeploy

Methods inherited from interface org.apache.brooklyn.api.objs.HasShortName

getShortName

Field Detail

ROOT_WAR

static final ConfigKey<java.lang.String> ROOT_WAR

SUGGESTED_VERSION

static final ConfigKey<java.lang.String> SUGGESTED_VERSION

ARCHIVE_DIRECTORY_NAME_FORMAT

static final ConfigKey<java.lang.String> ARCHIVE_DIRECTORY_NAME_FORMAT

DOWNLOAD_URL

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> DOWNLOAD_URL

SHUTDOWN_PORT

static final PortAttributeSensorAndConfigKey SHUTDOWN_PORT

Tomcat insists on having a port you can connect to for the sole purpose of shutting it down. Don't see an easy way to disable it; causes collisions in its out-of-the-box location of 8005, so override default here to a high-numbered port.

SERVER_XML_RESOURCE

static final ConfigKey<java.lang.String> SERVER_XML_RESOURCE

WEB_XML_RESOURCE

static final ConfigKey<java.lang.String> WEB_XML_RESOURCE

START_TIMEOUT

static final ConfigKey<Duration> START_TIMEOUT

CONNECTOR_STATUS

static final AttributeSensor<java.lang.String> CONNECTOR_STATUS

JMX_SERVICE_URL

static final AttributeSensor<java.lang.String> JMX_SERVICE_URL