org.apache.brooklyn.launcher.common

Class BasicLauncher<T extends BasicLauncher<T>>

java.lang.Object

org.apache.brooklyn.launcher.common.BasicLauncher<T>

public class BasicLauncher<T extends BasicLauncher<T>>
extends Object

Example usage is: *

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

Constructor Summary

Constructors

Constructor and Description
BasicLauncher()

Method Summary

Modifier and Type	Method and Description
protected void	addLocations()
T	application(org.apache.brooklyn.api.entity.Application app) Deprecated. since 0.9.0; instead use application(String) for YAML apps, or application(EntitySpec). Note that apps are now auto-managed on construction through EntitySpec/YAML.
T	application(ApplicationBuilder appBuilder) Deprecated. since 0.9.0; instead use application(String) for YAML apps, or application(EntitySpec). Note that apps are now auto-managed on construction through EntitySpec/YAML.
T	application(org.apache.brooklyn.api.entity.EntitySpec<? extends StartableApplication> appSpec) Specifies that the launcher should build and manage the Brooklyn application described by the given spec.
T	application(String yaml) Specifies that the launcher should build and manage the Brooklyn application described by the given YAML blueprint.
T	brooklynProperties(BrooklynProperties brooklynProperties) Specifies the brooklyn properties to be used.
<C> T	brooklynProperties(ConfigKey<C> key, C value)
T	brooklynProperties(String field, Object value) Specifies a property to be added to the brooklyn properties
T	catalogInitialization(CatalogInitialization catInit)
void	cleanOrphanedState(String destinationDir, String destinationLocationSpec)
void	copyPersistedState(String destinationDir)
void	copyPersistedState(String destinationDir, String destinationLocation)
void	copyPersistedState(String destinationDir, String destinationLocationSpec, CompoundTransformer transformer)
protected void	createApps()
protected org.apache.brooklyn.api.entity.EntitySpec<LocalBrooklynNode>	customizeBrooklynNodeSpec(org.apache.brooklyn.api.entity.EntitySpec<LocalBrooklynNode> brooklynNodeSpec) Configure the node so it can connect to Brooklyn's REST API.
List<org.apache.brooklyn.api.entity.Application>	getApplications()
BrooklynProperties	getBrooklynProperties()
BrooklynProperties.Factory.Builder	getBrooklynPropertiesBuilder()
org.apache.brooklyn.camp.CampPlatform	getCampPlatform()
List<org.apache.brooklyn.api.location.Location>	getLocations()
org.apache.brooklyn.api.mgmt.ManagementContext	getManagementContext()
PersistMode	getPersistMode()
T	haHeartbeatPeriod(Duration val) Controls both the frequency of heartbeats, and the frequency of checking the health of other nodes.
T	haHeartbeatTimeout(Duration val)
protected void	handlePersistence()
protected void	handleSubsystemStartupError(boolean ignoreSuchErrors, String system, Exception e)
T	highAvailabilityMode(org.apache.brooklyn.api.mgmt.ha.HighAvailabilityMode highAvailabilityMode)
T	ignoreAppErrors(boolean ignoreAppErrors)
T	ignoreCatalogErrors(boolean ignoreCatalogErrors)
T	ignorePersistenceErrors(boolean ignorePersistenceErrors)
protected void	initApps()
protected void	initBrooklynNode()
protected void	initCamp()
protected void	initManagementContext()
protected void	initPersistence()
boolean	isStarted()
T	location(org.apache.brooklyn.api.location.Location location) Adds a location to be passed in on start(), when that calls application.start(locations).
T	location(String spec) Give the spec of an application, to be created.
T	locations(List<String> specs)
T	managementContext(org.apache.brooklyn.api.mgmt.ManagementContext context) Specifies the management context this launcher should use.
protected void	markCatalogStartingUp(CatalogInitialization catInit)
protected void	markStartupComplete()
protected void	persist()
T	persistenceDir(File persistenceDir)
T	persistenceDir(String persistenceDir)
T	persistenceLocation(String persistenceLocationSpec)
T	persistMode(PersistMode persistMode)
T	persistPeriod(Duration persistPeriod)
void	persistState(org.apache.brooklyn.api.mgmt.rebind.mementos.BrooklynMementoRawData memento, String destinationDir, String destinationLocationSpec) Deprecated. since 0.7.0 use copyPersistedState(java.lang.String) instead
protected void	populateCatalog(CatalogInitialization catInit)
org.apache.brooklyn.api.mgmt.rebind.mementos.BrooklynMementoRawData	retrieveState() Deprecated. since 0.7.0 use copyPersistedState(java.lang.String) instead
void	setBrooklynPropertiesBuilder(BrooklynProperties.Factory.Builder brooklynPropertiesBuilder)
T	start() Starts the web server (with web console) and Brooklyn applications, as per the specifications configured.
protected void	startApps()
protected void	startBrooklynNode()
T	startBrooklynNode(boolean val)
protected void	startingUp()
protected void	startPersistence()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BasicLauncher

public BasicLauncher()

Method Detail

getManagementContext

