org.apache.brooklyn.entity.proxy.nginx

Class NginxControllerImpl

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

org.apache.brooklyn.entity.proxy.nginx.NginxControllerImpl

All Implemented Interfaces:

DriverDependentEntity, Entity, EntityLocal, Rebindable, BrooklynObject, Configurable, HasShortName, Identifiable, EntityInternal, Startable, BrooklynObjectInternal, AbstractController, LoadBalancer, NginxController, NginxController.NginxControllerInternal, SoftwareProcess

Direct Known Subclasses:

SimulatedNginxControllerImpl

public class NginxControllerImpl
extends AbstractControllerImpl
implements NginxController, NginxController.NginxControllerInternal

Implementation of the NginxController entity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NginxControllerImpl.UrlMappingsMemberTrackerPolicy

Nested classes/interfaces inherited from class org.apache.brooklyn.entity.proxy.AbstractControllerImpl

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.proxy.nginx.NginxController

NginxController.NginxControllerInternal

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.nginx.NginxController

ACCESS_LOG_LOCATION, ARCHIVE_DIRECTORY_NAME_FORMAT, DEPLOY, DOWNLOAD_ADDON_URLS, DOWNLOAD_URL, ERROR_LOG_LOCATION, GET_CURRENT_CONFIGURATION, HTTP_POLL_PERIOD, NGINX_URL_ANSWERS_NICELY, PCRE_VERSION, PID_FILE, SERVER_CONF_GENERATOR, SERVER_CONF_TEMPLATE_URL, STATIC_CONTENT_ARCHIVE_URL, STICKY, STICKY_VERSION, SUGGESTED_VERSION, WITH_CC_OPT, WITH_LD_OPT

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, CHILDREN_STARTABLE_MODE, CUSTOMIZE_FILES, CUSTOMIZE_LATCH, CUSTOMIZE_TEMPLATES, DONT_REQUIRE_TTY_FOR_SUDO, 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, 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, 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
NginxControllerImpl()

Method Summary

Modifier and Type	Method and Description
boolean	appendSslConfig(java.lang.String id, java.lang.StringBuilder out, java.lang.String prefix, ProxySslConfig ssl, boolean sslBlock, boolean certificateBlock)
void	connectSensors() For binding to the running app (e.g.
void	deploy(java.lang.String archiveUrl)
void	doExtraConfigurationDuringStart()
java.lang.String	getConfigFile()
java.lang.String	getCurrentConfiguration()
NginxDriver	getDriver()
java.lang.Class<?>	getDriverInterface()
java.lang.String	getShortName() gets a short name, for human-friendly identification e.g.
java.lang.Iterable<UrlMapping>	getUrlMappings()
void	installSslKeys(java.lang.String id, ProxySslConfig ssl) Installs SSL keys named as id.crt and id.key where nginx can find them.
boolean	isSticky()
void	reconfigureService() Implementations should update the configuration so that 'serverPoolAddresses' are targeted.
void	reload()

Methods inherited from class org.apache.brooklyn.entity.proxy.AbstractControllerImpl

bind, changeServerPool, getDomain, getHostAndPortSensor, getHostnameSensor, getPort, getPortNumberSensor, getProtocol, getServerPoolAddresses, getSslConfig, getUrl, init, isActive, isSsl, onManagementNoLongerMaster, update, updateAsync, updateNeeded

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

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.proxy.AbstractController

getDomain, getHostAndPortSensor, getHostnameSensor, getPort, getPortNumberSensor, getProtocol, getServerPoolAddresses, getSslConfig, getUrl, isActive, 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, 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

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

addSearchPath, setCatalogItemId, setCatalogItemIdAndSearchPath, stackCatalogItemId

Constructor Detail

NginxControllerImpl

public NginxControllerImpl()

Method Detail

reload

public void reload()

Specified by:

reload in interface LoadBalancer

Specified by:

reload in class AbstractControllerImpl

isSticky

public boolean isSticky()

Specified by:

isSticky in interface NginxController

connectSensors

public void connectSensors()

Description copied from class: SoftwareProcessImpl

For binding to the running app (e.g. connecting sensors to registry). Will be called on start() and on rebind().

Implementations should be idempotent (ie tell whether sensors already connected), though the framework is pretty good about not calling when already connected. TODO improve the framework's feed system to detect duplicate additions

getDriverInterface

public java.lang.Class<?> getDriverInterface()

Specified by:

getDriverInterface in interface DriverDependentEntity

getDriver

public NginxDriver getDriver()

Specified by:

getDriver in interface DriverDependentEntity

Overrides:

getDriver in class SoftwareProcessImpl

doExtraConfigurationDuringStart

public void doExtraConfigurationDuringStart()

Specified by:

doExtraConfigurationDuringStart in interface NginxController.NginxControllerInternal

getCurrentConfiguration

public java.lang.String getCurrentConfiguration()

Specified by:

getCurrentConfiguration in interface NginxController

deploy

public void deploy(java.lang.String archiveUrl)

Specified by:

deploy in interface NginxController

reconfigureService

public void reconfigureService()

Description copied from class: AbstractControllerImpl

Implementations should update the configuration so that 'serverPoolAddresses' are targeted. The caller will subsequently call reload to apply the new configuration.

installSslKeys

public void installSslKeys(java.lang.String id,
                           ProxySslConfig ssl)

Installs SSL keys named as id.crt and id.key where nginx can find them.

Currently skips re-installs (does not support changing)

getConfigFile

public java.lang.String getConfigFile()

Specified by:

getConfigFile in interface NginxController

getUrlMappings

public java.lang.Iterable<UrlMapping> getUrlMappings()

Specified by:

getUrlMappings in interface NginxController

getShortName

public java.lang.String getShortName()

Description copied from interface: HasShortName

gets a short name, for human-friendly identification e.g. inside the name of a VM

Specified by:

getShortName in interface HasShortName

appendSslConfig

public boolean appendSslConfig(java.lang.String id,
                               java.lang.StringBuilder out,
                               java.lang.String prefix,
                               ProxySslConfig ssl,
                               boolean sslBlock,
                               boolean certificateBlock)

Specified by:

appendSslConfig in interface NginxController