Package com.broadleafcommerce.scheduledjob.web.endpoint

Class ScheduledJobEndpoint

java.lang.Object

com.broadleafcommerce.scheduledjob.web.endpoint.ScheduledJobEndpoint

@FrameworkRestController
@FrameworkMapping("/scheduled-jobs")
@DataRouteByExample(ScheduledJob.class)
public class ScheduledJobEndpoint
extends Object

Author:

Chad Harchar (charchar)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
protected final ScheduledJobExecutionDetailService<ScheduledJobExecutionDetail>	jobExecutionDetailService
protected final ScheduledJobService<ScheduledJob>	service

Constructor Summary

Constructors

Constructor	Description
ScheduledJobEndpoint(ScheduledJobService<ScheduledJob> service, ScheduledJobExecutionDetailService<ScheduledJobExecutionDetail> jobExecutionDetailService)

Method Summary

Modifier and Type	Method	Description
ScheduledJob	createScheduledJob(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, ScheduledJob req)
void	deleteScheduledJob(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
ScheduledJob	executeScheduledJob(jakarta.servlet.http.HttpServletRequest request, String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<ScheduledJobExecutionDetail>	readAllScheduledJobExecutionDetailsByJobId(jakarta.servlet.http.HttpServletRequest request, String scheduledJobId, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<ScheduledJob>	readAllScheduledJobs(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
ScheduledJob	readScheduledJobById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String scheduledJobId)
ScheduledJobExecutionDetail	readScheduledJobExecutionDetail(jakarta.servlet.http.HttpServletRequest request, String scheduledJobExecutionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
ScheduledJob	replaceScheduledJob(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, ScheduledJob req)
ScheduledJob	updateScheduledJob(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, ScheduledJob req)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

service

protected final ScheduledJobService<ScheduledJob> service

jobExecutionDetailService

protected final ScheduledJobExecutionDetailService<ScheduledJobExecutionDetail> jobExecutionDetailService

Constructor Details

ScheduledJobEndpoint

public ScheduledJobEndpoint(ScheduledJobService<ScheduledJob> service,
 ScheduledJobExecutionDetailService<ScheduledJobExecutionDetail> jobExecutionDetailService)

Method Details

readAllScheduledJobs

@FrameworkGetMapping
@Policy(permissionRoots="SCHEDULED_JOB")
public org.springframework.data.domain.Page<ScheduledJob> readAllScheduledJobs(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(value="q",required=false)
 String query,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

readScheduledJobById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="SCHEDULED_JOB")
public ScheduledJob readScheduledJobById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String scheduledJobId)

updateScheduledJob

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="SCHEDULED_JOB")
public ScheduledJob updateScheduledJob(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @RequestBody
 ScheduledJob req)

replaceScheduledJob

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="SCHEDULED_JOB")
public ScheduledJob replaceScheduledJob(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @RequestBody
 ScheduledJob req)

createScheduledJob

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="SCHEDULED_JOB")
public ScheduledJob createScheduledJob(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 ScheduledJob req)

deleteScheduledJob

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="SCHEDULED_JOB")
public void deleteScheduledJob(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

executeScheduledJob

@FrameworkPostMapping("/{id}/execute")
@Policy(permissionRoots="SCHEDULED_JOB")
public ScheduledJob executeScheduledJob(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable("id")
 String id,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readAllScheduledJobExecutionDetailsByJobId

@FrameworkGetMapping("/{id}/execution-details")
@Policy(permissionRoots="SCHEDULED_JOB")
public org.springframework.data.domain.Page<ScheduledJobExecutionDetail> readAllScheduledJobExecutionDetailsByJobId(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable("id")
 String scheduledJobId,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readScheduledJobExecutionDetail

@FrameworkGetMapping("/{id}/execution-details/{detailId}")
@Policy(permissionRoots="SCHEDULED_JOB")
public ScheduledJobExecutionDetail readScheduledJobExecutionDetail(jakarta.servlet.http.HttpServletRequest request,
 @PathVariable("detailId")
 String scheduledJobExecutionId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)