/**
* 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.falcon.resource;
import org.apache.falcon.FalconWebException;
import org.apache.falcon.LifeCycle;
import org.apache.falcon.monitors.Dimension;
import org.apache.falcon.monitors.Monitored;
import javax.servlet.http.HttpServletRequest;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
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.Context;
import javax.ws.rs.core.MediaType;
import java.util.List;
/**
* This class provides RESTful API for the lifecycle management of the entity instances.
*/
@Path("instance")
public class InstanceManager extends AbstractInstanceManager {
//SUSPEND CHECKSTYLE CHECK ParameterNumberCheck
@GET
@Path("running/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "running")
@Override
public InstancesResult getRunningInstances(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles,
@DefaultValue("") @QueryParam("filterBy") String filterBy,
@DefaultValue("") @QueryParam("orderBy") String orderBy,
@DefaultValue("") @QueryParam("sortOrder") String sortOrder,
@DefaultValue("0") @QueryParam("offset") Integer offset,
@QueryParam("numResults") Integer resultsPerPage) {
try {
resultsPerPage = resultsPerPage == null ? getDefaultResultsPerPage() : resultsPerPage;
return super.getRunningInstances(type, entity, colo, lifeCycles, filterBy,
orderBy, sortOrder, offset, resultsPerPage);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
/*
getStatus(...) method actually gets all instances, filtered by a specific status. This is
a better named API which achieves the same result
*/
@GET
@Path("list/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-list")
@Override
public InstancesResult getInstances(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles,
@DefaultValue("") @QueryParam("filterBy") String filterBy,
@DefaultValue("") @QueryParam("orderBy") String orderBy,
@DefaultValue("") @QueryParam("sortOrder") String sortOrder,
@DefaultValue("0") @QueryParam("offset") Integer offset,
@QueryParam("numResults") Integer resultsPerPage,
@Dimension("allAttempts") @QueryParam("allAttempts") Boolean allAttempts) {
try {
resultsPerPage = resultsPerPage == null ? getDefaultResultsPerPage() : resultsPerPage;
return super.getInstances(type, entity, startStr, endStr, colo, lifeCycles,
filterBy, orderBy, sortOrder, offset, resultsPerPage, allAttempts);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("status/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-status")
@Override
public InstancesResult getStatus(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles,
@DefaultValue("") @QueryParam("filterBy") String filterBy,
@DefaultValue("") @QueryParam("orderBy") String orderBy,
@DefaultValue("") @QueryParam("sortOrder") String sortOrder,
@DefaultValue("0") @QueryParam("offset") Integer offset,
@QueryParam("numResults") Integer resultsPerPage,
@Dimension("allAttempts") @QueryParam("allAttempts") Boolean allAttempts) {
try {
resultsPerPage = resultsPerPage == null ? getDefaultResultsPerPage() : resultsPerPage;
return super.getStatus(type, entity, startStr, endStr, colo, lifeCycles,
filterBy, orderBy, sortOrder, offset, resultsPerPage, allAttempts);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("summary/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-summary")
public InstancesSummaryResult getSummary(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles,
@DefaultValue("") @QueryParam("filterBy") String filterBy,
@DefaultValue("") @QueryParam("orderBy") String orderBy,
@DefaultValue("") @QueryParam("sortOrder") String sortOrder) {
try {
return super.getSummary(type, entity, startStr, endStr, colo, lifeCycles,
filterBy, orderBy, sortOrder);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("listing/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-listing")
@Override
public FeedInstanceResult getListing(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String start,
@Dimension("end-time") @QueryParam("end") String end,
@Dimension("colo") @QueryParam("colo") String colo) {
try {
return super.getListing(type, entity, start, end, colo);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("logs/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-logs")
@Override
public InstancesResult getLogs(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("run-id") @QueryParam("runid") String runId,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles,
@DefaultValue("") @QueryParam("filterBy") String filterBy,
@DefaultValue("") @QueryParam("orderBy") String orderBy,
@DefaultValue("") @QueryParam("sortOrder") String sortOrder,
@DefaultValue("0") @QueryParam("offset") Integer offset,
@QueryParam("numResults") Integer resultsPerPage) {
try {
resultsPerPage = resultsPerPage == null ? getDefaultResultsPerPage() : resultsPerPage;
return super.getLogs(type, entity, startStr, endStr, colo, runId, lifeCycles,
filterBy, orderBy, sortOrder, offset, resultsPerPage);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("params/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-params")
@Override
public InstancesResult getInstanceParams(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String start,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles) {
try {
return super.getInstanceParams(type, entity, start, colo, lifeCycles);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@POST
@Path("kill/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "kill-instance")
@Override
public InstancesResult killInstance(
@Context HttpServletRequest request,
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles) {
try {
return super.killInstance(request, type, entity, startStr, endStr, colo, lifeCycles);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@POST
@Path("suspend/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "suspend-instance")
@Override
public InstancesResult suspendInstance(
@Context HttpServletRequest request,
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles) {
try {
return super.suspendInstance(request, type, entity, startStr, endStr, colo, lifeCycles);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@POST
@Path("resume/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "resume-instance")
@Override
public InstancesResult resumeInstance(
@Context HttpServletRequest request,
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles) {
try {
return super.resumeInstance(request, type, entity, startStr, endStr, colo, lifeCycles);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("triage/{type}/{name}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "triage-instance")
@Override
public TriageResult triageInstance(
@Dimension("type") @PathParam("type") String entityType,
@Dimension("name") @PathParam("name") String entityName,
@Dimension("instanceTime") @QueryParam("start") String instanceTime,
@Dimension("colo") @QueryParam("colo") String colo) {
try {
return super.triageInstance(entityType, entityName, instanceTime, colo);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@POST
@Path("rerun/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "re-run-instance")
@Override
public InstancesResult reRunInstance(
@Dimension("type") @PathParam("type") String type,
@Dimension("entity") @PathParam("entity") String entity,
@Dimension("start-time") @QueryParam("start") String startStr,
@Dimension("end-time") @QueryParam("end") String endStr,
@Context HttpServletRequest request,
@Dimension("colo") @QueryParam("colo") String colo,
@Dimension("lifecycle") @QueryParam("lifecycle") List<LifeCycle> lifeCycles,
@Dimension("force") @QueryParam("force") Boolean isForced) {
try {
return super.reRunInstance(type, entity, startStr, endStr, request, colo, lifeCycles, isForced);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
@GET
@Path("search")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-search")
@Override
public InstancesResult searchInstances(
@DefaultValue("") @QueryParam("type") String type,
@DefaultValue("") @QueryParam("nameseq") String nameSubsequence,
@DefaultValue("") @QueryParam("tagkeys") String tagKeywords,
@DefaultValue("") @QueryParam("start") String nominalStartTime,
@DefaultValue("") @QueryParam("end") String nominalEndTime,
@DefaultValue("") @QueryParam("instanceStatus") String status,
@DefaultValue("") @QueryParam("orderBy") String orderBy,
@DefaultValue("0") @QueryParam("offset") Integer offset,
@QueryParam("numResults") Integer resultsPerPage) {
return super.searchInstances(type, nameSubsequence, tagKeywords, nominalStartTime, nominalEndTime,
status, orderBy, offset, resultsPerPage);
}
//RESUME CHECKSTYLE CHECK ParameterNumberCheck
@GET
@Path("dependencies/{type}/{entity}")
@Produces(MediaType.APPLICATION_JSON)
@Monitored(event = "instance-dependency")
public InstanceDependencyResult instanceDependencies(
@Dimension("type") @PathParam("type") String entityType,
@Dimension("entityName") @PathParam("entity") String entityName,
@Dimension("instanceTime") @QueryParam("instanceTime") String instanceTimeStr,
@Dimension("colo") @QueryParam("colo") String colo) {
try {
return super.getInstanceDependencies(entityType, entityName, instanceTimeStr, colo);
} catch (Throwable throwable) {
throw FalconWebException.newAPIException(throwable);
}
}
}