keywhiz.service.resources.automation.AutomationClientResource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of keywhiz-server Show documentation
There is a newer version: 0.10.1
/*
 * Copyright (C) 2015 Square, Inc.
 *
 * 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 keywhiz.service.resources.automation;

import com.google.common.annotations.VisibleForTesting;
import com.google.common.collect.ImmutableList;
import io.dropwizard.auth.Auth;
import io.dropwizard.jersey.params.LongParam;
import java.util.List;
import java.util.Optional;
import javax.inject.Inject;
import javax.validation.Valid;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.NotFoundException;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Response;
import keywhiz.api.ClientDetailResponse;
import keywhiz.api.CreateClientRequest;
import keywhiz.api.model.AutomationClient;
import keywhiz.api.model.Client;
import keywhiz.api.model.Group;
import keywhiz.service.daos.AclDAO;
import keywhiz.service.daos.AclDAO.AclDAOFactory;
import keywhiz.service.daos.ClientDAO;
import keywhiz.service.daos.ClientDAO.ClientDAOFactory;
import keywhiz.service.exceptions.ConflictException;
import keywhiz.service.resources.admin.ClientsResource;
import keywhiz.service.resources.automation.v2.ClientResource;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import static java.util.stream.Collectors.toList;
import static javax.ws.rs.core.MediaType.APPLICATION_JSON;

/**
 * @parentEndpointName clients-automation
 * @resourceDescription Create and retrieve clients
 * @deprecated Will be removed in a future release. Migrate to {@link ClientResource}.
 */
@Deprecated
@Path("/automation/clients")
@Produces(APPLICATION_JSON)
public class AutomationClientResource {
  private static final Logger logger = LoggerFactory.getLogger(ClientsResource.class);

  private final ClientDAO clientDAO;
  private final AclDAO aclDAO;


  @Inject public AutomationClientResource(ClientDAOFactory clientDAOFactory, AclDAOFactory aclDAOFactory) {
    this.clientDAO = clientDAOFactory.readwrite();
    this.aclDAO = aclDAOFactory.readwrite();
  }

  @VisibleForTesting AutomationClientResource(ClientDAO clientDAO, AclDAO aclDAO) {
    this.clientDAO = clientDAO;
    this.aclDAO = aclDAO;
  }

  /**
   * Retrieve Client by ID
   *
   * @excludeParams automationClient
   * @param clientId the ID of the Client to retrieve
   *
   * @description Returns a single Client if found
   * @responseMessage 200 Found and retrieved Client with given ID
   * @responseMessage 404 Client with given ID not Found
   */
  @GET
  @Path("{clientId}")
  public Response findClientById(
      @Auth AutomationClient automationClient,
      @PathParam("clientId") LongParam clientId) {
    logger.info("Automation ({}) - Looking up an ID {}", automationClient.getName(), clientId);

    Client client = clientDAO.getClientById(clientId.get())
        .orElseThrow(NotFoundException::new);
    ImmutableList groups = ImmutableList.copyOf(aclDAO.getGroupsFor(client));

    return Response.ok()
        .entity(ClientDetailResponse.fromClient(client, groups, ImmutableList.of()))
        .build();
  }

  /**
   * Retrieve Client by a specified name, or all Clients if no name given
   *
   * @excludeParams automationClient
   * @optionalParams name
   * @param name the name of the Client to retrieve, if provided
   *
   * @description Returns a single Client or a set of all Clients
   * @responseMessage 200 Found and retrieved Client(s)
   * @responseMessage 404 Client with given name not found (if name provided)
   */
  @GET
  public Response findClient(
      @Auth AutomationClient automationClient,
      @QueryParam("name") Optional name) {
    logger.info("Automation ({}) - Looking up a name {}", automationClient.getName(), name);

    if (name.isPresent()) {
      Client client = clientDAO.getClient(name.get()).orElseThrow(NotFoundException::new);
      ImmutableList groups = ImmutableList.copyOf(aclDAO.getGroupsFor(client));
      return Response.ok()
          .entity(ClientDetailResponse.fromClient(client, groups, ImmutableList.of()))
          .build();
    }

    List clients = clientDAO.getClients().stream()
        .map(c -> ClientDetailResponse.fromClient(c, ImmutableList.copyOf(aclDAO.getGroupsFor(c)),
            ImmutableList.of()))
        .collect(toList());
    return Response.ok().entity(clients).build();
  }

  /**
   * Create Client
   *
   * @excludeParams automationClient
   * @param clientRequest the JSON client request used to formulate the Client
   *
   * @description Creates a Client with the name from a valid client request
   * @responseMessage 200 Successfully created Client
   * @responseMessage 409 Client with given name already exists
   */
  @POST
  @Consumes(APPLICATION_JSON)
  public ClientDetailResponse createClient(
      @Auth AutomationClient automationClient,
      @Valid CreateClientRequest clientRequest) {

    Optional client = clientDAO.getClient(clientRequest.name);
    if (client.isPresent()) {
      logger.info("Automation ({}) - Client {} already exists", automationClient.getName(), clientRequest.name);
      throw new ConflictException("Client name already exists.");
    }

    long id = clientDAO.createClient(clientRequest.name, automationClient.getName(), "");
    client = clientDAO.getClientById(id);

    return ClientDetailResponse.fromClient(client.get(), ImmutableList.of(), ImmutableList.of());
  }

  /**
   * Deletes a client
   *
   * @excludeParams automationClient
   * @param clientId the ID of the client to delete
   *
   * @description Deletes a single client by id
   * @responseMessage 200 Deleted client
   * @responseMessage 404 Client not found by id
   */
  @DELETE
  @Path("{clientId}")
  public Response deleteClient(@Auth AutomationClient automationClient,
      @PathParam("clientId") LongParam clientId) {
    Client client = clientDAO.getClientById(clientId.get()).orElseThrow(NotFoundException::new);
    clientDAO.deleteClient(client);
    return Response.ok().build();
  }
}