JavaWebAppSoftwareProcess (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.entity.webapp
[Java] Interface JavaWebAppSoftwareProcess

brooklyn.entity.java.UsesJava
  brooklyn.entity.trait.Startable
      brooklyn.entity.rebind.Rebindable
          brooklyn.entity.webapp.WebAppService
              brooklyn.entity.Entity
                  brooklyn.entity.basic.SoftwareProcess
                      brooklyn.entity.webapp.JavaWebAppSoftwareProcess
                          brooklyn.entity.webapp.WebAppServiceConstants
                              brooklyn.entity.trait.Identifiable
                                  brooklyn.entity.webapp.JavaWebAppService

All Superinterfaces:: UsesJava, Startable, Rebindable, WebAppService, Entity, SoftwareProcess, WebAppServiceConstants, Identifiable, JavaWebAppService

public interface JavaWebAppSoftwareProcess
extends JavaWebAppService, SoftwareProcess

Field Summary
`static MethodEffector`	`DEPLOY`
`static AttributeSensor`	`DEPLOYED_WARS`
`static MethodEffector`	`UNDEPLOY`

Fields inherited from interface JavaWebAppService
NAMED_WARS, ROOT_WAR, WARS_BY_CONTEXT

Fields inherited from interface SoftwareProcess
ADDRESS, CUSTOMIZE_LATCH, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, HOSTNAME, INSTALL_LATCH, LAUNCH_LATCH, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, SERVICE_STATE, SHELL_ENVIRONMENT, START_LATCH, START_TIMEOUT, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR, SUGGESTED_VERSION

Fields inherited from interface Startable
RESTART, SERVICE_UP, START, STOP

Method Summary
`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

Field Detail

DEPLOY

public static final MethodEffector DEPLOY

DEPLOYED_WARS

public static final AttributeSensor DEPLOYED_WARS

UNDEPLOY

public static final MethodEffector UNDEPLOY

Method Detail

deploy

@Effector(description="Deploys the given artifact, from a source URL, to a given deployment filename/context")
public void deploy(@EffectorParam(name="url", description="URL of WAR file") java.lang.String url, @EffectorParam(name="targetName", description="context path where WAR should be deployed (/ for ROOT)") 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

@Effector(description="Undeploys the given context/artifact")
public void undeploy(@EffectorParam(name="targetName") java.lang.String targetName)

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