org.apache.brooklyn.entity.proxy

Class AbstractControllerImpl

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.entity.AbstractEntity

org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

org.apache.brooklyn.entity.proxy.AbstractControllerImpl

All Implemented Interfaces:

DriverDependentEntity, Entity, EntityLocal, Rebindable, BrooklynObject, Configurable, Identifiable, EntityInternal, Startable, BrooklynObjectInternal, AbstractController, LoadBalancer, SoftwareProcess

Direct Known Subclasses:

NginxControllerImpl

public abstract class AbstractControllerImpl
extends SoftwareProcessImpl
implements AbstractController

Represents a controller mechanism for a Cluster.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractControllerImpl.ServerPoolMemberTrackerPolicy

Nested classes/interfaces inherited from class org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

SoftwareProcessImpl.ServiceNotUpDiagnosticsCollector, SoftwareProcessImpl.UpdatingNotUpFromServiceProcessIsRunning

Nested classes/interfaces inherited from class org.apache.brooklyn.core.entity.AbstractEntity

AbstractEntity.BasicConfigurationSupport, AbstractEntity.BasicEnricherSupport, AbstractEntity.BasicGroupSupport, AbstractEntity.BasicPolicySupport, AbstractEntity.BasicSensorSupport, AbstractEntity.BasicSubscriptionSupport

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

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

EntityInternal.EnricherSupportInternal, EntityInternal.EntitySubscriptionSupportInternal, EntityInternal.FeedSupport, EntityInternal.GroupSupportInternal, EntityInternal.PolicySupportInternal, EntityInternal.SensorSupportInternal

Nested classes/interfaces inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields inherited from class org.apache.brooklyn.core.entity.AbstractEntity

APPLICATION_ID, CATALOG_ID, CHILD_ADDED, CHILD_REMOVED, CONFIG_KEY_ADDED, CONFIG_KEY_REMOVED, DEFAULT_DISPLAY_NAME, EFFECTOR_ADDED, EFFECTOR_CHANGED, EFFECTOR_REMOVED, ENTITY_ID, GROUP_ADDED, GROUP_REMOVED, LOCATION_ADDED, LOCATION_REMOVED, POLICY_ADDED, POLICY_REMOVED, SENSOR_ADDED, SENSOR_REMOVED

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

DOMAIN_NAME, MAIN_URI_MAPPED_PUBLIC, MAIN_URI_MAPPED_SUBNET, SERVICE_UP_URL_PATH, 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

Constructor Summary

Constructors

Constructor and Description
AbstractControllerImpl()

Method Summary

Modifier and Type	Method and Description
void	bind(java.util.Map<?,?> flags) Opportunity to do late-binding of the cluster that is being controlled.
void	changeServerPool(java.lang.String groupId)
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
void	init() Default entity initialization sets ID sensors and calls AbstractEntity.initEnrichers().
boolean	isActive()
boolean	isSsl()
void	onManagementNoLongerMaster() Invoked by ManagementContext when this entity becomes mastered at a particular management node, including the final management end and subsequent management node master-change for this entity.
abstract void	reload()
void	update()
Task<?>	updateAsync()
void	updateNeeded()

Methods inherited from class org.apache.brooklyn.entity.software.base.SoftwareProcessImpl

getDriver, onManagementStarted, onManagementStarting, populateServiceNotUpDiagnostics, rebind, restart, start, stop, waitForEntityStart, waitForServiceUp, waitForServiceUp, waitForServiceUp, waitForServiceUp

Methods inherited from class org.apache.brooklyn.core.entity.AbstractEntity

addChild, addChild, addFeed, addLocations, addLocationsWithoutPublishing, clearLocations, clearParent, config, configure, configure, destroy, enrichers, equals, feeds, firstLocation, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getCreationTime, getDisplayName, getEffector, getEntityType, getExecutionContext, getIconUrl, getLocations, getManagementContext, getManagementSupport, getMutableEntityType, getParent, getProxy, getProxyIfAvailable, getRebindSupport, groups, hashCode, invalidateReferences, invoke, invoke, invoke, onManagementBecomingMaster, onManagementStopped, policies, relations, removeChild, removeLocations, requestPersist, resetProxy, sensors, setConfigEvenIfOwned, setConfigEvenIfOwned, setDisplayName, setManagementContext, setParent, setProxy, subscriptions, toMetadataRecord, toString

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

addSearchPath, getCatalogItemId, getCatalogItemIdSearchPath, getId, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId, tags

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

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

Methods inherited from interface org.apache.brooklyn.api.entity.drivers.DriverDependentEntity

getDriverInterface

Methods inherited from interface org.apache.brooklyn.core.objs.BrooklynObjectInternal

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

AbstractControllerImpl

public AbstractControllerImpl()

Method Detail

init

public void init()

Description copied from class: AbstractEntity

Default entity initialization sets ID sensors and calls AbstractEntity.initEnrichers().

Overrides:

init in class SoftwareProcessImpl

getServerPoolAddresses

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

Specified by:

getServerPoolAddresses in interface AbstractController

bind

public void bind(java.util.Map<?,?> flags)

Opportunity to do late-binding of the cluster that is being controlled. Must be called before start(). Can pass in the 'serverPool'.

Specified by:

bind in interface LoadBalancer

onManagementNoLongerMaster

public void onManagementNoLongerMaster()

Description copied from class: AbstractEntity

Invoked by ManagementContext when this entity becomes mastered at a particular management node, including the final management end and subsequent management node master-change for this entity.

Overrides:

onManagementNoLongerMaster in class AbstractEntity

isActive

public boolean isActive()

Specified by:

isActive in interface AbstractController

isSsl

public boolean isSsl()

Specified by:

isSsl in interface AbstractController

getSslConfig

public ProxySslConfig getSslConfig()

Specified by:

getSslConfig in interface AbstractController

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface AbstractController

getDomain

public java.lang.String getDomain()

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

Specified by:

getDomain in interface AbstractController

getPort

public java.lang.Integer getPort()

Specified by:

getPort in interface AbstractController

getUrl

public java.lang.String getUrl()

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

Specified by:

getUrl in interface AbstractController

getPortNumberSensor

public AttributeSensor<java.lang.Integer> getPortNumberSensor()

Specified by:

getPortNumberSensor in interface AbstractController

getHostnameSensor

public AttributeSensor<java.lang.String> getHostnameSensor()

Specified by:

getHostnameSensor in interface AbstractController

getHostAndPortSensor

public AttributeSensor<java.lang.String> getHostAndPortSensor()

Specified by:

getHostAndPortSensor in interface AbstractController

reload

public abstract void reload()

Specified by:

reload in interface LoadBalancer

updateNeeded

public void updateNeeded()

update

public void update()

Specified by:

update in interface LoadBalancer

updateAsync

public Task<?> updateAsync()

changeServerPool

public void changeServerPool(java.lang.String groupId)

Specified by:

changeServerPool in interface LoadBalancer