Add REST API for query/update/delete/enable/disable telemetry config
1. Add unit test for newly added REST APIs
2. Add codec and unit tests for TelemetryConfig
3. Split web package out from app package due to dep conflict
Change-Id: I85f52b2a7d059622e98832843bc9613cb8befa98
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/FlowInfoJsonCodec.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/FlowInfoJsonCodec.java
new file mode 100644
index 0000000..a6d75ec
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/FlowInfoJsonCodec.java
@@ -0,0 +1,148 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.codec.rest;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.onlab.packet.IpAddress;
+import org.onlab.packet.IpPrefix;
+import org.onlab.packet.MacAddress;
+import org.onlab.packet.TpPort;
+import org.onlab.packet.VlanId;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.net.DeviceId;
+import org.onosproject.openstacktelemetry.api.FlowInfo;
+import org.onosproject.openstacktelemetry.api.StatsInfo;
+import org.onosproject.openstacktelemetry.api.DefaultFlowInfo;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.onlab.packet.VlanId.NO_VID;
+
+/**
+ * Openstack telemetry codec used for serializing and de-serializing JSON string.
+ */
+public final class FlowInfoJsonCodec extends JsonCodec<FlowInfo> {
+
+ private static final String FLOW_TYPE = "flowType";
+ private static final String DEVICE_ID = "deviceId";
+ private static final String INPUT_INTERFACE_ID = "inputInterfaceId";
+ private static final String OUTPUT_INTERFACE_ID = "outputInterfaceId";
+
+ private static final String VLAN_ID = "vlanId";
+ private static final String VXLAN_ID = "vxlanId";
+ private static final String SRC_IP = "srcIp";
+ private static final String SRC_IP_PREFIX_LEN = "srcIpPrefixLength";
+ private static final String DST_IP = "dstIp";
+ private static final String DST_IP_PREFIX_LEN = "dstIpPrefixLength";
+ private static final String SRC_PORT = "srcPort";
+ private static final String DST_PORT = "dstPort";
+ private static final String PROTOCOL = "protocol";
+ private static final String SRC_MAC = "srcMac";
+ private static final String DST_MAC = "dstMac";
+ private static final String STATS_INFO = "statsInfo";
+
+ @Override
+ public ObjectNode encode(FlowInfo info, CodecContext context) {
+ checkNotNull(info, "FlowInfo cannot be null");
+
+ ObjectNode result = context.mapper().createObjectNode()
+ .put(FLOW_TYPE, info.flowType())
+ .put(DEVICE_ID, info.deviceId().toString())
+ .put(INPUT_INTERFACE_ID, info.inputInterfaceId())
+ .put(OUTPUT_INTERFACE_ID, info.outputInterfaceId())
+ .put(SRC_IP, info.srcIp().address().toString())
+ .put(SRC_IP_PREFIX_LEN, info.srcIp().prefixLength())
+ .put(DST_IP, info.dstIp().address().toString())
+ .put(DST_IP_PREFIX_LEN, info.dstIp().prefixLength())
+ .put(SRC_PORT, info.srcPort().toString())
+ .put(DST_PORT, info.dstPort().toString())
+ .put(PROTOCOL, info.protocol())
+ .put(SRC_MAC, info.srcMac().toString())
+ .put(DST_MAC, info.dstMac().toString());
+
+ if (info.vlanId() != null) {
+ result.put(VLAN_ID, info.vlanId().toString());
+ } else {
+ result.put(VXLAN_ID, info.vxlanId());
+ }
+
+ ObjectNode statsInfoJson =
+ context.codec(StatsInfo.class).encode(info.statsInfo(), context);
+
+ result.put(STATS_INFO, statsInfoJson);
+
+ return result;
+ }
+
+ @Override
+ public FlowInfo decode(ObjectNode json, CodecContext context) {
+ if (json == null || !json.isObject()) {
+ return null;
+ }
+
+ String flowType = json.get(FLOW_TYPE).asText();
+ String deviceId = json.get(DEVICE_ID).asText();
+ int inputInterfaceId = json.get(INPUT_INTERFACE_ID).asInt();
+ int outputInterfaceId = json.get(OUTPUT_INTERFACE_ID).asInt();
+ String srcIp = json.get(SRC_IP).asText();
+ int srcIpPrefixLength = json.get(SRC_IP_PREFIX_LEN).asInt();
+ String dstIp = json.get(DST_IP).asText();
+ int dstIpPrefixLength = json.get(DST_IP_PREFIX_LEN).asInt();
+ int srcPort = json.get(SRC_PORT).asInt();
+ int dstPort = json.get(DST_PORT).asInt();
+ String protocol = json.get(PROTOCOL).asText();
+ String srcMac = json.get(SRC_MAC).asText();
+ String dstMac = json.get(DST_MAC).asText();
+
+ VlanId vlanId;
+ short vxlanId = 0;
+ try {
+ if (json.get(VLAN_ID).isNull()) {
+ vlanId = VlanId.vlanId(NO_VID);
+ if (!(json.get(VXLAN_ID).isNull())) {
+ vxlanId = (short) json.get(VXLAN_ID).asInt();
+ }
+ } else {
+ vlanId = VlanId.vlanId((short) json.get(VLAN_ID).asInt());
+ }
+ } catch (NullPointerException ex) {
+ vlanId = VlanId.vlanId();
+ }
+
+ JsonNode statsInfoJson = json.get(STATS_INFO);
+
+ JsonCodec<StatsInfo> statsInfoCodec = context.codec(StatsInfo.class);
+ StatsInfo statsInfo = statsInfoCodec.decode((ObjectNode) statsInfoJson.deepCopy(), context);
+
+ return new DefaultFlowInfo.DefaultBuilder()
+ .withFlowType(Byte.valueOf(flowType))
+ .withDeviceId(DeviceId.deviceId(deviceId))
+ .withInputInterfaceId(inputInterfaceId)
+ .withOutputInterfaceId(outputInterfaceId)
+ .withSrcIp(IpPrefix.valueOf(IpAddress.valueOf(srcIp), srcIpPrefixLength))
+ .withDstIp(IpPrefix.valueOf(IpAddress.valueOf(dstIp), dstIpPrefixLength))
+ .withSrcPort(TpPort.tpPort(srcPort))
+ .withDstPort(TpPort.tpPort(dstPort))
+ .withProtocol(Byte.valueOf(protocol))
+ .withSrcMac(MacAddress.valueOf(srcMac))
+ .withDstMac(MacAddress.valueOf(dstMac))
+ .withVlanId(vlanId)
+ .withVxlanId(vxlanId)
+ .withStatsInfo(statsInfo)
+ .build();
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/StatsFlowRuleJsonCodec.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/StatsFlowRuleJsonCodec.java
new file mode 100644
index 0000000..3d2b13f
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/StatsFlowRuleJsonCodec.java
@@ -0,0 +1,112 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.codec.rest;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.apache.commons.lang3.exception.ExceptionUtils;
+import org.onlab.packet.IPv4;
+import org.onlab.packet.IpPrefix;
+import org.onlab.packet.TpPort;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.openstacktelemetry.api.DefaultStatsFlowRule;
+import org.onosproject.openstacktelemetry.api.StatsFlowRule;
+import org.slf4j.Logger;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * JSON codec for StatsFlowRule.
+ */
+public class StatsFlowRuleJsonCodec extends JsonCodec<StatsFlowRule> {
+
+ private final Logger log = getLogger(getClass());
+
+ private static final String PROTOCOL_NAME_TCP = "tcp";
+ private static final String PROTOCOL_NAME_UDP = "udp";
+ private static final String PROTOCOL_NAME_ANY = "any";
+ private static final int ARBITRARY_PROTOCOL = 0x0;
+
+ public static final String SRC_IP_PREFIX = "srcIpPrefix";
+ public static final String DST_IP_PREFIX = "dstIpPrefix";
+ public static final String IP_PROTOCOL = "ipProtocol";
+ public static final String SRC_TP_PORT = "srcTpPort";
+ public static final String DST_TP_PORT = "dstTpPort";
+
+ public ObjectNode encode(StatsFlowRule flowRule, CodecContext context) {
+ checkNotNull(flowRule, "FlowInfo cannot be null");
+ ObjectNode result = context.mapper().createObjectNode()
+ .put(SRC_IP_PREFIX, flowRule.srcIpPrefix().toString())
+ .put(DST_IP_PREFIX, flowRule.dstIpPrefix().toString())
+ .put(IP_PROTOCOL, flowRule.ipProtocol())
+ .put(SRC_TP_PORT, flowRule.srcTpPort().toString())
+ .put(DST_TP_PORT, flowRule.dstTpPort().toString());
+ return result;
+ }
+
+ @Override
+ public StatsFlowRule decode(ObjectNode json, CodecContext context) {
+ if (json == null || !json.isObject()) {
+ return null;
+ }
+ try {
+ String srcIpPrefix = json.get(SRC_IP_PREFIX).asText();
+ String dstIpPrefix = json.get(DST_IP_PREFIX).asText();
+
+ DefaultStatsFlowRule.Builder flowRuleBuilder;
+
+ if (json.get(IP_PROTOCOL) == null) {
+ log.info("ipProtocol: null");
+ flowRuleBuilder = DefaultStatsFlowRule.builder()
+ .srcIpPrefix(IpPrefix.valueOf(srcIpPrefix))
+ .dstIpPrefix(IpPrefix.valueOf(dstIpPrefix));
+ } else {
+ byte ipProtocol = getProtocolTypeFromString(json.get(IP_PROTOCOL).asText());
+ int srcTpPort = json.get(SRC_TP_PORT).asInt();
+ int dstTpPort = json.get(DST_TP_PORT).asInt();
+
+ flowRuleBuilder = DefaultStatsFlowRule.builder()
+ .srcIpPrefix(IpPrefix.valueOf(srcIpPrefix))
+ .dstIpPrefix(IpPrefix.valueOf(dstIpPrefix))
+ .ipProtocol(ipProtocol)
+ .srcTpPort(TpPort.tpPort(srcTpPort))
+ .dstTpPort(TpPort.tpPort(dstTpPort));
+ }
+ return flowRuleBuilder.build();
+ } catch (Exception ex) {
+ log.error("Exception Stack:\n{}", ExceptionUtils.getStackTrace(ex));
+ }
+ return null;
+ }
+
+ /**
+ * Obtains transport protocol type from the given string.
+ *
+ * @param str transport protocol name
+ * @return transport protocol type
+ */
+ private byte getProtocolTypeFromString(String str) {
+ switch (str.toLowerCase()) {
+ case PROTOCOL_NAME_TCP:
+ return IPv4.PROTOCOL_TCP;
+ case PROTOCOL_NAME_UDP:
+ return IPv4.PROTOCOL_UDP;
+ default:
+ return ARBITRARY_PROTOCOL;
+ }
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/StatsInfoJsonCodec.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/StatsInfoJsonCodec.java
new file mode 100644
index 0000000..de8a7ef
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/StatsInfoJsonCodec.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.codec.rest;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.openstacktelemetry.api.StatsInfo;
+import org.onosproject.openstacktelemetry.api.DefaultStatsInfo;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+
+/**
+ * Openstack telemetry codec used for serializing and de-serializing JSON string.
+ */
+public final class StatsInfoJsonCodec extends JsonCodec<StatsInfo> {
+
+ private static final String STARTUP_TIME = "startupTime";
+ private static final String FST_PKT_ARR_TIME = "fstPktArrTime";
+ private static final String LST_PKT_OFFSET = "lstPktOffset";
+ private static final String PREV_ACC_BYTES = "prevAccBytes";
+ private static final String PREV_ACC_PKTS = "prevAccPkts";
+ private static final String CURR_ACC_BYTES = "currAccBytes";
+ private static final String CURR_ACC_PKTS = "currAccPkts";
+ private static final String ERROR_PKTS = "errorPkts";
+ private static final String DROP_PKTS = "dropPkts";
+
+ @Override
+ public ObjectNode encode(StatsInfo info, CodecContext context) {
+ checkNotNull(info, "StatsInfo cannot be null");
+
+ return context.mapper().createObjectNode()
+ .put(STARTUP_TIME, info.startupTime())
+ .put(FST_PKT_ARR_TIME, info.fstPktArrTime())
+ .put(LST_PKT_OFFSET, info.lstPktOffset())
+ .put(PREV_ACC_BYTES, info.prevAccBytes())
+ .put(PREV_ACC_PKTS, info.prevAccPkts())
+ .put(CURR_ACC_BYTES, info.prevAccBytes())
+ .put(CURR_ACC_PKTS, info.prevAccPkts())
+ .put(ERROR_PKTS, info.errorPkts())
+ .put(DROP_PKTS, info.dropPkts());
+ }
+
+ @Override
+ public StatsInfo decode(ObjectNode json, CodecContext context) {
+ if (json == null || !json.isObject()) {
+ return null;
+ }
+
+ return new DefaultStatsInfo.DefaultBuilder()
+ .withStartupTime(json.get(STARTUP_TIME).asLong())
+ .withFstPktArrTime(json.get(FST_PKT_ARR_TIME).asLong())
+ .withLstPktOffset(json.get(LST_PKT_OFFSET).asInt())
+ .withPrevAccBytes(json.get(PREV_ACC_BYTES).asLong())
+ .withPrevAccPkts(json.get(PREV_ACC_PKTS).asInt())
+ .withCurrAccBytes(json.get(CURR_ACC_BYTES).asLong())
+ .withCurrAccPkts(json.get(CURR_ACC_PKTS).asInt())
+ .withErrorPkts((short) json.get(ERROR_PKTS).asInt())
+ .withDropPkts((short) json.get(DROP_PKTS).asInt())
+ .build();
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/TelemetryConfigJsonCodec.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/TelemetryConfigJsonCodec.java
new file mode 100644
index 0000000..8c0a6e3
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/TelemetryConfigJsonCodec.java
@@ -0,0 +1,131 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.codec.rest;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.google.common.collect.ImmutableList;
+import com.google.common.collect.Maps;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.openstacktelemetry.api.DefaultTelemetryConfig;
+import org.onosproject.openstacktelemetry.api.config.TelemetryConfig;
+
+import java.util.Map;
+import java.util.stream.IntStream;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.onlab.util.Tools.nullIsIllegal;
+
+/**
+ * Openstack telemetry config codec used for serializing and de-serializing JSON string.
+ */
+public final class TelemetryConfigJsonCodec extends JsonCodec<TelemetryConfig> {
+
+ private static final String NAME = "name";
+ private static final String TYPE = "type";
+ private static final String MANUFACTURER = "manufacturer";
+ private static final String SW_VERSION = "swVersion";
+ private static final String ENABLED = "enabled";
+ private static final String PROPS = "props";
+ private static final String KEY = "key";
+ private static final String VALUE = "value";
+
+ private static final String MISSING_MESSAGE = " is required in TelemetryConfig";
+
+ @Override
+ public ObjectNode encode(TelemetryConfig config, CodecContext context) {
+ checkNotNull(config, "TelemetryConfig cannot be null");
+
+ ObjectNode node = context.mapper().createObjectNode()
+ .put(NAME, config.name())
+ .put(TYPE, config.type().name())
+ .put(MANUFACTURER, config.manufacturer())
+ .put(SW_VERSION, config.swVersion())
+ .put(ENABLED, config.enabled());
+
+ Map<String, String> props = config.properties();
+ ArrayNode propsJson = context.mapper().createArrayNode();
+ props.forEach((k, v) -> {
+ ObjectNode propNode = context.mapper().createObjectNode();
+ propNode.put(KEY, k);
+ propNode.put(VALUE, v);
+ propsJson.add(propNode);
+ });
+ node.set(PROPS, propsJson);
+ return node;
+ }
+
+ @Override
+ public TelemetryConfig decode(ObjectNode json, CodecContext context) {
+ if (json == null || !json.isObject()) {
+ return null;
+ }
+
+ // parse name
+ String name = nullIsIllegal(json.get(NAME),
+ NAME + MISSING_MESSAGE).asText();
+
+ // parse type
+ String type = nullIsIllegal(json.get(TYPE),
+ TYPE + MISSING_MESSAGE).asText();
+
+ TelemetryConfig.ConfigType configType = configType(type);
+
+ // parse manufacturer
+ String manufacturer = nullIsIllegal(json.get(MANUFACTURER).asText(),
+ MANUFACTURER + MISSING_MESSAGE);
+
+ // parse software version
+ String swVersion = nullIsIllegal(json.get(SW_VERSION),
+ SW_VERSION + MISSING_MESSAGE).asText();
+
+ // parse enabled flag
+ boolean enabled = nullIsIllegal(json.get(ENABLED),
+ ENABLED + MISSING_MESSAGE).asBoolean();
+
+ JsonNode propertiesJson = json.get(PROPS);
+ Map<String, String> properties = Maps.newConcurrentMap();
+ if (propertiesJson != null) {
+ IntStream.range(0, propertiesJson.size()).forEach(i -> {
+ ObjectNode propertyJson = get(propertiesJson, i);
+ properties.put(propertyJson.get(KEY).asText(),
+ propertyJson.get(VALUE).asText());
+ });
+ }
+
+ return new DefaultTelemetryConfig(name, configType,
+ ImmutableList.of(), manufacturer, swVersion, enabled, properties);
+ }
+
+ private TelemetryConfig.ConfigType configType(String type) {
+ switch (type.toUpperCase()) {
+ case "KAFKA" :
+ return TelemetryConfig.ConfigType.KAFKA;
+ case "GRPC" :
+ return TelemetryConfig.ConfigType.GRPC;
+ case "INFLUXDB" :
+ return TelemetryConfig.ConfigType.INFLUXDB;
+ case "PROMETHEUS" :
+ return TelemetryConfig.ConfigType.PROMETHEUS;
+ case "REST" :
+ return TelemetryConfig.ConfigType.REST;
+ default:
+ return TelemetryConfig.ConfigType.UNKNOWN;
+ }
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/package-info.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/package-info.java
new file mode 100644
index 0000000..3a699c1
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/codec/rest/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.
+ */
+
+/**
+ * Implementations of the codec broker and openstack telemetry entity codecs.
+ */
+package org.onosproject.openstacktelemetry.codec.rest;
\ No newline at end of file
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryCodecRegister.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryCodecRegister.java
new file mode 100644
index 0000000..6bd8636
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryCodecRegister.java
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.web;
+
+import org.onosproject.codec.CodecService;
+import org.onosproject.openstacktelemetry.api.FlowInfo;
+import org.onosproject.openstacktelemetry.api.StatsFlowRule;
+import org.onosproject.openstacktelemetry.api.StatsInfo;
+import org.onosproject.openstacktelemetry.api.config.TelemetryConfig;
+import org.onosproject.openstacktelemetry.codec.rest.FlowInfoJsonCodec;
+import org.onosproject.openstacktelemetry.codec.rest.StatsFlowRuleJsonCodec;
+import org.onosproject.openstacktelemetry.codec.rest.StatsInfoJsonCodec;
+import org.onosproject.openstacktelemetry.codec.rest.TelemetryConfigJsonCodec;
+import org.osgi.service.component.annotations.Activate;
+import org.osgi.service.component.annotations.Component;
+import org.osgi.service.component.annotations.Deactivate;
+import org.osgi.service.component.annotations.Reference;
+import org.osgi.service.component.annotations.ReferenceCardinality;
+
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Implementation of the JSON codec brokering service for OpenstackTelemetry.
+ */
+@Component(immediate = true)
+public class OpenstackTelemetryCodecRegister {
+
+ private final org.slf4j.Logger log = getLogger(getClass());
+
+ @Reference(cardinality = ReferenceCardinality.MANDATORY)
+ protected CodecService codecService;
+
+ @Activate
+ protected void activate() {
+ codecService.registerCodec(StatsInfo.class, new StatsInfoJsonCodec());
+ codecService.registerCodec(FlowInfo.class, new FlowInfoJsonCodec());
+ codecService.registerCodec(StatsFlowRule.class, new StatsFlowRuleJsonCodec());
+ codecService.registerCodec(TelemetryConfig.class, new TelemetryConfigJsonCodec());
+
+ log.info("Started");
+ }
+
+ @Deactivate
+ protected void deactivate() {
+ codecService.unregisterCodec(StatsInfo.class);
+ codecService.unregisterCodec(FlowInfo.class);
+ codecService.unregisterCodec(StatsFlowRule.class);
+ codecService.unregisterCodec(TelemetryConfig.class);
+
+ log.info("Stopped");
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryConfigWebResource.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryConfigWebResource.java
new file mode 100644
index 0000000..7484d04
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryConfigWebResource.java
@@ -0,0 +1,212 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.web;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.google.common.collect.Maps;
+import org.onosproject.openstacktelemetry.api.TelemetryConfigAdminService;
+import org.onosproject.openstacktelemetry.api.config.TelemetryConfig;
+import org.onosproject.rest.AbstractWebResource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.PUT;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+import java.util.Map;
+
+import static org.onlab.util.Tools.nullIsIllegal;
+import static org.onlab.util.Tools.nullIsNotFound;
+
+/**
+ * Handles REST API call of openstack telemetry configuration.
+ */
+@Path("config")
+public class OpenstackTelemetryConfigWebResource extends AbstractWebResource {
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ private static final String MESSAGE_CONFIG = "Received config %s request";
+ private static final String CONFIG = "config";
+ private static final String ADDRESS = "address";
+ private static final String QUERY = "QUERY";
+ private static final String UPDATE = "UPDATE";
+ private static final String DELETE = "DELETE";
+ private static final String CONFIG_NAME = "config name";
+ private static final String NOT_NULL_MESSAGE = " cannot be null";
+ private static final String CONFIG_NOT_FOUND = "Config is not found";
+
+ private final TelemetryConfigAdminService configService =
+ get(TelemetryConfigAdminService.class);
+
+ @Context
+ private UriInfo uriInfo;
+
+ /**
+ * Updates the telemetry configuration address from the JSON input stream.
+ *
+ * @param configName telemetry config name
+ * @param address telemetry config address
+ * @return 200 OK with the updated telemetry config, 400 BAD_REQUEST
+ * if the JSON is malformed, and 304 NOT_MODIFIED without the updated config
+ * due to incorrect configuration name so that we cannot find the existing config
+ */
+ @PUT
+ @Path("address/{name}/{address}")
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response updateConfigAddress(@PathParam("name") String configName,
+ @PathParam("address") String address) {
+ log.trace(String.format(MESSAGE_CONFIG, UPDATE));
+
+ try {
+ TelemetryConfig config = configService.getConfig(
+ nullIsIllegal(configName, CONFIG_NAME + NOT_NULL_MESSAGE));
+
+ if (config == null) {
+ log.warn("There is no config found to modify for {}", configName);
+ return Response.notModified().build();
+ } else {
+ Map<String, String> updatedProperties =
+ Maps.newHashMap(config.properties());
+ updatedProperties.put(ADDRESS,
+ nullIsIllegal(address, ADDRESS + NOT_NULL_MESSAGE));
+ TelemetryConfig updatedConfig =
+ config.updateProperties(updatedProperties);
+
+ configService.updateTelemetryConfig(updatedConfig);
+ return Response.ok().build();
+ }
+
+ } catch (Exception e) {
+ throw new IllegalArgumentException(e);
+ }
+ }
+
+ /**
+ * Deletes the telemetry configuration by referring to configuration name.
+ *
+ * @param configName telemetry configuration name
+ * @return 204 NO_CONTENT, 400 BAD_REQUEST if the JSON is malformed,
+ * and 304 NOT_MODIFIED without removing config, due to incorrect
+ * configuration name so that we cannot find the existing config
+ */
+ @DELETE
+ @Path("{name}")
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response deleteTelemetryConfig(@PathParam("name") String configName) {
+ log.trace(String.format(MESSAGE_CONFIG, DELETE));
+
+ TelemetryConfig config = configService.getConfig(
+ nullIsIllegal(configName, CONFIG_NAME + NOT_NULL_MESSAGE));
+
+ if (config == null) {
+ log.warn("There is no config found to delete for {}", configName);
+ return Response.notModified().build();
+ } else {
+ configService.removeTelemetryConfig(configName);
+ return Response.noContent().build();
+ }
+ }
+
+ /**
+ * Get details of telemetry config.
+ * Returns detailed properties of the specified telemetry config.
+ *
+ * @param configName telemetry configName
+ * @return 200 OK with detailed properties of the specific telemetry config
+ * @onos.rsModel TelemetryConfig
+ */
+ @GET
+ @Path("{name}")
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response getConfig(@PathParam("name") String configName) {
+ log.trace(String.format(MESSAGE_CONFIG, QUERY));
+
+ final TelemetryConfig config =
+ nullIsNotFound(configService.getConfig(configName), CONFIG_NOT_FOUND);
+ final ObjectNode root = codec(TelemetryConfig.class).encode(config, this);
+ return ok(root).build();
+ }
+
+ /**
+ * Enables the telemetry configuration with the given config name.
+ *
+ * @param configName telemetry configuration name
+ * @return 200 OK with the enabled telemetry config,
+ * 400 BAD_REQUEST if the JSON is malformed,
+ * and 304 NOT_MODIFIED without removing config, due to incorrect
+ * configuration name so that we cannot find the existing config
+ */
+ @PUT
+ @Path("enable/{name}")
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response enableConfig(@PathParam("name") String configName) {
+ log.trace(String.format(MESSAGE_CONFIG, UPDATE));
+
+ TelemetryConfig config = configService.getConfig(
+ nullIsIllegal(configName, CONFIG_NAME + NOT_NULL_MESSAGE));
+
+ if (config == null) {
+ log.warn("There is no config found to enable for {}", configName);
+ return Response.notModified().build();
+ } else {
+ TelemetryConfig updatedConfig = config.updateEnabled(true);
+ configService.updateTelemetryConfig(updatedConfig);
+ return Response.ok().build();
+ }
+ }
+
+ /**
+ * Disables the telemetry configuration with the given config name.
+ *
+ * @param configName telemetry configuration name
+ * @return 200 OK with the disabled telemetry config
+ * 400 BAD_REQUEST if the JSON is malformed,
+ * and 304 NOT_MODIFIED without removing config, due to incorrect
+ * configuration name so that we cannot find the existing config
+ */
+ @PUT
+ @Path("disable/{name}")
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response disableConfig(@PathParam("name") String configName) {
+ log.trace(String.format(MESSAGE_CONFIG, UPDATE));
+
+ TelemetryConfig config = configService.getConfig(
+ nullIsIllegal(configName, CONFIG_NAME + NOT_NULL_MESSAGE));
+
+ if (config == null) {
+ log.warn("There is no config found to disable for {}", configName);
+ return Response.notModified().build();
+ } else {
+ TelemetryConfig updatedConfig = config.updateEnabled(false);
+ configService.updateTelemetryConfig(updatedConfig);
+ return Response.ok().build();
+ }
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryWebApplication.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryWebApplication.java
new file mode 100644
index 0000000..4deff1c
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryWebApplication.java
@@ -0,0 +1,31 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.web;
+
+import org.onlab.rest.AbstractWebApplication;
+
+import java.util.Set;
+
+/**
+ * Openstack telemetry REST APIs web application.
+ */
+public class OpenstackTelemetryWebApplication extends AbstractWebApplication {
+ @Override
+ public Set<Class<?>> getClasses() {
+ return getClasses(OpenstackTelemetryWebResource.class,
+ OpenstackTelemetryConfigWebResource.class);
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryWebResource.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryWebResource.java
new file mode 100644
index 0000000..40b5c93
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/OpenstackTelemetryWebResource.java
@@ -0,0 +1,185 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.onosproject.openstacktelemetry.web;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.node.ArrayNode;
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import com.google.common.collect.Sets;
+import org.apache.commons.lang3.exception.ExceptionUtils;
+import org.onosproject.codec.JsonCodec;
+import org.onosproject.openstacktelemetry.api.FlowInfo;
+import org.onosproject.openstacktelemetry.api.StatsFlowRule;
+import org.onosproject.openstacktelemetry.api.StatsFlowRuleAdminService;
+import org.onosproject.openstacktelemetry.codec.rest.FlowInfoJsonCodec;
+import org.onosproject.rest.AbstractWebResource;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.ws.rs.Consumes;
+import javax.ws.rs.DELETE;
+import javax.ws.rs.GET;
+import javax.ws.rs.POST;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriBuilder;
+import javax.ws.rs.core.UriInfo;
+import java.io.InputStream;
+import java.util.Set;
+
+import static com.fasterxml.jackson.databind.SerializationFeature.INDENT_OUTPUT;
+import static javax.ws.rs.core.Response.created;
+import static org.onlab.util.Tools.readTreeFromStream;
+
+/**
+ * Handles REST API call of openstack telemetry.
+ */
+@Path("telemetry")
+public class OpenstackTelemetryWebResource extends AbstractWebResource {
+
+ private final Logger log = LoggerFactory.getLogger(getClass());
+
+ private final ObjectNode root = mapper().createObjectNode();
+
+ private static final String JSON_NODE_FLOW_RULE = "rules";
+ private static final String FLOW_RULE_ID = "STATS_FLOW_RULE_ID";
+
+ private final StatsFlowRuleAdminService
+ statsFlowRuleService = get(StatsFlowRuleAdminService.class);
+
+ @Context
+ private UriInfo uriInfo;
+
+ /**
+ * Creates a flow rule for metric.
+ *
+ * @param input openstack flow rule JSON input stream
+ * @return 201 CREATED if the JSON is correct,
+ * 400 BAD_REQUEST if the JSON is malformed.
+ */
+ @POST
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response createBulkFlowRule(InputStream input) {
+ log.info("CREATE BULK FLOW RULE: {}", input.toString());
+
+ readNodeConfiguration(input).forEach(flowRule -> {
+ log.debug("FlowRule: {}", flowRule.toString());
+ statsFlowRuleService.createStatFlowRule(flowRule);
+ });
+
+ UriBuilder locationBuilder = uriInfo.getBaseUriBuilder()
+ .path(JSON_NODE_FLOW_RULE)
+ .path(FLOW_RULE_ID);
+
+ return created(locationBuilder.build()).build();
+ }
+
+ /**
+ * Delete flow rules.
+ *
+ * @param input openstack flow rule JSON input stream
+ * @return 200 OK if processing is correct.
+ */
+ @DELETE
+ @Consumes(MediaType.APPLICATION_JSON)
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response deleteBulkFlowRule(InputStream input) {
+ log.info("DELETE BULK FLOW RULE: {}", input.toString());
+
+ readNodeConfiguration(input).forEach(flowRule -> {
+ log.debug("FlowRule: {}", flowRule.toString());
+ statsFlowRuleService.deleteStatFlowRule(flowRule);
+ });
+
+ return ok(root).build();
+ }
+
+ /**
+ * Get flow rules which is installed on ONOS.
+ *
+ * @return 200 OK
+ */
+ public Response readBulkFlowRule() {
+ log.info("READ BULK FLOW RULE");
+
+ return ok(root).build();
+ }
+
+ /**
+ * Get flow information list.
+ *
+ * @return Flow information list
+ */
+ @GET
+ @Path("list")
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response getFlowInfoBulk() {
+ log.info("GET BULK FLOW RULE");
+
+ Set<FlowInfo> flowInfoSet;
+ flowInfoSet = statsFlowRuleService.getOverlayFlowInfos();
+
+ JsonCodec<FlowInfo> flowInfoCodec = new FlowInfoJsonCodec();
+
+ ObjectNode nodeJson;
+ int idx = 0;
+ for (FlowInfo flowInfo: flowInfoSet) {
+ nodeJson = flowInfoCodec.encode(flowInfo, this);
+ root.put("FlowInfo" + idx++, nodeJson.toString());
+ }
+ return ok(root).build();
+ }
+
+ @GET
+ @Path("list/{srcIpPrefix}/{dstIpPrefix}")
+ @Produces(MediaType.APPLICATION_JSON)
+ public Response getFlowRule(@PathParam("srcIpPrefix") String srcIpPrefix,
+ @PathParam("dstIpPrefix") String dstIpPrefix) {
+ return ok(root).build();
+ }
+
+ private Set<StatsFlowRule> readNodeConfiguration(InputStream input) {
+ log.info("Input JSON Data: \n\t\t{}", input.toString());
+ Set<StatsFlowRule> flowRuleSet = Sets.newHashSet();
+ try {
+ JsonNode jsonTree = readTreeFromStream(mapper().enable(INDENT_OUTPUT), input);
+ ArrayNode nodes = (ArrayNode) jsonTree.path(JSON_NODE_FLOW_RULE);
+ nodes.forEach(node -> {
+ try {
+ ObjectNode objectNode = node.deepCopy();
+ log.debug("ObjectNode: {}", objectNode.toString());
+ StatsFlowRule statsFlowRule = codec(StatsFlowRule.class)
+ .decode(objectNode, this);
+ log.debug("StatsFlowRule: {}", statsFlowRule.toString());
+ flowRuleSet.add(statsFlowRule);
+ } catch (Exception ex) {
+ log.error("Exception Stack:\n{}", ExceptionUtils.getStackTrace(ex));
+ throw new IllegalArgumentException();
+ }
+ });
+ } catch (Exception ex) {
+ log.error("Exception Stack:\n{}", ExceptionUtils.getStackTrace(ex));
+ throw new IllegalArgumentException(ex);
+ }
+
+ return flowRuleSet;
+ }
+}
diff --git a/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/package-info.java b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/package-info.java
new file mode 100644
index 0000000..24c5ed66
--- /dev/null
+++ b/apps/openstacktelemetry/web/src/main/java/org/onosproject/openstacktelemetry/web/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2018-present Open Networking Foundation
+ *
+ * Licensed 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.
+ */
+
+/**
+ * Web GUI and REST API of openstack telemetry.
+ */
+package org.onosproject.openstacktelemetry.web;
\ No newline at end of file