org.apache.brooklyn.entity.software.base

Interface SoftwareProcess

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, Startable

All Known Subinterfaces:

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

All Known Implementing Classes:

AbstractControllerImpl, AbstractZooKeeperImpl, ActiveMQBrokerImpl, AnsibleEntityImpl, BindDnsServerImpl, BrooklynNodeImpl, CassandraNodeImpl, ChefEntityImpl, CouchbaseNodeImpl, CouchbaseSyncGatewayImpl, CouchDBNodeImpl, CrateNodeImpl, DerbyDatabase, DockerContainerImpl, ElasticSearchNodeImpl, EmptySoftwareProcessImpl, EmptyWindowsProcessImpl, HazelcastNodeImpl, Infinispan5Server, JavaWebAppSoftwareProcessImpl, JBoss6ServerImpl, JBoss7ServerImpl, Jetty6ServerImpl, JMSBrokerImpl, KafkaBrokerImpl, KafkaZooKeeperImpl, KarafContainerImpl, KubernetesPodImpl, KubernetesResourceImpl, LocalBrooklynNodeImpl, MachineEntityImpl, MariaDbNodeImpl, MongoDBClientImpl, MongoDBConfigServerImpl, MongoDBRouterImpl, MongoDBServerImpl, MonitNodeImpl, MySqlNodeImpl, NginxControllerImpl, NodeJsWebAppServiceImpl, OpenShiftPodImpl, OpenShiftResourceImpl, PostgreSqlNodeChefImplFromScratch, PostgreSqlNodeImpl, PostgreSqlNodeSaltImpl, QpidBrokerImpl, RabbitBrokerImpl, RedisSlaveImpl, RedisStoreImpl, RiakNodeImpl, RubyRepNodeImpl, SaltEntityImpl, SimulatedJBoss7ServerImpl, SimulatedMySqlNodeImpl, SimulatedNginxControllerImpl, SimulatedVanillaSoftwareProcessImpl, 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.AdjunctSupport<T extends EntityAdjunct>, Entity.EnricherSupport, Entity.GroupSupport, Entity.PolicySupport, Entity.SensorSupport

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

BrooklynObject.RelationSupport<T extends BrooklynObject>, BrooklynObject.SubscriptionSupport, 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 ConfigKey<java.lang.Boolean>	ADD_OPEN_INBOUND_PORTS_EFFECTOR
static AttributeSensor<java.lang.String>	ADDRESS
static ConfigKey<java.lang.String>	ARCHIVE_DIRECTORY_NAME_FORMAT
static ConfigKey<SoftwareProcess.ChildStartableMode>	CHILDREN_STARTABLE_MODE
static MapConfigKey<java.lang.String>	CUSTOMIZE_FILES Files to be copied to the server before customize.
static ConfigKey<java.lang.Boolean>	CUSTOMIZE_LATCH
static MapConfigKey<java.lang.String>	CUSTOMIZE_TEMPLATES Templates to be filled in and then copied to the server before customize.
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 ConfigKey<java.lang.Boolean>	INBOUND_PORTS_AUTO_INFER
static ConfigKey<java.lang.String>	INBOUND_PORTS_CONFIG_REGEX
static AttributeSensorAndConfigKey<java.lang.String,java.lang.String>	INSTALL_DIR
static MapConfigKey<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 MapConfigKey<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_CUSTOMIZE_COMMAND
static ConfigKey<java.lang.String>	POST_INSTALL_COMMAND
static ConfigKey<java.lang.String>	POST_LAUNCH_COMMAND
static ConfigKey<java.lang.String>	PRE_CUSTOMIZE_COMMAND
static ConfigKey<java.lang.String>	PRE_INSTALL_COMMAND
static MapConfigKey<java.lang.String>	PRE_INSTALL_FILES Files to be copied to the server before pre-install.
static MapConfigKey<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 MapConfigKey<java.lang.String>	RUNTIME_FILES Files to be copied to the server after customisation.
static ConfigKey<java.lang.Boolean>	RUNTIME_RESOURCES_LATCH
static MapConfigKey<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 ConfigKey<Duration>	SERVICE_PROCESS_IS_RUNNING_POLL_PERIOD
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 ConfigKey<java.lang.Boolean>	STOP_LATCH
static AttributeSensor<java.lang.String>	SUBNET_ADDRESS
static AttributeSensor<java.lang.String>	SUBNET_HOSTNAME
static ConfigKey<java.lang.String>	SUGGESTED_VERSION
static MapConfigKey<java.lang.Object>	TEMPLATE_SUBSTITUTIONS

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

RESTART, SERVICE_UP, START, STOP

Method Summary

Modifier and Type	Method and Description
void	populateServiceNotUpDiagnostics()

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

addChild, addChild, addFeed, clearParent, enrichers, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getCreationTime, getDisplayName, getEntityType, getIconUrl, getId, getLocations, getParent, groups, invoke, policies, relations, removeChild, sensors, setDisplayName, setParent

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

getCatalogItemId, getCatalogItemIdSearchPath, subscriptions, tags

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

config, getConfig

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

restart, start, stop

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

INBOUND_PORTS_CONFIG_REGEX

static final ConfigKey<java.lang.String> INBOUND_PORTS_CONFIG_REGEX

INBOUND_PORTS_AUTO_INFER

static final ConfigKey<java.lang.Boolean> INBOUND_PORTS_AUTO_INFER

START_TIMEOUT

static final ConfigKey<Duration> START_TIMEOUT

START_LATCH

static final ConfigKey<java.lang.Boolean> START_LATCH

STOP_LATCH

static final ConfigKey<java.lang.Boolean> STOP_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_CUSTOMIZE_COMMAND

static final ConfigKey<java.lang.String> PRE_CUSTOMIZE_COMMAND

POST_CUSTOMIZE_COMMAND

static final ConfigKey<java.lang.String> POST_CUSTOMIZE_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

ARCHIVE_DIRECTORY_NAME_FORMAT

static final ConfigKey<java.lang.String> ARCHIVE_DIRECTORY_NAME_FORMAT

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

RUN_DIR

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

ADD_OPEN_INBOUND_PORTS_EFFECTOR

static final ConfigKey<java.lang.Boolean> ADD_OPEN_INBOUND_PORTS_EFFECTOR

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

TEMPLATE_SUBSTITUTIONS

static final MapConfigKey<java.lang.Object> TEMPLATE_SUBSTITUTIONS

PRE_INSTALL_FILES

static final MapConfigKey<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

static final MapConfigKey<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

static final MapConfigKey<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

static final MapConfigKey<java.lang.String> INSTALL_TEMPLATES

Templates to be filled in and then copied to the server before install.

See Also:

INSTALL_FILES

CUSTOMIZE_FILES

static final MapConfigKey<java.lang.String> CUSTOMIZE_FILES

Files to be copied to the server before customize.

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

CUSTOMIZE_TEMPLATES

static final MapConfigKey<java.lang.String> CUSTOMIZE_TEMPLATES

Templates to be filled in and then copied to the server before customize.

See Also:

INSTALL_FILES

RUNTIME_FILES

static final MapConfigKey<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

static final MapConfigKey<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

SERVICE_PROCESS_IS_RUNNING_POLL_PERIOD

static final ConfigKey<Duration> SERVICE_PROCESS_IS_RUNNING_POLL_PERIOD

LIFECYCLE_EFFECTOR_TASKS

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

void populateServiceNotUpDiagnostics()

Since:

0.8.0