ONOS-3658 - Adding REST APIs for query and management of device keys.

Change-Id: I3c70660a15d9085409e43d2d14120d29fd5020be

@@ -53,6 +53,7 @@ import org.onosproject.net.intent.Constraint;
 import org.onosproject.net.intent.HostToHostIntent;
 import org.onosproject.net.intent.Intent;
 import org.onosproject.net.intent.PointToPointIntent;
+import org.onosproject.net.key.DeviceKey;
 import org.onosproject.net.mcast.McastRoute;
 import org.onosproject.net.meter.Band;
 import org.onosproject.net.meter.Meter;
@@ -119,6 +120,7 @@ public class CodecManager implements CodecService {
         registerCodec(ForwardingObjective.class, new ForwardingObjectiveCodec());
         registerCodec(NextObjective.class, new NextObjectiveCodec());
         registerCodec(McastRoute.class, new McastRouteCodec());
+        registerCodec(DeviceKey.class, new DeviceKeyCodec());
         log.info("Started");
     }
 

+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.codec.impl;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.onosproject.codec.CodecContext;
+import org.onosproject.net.key.DeviceKey;
+import org.onosproject.net.key.DeviceKeyId;
+import org.onosproject.net.key.DeviceKeyService;
+import org.slf4j.Logger;
+
+import static com.google.common.base.Preconditions.checkNotNull;
+import static org.slf4j.LoggerFactory.getLogger;
+
+/**
+ * Device key JSON codec.
+ */
+public class DeviceKeyCodec extends AnnotatedCodec<DeviceKey> {
+
+    private final Logger log = getLogger(getClass());
+
+    // JSON fieldNames
+    private static final String ID = "id";
+    private static final String TYPE = "type";
+    private static final String LABEL = "label";
+    private static final String COMMUNITY_NAME = "community_name";
+    private static final String USERNAME = "username";
+    private static final String PASSWORD = "password";
+
+
+    @Override
+    public ObjectNode encode(DeviceKey deviceKey, CodecContext context) {
+        checkNotNull(deviceKey, "Device key cannot be null");
+        DeviceKeyService service = context.getService(DeviceKeyService.class);
+        ObjectNode result = context.mapper().createObjectNode()
+                .put(ID, deviceKey.deviceKeyId().id().toString())
+                .put(TYPE, deviceKey.type().toString())
+                .put(LABEL, deviceKey.label().toString());
+
+        if (deviceKey.type().equals(DeviceKey.Type.COMMUNITY_NAME)) {
+            result.put(COMMUNITY_NAME, deviceKey.asCommunityName().name());
+        } else if (deviceKey.type().equals(DeviceKey.Type.USERNAME_PASSWORD)) {
+            result.put(USERNAME, deviceKey.asUsernamePassword().username().toString());
+            result.put(PASSWORD, deviceKey.asUsernamePassword().password().toString());
+        }
+
+        return annotate(result, deviceKey, context);
+    }
+
+    @Override
+    public DeviceKey decode(ObjectNode json, CodecContext context) {
+        if (json == null || !json.isObject()) {
+            return null;
+        }
+
+        DeviceKeyId id = DeviceKeyId.deviceKeyId(json.get(ID).asText());
+
+        DeviceKey.Type type = DeviceKey.Type.valueOf(json.get(TYPE).asText());
+        String label = json.get(LABEL).asText();
+
+        if (type.equals(DeviceKey.Type.COMMUNITY_NAME)) {
+            String communityName = json.get(COMMUNITY_NAME).asText();
+            return DeviceKey.createDeviceKeyUsingCommunityName(id, label, communityName);
+        } else if (type.equals(DeviceKey.Type.USERNAME_PASSWORD)) {
+            String username = json.get(USERNAME).asText();
+            String password = json.get(PASSWORD).asText();
+            return DeviceKey.createDeviceKeyUsingUsernamePassword(id, label, username, password);
+        } else {
+            log.error("Unknown device key type: ", type);
+            return null;
+        }
+    }
+}

@@ -45,7 +45,8 @@ public class CoreWebApplication extends AbstractWebApplication {
                 StatisticsWebResource.class,
                 MetricsWebResource.class,
                 FlowObjectiveWebResource.class,
-                MulticastRouteWebResource.class
+                MulticastRouteWebResource.class,
+                DeviceKeyWebResource.class
         );
     }
 }

