brooklyn.launcher

Class BrooklynLauncher

java.lang.Object

brooklyn.launcher.BrooklynLauncher

public class BrooklynLauncher
extends 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()

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(String yaml) Specifies that the launcher should build and manage the Brooklyn application described by the given YAML blueprint.
BrooklynLauncher	bindAddress(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(String field, Object value) Specifies a property to be added to the brooklyn properties
BrooklynLauncher	catalogInitialization(CatalogInitialization catInit)
void	copyPersistedState(String destinationDir)
void	copyPersistedState(String destinationDir, String destinationLocation)
void	copyPersistedState(String destinationDir, String destinationLocationSpec, CompoundTransformer transformer)
protected void	createApps()
BrooklynLauncher	customizeManagement(com.google.common.base.Function<ManagementContext,Void> customizeManagement)
protected Application	getAppFromYaml(String input)
List<Application>	getApplications()
BrooklynServerDetails	getServerDetails()
BrooklynLauncher	globalBrooklynPropertiesFile(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)
protected void	initPersistence()
BrooklynLauncher	installSecurityFilter(Boolean val)
boolean	isStarted()
BrooklynLauncher	localBrooklynPropertiesFile(String file)
BrooklynLauncher	location(Location location) Adds a location to be passed in on start(), when that calls application.start(locations).
BrooklynLauncher	location(String spec) Give the spec of an application, to be created.
BrooklynLauncher	locations(List<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(File persistenceDir)
BrooklynLauncher	persistenceDir(String persistenceDir)
BrooklynLauncher	persistenceLocation(String persistenceLocationSpec)
BrooklynLauncher	persistMode(PersistMode persistMode)
BrooklynLauncher	persistPeriod(Duration persistPeriod)
void	persistState(BrooklynMementoRawData memento, String destinationDir, String destinationLocationSpec) Deprecated. since 0.7.0 use copyPersistedState(java.lang.String) instead
BrooklynLauncher	publicAddress(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	shutdownOnExit(boolean val)
BrooklynLauncher	start() Starts the web server (with web console) and Brooklyn applications, as per the specifications configured.
protected void	startApps()
protected void	startBrooklynNode()
BrooklynLauncher	startBrooklynNode(boolean val)
protected void	startPersistence()
protected void	startWebApps()
BrooklynLauncher	stopWhichAppsOnShutdown(StopWhichAppsOnShutdown stopWhich)
void	terminate() Terminates this launch, but does not stop the applications (i.e.
BrooklynLauncher	webapp(String contextPath, 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(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(String port) As webconsolePort(PortRange) taking a string range
BrooklynLauncher	webServerFlags(Map<String,?> webServerFlags) Specifies additional flags to be passed to BrooklynWebServer.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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 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(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(String spec)

Give the spec of an application, to be created.

See Also:

location(Location)

locations

public BrooklynLauncher locations(List<String> specs)

persistenceLocation

public BrooklynLauncher persistenceLocation(@Nullable
                                   String persistenceLocationSpec)

globalBrooklynPropertiesFile

public BrooklynLauncher globalBrooklynPropertiesFile(String file)

localBrooklynPropertiesFile

public BrooklynLauncher localBrooklynPropertiesFile(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(String field,
                                  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(Boolean val)

webconsolePort

public BrooklynLauncher webconsolePort(int port)

As webconsolePort(PortRange) taking a single port

webconsolePort

public BrooklynLauncher webconsolePort(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(Boolean useHttps)

Specifies whether the webconsole should use https.

bindAddress

public BrooklynLauncher bindAddress(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(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(Map<String,?> webServerFlags)

Specifies additional flags to be passed to BrooklynWebServer.

webapp

public BrooklynLauncher webapp(String contextPath,
                      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,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
                              String persistenceDir)

persistenceDir

public BrooklynLauncher persistenceDir(@Nullable
                              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(String destinationDir)

Parameters:

destinationDir - Directory for state to be copied to

copyPersistedState

public void copyPersistedState(String destinationDir,
                      @Nullable
                      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(String destinationDir,
                      @Nullable
                      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,
                           String destinationDir,
                           @Nullable
                           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.

startWebApps

protected void startWebApps()

initPersistence

protected void initPersistence()

startPersistence

protected void startPersistence()

createApps

protected void createApps()

startBrooklynNode

protected void startBrooklynNode()

getAppFromYaml

protected Application getAppFromYaml(String input)

startApps

protected void startApps()

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.