Package org.apache.syncope.common.rest.api.service

Interface ExecutableService

All Superinterfaces:

JAXRSService

All Known Subinterfaces:

ReportService, TaskService

All Known Implementing Classes:

AbstractExecutableService, ReportServiceImpl, TaskServiceImpl

public interface ExecutableService
extends JAXRSService

Field Summary

Fields inherited from interface org.apache.syncope.common.rest.api.service.JAXRSService

CRLF, DOUBLE_DASH, PARAM_ANYTYPE_KIND, PARAM_ANYTYPEKEY, PARAM_CONNID_PAGED_RESULTS_COOKIE, PARAM_DETAILS, PARAM_ENTITY_KEY, PARAM_FIQL, PARAM_KEYWORD, PARAM_MAX, PARAM_NOTIFICATION, PARAM_ORDERBY, PARAM_PAGE, PARAM_REALM, PARAM_RECURSIVE, PARAM_RESOURCE, PARAM_SIZE, PARAM_USER

Method Summary

Modifier and Type	Method	Description
void	actionJob(@NotNull String key, JobAction action)	Executes an action on an existing executable's job.
void	deleteExecution(@NotNull String executionKey)	Deletes the executable execution matching the provided key.
Response	deleteExecutions(ExecQuery query)	Deletes the executions matching the given query.
ExecTO	execute(ExecSpecs specs)	Executes the executable matching the given specs.
JobTO	getJob(String key)	Returns job (running or scheduled) for the executable matching the given key.
PagedResult<ExecTO>	listExecutions(ExecQuery query)	Returns a paged list of executions matching the given query.
List<JobTO>	listJobs()	List jobs (running and / or scheduled).
List<ExecTO>	listRecentExecutions(@jakarta.validation.constraints.Min(1L) int max)	Returns the list of recently completed executions, ordered by end date descendent.

Method Details

listExecutions

@GET
@Path("{key}/executions")
@Produces({"application/json","application/yaml","application/xml"})
PagedResult<ExecTO> listExecutions(@BeanParam
 ExecQuery query)

Returns a paged list of executions matching the given query.

Parameters:

query - query conditions

Returns:

paged list of executions the given query

listRecentExecutions

@GET
@Path("executions/recent")
@Produces({"application/json","application/yaml","application/xml"})
List<ExecTO> listRecentExecutions(@Min(1L) @QueryParam("max") @DefaultValue("25")
 @jakarta.validation.constraints.Min(1L) int max)

Returns the list of recently completed executions, ordered by end date descendent.

Parameters:

max - the maximum number of executions to return

Returns:

list of recently completed executions, ordered by end date descendent

deleteExecution

@DELETE
@Path("executions/{executionKey}")
@Produces({"application/json","application/yaml","application/xml"})
void deleteExecution(@NotNull @PathParam("executionKey")
 @NotNull String executionKey)

Deletes the executable execution matching the provided key.

Parameters:

executionKey - key of executable execution to be deleted

deleteExecutions

@DELETE
@Path("{key}/executions")
@Produces("multipart/mixed")
Response deleteExecutions(@BeanParam
 ExecQuery query)

Deletes the executions matching the given query.

Parameters:

query - query conditions

Returns:

batch results as Response entity

execute

@POST
@Path("{key}/execute")
@Produces({"application/json","application/yaml","application/xml"})
ExecTO execute(@BeanParam
 ExecSpecs specs)

Executes the executable matching the given specs.

Parameters:

specs - conditions to exec

Returns:

execution report for the executable matching the given specs

getJob

@GET
@Path("jobs/{key}")
@Produces({"application/json","application/yaml","application/xml"})
JobTO getJob(@PathParam("key")
 String key)

Returns job (running or scheduled) for the executable matching the given key.

Parameters:

key - executable key

Returns:

job (running or scheduled) for the given key

listJobs

@GET
@Path("jobs")
@Produces({"application/json","application/yaml","application/xml"})
List<JobTO> listJobs()

List jobs (running and / or scheduled).

Returns:

jobs (running and / or scheduled)

actionJob

@POST
@Path("jobs/{key}")
void actionJob(@NotNull @PathParam("key")
 @NotNull String key,
 @QueryParam("action")
 JobAction action)

Executes an action on an existing executable's job.

Parameters:

key - executable key

action - action to execute