Startable (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.entity.trait
[Java] Interface Startable

public interface Startable

This interface describes an Entity that can be started and stopped. The Effectors are START, STOP and RESTART. The start effector takes a collection of Location objects as an argument which will cause the entity to be started or stopped in all these locations. The other effectors will stop or restart the entity in the location(s) it is already running in.

Field Summary
`Effector`	`RESTART`
`AttributeSensor`	`SERVICE_UP`
`Effector`	`START`
`Effector`	`STOP`

Method Summary
`void`	`restart()` Restart the entity.
`void`	`start(java.util.Collection locations)` Start the entity in the given collection of locations.
`void`	`stop()` Stop the entity.

Field Detail

RESTART

public Effector RESTART

SERVICE_UP

public AttributeSensor SERVICE_UP

START

public Effector START

STOP

public Effector STOP

Method Detail

restart

@Description("Restart the process/service represented by an entity")
public void restart()

Restart the entity.

start

@Description("Start the process/service represented by an entity")
public void start(@NamedParameter("locations") java.util.Collection locations)

Start the entity in the given collection of locations.

stop

@Description("Stop the process/service represented by an entity")
public void stop()

Stop the entity.

brooklyn.entity.trait [Java] Interface Startable