/*
* Copyright © 2014 Cask Data, 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 co.cask.cdap.client;
import co.cask.cdap.client.config.ClientConfig;
import co.cask.cdap.client.exception.BadRequestException;
import co.cask.cdap.client.exception.NotFoundException;
import co.cask.cdap.client.exception.UnAuthorizedAccessTokenException;
import co.cask.cdap.client.util.RESTClient;
import co.cask.cdap.common.http.HttpMethod;
import co.cask.cdap.common.http.HttpRequest;
import co.cask.cdap.common.http.HttpResponse;
import co.cask.cdap.common.http.ObjectResponse;
import co.cask.cdap.proto.ProgramRecord;
import com.google.common.base.Charsets;
import com.google.common.reflect.TypeToken;
import com.google.gson.Gson;
import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URL;
import java.util.List;
import java.util.Map;
import javax.inject.Inject;
/**
* Provides ways to interact with CDAP Procedures.
*/
public class ProcedureClient {
private static final Gson GSON = new Gson();
private final RESTClient restClient;
private final ClientConfig config;
@Inject
public ProcedureClient(ClientConfig config) {
this.config = config;
this.restClient = RESTClient.create(config);
}
/**
* Calls a procedure's method.
*
* @param appId ID of the application that the procedure belongs to
* @param procedureId ID of the procedure
* @param methodId ID of the method belonging to the procedure
* @param parameters parameters to pass with the procedure call
* @return result of the procedure call
* @throws BadRequestException if the input was bad
* @throws NotFoundException if the application, procedure, or method could not be found
* @throws IOException if a network error occurred
* @throws UnAuthorizedAccessTokenException if the request is not authorized successfully in the gateway server
*/
public String call(String appId, String procedureId, String methodId, Map<String, String> parameters)
throws BadRequestException, NotFoundException, IOException, UnAuthorizedAccessTokenException {
URL url = config.resolveURL(String.format("apps/%s/procedures/%s/methods/%s", appId, procedureId, methodId));
HttpRequest request = HttpRequest.post(url).withBody(GSON.toJson(parameters)).build();
HttpResponse response = restClient.execute(request, config.getAccessToken(),
HttpURLConnection.HTTP_BAD_REQUEST,
HttpURLConnection.HTTP_NOT_FOUND);
if (response.getResponseCode() == HttpURLConnection.HTTP_BAD_REQUEST) {
throw new BadRequestException("The Application, Procedure and method exist, " +
"but the arguments are not as expected: " + GSON.toJson(parameters));
} else if (response.getResponseCode() == HttpURLConnection.HTTP_NOT_FOUND) {
throw new NotFoundException("application or procedure or method", appId + "/" + procedureId + "/" + methodId);
}
return new String(response.getResponseBody(), Charsets.UTF_8);
}
/**
* Lists all procedures.
*
* @return list of {@link ProgramRecord}s.
* @throws IOException if a network error occurred
* @throws UnAuthorizedAccessTokenException if the request is not authorized successfully in the gateway server
*/
public List<ProgramRecord> list() throws IOException, UnAuthorizedAccessTokenException {
URL url = config.resolveURL("procedures");
HttpResponse response = restClient.execute(HttpMethod.GET, url, config.getAccessToken());
return ObjectResponse.fromJsonBody(response, new TypeToken<List<ProgramRecord>>() { }).getResponseObject();
}
}