LoadBalancer (Brooklyn)

Overview

Package

Class

Deprecated

Index

Help

Brooklyn

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | METHOD

DETAIL: FIELD | METHOD

brooklyn.entity.proxy
[Java] Interface LoadBalancer

brooklyn.entity.trait.Startable
  brooklyn.entity.rebind.Rebindable
      brooklyn.entity.Entity
          brooklyn.entity.trait.Identifiable
              brooklyn.entity.proxy.LoadBalancer

All Superinterfaces:: Startable, Rebindable, Entity, Identifiable

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.

Authors:: aled

Field Summary
`static AttributeSensor`	`HOSTNAME`
`static BasicAttributeSensorAndConfigKey`	`HOSTNAME_SENSOR` sensor for hostname to forward to on target entities
`static BasicAttributeSensorAndConfigKey`	`PORT_NUMBER_SENSOR` sensor for port to forward to on target entities
`static BasicAttributeSensorAndConfigKey`	`PROTOCOL`
`static PortAttributeSensorAndConfigKey`	`PROXY_HTTP_PORT` port where this controller should live
`static MethodEffector`	`RELOAD`
`static AttributeSensor`	`ROOT_URL`
`ConfigKey`	`SERVER_POOL`
`static BasicAttributeSensor`	`SERVER_POOL_TARGETS`
`static BasicAttributeSensor`	`TARGETS` @deprecated since 0.6; Use SERVER_POOL_TARGETS
`static MethodEffector`	`UPDATE`
`ConfigKey`	`URL_MAPPINGS`

Fields inherited from interface Startable
RESTART, SERVICE_UP, START, STOP

Method Summary
`void`	`bind(java.util.Map flags)` Opportunity to do late-binding of the cluster that is being controlled.
`void`	`reload()`
`void`	`update()`

Methods inherited from interface Startable
restart, start, stop

Methods inherited from interface Entity
addChild, addChild, addEnricher, addGroup, addPolicy, clearParent, getApplication, getApplicationId, getAttribute, getChildren, getConfig, getConfig, getCreationTime, getDisplayName, getEnrichers, getEntityType, getGroups, getIconUrl, getId, getLocations, getParent, getPolicies, getRebindSupport, invoke, removeChild, removeEnricher, removePolicy, setParent

Methods inherited from interface Identifiable
getId

Methods inherited from interface Rebindable
getRebindSupport

Field Detail

HOSTNAME

public static final AttributeSensor HOSTNAME

HOSTNAME_SENSOR

@SetFromFlag("hostnameSensor")
public static final BasicAttributeSensorAndConfigKey HOSTNAME_SENSOR

sensor for hostname to forward to on target entities

PORT_NUMBER_SENSOR

@SetFromFlag("portNumberSensor")
public static final BasicAttributeSensorAndConfigKey PORT_NUMBER_SENSOR

sensor for port to forward to on target entities

PROTOCOL

@SetFromFlag("protocol")
public static final BasicAttributeSensorAndConfigKey PROTOCOL

PROXY_HTTP_PORT

@SetFromFlag("port")
    /** port where this controller should live */
public static final PortAttributeSensorAndConfigKey PROXY_HTTP_PORT

port where this controller should live

RELOAD

public static final MethodEffector RELOAD

ROOT_URL

public static final AttributeSensor ROOT_URL

SERVER_POOL

@SetFromFlag("serverPool")
public ConfigKey SERVER_POOL

SERVER_POOL_TARGETS

public static final BasicAttributeSensor SERVER_POOL_TARGETS

TARGETS

public static final BasicAttributeSensor TARGETS

deprecated:: since 0.6; Use SERVER_POOL_TARGETS

UPDATE

public static final MethodEffector UPDATE

URL_MAPPINGS

@SetFromFlag("urlMappings")
public ConfigKey URL_MAPPINGS

Method Detail

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

reload

@Effector(description="Forces reload of the configuration")
public void reload()

update

@Effector(description="Updates the entities configuration, and then forces reload of that configuration")
public void update()

brooklyn.entity.proxy [Java] Interface LoadBalancer