BrooklynLauncher (Apache Brooklyn)

java.lang.Object
- org.apache.brooklyn.launcher.common.BasicLauncher<BrooklynLauncher>
- - org.apache.brooklyn.launcher.BrooklynLauncher

public class BrooklynLauncher
extends BasicLauncher<BrooklynLauncher>

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`	`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`	`customizeManagement( customizeManagement)`
`BrooklynServerDetails`	`getServerDetails()`
`BrooklynLauncher`	`globalBrooklynPropertiesFile(java.lang.String file)`
`BrooklynLauncher`	`ignoreWebErrors(boolean ignoreWebErrors)`
`BrooklynLauncher`	`installSecurityFilter(java.lang.Boolean val)`
`BrooklynLauncher`	`localBrooklynPropertiesFile(java.lang.String file)`
`static BrooklynLauncher`	`newInstance()` Creates a configurable (fluent API) launcher for use starting the web console and Brooklyn applications.
`BrooklynLauncher`	`publicAddress(java.net.InetAddress publicAddress)` Specifies the address that the management context's REST API will be available on.
`BrooklynLauncher`	`shutdownHandler(ShutdownHandler shutdownHandler)` A listener to call when the user requests a shutdown (i.e.
`BrooklynLauncher`	`shutdownOnExit(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`	`webapp(WebAppContextProvider contextProvider)`
`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.
  - getServerDetails
```
public BrooklynServerDetails getServerDetails()
```
  - 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)://.
  - webapp
```
public BrooklynLauncher webapp(WebAppContextProvider contextProvider)
```
    See Also:
    webapp(String, String)
  - ignoreWebErrors
```
public BrooklynLauncher ignoreWebErrors(boolean ignoreWebErrors)
```
  - stopWhichAppsOnShutdown
```
public BrooklynLauncher stopWhichAppsOnShutdown(StopWhichAppsOnShutdown stopWhich)
```
  - customizeManagement
```
public BrooklynLauncher customizeManagement( customizeManagement)
```
  - shutdownOnExit
```
public BrooklynLauncher shutdownOnExit(boolean val)
```
  - shutdownHandler
```
public BrooklynLauncher shutdownHandler(ShutdownHandler shutdownHandler)
```
    A listener to call when the user requests a shutdown (i.e. through the REST API)
  - 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.
  - globalBrooklynPropertiesFile
```
public BrooklynLauncher globalBrooklynPropertiesFile(java.lang.String file)
```
  - localBrooklynPropertiesFile
```
public BrooklynLauncher localBrooklynPropertiesFile(java.lang.String file)
```

Class BrooklynLauncher

Constructor Summary

Method Summary

Methods inherited from class org.apache.brooklyn.launcher.common.BasicLauncher

Methods inherited from class java.lang.Object

Constructor Detail

BrooklynLauncher

Method Detail

newInstance

getServerDetails

webconsole

installSecurityFilter

webconsolePort

webconsolePort

webconsolePort

webconsoleHttps

bindAddress

publicAddress

webServerFlags

webapp

webapp

ignoreWebErrors

stopWhichAppsOnShutdown

customizeManagement

shutdownOnExit

shutdownHandler

terminate

globalBrooklynPropertiesFile

localBrooklynPropertiesFile