Github user aledsage commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/177#discussion_r66331540
--- Diff:
core/src/main/java/org/apache/brooklyn/core/network/OnPublicNetworkEnricher.java
---
@@ -0,0 +1,496 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.brooklyn.core.network;
+
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.net.URL;
+import java.util.Collection;
+
+import org.apache.brooklyn.api.entity.Entity;
+import org.apache.brooklyn.api.entity.EntityLocal;
+import org.apache.brooklyn.api.location.Location;
+import org.apache.brooklyn.api.location.MachineLocation;
+import org.apache.brooklyn.api.sensor.AttributeSensor;
+import org.apache.brooklyn.api.sensor.Sensor;
+import org.apache.brooklyn.api.sensor.SensorEvent;
+import org.apache.brooklyn.api.sensor.SensorEventListener;
+import org.apache.brooklyn.config.ConfigKey;
+import org.apache.brooklyn.core.config.ConfigKeys;
+import org.apache.brooklyn.core.enricher.AbstractEnricher;
+import org.apache.brooklyn.core.entity.AbstractEntity;
+import org.apache.brooklyn.core.location.Machines;
+import org.apache.brooklyn.core.location.access.PortForwardManager;
+import
org.apache.brooklyn.core.location.access.PortForwardManagerLocationResolver;
+import
org.apache.brooklyn.core.location.access.PortForwardManager.AssociationListener;
+import
org.apache.brooklyn.core.location.access.PortForwardManager.AssociationMetadata;
+import org.apache.brooklyn.core.sensor.Sensors;
+import org.apache.brooklyn.util.core.flags.TypeCoercions;
+import org.apache.brooklyn.util.exceptions.Exceptions;
+import org.apache.brooklyn.util.guava.Maybe;
+import org.apache.brooklyn.util.net.Networking;
+import org.apache.brooklyn.util.text.StringPredicates;
+import org.apache.brooklyn.util.text.Strings;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import com.google.common.annotations.Beta;
+import com.google.common.base.Function;
+import com.google.common.base.Optional;
+import com.google.common.base.Predicate;
+import com.google.common.base.Predicates;
+import com.google.common.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+/**
+ * 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:
+ * <pre>
+ * {@code
+ * 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.location.access.PublicNetworkFaceEnricher
+ * 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
+ * }
+ * </pre>
+ */
+@Beta
+public class OnPublicNetworkEnricher extends AbstractEnricher {
+
+ // TODO Is this the best package for the enricher?
+ //
+ // TODO Need more logging, particularly for when the value has *not*
been transformed.
+ //
+ // TODO What if the sensor has an unrelated hostname - we will
currently still transform this!
+ // That seems acceptable: if the user configures it to look at the
sensor, then we can make
+ // assumptions that the sensor's value will need translated.
+ //
+ // TODO If there is no port-mapping, should we advertise the original
sensor value?
+ // That would allow the enricher to be used for an entity in a private
network, and for
+ // it to be a no-op in a public cloud (so the same blueprint can be
used in both).
+ // However I don't think we should publish the original value: it
could be the association
+ // just hasn't been created yet. If we publish the wrong (i.e.
untransformed) value, that
+ // will cause other entity's using attributeWhenReady to immediately
trigger.
+
+ private static final Logger LOG =
LoggerFactory.getLogger(OnPublicNetworkEnricher.class);
+
+ @SuppressWarnings("serial")
+ public static final ConfigKey<AttributeSensor<?>> SENSOR =
ConfigKeys.newConfigKey(
+ new TypeToken<AttributeSensor<?>>() {},
+ "sensor",
+ "The sensor whose mapped value is to be re-published (with
suffix \"mapped.public\"); "
+ + "either 'sensor' or 'sensors' should be specified");
+
+ @SuppressWarnings("serial")
+ public static ConfigKey<Collection<? extends AttributeSensor<?>>>
SENSORS = ConfigKeys.newConfigKey(
+ new TypeToken<Collection<? extends AttributeSensor<?>>>() {},
+ "sensors",
+ "The multiple sensors whose mapped values are to be
re-published (with suffix \"mapped.public\"); "
+ + "if neither 'sensor' or 'sensors' is specified,
defaults to 'mapAll'");
+
+ public static ConfigKey<String> MAP_MATCHING =
ConfigKeys.newStringConfigKey(
+ "mapMatching",
+ "Whether to map all, based on a sensor naming convention
(re-published with suffix \"mapped.public\"); "
+ + "if neither 'sensor' or 'sensors' is specified,
defaults to matchin case-insensitive suffix of "
+ + "'port', 'uri', 'url' or 'endpoint' ",
+ "(?i).*(port|uri|url|endpoint)");
+
+ @SuppressWarnings("serial")
+ public static ConfigKey<Function<? super String, String>>
SENSOR_NAME_CONVERTER = ConfigKeys.newConfigKey(
+ new TypeToken<Function<? super String, String>>() {},
+ "sensorNameConverter",
+ "The converter to use, to map from the original sensor name to
the re-published sensor name",
+ new SensorNameConverter("public"));
+
+ public static final ConfigKey<PortForwardManager> PORT_FORWARD_MANAGER
= ConfigKeys.newConfigKey(
+ PortForwardManager.class,
+ "portForwardManager",
+ "The PortForwardManager storing the port-mappings; if null,
the global instance will be used");
+
+ public static class SensorNameConverter implements Function<String,
String> {
+ private final String network;
+
+ public SensorNameConverter(String network) {
+ this.network = network;
+ }
+
+ @Override
+ public String apply(String input) {
+ if (input == null) throw new NullPointerException("Sensor name
must not be null");
+ String lowerInput = input.toLowerCase();
+ if (lowerInput.endsWith("uri")) {
+ return input + ".mapped." + network;
+ } else if (lowerInput.endsWith("url")) {
+ return input + ".mapped." + network;
+ } else if (lowerInput.endsWith("endpoint")) {
+ return input + ".mapped." + network;
+ } else if (lowerInput.endsWith("port")) {
+ String prefix = input.substring(0, input.length() -
"port".length());
+ if (prefix.endsWith(".")) prefix = prefix.substring(0,
prefix.length() - 1);
+ return prefix + ".endpoint.mapped." + network;
+ } else {
+ return input + ".mapped." + network;
+ }
+ }
+ }
+
+ protected Collection<AttributeSensor<?>> sensors;
+ protected Optional<Predicate<Sensor<?>>> mapMatching;
+ protected Function<? super String, String> sensorNameConverter;
+ protected PortForwardManager.AssociationListener pfmListener;
+
+ @Override
+ public void setEntity(final EntityLocal entity) {
+ super.setEntity(entity);
+
+ checkConfig();
+ sensors = resolveSensorsConfig();
+ if (sensors.isEmpty()) {
+ mapMatching = Optional.of(resolveMapMatchingConfig());
+ } else {
+ mapMatching = Optional.absent();
+ }
+ sensorNameConverter = getRequiredConfig(SENSOR_NAME_CONVERTER);
+
+ /*
+ * To find the transformed sensor value we need several things to
be set. Therefore
+ * subscribe to all of them, and re-compute whenever any of the
change. These are:
+ * - A port-mapping to exist for the relevant machine + private
port.
+ * - The entity to have a machine location (so we can lookup the
mapped port association).
+ * - The relevant sensors to have a value, which includes the
private port.
+ */
+ pfmListener = new PortForwardManager.AssociationListener() {
+ @Override
+ public void
onAssociationCreated(PortForwardManager.AssociationMetadata metadata) {
+ Maybe<MachineLocation> machine = getMachine();
+ if (!(machine.isPresent() &&
machine.get().equals(metadata.getLocation()))) {
+ // not related to this entity's machine; ignoring
+ return;
+ }
+
+ LOG.debug("{} attempting transformations, triggered by
port-association {}, with machine {} of entity {}",
+ new Object[] {OnPublicNetworkEnricher.this,
metadata, machine.get(), entity});
+ tryTransformAll();
+ }
+ @Override
+ public void
onAssociationDeleted(PortForwardManager.AssociationMetadata metadata) {
+ // no-op
+ }
+ };
+ getPortForwardManager().addAssociationListener(pfmListener,
Predicates.alwaysTrue());
+
+ subscriptions().subscribe(entity, AbstractEntity.LOCATION_ADDED,
new SensorEventListener<Location>() {
+ @Override public void onEvent(SensorEvent<Location> event) {
+ LOG.debug("{} attempting transformations, triggered by
location-added {}, to {}", new Object[] {OnPublicNetworkEnricher.this,
event.getValue(), entity});
+ tryTransformAll();
+ }});
+
+ for (AttributeSensor<?> sensor : sensors) {
+ subscriptions().subscribe(entity, sensor, new
SensorEventListener<Object>() {
+ @Override public void onEvent(SensorEvent<Object> event) {
+ LOG.debug("{} attempting transformations, triggered by
sensor-event {}->{}, to {}",
+ new Object[] {OnPublicNetworkEnricher.this,
event.getSensor().getName(), event.getValue(), entity});
+ tryTransform((AttributeSensor<?>)event.getSensor());
+ }});
+ }
+ if (mapMatching.isPresent()) {
+ Sensor<?> wildcardSensor = null;
+ subscriptions().subscribe(entity, wildcardSensor, new
SensorEventListener<Object>() {
+ @Override public void onEvent(SensorEvent<Object> event) {
+ if (mapMatching.get().apply(event.getSensor())) {
+ LOG.debug("{} attempting transformations,
triggered by sensor-event {}->{}, to {}",
+ new Object[]
{OnPublicNetworkEnricher.this, event.getSensor().getName(), event.getValue(),
entity});
+
tryTransform((AttributeSensor<?>)event.getSensor());
+ }
+ }});
+ }
+
+ tryTransformAll();
+ }
+
+ @Override
+ public void destroy() {
+ try {
+ if (pfmListener != null) {
+
getPortForwardManager().removeAssociationListener(pfmListener);
+ }
+ } finally {
+ super.destroy();
+ }
+ }
+
+ protected void tryTransformAll() {
+ if (!isRunning()) {
+ return;
+ }
+ Maybe<MachineLocation> machine = getMachine();
+ if (machine.isAbsent()) {
+ return;
+ }
+ for (AttributeSensor<?> sensor : sensors) {
+ try {
+ tryTransform(machine.get(), sensor);
+ } catch (Exception e) {
+ // TODO Avoid repeated logging
+ Exceptions.propagateIfFatal(e);
+ LOG.warn("Problem transforming sensor "+sensor+" of
"+entity, e);
+ }
+ }
+ if (mapMatching.isPresent()) {
+ for (Sensor<?> sensor : entity.getEntityType().getSensors()) {
+ if (sensor instanceof AttributeSensor &&
mapMatching.get().apply(sensor)) {
+ try {
+ tryTransform(machine.get(),
(AttributeSensor<?>)sensor);
+ } catch (Exception e) {
+ // TODO Avoid repeated logging
+ Exceptions.propagateIfFatal(e);
+ LOG.warn("Problem transforming sensor "+sensor+"
of "+entity, e);
+ }
+ }
+ }
+ }
+ }
+
+ protected void tryTransform(AttributeSensor<?> sensor) {
+ if (!isRunning()) {
+ return;
+ }
+ Maybe<MachineLocation> machine = getMachine();
+ if (machine.isAbsent()) {
+ return;
+ }
+ tryTransform(machine.get(), sensor);
+ }
+
+ protected void tryTransform(MachineLocation machine,
AttributeSensor<?> sensor) {
+ Object sensorVal = entity.sensors().get(sensor);
+ if (sensorVal == null) {
+ return;
+ }
+ Maybe<String> newVal = transformVal(machine, sensor, sensorVal);
+ if (newVal.isAbsent()) {
+ return;
+ }
+ AttributeSensor<String> mappedSensor =
Sensors.newStringSensor(sensorNameConverter.apply(sensor.getName()));
+ if (newVal.get().equals(entity.sensors().get(mappedSensor))) {
+ // ignore duplicate
+ return;
+ }
+ LOG.debug("{} publishing value {} for transformed sensor {}, of
entity {}",
+ new Object[] {this, newVal.get(), sensor, entity});
+ entity.sensors().set(mappedSensor, newVal.get());
+ }
+
+ protected Maybe<String> transformVal(MachineLocation machine,
AttributeSensor<?> sensor, Object sensorVal) {
+ if (sensorVal == null) {
+ return Maybe.absent();
+ } else if (isPort(sensorVal)) {
+ int port = toInteger(sensorVal);
+ return transformPort(entity, machine, port);
+ } else if (isUri(sensorVal)) {
+ return transformUri(entity, machine, sensorVal.toString());
+ } else if (isHostAndPort(sensorVal)) {
+ return transformHostAndPort(entity, machine,
sensorVal.toString());
+ } else {
+ // no-op; unrecognised type
+ return Maybe.absent();
+ }
+ }
+
+ protected boolean isUri(Object sensorVal) {
+ if (sensorVal instanceof URI || sensorVal instanceof URL) {
+ return true;
+ }
+ try {
+ URI uri = new URI(sensorVal.toString());
+ return uri.getScheme() != null;
+ } catch (URISyntaxException e) {
+ return false;
+ }
+ }
+
+ protected boolean isPort(Object sensorVal) {
+ if (sensorVal instanceof Integer || sensorVal instanceof Long) {
+ return Networking.isPortValid(((Number)sensorVal).intValue());
+ } else if (sensorVal instanceof CharSequence) {
+ return sensorVal.toString().trim().matches("[0-9]+");
+ } else {
+ return false;
+ }
+ }
+
+ protected int toInteger(Object sensorVal) {
+ if (sensorVal instanceof Number) {
+ return ((Number)sensorVal).intValue();
+ } else if (sensorVal instanceof CharSequence) {
+ return Integer.parseInt(sensorVal.toString().trim());
+ } else {
+ throw new IllegalArgumentException("Expected number but got
"+sensorVal+" of type "+(sensorVal != null ? sensorVal.getClass() : null));
+ }
+ }
+
+ protected boolean isHostAndPort(Object sensorVal) {
+ if (sensorVal instanceof HostAndPort) {
+ return true;
+ } else if (sensorVal instanceof String) {
+ try {
+ HostAndPort hostAndPort =
HostAndPort.fromString((String)sensorVal);
+ return hostAndPort.hasPort();
+ } catch (IllegalArgumentException e) {
+ return false;
+ }
+ }
+ return false;
+ }
+
+ protected Maybe<String> transformUri(Entity source, MachineLocation
machine, String sensorVal) {
+ URI uri = URI.create(sensorVal);
+ int port = uri.getPort();
+ if (port == -1 && "http".equalsIgnoreCase(uri.getScheme())) port =
80;
+ if (port == -1 && "https".equalsIgnoreCase(uri.getScheme())) port
= 443;
+
+ if (port != -1) {
+ HostAndPort publicTarget =
getPortForwardManager().lookup(machine, port);
+ if (publicTarget == null) {
+ LOG.trace("network-facing enricher not transforming {} URI
{}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!publicTarget.hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} URI
{}, because no port in public-target {} for {}", new Object[] {source,
sensorVal, publicTarget, machine});
+ return Maybe.absent();
+ }
+ URI result;
+ try {
+ result = new URI(uri.getScheme(), uri.getUserInfo(),
publicTarget.getHostText(), publicTarget.getPort(), uri.getPath(),
uri.getQuery(), uri.getFragment());
+ } catch (URISyntaxException e) {
+ LOG.debug("Error transforming URI "+uri+", using target
"+publicTarget+"; rethrowing");
+ throw Exceptions.propagateAnnotated("Error transforming
URI "+uri+", using target "+publicTarget, e);
+ }
+ return Maybe.of(result.toString());
+ } else {
+ LOG.debug("sensor mapper not transforming URI "+uri+" because
no port defined");
+ return Maybe.absent();
+ }
+ }
+
+ protected Maybe<String> transformHostAndPort(Entity source,
MachineLocation machine, String sensorVal) {
+ HostAndPort hostAndPort = HostAndPort.fromString(sensorVal);
+ if (hostAndPort.hasPort()) {
+ int port = hostAndPort.getPort();
+ HostAndPort publicTarget =
getPortForwardManager().lookup(machine, port);
+ if (publicTarget == null) {
+ LOG.debug("network-facing enricher not transforming {}
host-and-port {}, because no port-mapping for {}", new Object[] {source,
sensorVal, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(publicTarget.toString());
+ } else {
+ LOG.debug("network-facing enricher not transforming {}
host-and-port {} because defines no port", source, hostAndPort);
+ return Maybe.absent();
+ }
+ }
+
+ protected Maybe<String> transformPort(Entity source, MachineLocation
machine, int sensorVal) {
+ if (Networking.isPortValid(sensorVal)) {
+ HostAndPort publicTarget =
getPortForwardManager().lookup(machine, sensorVal);
+ if (publicTarget == null) {
+ LOG.debug("network-facing enricher not transforming {}
host-and-port {}, because no port-mapping for {}", new Object[] {source,
sensorVal, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(publicTarget.toString());
+ } else {
+ LOG.debug("network-facing enricher not transforming {} port {}
because not a valid port", source, sensorVal);
+ return Maybe.absent();
+ }
+ }
+
+ protected Maybe<MachineLocation> getMachine() {
+ return Machines.findUniqueMachineLocation(entity.getLocations());
+ }
+
+ protected PortForwardManager getPortForwardManager() {
+ PortForwardManager portForwardManager =
config().get(PORT_FORWARD_MANAGER);
+ if (portForwardManager == null) {
+ portForwardManager = (PortForwardManager)
getManagementContext().getLocationRegistry().getLocationManaged(PortForwardManagerLocationResolver.PFM_GLOBAL_SPEC);
+ }
+ return portForwardManager;
+ }
+
+ protected void checkConfig() {
+ AttributeSensor<?> sensor = getConfig(SENSOR);
+ Collection<? extends AttributeSensor<?>> sensors =
getConfig(SENSORS);
+ Maybe<Object> rawMapMatching = config().getRaw(MAP_MATCHING);
+ String mapMatching = config().get(MAP_MATCHING);
+
+ if (sensor != null && sensors != null && sensors.isEmpty()) {
--- End diff --
Good spot! Have added tests as well.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
