apps/openstacknetworking/src/main/java/org/onosproject/openstacknetworking/web/OpenstackSecurityGroupWebResource.java

/*
 * Copyright 2017-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.openstacknetworking.web;

import org.onlab.osgi.DefaultServiceDirectory;
import org.onosproject.openstacknetworking.api.OpenstackSecurityGroupAdminService;
import org.onosproject.rest.AbstractWebResource;
import org.openstack4j.openstack.networking.domain.NeutronSecurityGroup;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.POST;
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.UriBuilder;
import javax.ws.rs.core.UriInfo;
import java.io.InputStream;

import static javax.ws.rs.core.Response.created;
import static javax.ws.rs.core.Response.noContent;
import static org.onosproject.openstacknetworking.util.OpenstackUtil.jsonToModelEntity;

/**
 * Handles Security Group Rest API call from Neutron ML2 plugin.
 */
@Path("security-groups")
public class OpenstackSecurityGroupWebResource extends AbstractWebResource {
    protected final Logger log = LoggerFactory.getLogger(getClass());

    private static final String MESSAGE = "Received security groups %s request";
    private static final String SECURITY_GROUPS = "security-groups";

    private final OpenstackSecurityGroupAdminService adminService =
            DefaultServiceDirectory.getService(OpenstackSecurityGroupAdminService.class);

    @Context
    private UriInfo uriInfo;

    /**
     * Creates a security group from the JSON input stream.
     *
     * @param input security group JSON input stream
     * @return 201 CREATED if the JSON is correct, 400 BAD_REQUEST if the JSON
     * is invalid or duplicated security group ID already exists
     * @onos.rsModel NeutronSecurityGroup
     */
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Response createSecurityGroups(InputStream input) {
        log.trace(String.format(MESSAGE, "CREATE"));

        final NeutronSecurityGroup sg = (NeutronSecurityGroup)
                            jsonToModelEntity(input, NeutronSecurityGroup.class);

        adminService.createSecurityGroup(sg);
        UriBuilder locationBuilder = uriInfo.getBaseUriBuilder()
                .path(SECURITY_GROUPS)
                .path(sg.getId());

        return created(locationBuilder.build()).build();
    }

    /**
     * Updates a security group from the JSON input stream.
     *
     * @param input security group JSON input stream
     * @return 200 OK with the updated security group, 400 BAD_REQUEST if the
     * request is invalid
     * @onos.rsModel NeutronSecurityGroup
     */
    @PUT
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Response updateSecurityGroups(InputStream input) {
        log.trace(String.format(MESSAGE, "UPDATE"));

        // Do nothing ...
        // TODO: this interface will purged sooner or later...
        return Response.ok().build();
    }

    /**
     * Removes the security group.
     *
     * @param id security group ID
     * @return 204 NO_CONTENT
     */
    @DELETE
    @Path("{id}")
    @Consumes(MediaType.APPLICATION_JSON)
    @Produces(MediaType.APPLICATION_JSON)
    public Response removeSecurityGroup(@PathParam("id") String id) {
        log.trace(String.format(MESSAGE, "REMOVE " + id));

        adminService.removeSecurityGroup(id);
        return noContent().build();
    }
}