/*-
 * ============LICENSE_START=======================================================
 * SDC
 * ================================================================================
 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
 * ================================================================================
 * 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.
 * ============LICENSE_END=========================================================
 */

package org.openecomp.sdcrests.vsp.rest;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.*;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.validation.IsValidJson;
import org.springframework.validation.annotation.Validated;

import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import java.io.File;
import java.io.IOException;

import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;

@Path("/v1.0/vendor-software-products")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Api(value = "Vendor Software Products")
@Validated
public interface VendorSoftwareProducts extends VspEntities {

  @POST
  @Path("/")
  @ApiOperation(value = "Create a new vendor software product",
      response = VspCreationDto.class)
  Response createVsp(@Valid VspDescriptionDto vspDescriptionDto,
                     @NotNull(message = USER_MISSING_ERROR_MSG)
                     @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @GET
  @Path("/")
  @ApiOperation(value = "Get list of vendor software products and their description",
      responseContainer = "List")
  Response listVsps(@ApiParam(
      value = "Currently supported values: 'Final' - only vendor software products with final "
          + " version will be return - with their latest final version")
                    @QueryParam("versionFilter") String versionFilter,
                    @NotNull(message = USER_MISSING_ERROR_MSG)
                    @HeaderParam(USER_ID_HEADER_PARAM) String user);


  @GET
  @Path("/{vspId}/versions/{versionId}")
  @ApiOperation(value = "Get details of a vendor software product")
  Response getVsp(@PathParam("vspId") String vspId,
                  @PathParam("versionId") String versionId,
                  @NotNull(message = USER_MISSING_ERROR_MSG)
                  @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @PUT
  @Path("/{vspId}/versions/{versionId}")
  @ApiOperation(value = "Update an existing vendor software product")
  Response updateVsp(@PathParam("vspId") String vspId,
                     @PathParam("versionId") String versionId,
                     @Valid VspDescriptionDto vspDescriptionDto,
                     @NotNull(message = USER_MISSING_ERROR_MSG)
                     @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @DELETE
  @Path("/{vspId}")
  @ApiOperation(value = "Deletes vendor software product by given id")
  Response deleteVsp(@PathParam("vspId") String vspId,
                     @NotNull(message = USER_MISSING_ERROR_MSG)
                     @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @GET
  @Path("/packages")
  @ApiOperation(value = "Get list of translated CSAR files details",
      response = PackageInfoDto.class,
      responseContainer = "List")
  Response listPackages(@ApiParam("Category") @QueryParam("category") String category,
                        @ApiParam("Sub-category") @QueryParam("subCategory") String subCategory,
                        @NotNull(message = USER_MISSING_ERROR_MSG)
                        @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @GET
  @Path("/{vspId}/versions/{versionId}/orchestration-template")
  @Produces(MediaType.APPLICATION_OCTET_STREAM)
  @ApiOperation(value = "Get Orchestration Template (HEAT) file",
      notes = "Downloads the latest HEAT package",
      response = File.class)
  Response getOrchestrationTemplate(
      @PathParam("vspId") String vspId,
      @PathParam("versionId") String versionId,
      @HeaderParam(USER_ID_HEADER_PARAM) String user);


  @GET
  @Path("/validation-vsp")
  Response getValidationVsp(
      @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user)
      throws Exception;

  @PUT
  @Path("/{vspId}/versions/{versionId}/actions")
  @ApiOperation(value = "Actions on a vendor software product",
      notes = "Performs one of the following actions on a vendor software product: |"
          + "Checkout: Locks it for edits by other users. Only the locking user sees the edited "
          + "version.|"
          + "Undo_Checkout: Unlocks it and deletes the edits that were done.|"
          + "Checkin: Unlocks it and activates the edited version to all users.| "
          + "Submit: Finalize its active version.|"
          + "Create_Package: Creates a CSAR zip file.|")
  Response actOnVendorSoftwareProduct(@PathParam("vspId") String vspId,
                                      @PathParam("versionId") String versionId,
                                      VersionSoftwareProductActionRequestDto request,
                                      @NotNull(message = USER_MISSING_ERROR_MSG)
                                      @HeaderParam(USER_ID_HEADER_PARAM) String user)
      throws IOException;

  @GET
  @Path("/packages/{vspId}")
  @Produces(MediaType.APPLICATION_OCTET_STREAM)
  @ApiOperation(value = "Get translated CSAR file",
      notes = "Exports translated file to a zip file",
      response = File.class)
  Response getTranslatedFile(@PathParam("vspId") String vspId,
                             @QueryParam("versionId") String versionId,
                             @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @GET
  @Path("/{vspId}/versions/{versionId}/questionnaire")
  @ApiOperation(value = "Get vendor software product questionnaire",
      response = QuestionnaireResponseDto.class)
  Response getQuestionnaire(@PathParam("vspId") String vspId,
                            @PathParam("versionId") String versionId,
                            @NotNull(message = USER_MISSING_ERROR_MSG)
                            @HeaderParam(USER_ID_HEADER_PARAM) String user);

  @PUT
  @Path("/{vspId}/versions/{versionId}/questionnaire")
  @ApiOperation(value = "Update vendor software product questionnaire")
  Response updateQuestionnaire(@NotNull @IsValidJson String questionnaireData,
                               @PathParam("vspId") String vspId,
                               @PathParam("versionId") String versionId,
                               @NotNull(message = USER_MISSING_ERROR_MSG)
                               @HeaderParam(USER_ID_HEADER_PARAM) String user);


  @PUT
  @Path("/{vspId}/versions/{versionId}/heal")
  @ApiOperation(value = "Checkout and heal vendor software product questionnaire",
      response = QuestionnaireResponseDto.class)
  Response heal(@PathParam("vspId") String vspId,
                @PathParam("versionId") String versionId,
                @NotNull(message = USER_MISSING_ERROR_MSG)
                @HeaderParam(USER_ID_HEADER_PARAM) String user);


  @GET
  @Path("/{vspId}/versions/{versionId}/vspInformationArtifact")
  @Produces(MediaType.TEXT_PLAIN)
  @ApiOperation(value = "Get vendor software product information artifact for specified version",
      response = File.class)
  Response getVspInformationArtifact(@PathParam("vspId") String vspId,
                                     @PathParam("versionId") String versionId,
                                     @NotNull(message = USER_MISSING_ERROR_MSG)
                                     @HeaderParam(USER_ID_HEADER_PARAM) String user);

}