Package org.sterl.spring.persistent_tasks.trigger.api

Class TriggerResource

java.lang.Object

org.sterl.spring.persistent_tasks.trigger.api.TriggerResource

@RestController
@RequestMapping("${spring.persistent-tasks.web.base-path:spring-tasks-api}")
public class TriggerResource
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PATH_GROUPED

Constructor Summary

Constructors

Constructor	Description
TriggerResource()

Method Summary

Modifier and Type	Method	Description
Optional<Trigger>	cancelTrigger(String taskName, String id)
long	count()
org.springframework.data.web.PagedModel<Trigger>	list(TriggerSearch search, org.springframework.data.domain.Pageable pageable)
List<CronTriggerInfo>	listCronTriggerInfos()	Lists all registered cron triggers (scheduled triggers).
org.springframework.data.web.PagedModel<TriggerGroup>	listGrouped(TriggerSearch search, org.springframework.data.domain.Pageable pageable)
boolean	resumeCron(String taskName, String id)	Resumes a suspended cron trigger, allowing new trigger instances to be created.
Optional<Trigger>	setRunAt(String taskName, String id, OffsetDateTime runAt)
boolean	suspendCron(String taskName, String id)	Suspends a cron trigger, preventing new trigger instances from being created.

Methods inherited from class java.lang.Object

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

Field Details

PATH_GROUPED

public static final String PATH_GROUPED

See Also:

• Constant Field Values

Constructor Details

TriggerResource

public TriggerResource()

Method Details

count

@GetMapping("triggers/count")
public long count()

listGrouped

@GetMapping("triggers-grouped")
public org.springframework.data.web.PagedModel<TriggerGroup> listGrouped(TriggerSearch search,
 @PageableDefault(size=100)
 org.springframework.data.domain.Pageable pageable)

list

@GetMapping("triggers")
public org.springframework.data.web.PagedModel<Trigger> list(TriggerSearch search,
 @PageableDefault(size=100,direction=ASC,sort="data.runAt")
 org.springframework.data.domain.Pageable pageable)

setRunAt

@PostMapping("triggers/{taskName}/{id}/run-at")
public Optional<Trigger> setRunAt(@PathVariable("taskName")
 String taskName,
 @PathVariable("id")
 String id,
 @RequestBody
 OffsetDateTime runAt)

cancelTrigger

@DeleteMapping("triggers/{taskName}/{id}")
public Optional<Trigger> cancelTrigger(@PathVariable("taskName")
 String taskName,
 @PathVariable("id")
 String id)

listCronTriggerInfos

@GetMapping("cron-triggers")
public List<CronTriggerInfo> listCronTriggerInfos()

Lists all registered cron triggers (scheduled triggers).

Returns:

list of all cron trigger definitions

suspendCron

@DeleteMapping("cron-triggers/{taskName}/{id}")
public boolean suspendCron(@PathVariable("taskName")
 String taskName,
 @PathVariable("id")
 String id)

Suspends a cron trigger, preventing new trigger instances from being created.

Parameters:

id - the cron trigger ID to suspend

Returns:

true if found, otherweise false

resumeCron

@PostMapping("cron-triggers/{taskName}/{id}")
public boolean resumeCron(@PathVariable("taskName")
 String taskName,
 @PathVariable("id")
 String id)

Resumes a suspended cron trigger, allowing new trigger instances to be created.

Parameters:

id - the cron trigger ID to resume

Returns:

true if found, otherweise false