Index (Brooklyn Launcher 0.11.0 API)

A B C D G H I L M N O P R S T U V W

A

actualAddress - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer: actual NIC where this is listening; in the case of 0.0.0.0 being passed in as bindAddress, this will revert to one address (such as localhost)
actualPort - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer: actual port where this gets bound; will be consistent with the "port" passed in but that might be a range and here it is a single port, or -1 if not yet set
addAttribute(String, Object) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Deprecated.
use setAttribute
addShutdownHook() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
addWar(String, String) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: specifies a WAR to use at a given context path (only if server not yet started); cf deploy(path, url)
addWar(WebAppContextProvider) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer

B

bindAddress(InetAddress) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies the NIC where the web console (and any additional webapps specified) will be bound; default 0.0.0.0, unless no security is specified (e.g.
bindAddress - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer: IP of NIC where this server should bind, or null to autodetect (e.g.
BROOKLYN_DEV_MODE - Static variable in class org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes: Deprecated.
BROOKLYN_WAR_URL - Static variable in class org.apache.brooklyn.launcher.BrooklynWebServer
BrooklynCampPlatformLauncher - Class in org.apache.brooklyn.launcher.camp: variant of super who also starts a CampServer for convenience
BrooklynCampPlatformLauncher() - Constructor for class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
BrooklynDevelopmentModes - Class in org.apache.brooklyn.launcher.config: Deprecated.
BrooklynDevelopmentModes() - Constructor for class org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes: Deprecated.
BrooklynDevelopmentModes.BrooklynDevelopmentMode - Enum in org.apache.brooklyn.launcher.config: Deprecated.
BrooklynGlobalConfig - Class in org.apache.brooklyn.launcher.config: Deprecated.
since 0.9.0 - not used
BrooklynGlobalConfig() - Constructor for class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
BrooklynLauncher - Class in org.apache.brooklyn.launcher: Example usage is: *
BrooklynLauncher() - Constructor for class org.apache.brooklyn.launcher.BrooklynLauncher
brooklynLauncher - Variable in class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
brooklynPropertiesSupplier(Supplier<Map<?, ?>>) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Poperties returned by the supplier have less precedence (get overwritten) by global & local properties
BrooklynServerDetails - Class in org.apache.brooklyn.launcher
BrooklynServerDetails(BrooklynWebServer, ManagementContext) - Constructor for class org.apache.brooklyn.launcher.BrooklynServerDetails
BrooklynWebServer - Class in org.apache.brooklyn.launcher: Starts the web-app running, connected to the given management context
BrooklynWebServer(ManagementContext) - Constructor for class org.apache.brooklyn.launcher.BrooklynWebServer
BrooklynWebServer(Map<?, ?>, ManagementContext) - Constructor for class org.apache.brooklyn.launcher.BrooklynWebServer: accepts flags: port, war (url of war file which is the root), wars (map of context-prefix to url), attrs (map of attribute-name : object pairs passed to the servlet)
BrooklynWebServer(ManagementContext, int) - Constructor for class org.apache.brooklyn.launcher.BrooklynWebServer
BrooklynWebServer(ManagementContext, int, String) - Constructor for class org.apache.brooklyn.launcher.BrooklynWebServer

C

campServer - Variable in class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
computeEnabled() - Method in enum org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes.BrooklynDevelopmentMode: Deprecated.
configure(ConfigKey<T>, T) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
ContextHandlerCollectionHotSwappable - Class in org.apache.brooklyn.util.web
ContextHandlerCollectionHotSwappable() - Constructor for class org.apache.brooklyn.util.web.ContextHandlerCollectionHotSwappable
customizeBrooklynNodeSpec(EntitySpec<LocalBrooklynNode>) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
customizeManagement(Function<ManagementContext, Void>) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
CustomResourceLocator - Class in org.apache.brooklyn.launcher.config: class which allows non-standard locators to be registered for URL's being loaded
CustomResourceLocator(ConfigMap, ResourceUtils) - Constructor for class org.apache.brooklyn.launcher.config.CustomResourceLocator
CustomResourceLocator.ResourceLocator - Interface in org.apache.brooklyn.launcher.config
CustomResourceLocator.SearchingClassPathInDevMode - Class in org.apache.brooklyn.launcher.config

D

deploy(String, String) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
deploy(WebAppContextProvider) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Serve the given WAR at the given pathSpec.
deploy(WebAppContext) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
DO_SYSTEM_GC - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.

G

GC_PERIOD - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
get(ManagementContext, Map<String, Object>, boolean) - Method in class org.apache.brooklyn.launcher.WebAppContextProvider: Serve given WAR at the given pathSpec; if not yet started, it is simply remembered until start; if server already running, the context for this WAR is started.
getActualPort() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: returns port where this is running, or -1 if not yet known
getAddress() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: interface/address where this server is listening; if bound to 0.0.0.0 (all NICs, e.g.
getAutodectectedDevelopmentMode() - Static method in class org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes: Deprecated.
getHttpsEnabled() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
getLocatorFor(String, ConfigMap) - Static method in class org.apache.brooklyn.launcher.config.CustomResourceLocator: returns the first known locator for the given url/config pair
getManagementContext() - Method in class org.apache.brooklyn.launcher.BrooklynServerDetails
getPath() - Method in class org.apache.brooklyn.launcher.WebAppContextProvider
getRequestedPort() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
getResourceFromUrl(String) - Method in class org.apache.brooklyn.launcher.config.CustomResourceLocator: finds the file indicated at the URL, using some rewrites if necessary to work around some known issues.
getRootContext() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
getRootUrl() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: URL for accessing this web server (root context)
getServer() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
getServerDetails() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
getWarUrl() - Method in class org.apache.brooklyn.launcher.WebAppContextProvider
getWebServer() - Method in class org.apache.brooklyn.launcher.BrooklynServerDetails
getWebServerUrl() - Method in class org.apache.brooklyn.launcher.BrooklynServerDetails
globalBrooklynPropertiesFile(String) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher

H

httpPort - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer
httpsPort - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer

I

ignoreWebappDeploymentFailures - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer
ignoreWebErrors(boolean) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
initBrooklynPropertiesBuilder() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
initManagementContext() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
installSecurityFilter(Boolean) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
isApplicable(String, ConfigMap) - Method in interface org.apache.brooklyn.launcher.config.CustomResourceLocator.ResourceLocator
isApplicable(String, ConfigMap) - Method in class org.apache.brooklyn.launcher.config.CustomResourceLocator.SearchingClassPathInDevMode
isEnabled() - Method in enum org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes.BrooklynDevelopmentMode: Deprecated.

L

launch() - Method in class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
localBrooklynPropertiesFile(String) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
LOCALHOST_IP_ADDRESS - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
locate(String, ConfigMap, ResourceUtils) - Method in interface org.apache.brooklyn.launcher.config.CustomResourceLocator.ResourceLocator
locate(String, ConfigMap, ResourceUtils) - Method in class org.apache.brooklyn.launcher.config.CustomResourceLocator.SearchingClassPathInDevMode

M

main(String[]) - Static method in class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
MAX_TASK_AGE - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
MAX_TASKS_GLOBAL - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
MAX_TASKS_PER_ENTITY - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
MAX_TASKS_PER_TAG - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
mgmtContext - Variable in class org.apache.brooklyn.launcher.BrooklynServerDetails

N

newInstance() - Static method in class org.apache.brooklyn.launcher.BrooklynLauncher: Creates a configurable (fluent API) launcher for use starting the web console and Brooklyn applications.
newManagementContext() - Method in class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
newPlatformLauncher() - Method in class org.apache.brooklyn.launcher.camp.SimpleYamlLauncher

O

org.apache.brooklyn.launcher - package org.apache.brooklyn.launcher
org.apache.brooklyn.launcher.camp - package org.apache.brooklyn.launcher.camp
org.apache.brooklyn.launcher.config - package org.apache.brooklyn.launcher.config
org.apache.brooklyn.util.web - package org.apache.brooklyn.util.web

P

pathSpec - Variable in class org.apache.brooklyn.launcher.WebAppContextProvider
publicAddress(InetAddress) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies the address that the management context's REST API will be available on.
publicAddress - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer: The address that this server's management context will be publically available on.
putAttributes(Map) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Specifies attributes passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT

R

r - Variable in class org.apache.brooklyn.launcher.config.CustomResourceLocator
registerAlternateLocator(CustomResourceLocator.ResourceLocator) - Static method in class org.apache.brooklyn.launcher.config.CustomResourceLocator
removeContextFromList(List<Handler>, String) - Static method in class org.apache.brooklyn.util.web.ContextHandlerCollectionHotSwappable
requestedPort - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer: base port to use, for http if enabled or else https; if not set, it uses httpPort or httpsPort
REQUIRE_HTTPS - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.

S

SearchingClassPathInDevMode(String, String, String) - Constructor for class org.apache.brooklyn.launcher.config.CustomResourceLocator.SearchingClassPathInDevMode
server - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer
setAttribute(String, Object) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Specifies an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes.BROOKLYN_MANAGEMENT_CONTEXT
setBindAddress(InetAddress) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: InetAddress to which server should bind; defaults to 0.0.0.0 (although common call path is to set to 127.0.0.1 when security is not set)
setHttpsEnabled(Boolean) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
setPort(Object) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
setPublicAddress(InetAddress) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Sets the public address that the server's management context's REST API will be available on
setSecurityFilter(Class<BrooklynPropertiesSecurityFilter>) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Deprecated.
since 0.9.0, use BrooklynWebServer.skipSecurity or BrooklynLoginModule
setShutdownHandler(ShutdownHandler) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
setWar(String) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: sets the WAR to use as the root context (only if server not yet started); cf deploy("/", url)
shutdownHandler(ShutdownHandler) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: A listener to call when the user requests a shutdown (i.e.
shutdownOnExit(boolean) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
SimpleYamlLauncher - Class in org.apache.brooklyn.launcher.camp: convenience for launching YAML files directly
SimpleYamlLauncher() - Constructor for class org.apache.brooklyn.launcher.camp.SimpleYamlLauncher
skipSecurity() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
skipSecurity(boolean) - Method in class org.apache.brooklyn.launcher.BrooklynWebServer
SSH_CONFIG_DIRECT_HEADER - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
SSH_CONFIG_NO_DELETE_SCRIPT - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
SSH_CONFIG_SCRIPT_DIR - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
SSH_CONFIG_SCRIPT_HEADER - Static variable in class org.apache.brooklyn.launcher.config.BrooklynGlobalConfig: Deprecated.
start() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Starts the embedded web application server.
startApps() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
startBrooklynNode() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
startingUp() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
startWebApps() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
stop() - Method in class org.apache.brooklyn.launcher.BrooklynWebServer: Asks the app server to stop and waits for it to finish up.
stopServers() - Method in class org.apache.brooklyn.launcher.camp.BrooklynCampPlatformLauncher
stopWhichAppsOnShutdown(StopWhichAppsOnShutdown) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
StopWhichAppsOnShutdown - Enum in org.apache.brooklyn.launcher.config

T

terminate() - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Terminates this launch, but does not stop the applications (i.e.
toString() - Method in class org.apache.brooklyn.launcher.WebAppContextProvider

U

updateHandler(WebAppContext) - Method in class org.apache.brooklyn.util.web.ContextHandlerCollectionHotSwappable

V

valueOf(String) - Static method in enum org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes.BrooklynDevelopmentMode: Deprecated.

Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.brooklyn.launcher.config.StopWhichAppsOnShutdown: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.brooklyn.launcher.config.BrooklynDevelopmentModes.BrooklynDevelopmentMode: Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.brooklyn.launcher.config.StopWhichAppsOnShutdown: Returns an array containing the constants of this enum type, in the order they are declared.

W

war - Variable in class org.apache.brooklyn.launcher.BrooklynWebServer
warUrl - Variable in class org.apache.brooklyn.launcher.WebAppContextProvider
webapp(String, String) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies an additional webapp to host on the webconsole port.
webapp(WebAppContextProvider) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher
WebAppContextProvider - Class in org.apache.brooklyn.launcher: Creates a WebAppContext for a web app running in the same Jetty container as the main Brooklyn app.
WebAppContextProvider(String, String) - Constructor for class org.apache.brooklyn.launcher.WebAppContextProvider
webconsole(boolean) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies whether the launcher will start the Brooklyn web console (and any additional webapps specified); default true.
webconsoleHttps(Boolean) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies whether the webconsole should use https.
webconsolePort(int) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: As BrooklynLauncher.webconsolePort(PortRange) taking a single port
webconsolePort(String) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: As BrooklynLauncher.webconsolePort(PortRange) taking a string range
webconsolePort(PortRange) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies the port where the web console (and any additional webapps specified) will listen; default (null) means "8081+" being the first available >= 8081 (or "8443+" for https).
webServer - Variable in class org.apache.brooklyn.launcher.BrooklynServerDetails
webServerFlags(Map<String, ?>) - Method in class org.apache.brooklyn.launcher.BrooklynLauncher: Specifies additional flags to be passed to BrooklynWebServer.

A B C D G H I L M N O P R S T U V W