You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@brooklyn.apache.org by aledsage <gi...@git.apache.org> on 2016/06/09 15:57:34 UTC
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
GitHub user aledsage opened a pull request:
https://github.com/apache/brooklyn-server/pull/192
Adds OnSubnetNetworkEnricher
Some entities publish their endpoint using the public hostname (e.g. `MySqlNode` publishes `datastore.url` using the sensor `host.name`). If trying to connect to it from within the same subnet, this can fail if the public ip/hostname is not accessible.
This topic is covered in the "Working with Multiple Networks" proposal (see dev@brooklyn email thread). That suggests we should use the subnet address in things like the datastore.url. That will likely break things for some of our users. But while we discuss/finalise that proposal...
This enricher allows one to publish another sensor that definitely uses the subnet address. It will publish the sensor as things like `datastore.url.mapping.subnet`.
This is really a temporary solution (hence marking this as `@Beta`).
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/aledsage/brooklyn-server OnSubnetNetworkEnricher
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/brooklyn-server/pull/192.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #192
----
commit 1660790c9c98b9993631f9107dd1c10c570de420
Author: Aled Sage <al...@gmail.com>
Date: 2016-06-09T15:49:48Z
Adds OnSubnetNetworkEnricher
----
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by geomacy <gi...@git.apache.org>.
Github user geomacy commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66594543
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "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");
+
+ 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;
--- End diff --
Why ".endpoint.mapped" here and not ".port.mapped"?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by geomacy <gi...@git.apache.org>.
Github user geomacy commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66594302
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "if neither 'sensor' or 'sensors' is specified, defaults to matchin case-insensitive suffix of "
+ + "'port', 'uri', 'url' or 'endpoint' ",
+ "(?i).*(port|uri|url|endpoint)");
--- End diff --
Maybe worth adding an explicit "." in front of the port|uri|url|endpoint? Just in case e.g. "port" would unintentionally match a sensor called xyz_export or something?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server issue #192: Adds OnSubnetNetworkEnricher
Posted by aledsage <gi...@git.apache.org>.
Github user aledsage commented on the issue:
https://github.com/apache/brooklyn-server/pull/192
Thanks all - merging now.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by aledsage <gi...@git.apache.org>.
Github user aledsage commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66601272
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "if neither 'sensor' or 'sensors' is specified, defaults to matchin case-insensitive suffix of "
+ + "'port', 'uri', 'url' or 'endpoint' ",
+ "(?i).*(port|uri|url|endpoint)");
--- End diff --
@geomacy yes, you're right. I checked what we're doing elsewhere and it does assume a ".port" suffix:
https://github.com/apache/brooklyn-server/blob/rel/apache-brooklyn-0.9.0/software/base/src/main/java/org/apache/brooklyn/entity/software/base/SoftwareProcess.java#L59-L61
https://github.com/apache/brooklyn-server/blob/rel/apache-brooklyn-0.9.0/software/base/src/main/java/org/apache/brooklyn/entity/software/base/InboundPortsUtils.java#L76-L96
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by Graeme-Miller <gi...@git.apache.org>.
Github user Graeme-Miller commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66592324
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.class);
+
+ @SuppressWarnings("serial")
+ public static final ConfigKey<AttributeSensor<?>> SENSOR = ConfigKeys.newConfigKey(
--- End diff --
why have SENSOR and SENORS?
Would it not be simpler to just have SENSORS? If someone only wants one sensor to be mapped they can configure SENSORS with one entry.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66622079
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "if neither 'sensor' or 'sensors' is specified, defaults to matchin case-insensitive suffix of "
+ + "'port', 'uri', 'url' or 'endpoint' ",
+ "(?i).*(port|uri|url|endpoint)");
--- End diff --
It does, but that rules out sensors like `httpPort` which are used in the wild. Perhaps we should standardize on the sensor naming instead.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by aledsage <gi...@git.apache.org>.
Github user aledsage commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66600767
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "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");
+
+ 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;
+
+ protected abstract Optional<HostAndPort> getMappedEndpoint(Entity source, MachineLocation machine, int port);
+
+ @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);
+
+ 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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.this, event.getSensor().getName(), event.getValue(), entity});
+ tryTransform((AttributeSensor<?>)event.getSensor());
+ }
+ }});
+ }
+
+ tryTransformAll();
+ }
+
+ 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 {} (original sensor value {}) for mapped sensor {}, of entity {}",
+ new Object[] {this, newVal.get(), sensorVal, mappedSensor, 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) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.trace("network-facing enricher not transforming {} URI {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} URI {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ URI result;
+ try {
+ result = new URI(uri.getScheme(), uri.getUserInfo(), mappedEndpoint.get().getHostText(), mappedEndpoint.get().getPort(), uri.getPath(), uri.getQuery(), uri.getFragment());
+ } catch (URISyntaxException e) {
+ LOG.debug("Error transforming URI "+uri+", using target "+mappedEndpoint+"; rethrowing");
+ throw Exceptions.propagateAnnotated("Error transforming URI "+uri+", using target "+mappedEndpoint, 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();
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().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)) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, sensorVal);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().toString());
--- End diff --
Correct. The mapped value tells us exactly which IP to use, as well as the port number.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server issue #192: Adds OnSubnetNetworkEnricher
Posted by Graeme-Miller <gi...@git.apache.org>.
Github user Graeme-Miller commented on the issue:
https://github.com/apache/brooklyn-server/pull/192
Couple of comments then LGTM
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by aledsage <gi...@git.apache.org>.
Github user aledsage commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66600837
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.class);
+
+ @SuppressWarnings("serial")
+ public static final ConfigKey<AttributeSensor<?>> SENSOR = ConfigKeys.newConfigKey(
--- End diff --
Yes, you're right. I'll delete `SENSOR` before this gets into any official release!
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server issue #192: Adds OnSubnetNetworkEnricher
Posted by geomacy <gi...@git.apache.org>.
Github user geomacy commented on the issue:
https://github.com/apache/brooklyn-server/pull/192
Couple of minor questions and comments but none that *need* done, looks good to me.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by Graeme-Miller <gi...@git.apache.org>.
Github user Graeme-Miller commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66616715
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "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");
+
+ 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;
+
+ protected abstract Optional<HostAndPort> getMappedEndpoint(Entity source, MachineLocation machine, int port);
+
+ @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);
+
+ 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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.this, event.getSensor().getName(), event.getValue(), entity});
+ tryTransform((AttributeSensor<?>)event.getSensor());
+ }
+ }});
+ }
+
+ tryTransformAll();
+ }
+
+ 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 {} (original sensor value {}) for mapped sensor {}, of entity {}",
+ new Object[] {this, newVal.get(), sensorVal, mappedSensor, 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) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.trace("network-facing enricher not transforming {} URI {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} URI {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ URI result;
+ try {
+ result = new URI(uri.getScheme(), uri.getUserInfo(), mappedEndpoint.get().getHostText(), mappedEndpoint.get().getPort(), uri.getPath(), uri.getQuery(), uri.getFragment());
+ } catch (URISyntaxException e) {
+ LOG.debug("Error transforming URI "+uri+", using target "+mappedEndpoint+"; rethrowing");
+ throw Exceptions.propagateAnnotated("Error transforming URI "+uri+", using target "+mappedEndpoint, 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();
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().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)) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, sensorVal);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().toString());
--- End diff --
ok, makes sense are we are using a different name for the mapped sensor
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by geomacy <gi...@git.apache.org>.
Github user geomacy commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66598970
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "if neither 'sensor' or 'sensors' is specified, defaults to matchin case-insensitive suffix of "
+ + "'port', 'uri', 'url' or 'endpoint' ",
+ "(?i).*(port|uri|url|endpoint)");
--- End diff --
Although that then won't match xyz.HostAndPort. Hm. Would it be worth checking for that suffix explicitly?
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by neykov <gi...@git.apache.org>.
Github user neykov commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66622693
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,402 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.class);
+
+ @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.networkName\"); "
+ + "if 'sensors' is not specified, defaults to 'mapMatching'");
+
+ public static ConfigKey<String> MAP_MATCHING = ConfigKeys.newStringConfigKey(
+ "mapMatching",
+ "Whether to map all, based on a sensor naming convention (re-published with suffix \"mapped.networkName\"); "
+ + "if 'sensors' is not specified, defaults to matching case-insensitive suffix of "
+ + "'port', 'uri', 'url', 'endpoint' or 'hostAndPort'",
+ "(?i)(.+\\.)?(port|uri|url|endpoint|hostandport)");
+
+ @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");
+
+ 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("hostandport")) {
+ return input + ".mapped." + network;
+ } else if (lowerInput.endsWith("port")) {
+ String prefix = input.substring(0, input.length() - "port".length());
+ boolean includeDot = (!prefix.isEmpty() && !prefix.endsWith("."));
+ return prefix + (includeDot ? "." : "") + "endpoint.mapped." + network;
+ } else {
+ return input + ".mapped." + network;
+ }
+ }
+
+ @Override
+ public String toString() {
+ return getClass().getSimpleName()+"("+network+")";
+ }
+ }
+
+ protected Collection<AttributeSensor<?>> sensors;
+ protected Optional<Predicate<Sensor<?>>> mapMatching;
+ protected Function<? super String, String> sensorNameConverter;
+ protected PortForwardManager.AssociationListener pfmListener;
+
+ protected abstract Optional<HostAndPort> getMappedEndpoint(Entity source, MachineLocation machine, int port);
+
+ @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);
+
+ 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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.this, event.getSensor().getName(), event.getValue(), entity});
+ tryTransform((AttributeSensor<?>)event.getSensor());
+ }
+ }});
+ }
+
+ tryTransformAll();
+ }
+
+ 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 {} (original sensor value {}) for mapped sensor {}, of entity {}",
+ new Object[] {this, newVal.get(), sensorVal, mappedSensor, 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) {
+ String val = sensorVal.toString().trim();
+ return val.matches("[0-9]+") && val.length() <= 5
+ && Networking.isPortValid(Integer.parseInt(val));
+
+ } 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) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.trace("network-facing enricher not transforming {} URI {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} URI {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ URI result;
+ try {
+ result = new URI(uri.getScheme(), uri.getUserInfo(), mappedEndpoint.get().getHostText(), mappedEndpoint.get().getPort(), uri.getPath(), uri.getQuery(), uri.getFragment());
+ } catch (URISyntaxException e) {
+ LOG.debug("Error transforming URI "+uri+", using target "+mappedEndpoint+"; rethrowing");
+ throw Exceptions.propagateAnnotated("Error transforming URI "+uri+", using target "+mappedEndpoint, 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();
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().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)) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, sensorVal);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().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 void checkConfig() {
+ Collection<? extends AttributeSensor<?>> sensors = getConfig(SENSORS);
+ Maybe<Object> rawMapMatching = config().getRaw(MAP_MATCHING);
+ String mapMatching = config().get(MAP_MATCHING);
+
+ if (sensors == null || sensors.isEmpty()) {
+ if (Strings.isBlank(mapMatching)) {
+ throw new IllegalStateException(this+" requires 'sensors' config (when 'mapMatching' is explicitly blank)");
+ }
+ } else if (rawMapMatching.isPresent()) {
+ throw new IllegalStateException(this+" must not have explicit 'mapMatching' and 'sensors' config");
+ }
+ }
+
+ protected Collection<AttributeSensor<?>> resolveSensorsConfig() {
+ Collection<? extends AttributeSensor<?>> sensors = getConfig(SENSORS);
--- End diff --
Could've gone one step further and accept both `String` and `List` after removing `SENSOR`.
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by Graeme-Miller <gi...@git.apache.org>.
Github user Graeme-Miller commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66591368
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "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");
+
+ 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;
+
+ protected abstract Optional<HostAndPort> getMappedEndpoint(Entity source, MachineLocation machine, int port);
+
+ @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);
+
+ 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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.this, event.getSensor().getName(), event.getValue(), entity});
+ tryTransform((AttributeSensor<?>)event.getSensor());
+ }
+ }});
+ }
+
+ tryTransformAll();
+ }
+
+ 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 {} (original sensor value {}) for mapped sensor {}, of entity {}",
+ new Object[] {this, newVal.get(), sensorVal, mappedSensor, 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) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.trace("network-facing enricher not transforming {} URI {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} URI {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ URI result;
+ try {
+ result = new URI(uri.getScheme(), uri.getUserInfo(), mappedEndpoint.get().getHostText(), mappedEndpoint.get().getPort(), uri.getPath(), uri.getQuery(), uri.getFragment());
+ } catch (URISyntaxException e) {
+ LOG.debug("Error transforming URI "+uri+", using target "+mappedEndpoint+"; rethrowing");
+ throw Exceptions.propagateAnnotated("Error transforming URI "+uri+", using target "+mappedEndpoint, 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();
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, port);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} host-and-port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().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)) {
+ Optional<HostAndPort> mappedEndpoint = getMappedEndpoint(source, machine, sensorVal);
+ if (!mappedEndpoint.isPresent()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port-mapping for {}", new Object[] {source, sensorVal, machine});
+ return Maybe.absent();
+ }
+ if (!mappedEndpoint.get().hasPort()) {
+ LOG.debug("network-facing enricher not transforming {} port {}, because no port in target {} for {}", new Object[] {source, sensorVal, mappedEndpoint, machine});
+ return Maybe.absent();
+ }
+ return Maybe.of(mappedEndpoint.get().toString());
--- End diff --
sensor is a port, but we are returning a HostAndPort here
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/brooklyn-server/pull/192
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] brooklyn-server pull request #192: Adds OnSubnetNetworkEnricher
Posted by geomacy <gi...@git.apache.org>.
Github user geomacy commented on a diff in the pull request:
https://github.com/apache/brooklyn-server/pull/192#discussion_r66596473
--- Diff: core/src/main/java/org/apache/brooklyn/core/network/AbstractOnNetworkEnricher.java ---
@@ -0,0 +1,407 @@
+/*
+ * 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.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.collect.Lists;
+import com.google.common.net.HostAndPort;
+import com.google.common.reflect.TypeToken;
+
+@Beta
+public abstract class AbstractOnNetworkEnricher extends AbstractEnricher {
+
+ private static final Logger LOG = LoggerFactory.getLogger(AbstractOnNetworkEnricher.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.networkName\"); "
+ + "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.networkName\"); "
+ + "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.networkName\"); "
+ + "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");
+
+ 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;
+
+ protected abstract Optional<HostAndPort> getMappedEndpoint(Entity source, MachineLocation machine, int port);
+
+ @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);
+
+ 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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.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[] {AbstractOnNetworkEnricher.this, event.getSensor().getName(), event.getValue(), entity});
+ tryTransform((AttributeSensor<?>)event.getSensor());
+ }
+ }});
+ }
+
+ tryTransformAll();
+ }
+
+ 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 {} (original sensor value {}) for mapped sensor {}, of entity {}",
+ new Object[] {this, newVal.get(), sensorVal, mappedSensor, 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]+");
--- End diff --
Is it not worth doing the isPortValid check here too? i.e. convert to number and then same as line 258
---
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 infrastructure@apache.org or file a JIRA ticket
with INFRA.
---