Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

brooklyn.launcher
[Java] Class BrooklynLauncher

java.lang.Object
  brooklyn.launcher.BrooklynLauncher

public class BrooklynLauncher

Example usage is: * 

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

Method Summary
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 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. users) in which case it is localhost.
BrooklynLauncher brooklynProperties(BrooklynProperties brooklynProperties)

Specifies the brooklyn properties to be used.

BrooklynLauncher brooklynProperties(java.lang.String field, java.lang.Object value)

Specifies an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes#BROOKLYN_MANAGEMENT_CONTEXT#BROOKLYN_MANAGEMENT_CONTEXT
BrooklynLauncher brooklynProperties(ConfigKey key, java.lang.Object value)

protected void checkPersistenceDirAccessible(java.io.File persistenceDir)

protected void checkPersistenceDirNonEmpty(java.io.File persistenceDir)

protected void createApps()

protected Application getAppFromYaml(java.lang.String input)

java.util.List getApplications()

BrooklynServerDetails getServerDetails()

BrooklynLauncher globalBrooklynPropertiesFile(java.lang.String file)

protected void initPersistence()

BrooklynLauncher installSecurityFilter(java.lang.Boolean val)

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 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 persistMode(PersistMode persistMode)

BrooklynLauncher persistPeriod(Duration persistPeriod)

BrooklynLauncher persistenceDir(java.lang.String persistenceDir)

BrooklynLauncher persistenceDir(java.io.File persistenceDir)

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 startWebApps()

void terminate()

Terminates this launch, but does not stop the applications (i.e. external processes are left running, etc).

BrooklynLauncher webServerFlags(java.util.Map webServerFlags)

Specifies additional flags to be passed to BrooklynWebServer.
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 webconsolePort(int port)

Specifies the port where the web console (and any additional webapps specified) will listen; default "8081+" being the first available >= 8081.
BrooklynLauncher webconsolePort(java.lang.String port)

Specifies the port where the web console (and any additional webapps specified) will listen; default "8081+" being the first available >= 8081.
BrooklynLauncher webconsolePort(PortRange port)

Specifies the port where the web console (and any additional webapps specified) will listen; default "8081+" being the first available >= 8081.
 
Methods inherited from class java.lang.Object
java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()
 

Method Detail

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 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)

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.

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 an attribute passed to deployed webapps (in addition to BrooklynServiceAttributes#BROOKLYN_MANAGEMENT_CONTEXT#BROOKLYN_MANAGEMENT_CONTEXT

brooklynProperties

public BrooklynLauncher brooklynProperties(ConfigKey key, java.lang.Object value)

checkPersistenceDirAccessible

protected void checkPersistenceDirAccessible(java.io.File persistenceDir)

checkPersistenceDirNonEmpty

protected void checkPersistenceDirNonEmpty(java.io.File persistenceDir)

createApps

protected void createApps()

getAppFromYaml

protected Application getAppFromYaml(java.lang.String input)

getApplications

public java.util.List getApplications()

getServerDetails

public BrooklynServerDetails getServerDetails()

globalBrooklynPropertiesFile

public BrooklynLauncher globalBrooklynPropertiesFile(java.lang.String file)

initPersistence

protected void initPersistence()

installSecurityFilter

public BrooklynLauncher installSecurityFilter(java.lang.Boolean val)

localBrooklynPropertiesFile

public BrooklynLauncher localBrooklynPropertiesFile(java.lang.String file)

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 specs)

managementContext

public BrooklynLauncher managementContext(ManagementContext context)
Specifies the management context this launcher should use. If not specified a new one is created automatically.

newInstance

public static BrooklynLauncher newInstance()
Creates a configurable (fluent API) launcher for use starting the web console and Brooklyn applications.

persistMode

public BrooklynLauncher persistMode(PersistMode persistMode)

persistPeriod

public BrooklynLauncher persistPeriod(Duration persistPeriod)

persistenceDir

public BrooklynLauncher persistenceDir(java.lang.String persistenceDir)

persistenceDir

public BrooklynLauncher persistenceDir(java.io.File persistenceDir)

shutdownOnExit

public BrooklynLauncher shutdownOnExit(boolean val)

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.

startApps

protected void startApps()

startWebApps

protected void startWebApps()

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.

webServerFlags

public BrooklynLauncher webServerFlags(java.util.Map 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)://.

webconsole

public BrooklynLauncher webconsole(boolean startWebApps)
Specifies whether the launcher will start the Brooklyn web console (and any additional webapps specified); default true.

webconsolePort

public BrooklynLauncher webconsolePort(int port)
Specifies the port where the web console (and any additional webapps specified) will listen; default "8081+" being the first available >= 8081.

webconsolePort

public BrooklynLauncher webconsolePort(java.lang.String port)
Specifies the port where the web console (and any additional webapps specified) will listen; default "8081+" being the first available >= 8081.

webconsolePort

public BrooklynLauncher webconsolePort(PortRange port)
Specifies the port where the web console (and any additional webapps specified) will listen; default "8081+" being the first available >= 8081.

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.