org.apache.brooklyn.entity.proxy

Interface AbstractController

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, LoadBalancer, SoftwareProcess, Startable

All Known Subinterfaces:

NginxController

All Known Implementing Classes:

AbstractControllerImpl, NginxControllerImpl, SimulatedNginxControllerImpl

public interface AbstractController
extends SoftwareProcess, LoadBalancer

Represents a controller mechanism for a Cluster.

Nested Class Summary

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>	DOMAIN_NAME
static AttributeSensor<java.net.URI>	MAIN_URI_MAPPED_PUBLIC
static AttributeSensor<java.net.URI>	MAIN_URI_MAPPED_SUBNET
static ConfigKey<java.lang.String>	SERVICE_UP_URL_PATH
static ConfigKey<ProxySslConfig>	SSL_CONFIG

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

ADD_OPEN_INBOUND_PORTS_EFFECTOR, ADDRESS, ARCHIVE_DIRECTORY_NAME_FORMAT, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, 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_CUSTOMIZE_COMMAND, POST_INSTALL_COMMAND, POST_LAUNCH_COMMAND, PRE_CUSTOMIZE_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_PROCESS_IS_RUNNING_POLL_PERIOD, SERVICE_STATE_ACTUAL, SERVICE_STATE_EXPECTED, SETUP_LATCH, SHELL_ENVIRONMENT, SKIP_ENTITY_START_IF_RUNNING, SKIP_INSTALLATION, START_LATCH, START_TIMEOUT, STOP_IPTABLES, STOP_LATCH, SUBNET_ADDRESS, SUBNET_HOSTNAME, SUGGESTED_VERSION, TEMPLATE_SUBSTITUTIONS

Fields inherited from interface org.apache.brooklyn.entity.proxy.LoadBalancer

HOST_AND_PORT_SENSOR, HOSTNAME, HOSTNAME_SENSOR, MAIN_URI, PORT_NUMBER_SENSOR, PROTOCOL, PROXY_HTTP_PORT, PROXY_HTTPS_PORT, RELOAD, ROOT_URL, SERVER_POOL, SERVER_POOL_TARGETS, UPDATE, URL_MAPPINGS

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

RESTART, SERVICE_UP, START, STOP

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDomain() returns primary domain this controller responds to, or null if it responds to all domains
AttributeSensor<java.lang.String>	getHostAndPortSensor()
AttributeSensor<java.lang.String>	getHostnameSensor()
java.lang.Integer	getPort()
AttributeSensor<java.lang.Integer>	getPortNumberSensor()
java.lang.String	getProtocol()
java.util.Set<java.lang.String>	getServerPoolAddresses()
ProxySslConfig	getSslConfig()
java.lang.String	getUrl() primary URL this controller serves, if one can / has been inferred
boolean	isActive()
boolean	isSsl()

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

populateServiceNotUpDiagnostics

Methods inherited from interface org.apache.brooklyn.entity.proxy.LoadBalancer

bind, changeServerPool, reload, update

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

DOMAIN_NAME

static final BasicAttributeSensorAndConfigKey<java.lang.String> DOMAIN_NAME

SSL_CONFIG

static final ConfigKey<ProxySslConfig> SSL_CONFIG

SERVICE_UP_URL_PATH

static final ConfigKey<java.lang.String> SERVICE_UP_URL_PATH

MAIN_URI_MAPPED_SUBNET

static final AttributeSensor<java.net.URI> MAIN_URI_MAPPED_SUBNET

MAIN_URI_MAPPED_PUBLIC

static final AttributeSensor<java.net.URI> MAIN_URI_MAPPED_PUBLIC

Method Detail

isActive

boolean isActive()

getSslConfig

ProxySslConfig getSslConfig()

isSsl

boolean isSsl()

getProtocol

java.lang.String getProtocol()

getDomain

java.lang.String getDomain()

returns primary domain this controller responds to, or null if it responds to all domains

getPort

java.lang.Integer getPort()

getUrl

java.lang.String getUrl()

primary URL this controller serves, if one can / has been inferred

getPortNumberSensor

AttributeSensor<java.lang.Integer> getPortNumberSensor()

getHostnameSensor

AttributeSensor<java.lang.String> getHostnameSensor()

getHostAndPortSensor

AttributeSensor<java.lang.String> getHostAndPortSensor()

getServerPoolAddresses

java.util.Set<java.lang.String> getServerPoolAddresses()