submarine-master/submarine-server/server-core/src/main/java/org/apache/submarine/server/rest/InternalServiceRestApi.java
/*
 * 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 permissions and limitations
 * under the License.
 */
package org.apache.submarine.server.rest;

import java.util.Map;

import javax.ws.rs.Consumes;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

import org.apache.submarine.commons.utils.exception.SubmarineRuntimeException;
import org.apache.submarine.server.api.common.CustomResourceType;
import org.apache.submarine.server.internal.InternalServiceManager;
import org.apache.submarine.server.utils.response.JsonResponse;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.google.common.annotations.VisibleForTesting;
import com.google.gson.Gson;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;

/**
 * Internal Service REST API v1, providing internal service to sync status of CR.
 * 
 */
@Path(RestConstants.V1 + "/" + RestConstants.INTERNAL)
@Produces("application/json")
public class InternalServiceRestApi {
    
  private static final Logger LOG = LoggerFactory.getLogger(InternalServiceRestApi.class);
  private InternalServiceManager internalServiceManager = InternalServiceManager.getInstance();
  
  @VisibleForTesting
  public void setInternalServiceManager(InternalServiceManager internalServiceManager) {
    this.internalServiceManager = internalServiceManager;
  }
  
  /**
   * Update status of custom resource
   * @param name Name of the environment
   * @param spec environment spec
   * @return the detailed info about updated environment
  */
  @POST
  @Path("/{customResourceType}/{resourceId}")
  @Consumes({RestConstants.MEDIA_TYPE_YAML, MediaType.APPLICATION_JSON})
  @Operation(summary = "Update the environment with job spec",
          tags = {"environments"},
          responses = {
                  @ApiResponse(description = "successful operation", 
                      content = @Content(
                          schema = @Schema(
                              implementation = String.class))),
                  @ApiResponse(
                      responseCode = "404", 
                      description = "resource not found")})
  public Response updateEnvironment(
      @PathParam(RestConstants.CUSTOM_RESOURCE_TYPE) String type,
      @PathParam(RestConstants.CUSTOM_RESOURCE_ID) String resourceId,
      Map<String, Object> updatedCustomObject) {
    try {
      LOG.info("In:" + new Gson().toJson(updatedCustomObject));
      internalServiceManager.updateCRStatus(CustomResourceType.valueOf(type)
              , resourceId, updatedCustomObject);
      return new JsonResponse.Builder<String>(Response.Status.OK)
        .success(true).build();
    } catch (SubmarineRuntimeException e) {
      return new JsonResponse.Builder<String>(e.getCode()).message(e.getMessage())
        .build();
    }
  }
}
