RestEnvironments.java

/*
 * Copyright 2015-2016 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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.hawkular.inventory.rest.deprecated;

import static javax.ws.rs.core.MediaType.APPLICATION_JSON;
import static javax.ws.rs.core.Response.Status.FORBIDDEN;

import static org.hawkular.inventory.rest.RequestUtil.extractPaging;

import java.util.Set;

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
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.Response;
import javax.ws.rs.core.UriInfo;

import org.hawkular.inventory.api.model.Environment;
import org.hawkular.inventory.api.paging.Page;
import org.hawkular.inventory.paths.CanonicalPath;
import org.hawkular.inventory.rest.ResponseUtil;
import org.hawkular.inventory.rest.RestBase;
import org.hawkular.inventory.rest.json.ApiError;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;

/**
 * @author Lukas Krejci
 * @since 1.0
 */
@Path("/deprecated")
@Produces(value = APPLICATION_JSON)
@Consumes(value = APPLICATION_JSON)
@Api(value = "/deprecated", description = "CRUD of environments.", tags = {"Deprecated"})
public class RestEnvironments extends RestBase {

    @GET
    @Path("/environments")
    @ApiOperation("Returns all environments under given tenant. Accepts paging query parameters.")
    @ApiResponses({
            @ApiResponse(code = 200, message = "OK", response = Set.class),
            @ApiResponse(code = 401, message = "Unauthorized access"),
            @ApiResponse(code = 404, message = "Tenant not found", response = ApiError.class),
            @ApiResponse(code = 500, message = "Server error", response = ApiError.class)
    })
    public Response getAll(@Context UriInfo uri) throws Exception {
        String tenantId = getTenantId();

        Page<Environment> ret = inventory.tenants().get(tenantId).environments().getAll()
                .entities(extractPaging(uri));

        return pagedResponse(Response.ok(), uri, ret).build();
    }

    @GET
    @Path("/environments/{environmentId}")
    @ApiOperation("Retrieves a single environment")
    @ApiResponses({
            @ApiResponse(code = 200, message = "OK"),
            @ApiResponse(code = 401, message = "Unauthorized access"),
            @ApiResponse(code = 404, message = "Environment doesn't exist", response = ApiError.class),
            @ApiResponse(code = 500, message = "Server error", response = ApiError.class)
    })
    public Response get(@PathParam("environmentId") String environmentId)
            throws Exception {
        String tenantId = getTenantId();

        return Response.ok(inventory.tenants().get(tenantId).environments().get(environmentId).entity()).build();
    }

    @POST
    @Path("/environments")
    @ApiOperation("Creates a new environment in given tenant.")
    @ApiResponses({
            @ApiResponse(code = 201, message = "Environment created"),
            @ApiResponse(code = 401, message = "Unauthorized access"),
            @ApiResponse(code = 409, message = "Environment already exists", response = ApiError.class),
            @ApiResponse(code = 500, message = "Server error", response = ApiError.class)
    })
    public Response create(@ApiParam(required = true) Environment.Blueprint environmentBlueprint,
            @Context UriInfo uriInfo) throws Exception {
        String tenantId = getTenantId();
        if (!security.canCreate(Environment.class).under(CanonicalPath.of().tenant(tenantId).get())) {
            return Response.status(FORBIDDEN).build();
        }

        Environment entity = inventory.tenants().get(tenantId).environments().create(environmentBlueprint).entity();
        return ResponseUtil.created(entity, uriInfo, environmentBlueprint.getId()).build();
    }

    @PUT
    @Path("/environments/{environmentId}")
    @ApiOperation("Updates properties of the environment")
    @ApiResponses({
            @ApiResponse(code = 204, message = "The properties of the environment successfully updated"),
            @ApiResponse(code = 400, message = "Properties invalid", response = ApiError.class),
            @ApiResponse(code = 401, message = "Unauthorized access"),
            @ApiResponse(code = 404, message = "Tenant or environment not found", response = ApiError.class),
            @ApiResponse(code = 500, message = "Server error", response = ApiError.class)
    })
    public Response update(@PathParam("environmentId") String environmentId,
            @ApiParam(required = true) Environment.Update update) throws Exception {

        String tenantId = getTenantId();

        if (!security.canUpdate(CanonicalPath.of().tenant(tenantId).environment(environmentId).get())) {
            return Response.status(FORBIDDEN).build();
        }

        inventory.tenants().get(tenantId).environments().update(environmentId, update);
        return Response.noContent().build();
    }

    @DELETE
    @Path("/environments/{environmentId}")
    @ApiOperation("Deletes the environment from the tenant")
    @ApiResponses({
        @ApiResponse(code = 204, message = "Environment successfully deleted"),
        @ApiResponse(code = 400, message = "Delete failed because it would leave inventory in invalid state",
                response = ApiError.class),
            @ApiResponse(code = 401, message = "Unauthorized access"),
        @ApiResponse(code = 404, message = "Tenant or environment not found", response = ApiError.class),
        @ApiResponse(code = 500, message = "Server error", response = ApiError.class)
    })
    public Response delete(@PathParam("environmentId") String environmentId) throws Exception {

        String tenantId = getTenantId();

        if (!security.canDelete(CanonicalPath.of().tenant(tenantId).environment(environmentId).get())) {
            return Response.status(FORBIDDEN).build();
        }

        inventory.tenants().get(tenantId).environments().delete(environmentId);
        return Response.noContent().build();
    }
}