org.apache.brooklyn.entity.webapp

Interface JavaWebAppService.CanDeployAndUndeploy

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable

All Known Subinterfaces:

ControlledDynamicWebAppCluster, DynamicWebAppCluster, JavaWebAppSoftwareProcess, JBoss6Server, JBoss7Server, Jetty6Server, Tomcat8Server, TomcatServer

All Known Implementing Classes:

ControlledDynamicWebAppClusterImpl, DynamicWebAppClusterImpl, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, SimulatedJBoss7ServerImpl, Tomcat8ServerImpl, TomcatServerImpl

Enclosing interface:

JavaWebAppService

public static interface JavaWebAppService.CanDeployAndUndeploy
extends Entity

Optional marker interface for entities which support 'deploy' and 'undeploy'

Nested Class Summary

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

Field Summary

Fields

Modifier and Type	Field and Description
static MethodEffector<java.lang.Void>	DEPLOY
static AttributeSensor<java.util.Set<java.lang.String>>	DEPLOYED_WARS
static MethodEffector<java.lang.Void>	UNDEPLOY

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	undeploy(java.lang.String targetName) For the DEPLOYED_WARS to be updated, the input must match the result of the call to deploy, e.g.

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

Field Detail

DEPLOYED_WARS

static final AttributeSensor<java.util.Set<java.lang.String>> DEPLOYED_WARS

DEPLOY

static final MethodEffector<java.lang.Void> DEPLOY

UNDEPLOY

static final MethodEffector<java.lang.Void> UNDEPLOY

Method Detail

deploy

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!

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

void undeploy(java.lang.String targetName)

For the DEPLOYED_WARS to be updated, the input must match the result of the call to deploy, e.g. the transformed name using