org.apache.brooklyn.core.network

Class OnPublicNetworkEnricher

java.lang.Object

org.apache.brooklyn.core.objs.AbstractBrooklynObject

org.apache.brooklyn.core.objs.AbstractEntityAdjunct

org.apache.brooklyn.core.enricher.AbstractEnricher

org.apache.brooklyn.core.network.AbstractOnNetworkEnricher

org.apache.brooklyn.core.network.OnPublicNetworkEnricher

All Implemented Interfaces:

Rebindable, BrooklynObject, Configurable, EntityAdjunct, Identifiable, Enricher, BrooklynObjectInternal

@Beta
public class OnPublicNetworkEnricher
extends AbstractOnNetworkEnricher

Can be added to an entity so that it advertises its mapped ports (according to the port-mappings recorded in the PortForwardManager). This can be used with sensors of type URI, HostAndPort or plain integer port values. The port-mappings is retrieved by looking up the entity's machine and the private port, in the PortForwardManager's recorded port-mappings. For example, to configure each Tomcat node to publish its mapped uri, and to use that sensor in Nginx for the target servers:

 
 services:
 - type: cluster
   id: cluster
   brooklyn.config:
    memberSpec:
      $brooklyn:entitySpec:
        type: org.apache.brooklyn.entity.webapp.tomcat.TomcatServer
        brooklyn.enrichers:
        - type: org.apache.brooklyn.core.network.OnPublicNetworkEnricher
          brooklyn.config:
            sensor: main.uri
 - type: org.apache.brooklyn.entity.proxy.nginx.NginxController
   brooklyn.config:
     member.sensor.hostandport: $brooklyn:sensor("main.uri.mapped.public")
     serverPool: cluster
 
 

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.brooklyn.core.network.AbstractOnNetworkEnricher

AbstractOnNetworkEnricher.SensorNameConverter

Nested classes/interfaces inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

AbstractEntityAdjunct.AdjunctTagSupport, AbstractEntityAdjunct.BasicSubscriptionSupport

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.objs.BrooklynObjectInternal

BrooklynObjectInternal.ConfigurationSupportInternal, BrooklynObjectInternal.RelationSupportInternal<T extends BrooklynObject>, BrooklynObjectInternal.SubscriptionSupportInternal

Field Summary

Fields

Modifier and Type	Field and Description
static ConfigKey<AttributeSensor<java.lang.String>>	ADDRESS_SENSOR
static ConfigKey<PortForwardManager>	PORT_FORWARD_MANAGER
static ConfigKey<com.google.common.base.Function<? super java.lang.String,java.lang.String>>	SENSOR_NAME_CONVERTER

Fields inherited from class org.apache.brooklyn.core.network.AbstractOnNetworkEnricher

MAP_MATCHING, SENSORS

Fields inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

SUPPRESS_DUPLICATES

Constructor Summary

Constructors

Constructor and Description
OnPublicNetworkEnricher()

Method Summary

Modifier and Type	Method and Description
void	destroy() Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method
void	setEntity(EntityLocal entity)

Methods inherited from class org.apache.brooklyn.core.enricher.AbstractEnricher

getEnricherType, getRebindSupport, relations

Methods inherited from class org.apache.brooklyn.core.objs.AbstractEntityAdjunct

config, configure, getAdjunctType, getConfig, getDisplayName, getEntity, getUniqueTag, isDestroyed, isRunning, setConfig, setDisplayName, subscribe, subscribeToChildren, subscribeToMembers, subscriptions, tags, toString, unsubscribe, unsubscribe

Methods inherited from class org.apache.brooklyn.core.objs.AbstractBrooklynObject

getCatalogItemId, getId, getManagementContext, init, rebind, setCatalogItemId, setManagementContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.brooklyn.api.sensor.Enricher

getId

Methods inherited from interface org.apache.brooklyn.api.objs.EntityAdjunct

getUniqueTag, isDestroyed, isRunning

Methods inherited from interface org.apache.brooklyn.api.objs.BrooklynObject

getCatalogItemId, getDisplayName, subscriptions, tags

Methods inherited from interface org.apache.brooklyn.api.objs.Configurable

config, getConfig, setConfig

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

setCatalogItemId

Field Detail

SENSOR_NAME_CONVERTER

public static ConfigKey<com.google.common.base.Function<? super java.lang.String,java.lang.String>> SENSOR_NAME_CONVERTER

PORT_FORWARD_MANAGER

public static final ConfigKey<PortForwardManager> PORT_FORWARD_MANAGER

ADDRESS_SENSOR

public static final ConfigKey<AttributeSensor<java.lang.String>> ADDRESS_SENSOR

Constructor Detail

OnPublicNetworkEnricher

public OnPublicNetworkEnricher()

Method Detail

setEntity

public void setEntity(EntityLocal entity)

Overrides:

setEntity in class AbstractOnNetworkEnricher

destroy

public void destroy()

Description copied from class: AbstractEntityAdjunct

Unsubscribes and clears all managed subscriptions; is called by the owning entity when a policy is removed and should always be called by any subclasses overriding this method

Overrides:

destroy in class AbstractEntityAdjunct