BrooklynNode (Apache Brooklyn)

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, SoftwareProcess, Startable, UsesJava

All Known Subinterfaces:

LocalBrooklynNode

All Known Implementing Classes:

BrooklynNodeImpl, LocalBrooklynNodeImpl
```
public interface BrooklynNode
extends SoftwareProcess, UsesJava
```

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`BrooklynNode.DeployBlueprintEffector`
`static class`	`BrooklynNode.ExistingFileBehaviour`
`static interface`	`BrooklynNode.SetHighAvailabilityModeEffector`
`static interface`	`BrooklynNode.SetHighAvailabilityPriorityEffector`
`static interface`	`BrooklynNode.ShutdownEffector`
`static interface`	`BrooklynNode.StopNodeAndKillAppsEffector`
`static interface`	`BrooklynNode.StopNodeButLeaveAppsEffector`

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
SoftwareProcess.ChildStartableMode, SoftwareProcess.RestartSoftwareParameters, 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 BasicAttributeSensorAndConfigKey<java.lang.String>`	`APP`
`static ConfigKey<java.lang.String>`	`BROOKLYN_CATALOG_CONTENTS` Deprecated. since 0.7.0; TODO this should support BOM files
`static ConfigKey<java.lang.String>`	`BROOKLYN_CATALOG_REMOTE_PATH` Deprecated. since 0.7.0; TODO this should support BOM files
`static ConfigKey<java.lang.String>`	`BROOKLYN_CATALOG_URI` Deprecated. since 0.7.0; TODO this should support BOM files
`static ConfigKey<java.lang.String>`	`BROOKLYN_GLOBAL_PROPERTIES_CONTENTS`
`static ConfigKey<java.lang.String>`	`BROOKLYN_GLOBAL_PROPERTIES_REMOTE_PATH` Exposed just for testing; remote path is not passed into the launched brooklyn so this won't be used! This will likely change in a future version.
`static ConfigKey<java.lang.String>`	`BROOKLYN_GLOBAL_PROPERTIES_URI`
`static ConfigKey<java.lang.String>`	`BROOKLYN_LOCAL_PROPERTIES_CONTENTS`
`static ConfigKey<java.lang.String>`	`BROOKLYN_LOCAL_PROPERTIES_REMOTE_PATH`
`static ConfigKey<java.lang.String>`	`BROOKLYN_LOCAL_PROPERTIES_URI`
`static BasicAttributeSensorAndConfigKey<java.util.List>`	`CLASSPATH`
`static BasicAttributeSensorAndConfigKey<java.util.Map<java.lang.String,java.lang.String>>`	`COPY_TO_RUNDIR`
`static Effector<java.lang.String>`	`DEPLOY_BLUEPRINT`
`static ConfigKey<java.lang.String>`	`DISTRO_UPLOAD_URL`
`static BasicAttributeSensorAndConfigKey<java.lang.String>`	`DOWNLOAD_URL`
`static BasicAttributeSensorAndConfigKey<java.util.List<java.lang.String>>`	`ENABLED_HTTP_PROTOCOLS`
`static ConfigKey<java.lang.String>`	`EXTRA_CUSTOMIZATION_SCRIPT` useful e.g.
`static ConfigKey<java.lang.String>`	`EXTRA_LAUNCH_PARAMETERS`
`static PortAttributeSensorAndConfigKey`	`HTTP_PORT`
`static PortAttributeSensorAndConfigKey`	`HTTPS_PORT`
`static ConfigKey<java.lang.String>`	`LAUNCH_COMMAND`
`static ConfigKey<java.lang.Boolean>`	`LAUNCH_COMMAND_CREATES_PID_FILE`
`static BasicAttributeSensorAndConfigKey<java.lang.String>`	`LOCATIONS`
`static AttributeSensor<ManagementNodeState>`	`MANAGEMENT_NODE_STATE`
`static ConfigKey<java.lang.String>`	`MANAGEMENT_PASSWORD`
`static ConfigKey<java.lang.String>`	`MANAGEMENT_USER`
`static BasicAttributeSensorAndConfigKey<java.lang.Boolean>`	`NO_WEB_CONSOLE_AUTHENTICATION`
`static ConfigKey<BrooklynNode.ExistingFileBehaviour>`	`ON_EXISTING_PROPERTIES_FILE`
`static ConfigKey<Duration>`	`POLL_PERIOD`
`static ConfigKey<com.google.common.base.Function<? super java.lang.Integer,? extends java.lang.Integer>>`	`PORT_MAPPER`
`static Effector<ManagementNodeState>`	`SET_HIGH_AVAILABILITY_MODE`
`static Effector<java.lang.Integer>`	`SET_HIGH_AVAILABILITY_PRIORITY`
`static Effector<java.lang.Void>`	`SHUTDOWN`
`static Effector<java.lang.Void>`	`STOP_NODE_AND_KILL_APPS`
`static Effector<java.lang.Void>`	`STOP_NODE_BUT_LEAVE_APPS`
`static ConfigKey<java.lang.String>`	`SUBPATH_IN_ARCHIVE`
`static ConfigKey<java.lang.String>`	`SUGGESTED_VERSION`
`static AttributeSensor<java.lang.Boolean>`	`WEB_CONSOLE_ACCESSIBLE`
`static BasicAttributeSensorAndConfigKey<java.net.InetAddress>`	`WEB_CONSOLE_BIND_ADDRESS`
`static BasicAttributeSensorAndConfigKey<java.net.InetAddress>`	`WEB_CONSOLE_PUBLIC_ADDRESS`
`static AttributeSensor<java.net.URI>`	`WEB_CONSOLE_URI`

Fields inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess
ADDRESS, CHILDREN_STARTABLE_MODE, CUSTOMIZE_LATCH, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, ENTITY_STARTED, EXPANDED_INSTALL_DIR, HOSTNAME, INBOUND_PORTS_AUTO_INFER, INBOUND_PORTS_CONFIG_REGEX, INSTALL_DIR, INSTALL_FILES, INSTALL_LATCH, INSTALL_RESOURCES_LATCH, INSTALL_TEMPLATES, INSTALL_UNIQUE_LABEL, LAUNCH_LATCH, LIFECYCLE_EFFECTOR_TASKS, MAXIMUM_REBIND_SENSOR_CONNECT_DELAY, OPEN_IPTABLES, PID_FILE, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_INSTALL_COMMAND, PRE_INSTALL_FILES, PRE_INSTALL_TEMPLATES, PRE_LAUNCH_COMMAND, PROVISIONING_LOCATION, PROVISIONING_PROPERTIES, REQUIRED_OPEN_LOGIN_PORTS, RETRIEVE_USAGE_METRICS, RUN_DIR, RUNTIME_FILES, RUNTIME_RESOURCES_LATCH, RUNTIME_TEMPLATES, SERVICE_PROCESS_IS_RUNNING, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, START_TIMEOUT, STOP_IPTABLES, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_INSTALL_DIR, SUGGESTED_RUN_DIR

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

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava
CHECK_JAVA_HOSTNAME_BUG, JAVA_OPTS, JAVA_SYSPROPS, JAVA_VERSION_REQUIRED

Method Summary

Methods
Modifier and Type Method and Description

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

Methods
Modifier and Type	Method and Description
`EntityHttpClient`	`http()`

Field Detail

COPY_TO_RUNDIR

static final BasicAttributeSensorAndConfigKey<java.util.Map<java.lang.String,java.lang.String>> COPY_TO_RUNDIR

SUGGESTED_VERSION

static final ConfigKey<java.lang.String> SUGGESTED_VERSION

DISTRO_UPLOAD_URL

static final ConfigKey<java.lang.String> DISTRO_UPLOAD_URL

DOWNLOAD_URL

static final BasicAttributeSensorAndConfigKey<java.lang.String> DOWNLOAD_URL

SUBPATH_IN_ARCHIVE

static final ConfigKey<java.lang.String> SUBPATH_IN_ARCHIVE

MANAGEMENT_USER

static final ConfigKey<java.lang.String> MANAGEMENT_USER

MANAGEMENT_PASSWORD

static final ConfigKey<java.lang.String> MANAGEMENT_PASSWORD

EXTRA_CUSTOMIZATION_SCRIPT
```
static final ConfigKey<java.lang.String> EXTRA_CUSTOMIZATION_SCRIPT
```
useful e.g. with BashCommands.generateKeyInDotSshIdRsaIfNotThere()

ON_EXISTING_PROPERTIES_FILE

static final ConfigKey<BrooklynNode.ExistingFileBehaviour> ON_EXISTING_PROPERTIES_FILE

LAUNCH_COMMAND

static final ConfigKey<java.lang.String> LAUNCH_COMMAND

EXTRA_LAUNCH_PARAMETERS

static final ConfigKey<java.lang.String> EXTRA_LAUNCH_PARAMETERS

LAUNCH_COMMAND_CREATES_PID_FILE

static final ConfigKey<java.lang.Boolean> LAUNCH_COMMAND_CREATES_PID_FILE

APP

static final BasicAttributeSensorAndConfigKey<java.lang.String> APP

LOCATIONS

static final BasicAttributeSensorAndConfigKey<java.lang.String> LOCATIONS

BROOKLYN_GLOBAL_PROPERTIES_REMOTE_PATH
```
static final ConfigKey<java.lang.String> BROOKLYN_GLOBAL_PROPERTIES_REMOTE_PATH
```
Exposed just for testing; remote path is not passed into the launched brooklyn so this won't be used! This will likely change in a future version.

BROOKLYN_GLOBAL_PROPERTIES_URI

static final ConfigKey<java.lang.String> BROOKLYN_GLOBAL_PROPERTIES_URI

BROOKLYN_GLOBAL_PROPERTIES_CONTENTS

static final ConfigKey<java.lang.String> BROOKLYN_GLOBAL_PROPERTIES_CONTENTS

BROOKLYN_LOCAL_PROPERTIES_REMOTE_PATH

static final ConfigKey<java.lang.String> BROOKLYN_LOCAL_PROPERTIES_REMOTE_PATH

BROOKLYN_LOCAL_PROPERTIES_URI

static final ConfigKey<java.lang.String> BROOKLYN_LOCAL_PROPERTIES_URI

BROOKLYN_LOCAL_PROPERTIES_CONTENTS

static final ConfigKey<java.lang.String> BROOKLYN_LOCAL_PROPERTIES_CONTENTS

BROOKLYN_CATALOG_REMOTE_PATH
```
@Deprecated
static final ConfigKey<java.lang.String> BROOKLYN_CATALOG_REMOTE_PATH
```
Deprecated. since 0.7.0; TODO this should support BOM files

BROOKLYN_CATALOG_URI
```
@Deprecated
static final ConfigKey<java.lang.String> BROOKLYN_CATALOG_URI
```
Deprecated. since 0.7.0; TODO this should support BOM files

BROOKLYN_CATALOG_CONTENTS
```
@Deprecated
static final ConfigKey<java.lang.String> BROOKLYN_CATALOG_CONTENTS
```
Deprecated. since 0.7.0; TODO this should support BOM files

ENABLED_HTTP_PROTOCOLS

static final BasicAttributeSensorAndConfigKey<java.util.List<java.lang.String>> ENABLED_HTTP_PROTOCOLS

HTTP_PORT

static final PortAttributeSensorAndConfigKey HTTP_PORT

HTTPS_PORT

static final PortAttributeSensorAndConfigKey HTTPS_PORT

NO_WEB_CONSOLE_AUTHENTICATION

static final BasicAttributeSensorAndConfigKey<java.lang.Boolean> NO_WEB_CONSOLE_AUTHENTICATION

WEB_CONSOLE_BIND_ADDRESS

static final BasicAttributeSensorAndConfigKey<java.net.InetAddress> WEB_CONSOLE_BIND_ADDRESS

WEB_CONSOLE_PUBLIC_ADDRESS

static final BasicAttributeSensorAndConfigKey<java.net.InetAddress> WEB_CONSOLE_PUBLIC_ADDRESS

WEB_CONSOLE_ACCESSIBLE

static final AttributeSensor<java.lang.Boolean> WEB_CONSOLE_ACCESSIBLE

CLASSPATH

static final BasicAttributeSensorAndConfigKey<java.util.List> CLASSPATH

PORT_MAPPER

static final ConfigKey<com.google.common.base.Function<? super java.lang.Integer,? extends java.lang.Integer>> PORT_MAPPER

WEB_CONSOLE_URI

static final AttributeSensor<java.net.URI> WEB_CONSOLE_URI

MANAGEMENT_NODE_STATE

static final AttributeSensor<ManagementNodeState> MANAGEMENT_NODE_STATE

POLL_PERIOD

static final ConfigKey<Duration> POLL_PERIOD

DEPLOY_BLUEPRINT

static final Effector<java.lang.String> DEPLOY_BLUEPRINT

SHUTDOWN

static final Effector<java.lang.Void> SHUTDOWN

STOP_NODE_BUT_LEAVE_APPS

static final Effector<java.lang.Void> STOP_NODE_BUT_LEAVE_APPS

STOP_NODE_AND_KILL_APPS

static final Effector<java.lang.Void> STOP_NODE_AND_KILL_APPS

SET_HIGH_AVAILABILITY_PRIORITY

static final Effector<java.lang.Integer> SET_HIGH_AVAILABILITY_PRIORITY

SET_HIGH_AVAILABILITY_MODE

static final Effector<ManagementNodeState> SET_HIGH_AVAILABILITY_MODE

Method Detail
- http
```
EntityHttpClient http()
```

Interface BrooklynNode

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

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.entity.software.base.SoftwareProcess

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

Fields inherited from interface org.apache.brooklyn.entity.java.UsesJava

Method Summary

Methods inherited from interface org.apache.brooklyn.entity.software.base.SoftwareProcess

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

COPY_TO_RUNDIR

SUGGESTED_VERSION

DISTRO_UPLOAD_URL

DOWNLOAD_URL

SUBPATH_IN_ARCHIVE

MANAGEMENT_USER

MANAGEMENT_PASSWORD

EXTRA_CUSTOMIZATION_SCRIPT

ON_EXISTING_PROPERTIES_FILE

LAUNCH_COMMAND

EXTRA_LAUNCH_PARAMETERS

LAUNCH_COMMAND_CREATES_PID_FILE

APP

LOCATIONS

BROOKLYN_GLOBAL_PROPERTIES_REMOTE_PATH

BROOKLYN_GLOBAL_PROPERTIES_URI

BROOKLYN_GLOBAL_PROPERTIES_CONTENTS

BROOKLYN_LOCAL_PROPERTIES_REMOTE_PATH

BROOKLYN_LOCAL_PROPERTIES_URI

BROOKLYN_LOCAL_PROPERTIES_CONTENTS

BROOKLYN_CATALOG_REMOTE_PATH

BROOKLYN_CATALOG_URI

BROOKLYN_CATALOG_CONTENTS

ENABLED_HTTP_PROTOCOLS

HTTP_PORT

HTTPS_PORT

NO_WEB_CONSOLE_AUTHENTICATION

WEB_CONSOLE_BIND_ADDRESS

WEB_CONSOLE_PUBLIC_ADDRESS

WEB_CONSOLE_ACCESSIBLE

CLASSPATH

PORT_MAPPER

WEB_CONSOLE_URI

MANAGEMENT_NODE_STATE

POLL_PERIOD

DEPLOY_BLUEPRINT

SHUTDOWN

STOP_NODE_BUT_LEAVE_APPS

STOP_NODE_AND_KILL_APPS

SET_HIGH_AVAILABILITY_PRIORITY

SET_HIGH_AVAILABILITY_MODE

Method Detail

http