Package org.apache.fineract.infrastructure.jobs.api

Class SchedulerJobApiResource

java.lang.Object

org.apache.fineract.infrastructure.jobs.api.SchedulerJobApiResource

@Path("/v1/jobs")
@Consumes("application/json")
@Produces("application/json")
@Component
public class SchedulerJobApiResource
extends Object

Constructor Summary

Constructors

Constructor	Description
SchedulerJobApiResource()

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	executeJob(Long jobId, String commandParam, String jsonRequestBody)
jakarta.ws.rs.core.Response	executeJobByShortName(String shortName, String commandParam, String jsonRequestBody)
String	retrieveAll(jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveByShortName(String shortName, jakarta.ws.rs.core.UriInfo uriInfo)
String	retrieveHistory(jakarta.ws.rs.core.UriInfo uriInfo, Long jobId, Integer offset, Integer limit, String orderBy, String sortOrder)
String	retrieveHistoryByShortName(jakarta.ws.rs.core.UriInfo uriInfo, String shortName, Integer offset, Integer limit, String orderBy, String sortOrder)
String	retrieveOne(Long jobId, jakarta.ws.rs.core.UriInfo uriInfo)
String	updateJobDetail(Long jobId, String jsonRequestBody)
String	updateJobDetailByShortName(String shortName, String jsonRequestBody)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SchedulerJobApiResource

public SchedulerJobApiResource()

Method Details

retrieveAll

@GET
public String retrieveAll(@Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveOne

@GET
@Path("{jobId}")
public String retrieveOne(@PathParam("jobId")
 Long jobId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveByShortName

@GET
@Path("short-name/{shortName}")
public String retrieveByShortName(@PathParam("shortName")
 String shortName,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

retrieveHistory

@GET
@Path("{jobId}/runhistory")
public String retrieveHistory(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("jobId")
 Long jobId,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder)

retrieveHistoryByShortName

@GET
@Path("short-name/{shortName}/runhistory")
public String retrieveHistoryByShortName(@Context
 jakarta.ws.rs.core.UriInfo uriInfo,
 @PathParam("shortName")
 String shortName,
 @QueryParam("offset")
 Integer offset,
 @QueryParam("limit")
 Integer limit,
 @QueryParam("orderBy")
 String orderBy,
 @QueryParam("sortOrder")
 String sortOrder)

executeJob

@POST
@Path("{jobId}")
public jakarta.ws.rs.core.Response executeJob(@PathParam("jobId")
 Long jobId,
 @QueryParam("command")
 String commandParam,
 String jsonRequestBody)

executeJobByShortName

@POST
@Path("short-name/{shortName}")
public jakarta.ws.rs.core.Response executeJobByShortName(@PathParam("shortName")
 String shortName,
 @QueryParam("command")
 String commandParam,
 String jsonRequestBody)

updateJobDetail

@PUT
@Path("{jobId}")
public String updateJobDetail(@PathParam("jobId")
 Long jobId,
 String jsonRequestBody)

updateJobDetailByShortName

@PUT
@Path("short-name/{shortName}")
public String updateJobDetailByShortName(@PathParam("shortName")
 String shortName,
 String jsonRequestBody)