org.apache.brooklyn.entity.webapp

Class JavaWebAppSoftwareProcessImpl

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.entity.AbstractEntity

org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

org.apache.brooklyn.entity.webapp.JavaWebAppSoftwareProcessImpl

All Implemented Interfaces:

DriverDependentEntity, Entity, EntityLocal, Rebindable, BrooklynObject, Configurable, Identifiable, EntityInternal, Startable, BrooklynObjectInternal, UsesJava, SoftwareProcess, JavaWebAppService, JavaWebAppService.CanDeployAndUndeploy, JavaWebAppSoftwareProcess, WebAppService, WebAppServiceConstants, WebAppServiceMetrics

Direct Known Subclasses:

JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, TomcatServerImpl

public abstract class JavaWebAppSoftwareProcessImpl
extends SoftwareProcessImpl
implements JavaWebAppService, JavaWebAppSoftwareProcess

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

SoftwareProcessImpl.ServiceNotUpDiagnosticsCollector, SoftwareProcessImpl.UpdatingNotUpFromServiceProcessIsRunning

Nested classes/interfaces inherited from class org.apache.brooklyn.core.entity.AbstractEntity

AbstractEntity.BasicConfigurationSupport, AbstractEntity.BasicEnricherSupport, AbstractEntity.BasicGroupSupport, AbstractEntity.BasicPolicySupport, AbstractEntity.BasicSensorSupport, AbstractEntity.BasicSubscriptionSupport

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.core.entity.EntityInternal

EntityInternal.EnricherSupportInternal, EntityInternal.EntitySubscriptionSupportInternal, EntityInternal.FeedSupport, EntityInternal.GroupSupportInternal, EntityInternal.PolicySupportInternal, EntityInternal.SensorSupportInternal

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.core.entity.AbstractEntity

APPLICATION_ID, CATALOG_ID, CHILD_ADDED, CHILD_REMOVED, CONFIG_KEY_ADDED, CONFIG_KEY_REMOVED, DEFAULT_DISPLAY_NAME, EFFECTOR_ADDED, EFFECTOR_CHANGED, EFFECTOR_REMOVED, ENTITY_ID, GROUP_ADDED, GROUP_REMOVED, LOCATION_ADDED, LOCATION_REMOVED, POLICY_ADDED, POLICY_REMOVED, SENSOR_ADDED, SENSOR_REMOVED

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

ADD_OPEN_INBOUND_PORTS_EFFECTOR, ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, 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, START_TIMEOUT, STOP_IPTABLES, STOP_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_VERSION, 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, ROOT_WAR, 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

Constructor Summary

Constructors

Constructor and Description
JavaWebAppSoftwareProcessImpl()

Method Summary

Modifier and Type	Method and Description
void	deploy(java.lang.String url, java.lang.String targetName) Deploys the given artifact, from a source URL, to a given deployment filename/context.
void	deployInitialWars()
JavaWebAppDriver	getDriver()
java.lang.Integer	getHttpPort()
java.lang.Integer	getHttpsPort()
java.lang.String	getHttpsSslKeyAlias()
java.lang.String	getHttpsSslKeystorePassword()
void	init() Default entity initialization sets ID sensors and calls AbstractEntity.initEnrichers().
boolean	isHttpEnabled()
boolean	isHttpsEnabled()
void	undeploy(java.lang.String targetName) For the DEPLOYED_WARS to be updated, the input must match the result of the call to deploy

Methods inherited from class org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

onManagementStarted, onManagementStarting, populateServiceNotUpDiagnostics, rebind, restart, start, stop, waitForEntityStart, waitForServiceUp, waitForServiceUp, waitForServiceUp, waitForServiceUp

Methods inherited from class org.apache.brooklyn.core.entity.AbstractEntity

addChild, addChild, addFeed, addLocations, addLocationsWithoutPublishing, clearLocations, clearParent, config, configure, configure, destroy, enrichers, equals, feeds, firstLocation, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getCreationTime, getDisplayName, getEffector, getEntityType, getExecutionContext, getIconUrl, getLocations, getManagementContext, getManagementSupport, getMutableEntityType, getParent, getProxy, getProxyIfAvailable, getRebindSupport, groups, hashCode, invalidateReferences, invoke, invoke, invoke, onManagementBecomingMaster, onManagementNoLongerMaster, onManagementStopped, policies, relations, removeChild, removeLocations, requestPersist, resetProxy, sensors, setConfigEvenIfOwned, setConfigEvenIfOwned, setDisplayName, setManagementContext, setParent, setProxy, subscriptions, toMetadataRecord, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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.api.entity.drivers.DriverDependentEntity

getDriverInterface

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

JavaWebAppSoftwareProcessImpl

public JavaWebAppSoftwareProcessImpl()

Method Detail

init

public void init()

Description copied from class: AbstractEntity

Default entity initialization sets ID sensors and calls AbstractEntity.initEnrichers().

Overrides:

init in class SoftwareProcessImpl

getDriver

public JavaWebAppDriver getDriver()

Specified by:

getDriver in interface DriverDependentEntity

Overrides:

getDriver in class SoftwareProcessImpl

deployInitialWars

public void deployInitialWars()

deploy

public void deploy(java.lang.String url,
                   java.lang.String targetName)

Deploys the given artifact, from a source URL, to a given deployment filename/context. There is some variance in expected filename/context at various servers, so the following conventions are followed:

either ROOT.WAR or / denotes root context

anything of form FOO.?AR (ending .?AR) is copied with that name (unless copying not necessary) and is expected to be served from /FOO

anything of form /FOO (with leading slash) is expected to be served from /FOO (and is copied as FOO.WAR)

anything of form FOO (without a dot) is expected to be served from /FOO (and is copied as FOO.WAR)

otherwise please note behaviour may vary on different appservers; e.g. FOO.FOO would probably be ignored on appservers which expect a file copied across (usually), but served as /FOO.FOO on systems that take a deployment context.

See FileNameToContextMappingTest for definitive examples!

Specified by:

deploy in interface JavaWebAppService.CanDeployAndUndeploy

Parameters:

url - where to get the war, as a URL, either classpath://xxx or file:///home/xxx or http(s)...

targetName - where to tell the server to serve the WAR, see above

undeploy

public void undeploy(java.lang.String targetName)

For the DEPLOYED_WARS to be updated, the input must match the result of the call to deploy

Specified by:

undeploy in interface JavaWebAppService.CanDeployAndUndeploy

isHttpEnabled

public boolean isHttpEnabled()

Specified by:

isHttpEnabled in interface JavaWebAppSoftwareProcess

isHttpsEnabled

public boolean isHttpsEnabled()

Specified by:

isHttpsEnabled in interface JavaWebAppSoftwareProcess

getHttpPort

public java.lang.Integer getHttpPort()

Specified by:

getHttpPort in interface JavaWebAppSoftwareProcess

getHttpsPort

public java.lang.Integer getHttpsPort()

Specified by:

getHttpsPort in interface JavaWebAppSoftwareProcess

getHttpsSslKeyAlias

public java.lang.String getHttpsSslKeyAlias()

Specified by:

getHttpsSslKeyAlias in interface JavaWebAppSoftwareProcess

getHttpsSslKeystorePassword

public java.lang.String getHttpsSslKeystorePassword()

Specified by:

getHttpsSslKeystorePassword in interface JavaWebAppSoftwareProcess