BrooklynLauncher (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.launcher.BrooklynLauncher

public class BrooklynLauncher
extends java.lang.Object

Example usage is: *

 {@code
 BrooklynLauncher launcher = BrooklynLauncher.newInstance()
     .application(new WebClusterDatabaseExample().appDisplayName("Web-cluster example"))
     .location("localhost")
     .start();
 
 Entities.dumpInfo(launcher.getApplications());

Constructor Summary

Constructors
Constructor and Description

BrooklynLauncher()

Constructors
Constructor and Description
`BrooklynLauncher()`

Method Summary

Methods
Modifier and Type	Method and Description
`BrooklynLauncher`	`application(Application app)` Specifies that the launcher should manage the given Brooklyn application.
`BrooklynLauncher`	`application(ApplicationBuilder appBuilder)` Specifies that the launcher should build and manage the given Brooklyn application.
`BrooklynLauncher`	`application(EntitySpec<? extends StartableApplication> appSpec)` Specifies that the launcher should build and manage the Brooklyn application described by the given spec.
`BrooklynLauncher`	`application(java.lang.String yaml)` Specifies that the launcher should build and manage the Brooklyn application described by the given YAML blueprint.
`BrooklynLauncher`	`bindAddress(java.net.InetAddress bindAddress)` 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.
`BrooklynLauncher`	`brooklynProperties(BrooklynProperties brooklynProperties)` Specifies the brooklyn properties to be used.
`<T> BrooklynLauncher`	`brooklynProperties(ConfigKey<T> key, T value)`
`BrooklynLauncher`	`brooklynProperties(java.lang.String field, java.lang.Object value)` Specifies a property to be added to the brooklyn properties
`BrooklynLauncher`	`catalogInitialization(CatalogInitialization catInit)`
`void`	`copyPersistedState(java.lang.String destinationDir)`
`void`	`copyPersistedState(java.lang.String destinationDir, java.lang.String destinationLocation)`
`void`	`copyPersistedState(java.lang.String destinationDir, java.lang.String destinationLocationSpec, CompoundTransformer transformer)`
`BrooklynLauncher`	`customizeManagement(com.google.common.base.Function<ManagementContext,java.lang.Void> customizeManagement)`
`java.util.List<Application>`	`getApplications()`
`BrooklynServerDetails`	`getServerDetails()`
`BrooklynLauncher`	`globalBrooklynPropertiesFile(java.lang.String file)`
`BrooklynLauncher`	`haHeartbeatPeriod(Duration val)` Controls both the frequency of heartbeats, and the frequency of checking the health of other nodes.
`BrooklynLauncher`	`haHeartbeatTimeout(Duration val)`
`BrooklynLauncher`	`highAvailabilityMode(HighAvailabilityMode highAvailabilityMode)`
`BrooklynLauncher`	`ignoreAppErrors(boolean ignoreAppErrors)`
`BrooklynLauncher`	`ignoreCatalogErrors(boolean ignoreCatalogErrors)`
`BrooklynLauncher`	`ignorePersistenceErrors(boolean ignorePersistenceErrors)`
`BrooklynLauncher`	`ignoreWebErrors(boolean ignoreWebErrors)`
`BrooklynLauncher`	`installSecurityFilter(java.lang.Boolean val)`
`boolean`	`isStarted()`
`BrooklynLauncher`	`localBrooklynPropertiesFile(java.lang.String file)`
`BrooklynLauncher`	`location(Location location)` Adds a location to be passed in on `start()`, when that calls `application.start(locations)`.
`BrooklynLauncher`	`location(java.lang.String spec)` Give the spec of an application, to be created.
`BrooklynLauncher`	`locations(java.util.List<java.lang.String> specs)`
`BrooklynLauncher`	`managementContext(ManagementContext context)` Specifies the management context this launcher should use.
`static BrooklynLauncher`	`newInstance()` Creates a configurable (fluent API) launcher for use starting the web console and Brooklyn applications.
`BrooklynLauncher`	`persistenceDir(java.io.File persistenceDir)`
`BrooklynLauncher`	`persistenceDir(java.lang.String persistenceDir)`
`BrooklynLauncher`	`persistenceLocation(java.lang.String persistenceLocationSpec)`
`BrooklynLauncher`	`persistMode(PersistMode persistMode)`
`BrooklynLauncher`	`persistPeriod(Duration persistPeriod)`
`void`	`persistState(BrooklynMementoRawData memento, java.lang.String destinationDir, java.lang.String destinationLocationSpec)` Deprecated. since 0.7.0 use `copyPersistedState(java.lang.String)` instead
`BrooklynLauncher`	`publicAddress(java.net.InetAddress publicAddress)` Specifies the address that the management context's REST API will be available on.
`BrooklynMementoRawData`	`retrieveState()` Deprecated. since 0.7.0 use `copyPersistedState(java.lang.String)` instead
`BrooklynLauncher`	`shutdownHandler(ShutdownHandler shutdownHandler)` A listener to call when the user requests a shutdown (i.e.
`BrooklynLauncher`	`shutdownOnExit(boolean val)`
`BrooklynLauncher`	`start()` Starts the web server (with web console) and Brooklyn applications, as per the specifications configured.
`BrooklynLauncher`	`startBrooklynNode(boolean val)`
`BrooklynLauncher`	`stopWhichAppsOnShutdown(StopWhichAppsOnShutdown stopWhich)`
`void`	`terminate()` Terminates this launch, but does not stop the applications (i.e.
`BrooklynLauncher`	`webapp(java.lang.String contextPath, java.lang.String warUrl)` Specifies an additional webapp to host on the webconsole port.
`BrooklynLauncher`	`webconsole(boolean startWebApps)` Specifies whether the launcher will start the Brooklyn web console (and any additional webapps specified); default true.
`BrooklynLauncher`	`webconsoleHttps(java.lang.Boolean useHttps)` Specifies whether the webconsole should use https.
`BrooklynLauncher`	`webconsolePort(int port)` As `webconsolePort(PortRange)` taking a single port
`BrooklynLauncher`	`webconsolePort(PortRange port)` 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).
`BrooklynLauncher`	`webconsolePort(java.lang.String port)` As `webconsolePort(PortRange)` taking a string range
`BrooklynLauncher`	`webServerFlags(java.util.Map<java.lang.String,?> webServerFlags)` Specifies additional flags to be passed to `BrooklynWebServer`.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BrooklynLauncher
```
public BrooklynLauncher()
```
- Method Detail
  - newInstance
```
public static BrooklynLauncher newInstance()
```
    Creates a configurable (fluent API) launcher for use starting the web console and Brooklyn applications.
  - getApplications
```
public java.util.List<Application> getApplications()
```
  - getServerDetails
```
public BrooklynServerDetails getServerDetails()
```
  - application
```
public BrooklynLauncher application(Application app)
```
    Specifies that the launcher should manage the given Brooklyn application. The application must not yet be managed. The application will not be started as part of this call (callers can subsequently call start() or getApplications().
    
    See Also:
    application(ApplicationBuilder)
  - application
```
public BrooklynLauncher application(ApplicationBuilder appBuilder)
```
    Specifies that the launcher should build and manage the given Brooklyn application. The application must not yet be managed. The application will not be started as part of this call (callers can subsequently call start() or getApplications().
    
    See Also:
    application(Application)
  - application
```
public BrooklynLauncher application(EntitySpec<? extends StartableApplication> appSpec)
```
    Specifies that the launcher should build and manage the Brooklyn application described by the given spec. The application will not be started as part of this call (callers can subsequently call start() or getApplications().
    
    See Also:
    application(Application)
  - application
```
public BrooklynLauncher application(java.lang.String yaml)
```
    Specifies that the launcher should build and manage the Brooklyn application described by the given YAML blueprint. The application will not be started as part of this call (callers can subsequently call start() or getApplications().
    
    See Also:
    application(Application)
  - location
```
public BrooklynLauncher location(Location location)
```
    Adds a location to be passed in on start(), when that calls application.start(locations).
  - location
```
public BrooklynLauncher location(java.lang.String spec)
```
    Give the spec of an application, to be created.
    
    See Also:
    location(Location)
  - locations
```
public BrooklynLauncher locations(java.util.List<java.lang.String> specs)
```
  - persistenceLocation
```
public BrooklynLauncher persistenceLocation(@Nullable
                                   java.lang.String persistenceLocationSpec)
```
  - globalBrooklynPropertiesFile
```
public BrooklynLauncher globalBrooklynPropertiesFile(java.lang.String file)
```
  - localBrooklynPropertiesFile
```
public BrooklynLauncher localBrooklynPropertiesFile(java.lang.String file)
```
  - managementContext
```
public BrooklynLauncher managementContext(ManagementContext context)
```
    Specifies the management context this launcher should use. If not specified a new one is created automatically.
  - brooklynProperties
```
public BrooklynLauncher brooklynProperties(BrooklynProperties brooklynProperties)
```
    Specifies the brooklyn properties to be used. Must not be set if managementContext is explicitly set.
  - brooklynProperties
```
public BrooklynLauncher brooklynProperties(java.lang.String field,
                                  java.lang.Object value)
```
    Specifies a property to be added to the brooklyn properties
  - brooklynProperties
```
public <T> BrooklynLauncher brooklynProperties(ConfigKey<T> key,
                                      T value)
```
  - webconsole
```
public BrooklynLauncher webconsole(boolean startWebApps)
```
    Specifies whether the launcher will start the Brooklyn web console (and any additional webapps specified); default true.
  - installSecurityFilter
```
public BrooklynLauncher installSecurityFilter(java.lang.Boolean val)
```
  - webconsolePort
```
public BrooklynLauncher webconsolePort(int port)
```
    As webconsolePort(PortRange) taking a single port
  - webconsolePort
```
public BrooklynLauncher webconsolePort(java.lang.String port)
```
    As webconsolePort(PortRange) taking a string range
  - webconsolePort
```
public BrooklynLauncher webconsolePort(PortRange port)
```
    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).
  - webconsoleHttps
```
public BrooklynLauncher webconsoleHttps(java.lang.Boolean useHttps)
```
    Specifies whether the webconsole should use https.
  - bindAddress
```
public BrooklynLauncher bindAddress(java.net.InetAddress bindAddress)
```
    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. users) in which case it is localhost.
  - publicAddress
```
public BrooklynLauncher publicAddress(java.net.InetAddress publicAddress)
```
    Specifies the address that the management context's REST API will be available on. Defaults to bindAddress if it is not 0.0.0.0.
    
    See Also:
    bindAddress(java.net.InetAddress)
  - webServerFlags
```
public BrooklynLauncher webServerFlags(java.util.Map<java.lang.String,?> webServerFlags)
```
    Specifies additional flags to be passed to BrooklynWebServer.
  - webapp
```
public BrooklynLauncher webapp(java.lang.String contextPath,
                      java.lang.String warUrl)
```
    Specifies an additional webapp to host on the webconsole port.
    
    Parameters:
    contextPath - The context path (e.g. "/hello", or equivalently just "hello") where the webapp will be hosted. "/" will override the brooklyn console webapp.
    warUrl - The URL from which the WAR should be loaded, supporting classpath:// protocol in addition to file:// and http(s)://.
  - ignorePersistenceErrors
```
public BrooklynLauncher ignorePersistenceErrors(boolean ignorePersistenceErrors)
```
  - ignoreCatalogErrors
```
public BrooklynLauncher ignoreCatalogErrors(boolean ignoreCatalogErrors)
```
  - ignoreWebErrors
```
public BrooklynLauncher ignoreWebErrors(boolean ignoreWebErrors)
```
  - ignoreAppErrors
```
public BrooklynLauncher ignoreAppErrors(boolean ignoreAppErrors)
```
  - stopWhichAppsOnShutdown
```
public BrooklynLauncher stopWhichAppsOnShutdown(StopWhichAppsOnShutdown stopWhich)
```
  - customizeManagement
```
public BrooklynLauncher customizeManagement(com.google.common.base.Function<ManagementContext,java.lang.Void> customizeManagement)
```
  - catalogInitialization
```
@Beta
public BrooklynLauncher catalogInitialization(CatalogInitialization catInit)
```
  - shutdownOnExit
```
public BrooklynLauncher shutdownOnExit(boolean val)
```
  - persistMode
```
public BrooklynLauncher persistMode(PersistMode persistMode)
```
  - highAvailabilityMode
```
public BrooklynLauncher highAvailabilityMode(HighAvailabilityMode highAvailabilityMode)
```
  - persistenceDir
```
public BrooklynLauncher persistenceDir(@Nullable
                              java.lang.String persistenceDir)
```
  - persistenceDir
```
public BrooklynLauncher persistenceDir(@Nullable
                              java.io.File persistenceDir)
```
  - persistPeriod
```
public BrooklynLauncher persistPeriod(Duration persistPeriod)
```
  - haHeartbeatTimeout
```
public BrooklynLauncher haHeartbeatTimeout(Duration val)
```
  - startBrooklynNode
```
public BrooklynLauncher startBrooklynNode(boolean val)
```
  - haHeartbeatPeriod
```
public BrooklynLauncher haHeartbeatPeriod(Duration val)
```
    Controls both the frequency of heartbeats, and the frequency of checking the health of other nodes.
  - copyPersistedState
```
public void copyPersistedState(java.lang.String destinationDir)
```
    Parameters:
    destinationDir - Directory for state to be copied to
  - shutdownHandler
```
public BrooklynLauncher shutdownHandler(ShutdownHandler shutdownHandler)
```
    A listener to call when the user requests a shutdown (i.e. through the REST API)
  - copyPersistedState
```
public void copyPersistedState(java.lang.String destinationDir,
                      @Nullable
                      java.lang.String destinationLocation)
```
    Parameters:
    destinationDir - Directory for state to be copied to
    destinationLocation - Optional location if target for copied state is a blob store.
  - copyPersistedState
```
public void copyPersistedState(java.lang.String destinationDir,
                      @Nullable
                      java.lang.String destinationLocationSpec,
                      @Nullable
                      CompoundTransformer transformer)
```
    Parameters:
    destinationDir - Directory for state to be copied to
    destinationLocationSpec - Optional location if target for copied state is a blob store.
    transformer - Optional transformations to apply to retrieved state before it is copied.
  - retrieveState
```
@Deprecated
public BrooklynMementoRawData retrieveState()
```
    Deprecated. since 0.7.0 use copyPersistedState(java.lang.String) instead
  - persistState
```
@Deprecated
public void persistState(BrooklynMementoRawData memento,
                           java.lang.String destinationDir,
                           @Nullable
                           java.lang.String destinationLocationSpec)
```
    Deprecated. since 0.7.0 use copyPersistedState(java.lang.String) instead
    
    Parameters:
    memento - The state to copy
    destinationDir - Directory for state to be copied to
    destinationLocation - Optional location if target for copied state is a blob store.
  - start
```
public BrooklynLauncher start()
```
    Starts the web server (with web console) and Brooklyn applications, as per the specifications configured.
    
    Returns:
    An object containing details of the web server and the management context.
  - isStarted
```
public boolean isStarted()
```
  - terminate
```
public void terminate()
```
    Terminates this launch, but does not stop the applications (i.e. external processes are left running, etc). However, by terminating the management console the brooklyn applications become unusable.

Class BrooklynLauncher

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BrooklynLauncher

Method Detail

newInstance

getApplications

getServerDetails

application

application

application

application

location

location

locations

persistenceLocation

globalBrooklynPropertiesFile

localBrooklynPropertiesFile

managementContext

brooklynProperties

brooklynProperties

brooklynProperties

webconsole

installSecurityFilter

webconsolePort

webconsolePort

webconsolePort

webconsoleHttps

bindAddress

publicAddress

webServerFlags

webapp

ignorePersistenceErrors

ignoreCatalogErrors

ignoreWebErrors

ignoreAppErrors

stopWhichAppsOnShutdown

customizeManagement

catalogInitialization

shutdownOnExit

persistMode

highAvailabilityMode

persistenceDir

persistenceDir

persistPeriod

haHeartbeatTimeout

startBrooklynNode

haHeartbeatPeriod

copyPersistedState

shutdownHandler

copyPersistedState

copyPersistedState

retrieveState

persistState

start

isStarted

terminate