org.apache.brooklyn.entity.proxy

Interface LoadBalancer

All Superinterfaces:

BrooklynObject, Configurable, Entity, Identifiable, Startable

All Known Subinterfaces:

AbstractController, AbstractNonProvisionedController, LoadBalancerCluster, NginxController

All Known Implementing Classes:

AbstractControllerImpl, AbstractNonProvisionedControllerImpl, LoadBalancerClusterImpl, NginxControllerImpl, SimulatedNginxControllerImpl

public interface LoadBalancer
extends Entity, Startable

A load balancer that routes requests to set(s) of servers. There is an optional "serverPool" that will have requests routed to it (e.g. as round-robin). This is a group whose members are appropriate servers; membership of that group will be tracked to automatically update the load balancer's configuration as appropriate. There is an optional urlMappings group for defining additional mapping rules. Members of this group (of type UrlMapping) will be tracked, to automatically update the load balancer's configuration. The UrlMappings can give custom routing rules so that specific urls are routed (and potentially re-written) to particular sets of servers.

Nested Class Summary

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<AttributeSensor<java.lang.String>>	HOST_AND_PORT_SENSOR sensor for hostname to forward to on target entities
static AttributeSensor<java.lang.String>	HOSTNAME
static BasicAttributeSensorAndConfigKey<AttributeSensor<java.lang.String>>	HOSTNAME_SENSOR sensor for hostname to forward to on target entities
static AttributeSensor<java.net.URI>	MAIN_URI
static BasicAttributeSensorAndConfigKey<AttributeSensor<java.lang.Integer>>	PORT_NUMBER_SENSOR sensor for port to forward to on target entities
static BasicAttributeSensorAndConfigKey<java.lang.String>	PROTOCOL
static PortAttributeSensorAndConfigKey	PROXY_HTTP_PORT
static PortAttributeSensorAndConfigKey	PROXY_HTTPS_PORT
static MethodEffector<java.lang.Void>	RELOAD
static AttributeSensor<java.lang.String>	ROOT_URL
static ConfigKey<Group>	SERVER_POOL
static AttributeSensor<java.util.Map<Entity,java.lang.String>>	SERVER_POOL_TARGETS
static MethodEffector<java.lang.Void>	UPDATE
static ConfigKey<Group>	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
void	bind(java.util.Map<?,?> flags) Opportunity to do late-binding of the cluster that is being controlled.
void	changeServerPool(java.lang.String groupId)
void	reload()
void	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

SERVER_POOL

static final ConfigKey<Group> SERVER_POOL

URL_MAPPINGS

static final ConfigKey<Group> URL_MAPPINGS

PORT_NUMBER_SENSOR

static final BasicAttributeSensorAndConfigKey<AttributeSensor<java.lang.Integer>> PORT_NUMBER_SENSOR

sensor for port to forward to on target entities

HOSTNAME_SENSOR

static final BasicAttributeSensorAndConfigKey<AttributeSensor<java.lang.String>> HOSTNAME_SENSOR

sensor for hostname to forward to on target entities

HOST_AND_PORT_SENSOR

static final BasicAttributeSensorAndConfigKey<AttributeSensor<java.lang.String>> HOST_AND_PORT_SENSOR

sensor for hostname to forward to on target entities

PROXY_HTTP_PORT

static final PortAttributeSensorAndConfigKey PROXY_HTTP_PORT

PROXY_HTTPS_PORT

static final PortAttributeSensorAndConfigKey PROXY_HTTPS_PORT

PROTOCOL

static final BasicAttributeSensorAndConfigKey<java.lang.String> PROTOCOL

HOSTNAME

static final AttributeSensor<java.lang.String> HOSTNAME

MAIN_URI

static final AttributeSensor<java.net.URI> MAIN_URI

ROOT_URL

static final AttributeSensor<java.lang.String> ROOT_URL

SERVER_POOL_TARGETS

static final AttributeSensor<java.util.Map<Entity,java.lang.String>> SERVER_POOL_TARGETS

RELOAD

static final MethodEffector<java.lang.Void> RELOAD

UPDATE

static final MethodEffector<java.lang.Void> UPDATE

Method Detail

changeServerPool

void changeServerPool(java.lang.String groupId)

reload

void reload()

update

void update()

bind

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'.