org.apache.brooklyn.entity.proxy.nginx

Interface UrlMapping

All Superinterfaces:

AbstractGroup, BrooklynObject, Changeable, Configurable, Entity, Group, Identifiable

All Known Implementing Classes:

UrlMappingImpl

public interface UrlMapping
extends AbstractGroup

This is a group whose members will be made available to a load-balancer / URL forwarding service (such as nginx). Configuration requires a domain and some mechanism for finding members. The easiest way to find members is using a target whose children will be tracked, but alternative membership policies can also be used.

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

Field Summary

Fields

Modifier and Type	Field and Description
static MethodEffector<java.lang.Void>	DISCARD
static ConfigKey<java.lang.String>	DOMAIN
static ConfigKey<java.lang.String>	LABEL
static ConfigKey<java.lang.String>	PATH
static ConfigKey<java.util.Collection<UrlRewriteRule>>	REWRITES
static ConfigKey<ProxySslConfig>	SSL_CONFIG
static AttributeSensor<java.util.Collection<java.lang.String>>	TARGET_ADDRESSES
static ConfigKey<Entity>	TARGET_PARENT

Fields inherited from interface org.apache.brooklyn.entity.group.AbstractGroup

FIRST, GROUP_MEMBERS, MEMBER_DELEGATE_CHILDREN, MEMBER_DELEGATE_NAME_FORMAT, RUNNING_QUORUM_CHECK, UP_QUORUM_CHECK

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

GROUP_SIZE, MEMBER_ADDED, MEMBER_REMOVED

Method Summary

Modifier and Type	Method and Description
UrlMapping	addRewrite(java.lang.String from, java.lang.String to) Adds a rewrite rule, must be called at config time.
UrlMapping	addRewrite(UrlRewriteRule rule) Adds a rewrite rule, must be called at config time.
void	discard()
java.lang.String	getDomain()
java.lang.String	getPath()
ProxySslConfig	getSsl()
Entity	getTarget()
java.util.Collection<java.lang.String>	getTargetAddresses()
java.lang.String	getUniqueLabel()
void	recompute()
void	setTarget(Entity target)

Methods inherited from interface org.apache.brooklyn.entity.group.AbstractGroup

getFirst, setMembers, setMembers

Methods inherited from interface org.apache.brooklyn.api.entity.Group

addChild, addChild, addMember, addMemberChild, addMemberChild, getCurrentSize, getMembers, hasMember, removeMember

Methods inherited from interface org.apache.brooklyn.api.entity.Entity

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

Field Detail

DISCARD

static final MethodEffector<java.lang.Void> DISCARD

LABEL

static final ConfigKey<java.lang.String> LABEL

DOMAIN

static final ConfigKey<java.lang.String> DOMAIN

PATH

static final ConfigKey<java.lang.String> PATH

SSL_CONFIG

static final ConfigKey<ProxySslConfig> SSL_CONFIG

REWRITES

static final ConfigKey<java.util.Collection<UrlRewriteRule>> REWRITES

TARGET_PARENT

static final ConfigKey<Entity> TARGET_PARENT

TARGET_ADDRESSES

static final AttributeSensor<java.util.Collection<java.lang.String>> TARGET_ADDRESSES

Method Detail

getUniqueLabel

java.lang.String getUniqueLabel()

addRewrite

UrlMapping addRewrite(java.lang.String from,
                      java.lang.String to)

Adds a rewrite rule, must be called at config time. See UrlRewriteRule for more info.

addRewrite

UrlMapping addRewrite(UrlRewriteRule rule)

Adds a rewrite rule, must be called at config time. See UrlRewriteRule for more info.

getDomain

java.lang.String getDomain()

getPath

java.lang.String getPath()

getTarget

Entity getTarget()

setTarget

void setTarget(Entity target)

recompute

void recompute()

getTargetAddresses

java.util.Collection<java.lang.String> getTargetAddresses()

getSsl

ProxySslConfig getSsl()

discard

void discard()