/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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 privileges and
 * limitations under the License.
 */

package org.apache.ambari.server.api.services;

import jakarta.ws.rs.DELETE;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.PUT;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.core.UriInfo;

import org.apache.ambari.annotations.ApiIgnore;
import org.apache.ambari.server.api.resources.ResourceInstance;

/**
 * Service responsible for privilege requests.
 */
public abstract class PrivilegeService extends BaseService {

  /**
   * Handles: GET /privileges/{privilegeID}
   * Get a specific privilege.
   *
   * @param headers        http headers
   * @param ui             uri info
   * @param privilegeId   privilege id
   *
   * @return privilege instance representation
   */
  @GET @ApiIgnore // until documented
  @Path("{privilegeId}")
  @Produces("text/plain")
  public Response getPrivilege(@Context HttpHeaders headers, @Context UriInfo ui,
                                @PathParam("privilegeId") String privilegeId) {

    return handleRequest(headers, null, ui, Request.Type.GET, createPrivilegeResource(privilegeId));
  }

  /**
   * Handles: GET  /privileges
   * Get all privileges.
   *
   * @param headers  http headers
   * @param ui       uri info
   *
   * @return privilege collection representation
   */
  @GET @ApiIgnore // until documented
  @Produces("text/plain")
  public Response getPrivileges(@Context HttpHeaders headers, @Context UriInfo ui) {
    return handleRequest(headers, null, ui, Request.Type.GET, createPrivilegeResource(null));
  }

  /**
   * Handles: POST /privileges
   * Create a privilege.
   *
   * @param body       request body
   * @param headers    http headers
   * @param ui         uri info
   *
   * @return information regarding the created privilege
   */
  @POST @ApiIgnore // until documented
  @Produces("text/plain")
  public Response createPrivilege(String body, @Context HttpHeaders headers, @Context UriInfo ui) {

    return handleRequest(headers, body, ui, Request.Type.POST, createPrivilegeResource(null));
  }

  /**
   * Handles: PUT /privileges/{privilegeID}
   * Update a specific privilege.
   *
   * @param headers   http headers
   * @param ui        uri info
   * @param privilegeId  privilege id
   *
   * @return information regarding the updated privilege
   */
  @PUT @ApiIgnore // until documented
  @Path("{privilegeId}")
  @Produces("text/plain")
  public Response updatePrivilege(String body, @Context HttpHeaders headers, @Context UriInfo ui,
                                   @PathParam("privilegeId") String privilegeId) {

    return handleRequest(headers, body, ui, Request.Type.PUT, createPrivilegeResource(privilegeId));
  }

  /**
   * Handles: PUT /privileges
   * Update a set of privileges for the resource.
   *
   * @param body      request body
   * @param headers   http headers
   * @param ui        uri info
   *
   * @return information regarding the updated privileges
   */
  @PUT @ApiIgnore // until documented
  @Produces("text/plain")
  public Response updatePrivileges(String body, @Context HttpHeaders headers, @Context UriInfo ui) {
    return handleRequest(headers, body, ui, Request.Type.PUT, createPrivilegeResource(null));
  }

  /**
   * Handles: DELETE /privileges
   * Delete privileges.
   *
   * @param body      request body
   * @param headers   http headers
   * @param ui        uri info
   *
   * @return information regarding the deleted privileges
   */
  @DELETE @ApiIgnore // until documented
  @Produces("text/plain")
  public Response deletePrivileges(String body, @Context HttpHeaders headers, @Context UriInfo ui) {

    return handleRequest(headers, body, ui, Request.Type.DELETE, createPrivilegeResource(null));
  }

  /**
   * Handles: DELETE /privileges/{privilegeID}
   * Delete a specific privilege.
   *
   * @param headers   http headers
   * @param ui        uri info
   * @param privilegeId  privilege id
   *
   * @return information regarding the deleted privilege
   */
  @DELETE @ApiIgnore // until documented
  @Path("{privilegeId}")
  @Produces("text/plain")
  public Response deletePrivilege(@Context HttpHeaders headers, @Context UriInfo ui,
                                  @PathParam("privilegeId") String privilegeId) {

    return handleRequest(headers, null, ui, Request.Type.DELETE, createPrivilegeResource(privilegeId));
  }

  // ----- PrivilegeService --------------------------------------------------

  /**
   * Create a privilege resource.
   *
   * @param privilegeId privilege name
   *
   * @return a privilege resource instance
   */
  protected abstract ResourceInstance createPrivilegeResource(String privilegeId);
}
