Overview  Package   Class  Deprecated  Index  Help 
Brooklyn
FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | METHOD DETAIL: FIELD | METHOD

brooklyn.entity.proxy.nginx
[Java] Interface UrlMapping

brooklyn.entity.proxy.nginx.UrlMapping
  brooklyn.entity.rebind.Rebindable
      brooklyn.entity.Entity
          brooklyn.entity.Group
              brooklyn.entity.trait.Changeable
                  brooklyn.entity.basic.AbstractGroup
                      brooklyn.entity.trait.Identifiable
All Superinterfaces:
Rebindable, Entity, Group, Changeable, AbstractGroup, Identifiable
@ImplementedBy(UrlMappingImpl.class)
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.

Field Summary
static MethodEffector DISCARD

static ConfigKey DOMAIN

static ConfigKey LABEL

static ConfigKey PATH

static ConfigKey REWRITES

static AttributeSensor ROOT_URL

static ConfigKey SSL_CONFIG

static AttributeSensor TARGET_ADDRESSES

static ConfigKey TARGET_PARENT

 
Fields inherited from interface Changeable
GROUP_SIZE, MEMBER_ADDED, MEMBER_REMOVED
 
Method Summary
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()

Entity getTarget()

java.lang.String getUniqueLabel()

void recompute()

void setTarget(Entity target)

 
Methods inherited from interface AbstractGroup
setMembers, setMembers
 
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 Group
addMember, getCurrentSize, getMembers, hasMember, removeMember
 

Field Detail

DISCARD

public static final MethodEffector DISCARD

DOMAIN

@SetFromFlag("domain")
public static final ConfigKey DOMAIN

LABEL

@SetFromFlag("label")
public static final ConfigKey LABEL

PATH

@SetFromFlag("path")
public static final ConfigKey PATH

REWRITES

@SetFromFlag("rewrites")
public static final ConfigKey REWRITES

ROOT_URL

public static final AttributeSensor ROOT_URL

SSL_CONFIG

@SetFromFlag("ssl")
public static final ConfigKey SSL_CONFIG

TARGET_ADDRESSES

public static final AttributeSensor TARGET_ADDRESSES

TARGET_PARENT

@SetFromFlag("target")
public static final ConfigKey TARGET_PARENT

 
Method Detail

addRewrite

public 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

public UrlMapping addRewrite(UrlRewriteRule rule)
adds a rewrite rule, must be called at config time. see UrlRewriteRule for more info.

discard

@Effector(description="Unmanages the url-mapping, so it is discarded and no longer applies")
public void discard()

getDomain

public java.lang.String getDomain()

getPath

public java.lang.String getPath()

getTarget

public Entity getTarget()

getUniqueLabel

public java.lang.String getUniqueLabel()

recompute

public void recompute()

setTarget

public void setTarget(Entity target)

 

Brooklyn Multi-Cloud Application Management Platform
brooklyncentral.github.com. Apache License. © 2012.