+/*
+ * Copyright 2016 Open Networking Laboratory
+ *
+ * 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.rest.resources;
+
+import com.fasterxml.jackson.databind.node.ObjectNode;
+import org.onosproject.net.key.DeviceKey;
+import org.onosproject.net.key.DeviceKeyAdminService;
+import org.onosproject.net.key.DeviceKeyId;
+import org.onosproject.net.key.DeviceKeyService;
+import org.onosproject.rest.AbstractWebResource;
+
+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.IOException;
+import java.io.InputStream;
+
+import static org.onlab.util.Tools.nullIsNotFound;
+
+/**
+ * Query and Manage Device Keys.
+ */
+@Path("keys")
+public class DeviceKeyWebResource extends AbstractWebResource {
+
+    @Context
+    UriInfo uriInfo;
+
+    private static final String DEVICE_KEY_NOT_FOUND = "Device key was not found";
+
+    /**
+     * Gets all device keys.
+     * Returns array of all device keys.
+     *
+     * @return 200 OK
+     * @onos.rsModel DeviceKeysGet
+     */
+    @GET
+    public Response getDeviceKeys() {
+        Iterable<DeviceKey> deviceKeys = get(DeviceKeyService.class).getDeviceKeys();
+        return ok(encodeArray(DeviceKey.class, "keys", deviceKeys)).build();
+    }
+
+    /**
+     * Get a single device key by device key unique identifier.
+     * Returns the specified device key.
+     *
+     * @param id device identifier
+     * @return 200 OK
+     * @onos.rsModel DeviceKeyGet
+     */
+    @GET
+    @Path("{id}")
+    public Response getDeviceKey(@PathParam("id") String id) {
+        DeviceKey deviceKey = nullIsNotFound(get(DeviceKeyService.class).getDeviceKey(DeviceKeyId.deviceKeyId(id)),
+                                             DEVICE_KEY_NOT_FOUND);
+        return ok(codec(DeviceKey.class).encode(deviceKey, this)).build();
+    }
+
+    /**
+     * Adds a new device key from the JSON request.
+     *
+     * @param stream input JSON
+     * @return status of the request - CREATED if the JSON is correct,
+     * BAD_REQUEST if the JSON is invalid
+     * @onos.rsModel IntentHost
+     */
+    @POST
+    @Consumes(MediaType.APPLICATION_JSON)
+    @Produces(MediaType.APPLICATION_JSON)
+    public Response addDeviceKey(InputStream stream) {
+        try {
+            DeviceKeyAdminService service = get(DeviceKeyAdminService.class);
+            ObjectNode root = (ObjectNode) mapper().readTree(stream);
+            DeviceKey deviceKey = codec(DeviceKey.class).decode(root, this);
+            service.addKey(deviceKey);
+
+            UriBuilder locationBuilder = uriInfo.getBaseUriBuilder()
+                    .path("keys")
+                    .path(deviceKey.deviceKeyId().id());
+
+            return Response
+                    .created(locationBuilder.build())
+                    .build();
+
+        } catch (IOException ioe) {
+            throw new IllegalArgumentException(ioe);
+        }
+    }
+
+    /**
+     * Removes a device key by device key identifier.
+     *
+     * @param id device identifier
+     * @return 200 OK
+     */
+    @DELETE
+    @Path("{id}")
+    public Response removeDeviceKey(@PathParam("id") String id) {
+        DeviceKey deviceKey = nullIsNotFound(get(DeviceKeyService.class).getDeviceKey(DeviceKeyId.deviceKeyId(id)),
+                                             DEVICE_KEY_NOT_FOUND);
+        get(DeviceKeyAdminService.class).removeKey(DeviceKeyId.deviceKeyId(id));
+        return ok(codec(DeviceKey.class).encode(deviceKey, this)).build();
+    }
+}

+{
+  "id": "DeviceKeyId3",
+  "type": "USERNAME_PASSWORD",
+  "label": "DeviceKeyLabel3",
+  "username": "DeviceKeyUsername3",
+  "password": "DeviceKeyPassword3"
+}