public org.apache.brooklyn.api.mgmt.ManagementContext getManagementContext()

getApplications

public List<org.apache.brooklyn.api.entity.Application> getApplications()

application

@Deprecated
public T application(org.apache.brooklyn.api.entity.Application app)

Deprecated. since 0.9.0; instead use application(String) for YAML apps, or application(EntitySpec). Note that apps are now auto-managed on construction through EntitySpec/YAML.

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 T application(ApplicationBuilder appBuilder)

Deprecated. since 0.9.0; instead use application(String) for YAML apps, or application(EntitySpec). Note that apps are now auto-managed on construction through EntitySpec/YAML.

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

application

public T application(org.apache.brooklyn.api.entity.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 T 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 T location(org.apache.brooklyn.api.location.Location location)

Adds a location to be passed in on start(), when that calls application.start(locations).

location

public T location(String spec)

Give the spec of an application, to be created.

See Also:

location(Location)

locations

public T locations(List<String> specs)

persistenceLocation

public T persistenceLocation(@Nullable
                             String persistenceLocationSpec)

managementContext

public T managementContext(org.apache.brooklyn.api.mgmt.ManagementContext context)

Specifies the management context this launcher should use. If not specified a new one is created automatically.

brooklynProperties

public T brooklynProperties(BrooklynProperties brooklynProperties)

Specifies the brooklyn properties to be used. Must not be set if managementContext is explicitly set.

brooklynProperties

public T brooklynProperties(String field,
                            Object value)

Specifies a property to be added to the brooklyn properties

brooklynProperties

public <C> T brooklynProperties(ConfigKey<C> key,
                                C value)

ignorePersistenceErrors

public T ignorePersistenceErrors(boolean ignorePersistenceErrors)

ignoreCatalogErrors

public T ignoreCatalogErrors(boolean ignoreCatalogErrors)

ignoreAppErrors

public T ignoreAppErrors(boolean ignoreAppErrors)

catalogInitialization

@Beta
public T catalogInitialization(CatalogInitialization catInit)

persistMode

public T persistMode(PersistMode persistMode)

highAvailabilityMode

public T highAvailabilityMode(org.apache.brooklyn.api.mgmt.ha.HighAvailabilityMode highAvailabilityMode)

persistenceDir

public T persistenceDir(@Nullable
                        String persistenceDir)

persistenceDir

public T persistenceDir(@Nullable
                        File persistenceDir)

persistPeriod

public T persistPeriod(Duration persistPeriod)

haHeartbeatTimeout

public T haHeartbeatTimeout(Duration val)

startBrooklynNode

public T startBrooklynNode(boolean val)

haHeartbeatPeriod

public T 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.

cleanOrphanedState

public void cleanOrphanedState(String destinationDir,
                               @Nullable
                               String destinationLocationSpec)

retrieveState

@Deprecated
public org.apache.brooklyn.api.mgmt.rebind.mementos.BrooklynMementoRawData retrieveState()

Deprecated. since 0.7.0 use copyPersistedState(java.lang.String) instead

persistState

@Deprecated
public void persistState(org.apache.brooklyn.api.mgmt.rebind.mementos.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

destinationLocationSpec - Optional location if target for copied state is a blob store.

start

public T 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.

persist

protected void persist()

initBrooklynNode

protected void initBrooklynNode()

initApps

protected void initApps()

markStartupComplete

protected void markStartupComplete()

addLocations

protected void addLocations()

startingUp

protected void startingUp()

populateCatalog

protected void populateCatalog(CatalogInitialization catInit)

handlePersistence

protected void handlePersistence()

initCamp

protected void initCamp()

markCatalogStartingUp

protected void markCatalogStartingUp(CatalogInitialization catInit)

initManagementContext

protected void initManagementContext()

handleSubsystemStartupError

protected void handleSubsystemStartupError(boolean ignoreSuchErrors,
                                           String system,
                                           Exception e)

initPersistence

protected void initPersistence()

startPersistence

protected void startPersistence()

createApps

protected void createApps()

startBrooklynNode

protected void startBrooklynNode()

customizeBrooklynNodeSpec

protected org.apache.brooklyn.api.entity.EntitySpec<LocalBrooklynNode> customizeBrooklynNodeSpec(org.apache.brooklyn.api.entity.EntitySpec<LocalBrooklynNode> brooklynNodeSpec)

Configure the node so it can connect to Brooklyn's REST API. Return null to skip registering the node

startApps

protected void startApps()

isStarted

public boolean isStarted()

getPersistMode

public PersistMode getPersistMode()

getLocations

public List<org.apache.brooklyn.api.location.Location> getLocations()

getCampPlatform

public org.apache.brooklyn.camp.CampPlatform getCampPlatform()

setBrooklynPropertiesBuilder

public void setBrooklynPropertiesBuilder(BrooklynProperties.Factory.Builder brooklynPropertiesBuilder)

getBrooklynPropertiesBuilder

public BrooklynProperties.Factory.Builder getBrooklynPropertiesBuilder()

getBrooklynProperties

public BrooklynProperties getBrooklynProperties()