Class QuartzEndpointWebExtension

java.lang.Object

org.springframework.boot.quartz.actuate.endpoint.QuartzEndpointWebExtension

@EndpointWebExtension(endpoint=QuartzEndpoint.class)
@ImportRuntimeHints(org.springframework.boot.quartz.actuate.endpoint.QuartzEndpointWebExtension.QuartzEndpointWebExtensionRuntimeHints.class)
public class QuartzEndpointWebExtension
extends Object

@EndpointWebExtension for the QuartzEndpoint.

Since:

4.0.0

Author:

Stephane Nicoll

Constructor Summary

Constructors

Constructor	Description
QuartzEndpointWebExtension(QuartzEndpoint delegate, Show showValues, Set<String> roles)

Method Summary

Modifier and Type	Method	Description
WebEndpointResponse<Object>	quartzJobOrTrigger(SecurityContext securityContext, String jobsOrTriggers, String group, String name)
WebEndpointResponse<Object>	quartzJobOrTriggerGroup(String jobsOrTriggers, String group)
WebEndpointResponse<QuartzEndpoint.QuartzGroupsDescriptor>	quartzJobOrTriggerGroups(String jobsOrTriggers)
WebEndpointResponse<Object>	triggerQuartzJob(String jobs, String group, String name, String state)	Trigger a Quartz job.

Methods inherited from class Object

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

Constructor Details

QuartzEndpointWebExtension

public QuartzEndpointWebExtension(QuartzEndpoint delegate,
 Show showValues,
 Set<String> roles)

Method Details

quartzJobOrTriggerGroups

@ReadOperation
public WebEndpointResponse<QuartzEndpoint.QuartzGroupsDescriptor> quartzJobOrTriggerGroups(@Selector
 String jobsOrTriggers)
                                                                                    throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

quartzJobOrTriggerGroup

@ReadOperation
public WebEndpointResponse<Object> quartzJobOrTriggerGroup(@Selector
 String jobsOrTriggers,
 @Selector
 String group)
                                                    throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

quartzJobOrTrigger

@ReadOperation
public WebEndpointResponse<Object> quartzJobOrTrigger(SecurityContext securityContext,
 @Selector
 String jobsOrTriggers,
 @Selector
 String group,
 @Selector
 String name)
                                               throws org.quartz.SchedulerException

Throws:

org.quartz.SchedulerException

triggerQuartzJob

@WriteOperation
public WebEndpointResponse<Object> triggerQuartzJob(@Selector
 String jobs,
 @Selector
 String group,
 @Selector
 String name,
 String state)
                                             throws org.quartz.SchedulerException

Trigger a Quartz job.

Parameters:

jobs - path segment "jobs"

group - job's group

name - job name

state - desired state

Returns:

web endpoint response

Throws:

org.quartz.SchedulerException - if there is an error triggering the job