SoftwareProcess (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, Startable

All Known Subinterfaces:

AbstractController, AbstractMongoDBServer, AbstractVanillaProcess, ActiveMQBroker, BindDnsServer, BrooklynNode, CassandraNode, ChefEntity, CouchbaseNode, CouchbaseSyncGateway, CouchDBNode, CrateNode, ElasticSearchNode, EmptySoftwareProcess, JavaWebAppSoftwareProcess, JBoss6Server, JBoss7Server, Jetty6Server, JMSBroker<Q,T>, KafkaBroker, KafkaZooKeeper, KarafContainer, LocalBrooklynNode, MachineEntity, MariaDbNode, MongoDBClient, MongoDBConfigServer, MongoDBRouter, MongoDBServer, MonitNode, MySqlNode, NginxController, NodeJsWebAppService, PostgreSqlNode, QpidBroker, RabbitBroker, RedisSlave, RedisStore, RiakNode, RubyRepNode, SolrServer, Storm, Tomcat8Server, TomcatServer, VanillaJavaApp, VanillaSoftwareProcess, VanillaWindowsProcess, ZooKeeperNode

All Known Implementing Classes:

AbstractControllerImpl, AbstractZooKeeperImpl, ActiveMQBrokerImpl, BindDnsServerImpl, BrooklynNodeImpl, CassandraNodeImpl, ChefEntityImpl, CouchbaseNodeImpl, CouchbaseSyncGatewayImpl, CouchDBNodeImpl, CrateNodeImpl, ElasticSearchNodeImpl, EmptySoftwareProcessImpl, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, JMSBrokerImpl, KafkaBrokerImpl, KafkaZooKeeperImpl, KarafContainerImpl, LocalBrooklynNodeImpl, MachineEntityImpl, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerImpl, MongoDBRouterImpl, MongoDBServerImpl, MonitNodeImpl, MySqlNodeImpl, NginxControllerImpl, NodeJsWebAppServiceImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, QpidBrokerImpl, RabbitBrokerImpl, RedisSlaveImpl, RedisStoreImpl, RiakNodeImpl, RubyRepNodeImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SoftwareProcessImpl, SolrServerImpl, StormImpl, Tomcat8ServerImpl, TomcatServerImpl, VanillaJavaAppImpl, VanillaSoftwareProcessImpl, VanillaWindowsProcessImpl, ZooKeeperNodeImpl
```
public interface SoftwareProcess
extends Entity, Startable
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`SoftwareProcess.ChildStartableMode` Controls the behavior when starting (stop, restart) `Startable` children as part of the start (stop, restart) effector on this entity
`static class`	`SoftwareProcess.RestartSoftwareParameters`
`static class`	`SoftwareProcess.StopSoftwareParameters`

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity
Entity.SensorSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject
BrooklynObject.TagSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable
Configurable.ConfigurationSupport

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable
Startable.RestartEffectorBody, Startable.StartEffectorBody, Startable.StopEffectorBody

Field Summary

Fields
Modifier and Type	Field and Description
`static AttributeSensor<java.lang.String>`	`ADDRESS`
`static ConfigKey<SoftwareProcess.ChildStartableMode>`	`CHILDREN_STARTABLE_MODE`
`static ConfigKey<java.lang.Boolean>`	`CUSTOMIZE_LATCH`
`static ConfigKey<java.lang.Boolean>`	`DONT_REQUIRE_TTY_FOR_SUDO`
`static AttributeSensorAndConfigKey<java.util.Map<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,java.lang.String>>`	`DOWNLOAD_ADDON_URLS`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`DOWNLOAD_URL`
`static ConfigKey<java.lang.Boolean>`	`ENTITY_STARTED`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`EXPANDED_INSTALL_DIR`
`static AttributeSensor<java.lang.String>`	`HOSTNAME`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`INSTALL_DIR`
`static ConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`INSTALL_FILES` Files to be copied to the server before install.
`static ConfigKey<java.lang.Boolean>`	`INSTALL_LATCH`
`static ConfigKey<java.lang.Boolean>`	`INSTALL_RESOURCES_LATCH`
`static ConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`INSTALL_TEMPLATES` Templates to be filled in and then copied to the server before install.
`static ConfigKey<java.lang.String>`	`INSTALL_UNIQUE_LABEL`
`static ConfigKey<java.lang.Boolean>`	`LAUNCH_LATCH`
`static ConfigKey<SoftwareProcessDriverLifecycleEffectorTasks>`	`LIFECYCLE_EFFECTOR_TASKS` Sets the object that manages the sequence of calls of the entity's driver.
`static ConfigKey<Duration>`	`MAXIMUM_REBIND_SENSOR_CONNECT_DELAY`
`static ConfigKey<java.lang.Boolean>`	`OPEN_IPTABLES`
`static AttributeSensor<java.lang.String>`	`PID_FILE`
`static ConfigKey<java.lang.String>`	`POST_INSTALL_COMMAND`
`static ConfigKey<java.lang.String>`	`POST_LAUNCH_COMMAND`
`static ConfigKey<java.lang.String>`	`PRE_INSTALL_COMMAND`
`static ConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`PRE_INSTALL_FILES` Files to be copied to the server before pre-install.
`static ConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`PRE_INSTALL_TEMPLATES` Templates to be filled in and then copied to the server before install.
`static ConfigKey<java.lang.String>`	`PRE_LAUNCH_COMMAND`
`static AttributeSensor<MachineProvisioningLocation>`	`PROVISIONING_LOCATION`
`static MapConfigKey<java.lang.Object>`	`PROVISIONING_PROPERTIES`
`static ConfigKey<java.util.Collection<java.lang.Integer>>`	`REQUIRED_OPEN_LOGIN_PORTS`
`static ConfigKey<java.lang.Boolean>`	`RETRIEVE_USAGE_METRICS`
`static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>`	`RUN_DIR`
`static ConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`RUNTIME_FILES` Files to be copied to the server after customisation.
`static ConfigKey<java.lang.Boolean>`	`RUNTIME_RESOURCES_LATCH`
`static ConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`RUNTIME_TEMPLATES` Templates to be filled in and then copied to the server after customisation.
`static AttributeSensor<java.lang.Boolean>`	`SERVICE_PROCESS_IS_RUNNING`
`static AttributeSensor<Lifecycle>`	`SERVICE_STATE_ACTUAL`
`static AttributeSensor<Lifecycle.Transition>`	`SERVICE_STATE_EXPECTED`
`static ConfigKey<java.lang.Boolean>`	`SETUP_LATCH`
`static MapConfigKey<java.lang.Object>`	`SHELL_ENVIRONMENT`
`static ConfigKey<java.lang.Boolean>`	`SKIP_ENTITY_START_IF_RUNNING`
`static ConfigKey<java.lang.Boolean>`	`SKIP_INSTALLATION`
`static ConfigKey<java.lang.Boolean>`	`START_LATCH`
`static ConfigKey<Duration>`	`START_TIMEOUT`
`static ConfigKey<java.lang.Boolean>`	`STOP_IPTABLES`
`static AttributeSensor<java.lang.String>`	`SUBNET_ADDRESS`
`static AttributeSensor<java.lang.String>`	`SUBNET_HOSTNAME`
`static ConfigKey<java.lang.String>`	`SUGGESTED_INSTALL_DIR` Deprecated.
`static ConfigKey<java.lang.String>`	`SUGGESTED_RUN_DIR` Deprecated.
`static ConfigKey<java.lang.String>`	`SUGGESTED_VERSION`

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable
RESTART, SERVICE_UP, START, STOP

Method Summary

Methods
Modifier and Type Method and Description

void populateServiceNotUpDiagnostics()
- Methods inherited from interface org.apache.brooklyn.api.entity.Entity
  addChild, addChild, addEnricher, addEnricher, addFeed, addGroup, addPolicy, addPolicy, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getConfigRaw, getConfigRaw, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, invoke, removeChild, removeEnricher, removeGroup, removePolicy, sensors, setParent
- Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject
  getCatalogItemId, tags
- Methods inherited from interface org.apache.brooklyn.api.objs.Configurable
  config, setConfig
- Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable
  restart, start, stop

Methods
Modifier and Type	Method and Description
`void`	`populateServiceNotUpDiagnostics()`

Field Detail

HOSTNAME

static final AttributeSensor<java.lang.String> HOSTNAME

ADDRESS

static final AttributeSensor<java.lang.String> ADDRESS

SUBNET_HOSTNAME

static final AttributeSensor<java.lang.String> SUBNET_HOSTNAME

SUBNET_ADDRESS

static final AttributeSensor<java.lang.String> SUBNET_ADDRESS

REQUIRED_OPEN_LOGIN_PORTS

static final ConfigKey<java.util.Collection<java.lang.Integer>> REQUIRED_OPEN_LOGIN_PORTS

START_TIMEOUT

static final ConfigKey<Duration> START_TIMEOUT

START_LATCH

static final ConfigKey<java.lang.Boolean> START_LATCH

SETUP_LATCH

static final ConfigKey<java.lang.Boolean> SETUP_LATCH

INSTALL_RESOURCES_LATCH

static final ConfigKey<java.lang.Boolean> INSTALL_RESOURCES_LATCH

INSTALL_LATCH

static final ConfigKey<java.lang.Boolean> INSTALL_LATCH

RUNTIME_RESOURCES_LATCH

static final ConfigKey<java.lang.Boolean> RUNTIME_RESOURCES_LATCH

CUSTOMIZE_LATCH

static final ConfigKey<java.lang.Boolean> CUSTOMIZE_LATCH

LAUNCH_LATCH

static final ConfigKey<java.lang.Boolean> LAUNCH_LATCH

ENTITY_STARTED

static final ConfigKey<java.lang.Boolean> ENTITY_STARTED

SKIP_ENTITY_START_IF_RUNNING

static final ConfigKey<java.lang.Boolean> SKIP_ENTITY_START_IF_RUNNING

SKIP_INSTALLATION

static final ConfigKey<java.lang.Boolean> SKIP_INSTALLATION

PRE_INSTALL_COMMAND

static final ConfigKey<java.lang.String> PRE_INSTALL_COMMAND

POST_INSTALL_COMMAND

static final ConfigKey<java.lang.String> POST_INSTALL_COMMAND

PRE_LAUNCH_COMMAND

static final ConfigKey<java.lang.String> PRE_LAUNCH_COMMAND

POST_LAUNCH_COMMAND

static final ConfigKey<java.lang.String> POST_LAUNCH_COMMAND

SHELL_ENVIRONMENT

static final MapConfigKey<java.lang.Object> SHELL_ENVIRONMENT

SUGGESTED_VERSION

static final ConfigKey<java.lang.String> SUGGESTED_VERSION

DOWNLOAD_URL

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> DOWNLOAD_URL

DOWNLOAD_ADDON_URLS

static final AttributeSensorAndConfigKey<java.util.Map<java.lang.String,java.lang.String>,java.util.Map<java.lang.String,java.lang.String>> DOWNLOAD_ADDON_URLS

INSTALL_UNIQUE_LABEL

static final ConfigKey<java.lang.String> INSTALL_UNIQUE_LABEL

EXPANDED_INSTALL_DIR

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> EXPANDED_INSTALL_DIR

INSTALL_DIR

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> INSTALL_DIR

SUGGESTED_INSTALL_DIR

@Deprecated
static final ConfigKey<java.lang.String> SUGGESTED_INSTALL_DIR

Deprecated.

RUN_DIR

static final AttributeSensorAndConfigKey<java.lang.String,java.lang.String> RUN_DIR

SUGGESTED_RUN_DIR

@Deprecated
static final ConfigKey<java.lang.String> SUGGESTED_RUN_DIR

Deprecated.

OPEN_IPTABLES

static final ConfigKey<java.lang.Boolean> OPEN_IPTABLES

STOP_IPTABLES

static final ConfigKey<java.lang.Boolean> STOP_IPTABLES

DONT_REQUIRE_TTY_FOR_SUDO

static final ConfigKey<java.lang.Boolean> DONT_REQUIRE_TTY_FOR_SUDO

PRE_INSTALL_FILES
```
@Beta
static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> PRE_INSTALL_FILES
```
Files to be copied to the server before pre-install.
Map of classpath://foo/file.txt (or other url) source to destination path, as subdir/file relative to installation directory or /absolute/path/to/file.

See Also:
PRE_INSTALL_TEMPLATES

PRE_INSTALL_TEMPLATES
```
@Beta
static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> PRE_INSTALL_TEMPLATES
```
Templates to be filled in and then copied to the server before install.

See Also:
PRE_INSTALL_FILES

INSTALL_FILES
```
@Beta
static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> INSTALL_FILES
```
Files to be copied to the server before install.
Map of classpath://foo/file.txt (or other url) source to destination path, as subdir/file relative to installation directory or /absolute/path/to/file.

See Also:
INSTALL_TEMPLATES

INSTALL_TEMPLATES
```
@Beta
static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> INSTALL_TEMPLATES
```
Templates to be filled in and then copied to the server before install.

See Also:
INSTALL_FILES

RUNTIME_FILES
```
@Beta
static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> RUNTIME_FILES
```
Files to be copied to the server after customisation.
Map of classpath://foo/file.txt (or other url) source to destination path, as subdir/file relative to runtime directory or /absolute/path/to/file.

See Also:
RUNTIME_TEMPLATES

RUNTIME_TEMPLATES
```
@Beta
static final ConfigKey<java.util.Map<java.lang.String,java.lang.String>> RUNTIME_TEMPLATES
```
Templates to be filled in and then copied to the server after customisation.

See Also:
RUNTIME_FILES

PROVISIONING_PROPERTIES

static final MapConfigKey<java.lang.Object> PROVISIONING_PROPERTIES

MAXIMUM_REBIND_SENSOR_CONNECT_DELAY

static final ConfigKey<Duration> MAXIMUM_REBIND_SENSOR_CONNECT_DELAY

LIFECYCLE_EFFECTOR_TASKS

@Beta
static final ConfigKey<SoftwareProcessDriverLifecycleEffectorTasks> LIFECYCLE_EFFECTOR_TASKS

Sets the object that manages the sequence of calls of the entity's driver.

RETRIEVE_USAGE_METRICS

static final ConfigKey<java.lang.Boolean> RETRIEVE_USAGE_METRICS

CHILDREN_STARTABLE_MODE

static final ConfigKey<SoftwareProcess.ChildStartableMode> CHILDREN_STARTABLE_MODE

PROVISIONING_LOCATION

static final AttributeSensor<MachineProvisioningLocation> PROVISIONING_LOCATION

SERVICE_PROCESS_IS_RUNNING

static final AttributeSensor<java.lang.Boolean> SERVICE_PROCESS_IS_RUNNING

SERVICE_STATE_ACTUAL

static final AttributeSensor<Lifecycle> SERVICE_STATE_ACTUAL

SERVICE_STATE_EXPECTED

static final AttributeSensor<Lifecycle.Transition> SERVICE_STATE_EXPECTED

PID_FILE

static final AttributeSensor<java.lang.String> PID_FILE

Method Detail
- populateServiceNotUpDiagnostics
```
@Beta
void populateServiceNotUpDiagnostics()
```
  Since:
  
  0.8.0

Interface SoftwareProcess

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.entity.Entity

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

Nested classes/interfaces inherited from interface org.apache.brooklyn.api.objs.Configurable

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Field Summary

Fields inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Method Summary

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

Methods inherited from interface org.apache.brooklyn.core.entity.trait.Startable

Field Detail

HOSTNAME

ADDRESS

SUBNET_HOSTNAME

SUBNET_ADDRESS

REQUIRED_OPEN_LOGIN_PORTS

START_TIMEOUT

START_LATCH

SETUP_LATCH

INSTALL_RESOURCES_LATCH

INSTALL_LATCH

RUNTIME_RESOURCES_LATCH

CUSTOMIZE_LATCH

LAUNCH_LATCH

ENTITY_STARTED

SKIP_ENTITY_START_IF_RUNNING

SKIP_INSTALLATION

PRE_INSTALL_COMMAND

POST_INSTALL_COMMAND

PRE_LAUNCH_COMMAND

POST_LAUNCH_COMMAND

SHELL_ENVIRONMENT

SUGGESTED_VERSION

DOWNLOAD_URL

DOWNLOAD_ADDON_URLS

INSTALL_UNIQUE_LABEL

EXPANDED_INSTALL_DIR

INSTALL_DIR

SUGGESTED_INSTALL_DIR

RUN_DIR

SUGGESTED_RUN_DIR

OPEN_IPTABLES

STOP_IPTABLES

DONT_REQUIRE_TTY_FOR_SUDO

PRE_INSTALL_FILES

PRE_INSTALL_TEMPLATES

INSTALL_FILES

INSTALL_TEMPLATES

RUNTIME_FILES

RUNTIME_TEMPLATES

PROVISIONING_PROPERTIES

MAXIMUM_REBIND_SENSOR_CONNECT_DELAY

LIFECYCLE_EFFECTOR_TASKS

RETRIEVE_USAGE_METRICS

CHILDREN_STARTABLE_MODE

PROVISIONING_LOCATION

SERVICE_PROCESS_IS_RUNNING

SERVICE_STATE_ACTUAL

SERVICE_STATE_EXPECTED

PID_FILE

Method Detail

populateServiceNotUpDiagnostics