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 String	BASE_URI
protected ScheduledJobService<ScheduledJob>	service

Constructor Summary

Constructors

Constructor	Description
ScheduledJobEndpoint(ScheduledJobService<ScheduledJob> service)

Method Summary

Modifier and Type	Method	Description
ScheduledJob	createScheduledJob(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, ScheduledJob req)
void	deleteScheduledJob(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
ScheduledJob	executeScheduledJob(javax.servlet.http.HttpServletRequest request, String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
org.springframework.data.domain.Page<ScheduledJob>	readAllScheduledJobs(javax.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(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String scheduledJobId)
ScheduledJob	replaceScheduledJob(javax.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, ScheduledJob req)
ScheduledJob	updateScheduledJob(javax.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 Detail

BASE_URI

public static final String BASE_URI

See Also:

Constant Field Values

service

protected final ScheduledJobService<ScheduledJob> service

Constructor Detail

ScheduledJobEndpoint

public ScheduledJobEndpoint(ScheduledJobService<ScheduledJob> service)

Method Detail

readAllScheduledJobs

@FrameworkGetMapping
@Policy(permissionRoots="SCHEDULED_JOB")
public org.springframework.data.domain.Page<ScheduledJob> readAllScheduledJobs(javax.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(javax.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(javax.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(javax.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(javax.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(javax.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(javax.servlet.http.HttpServletRequest request,
                                        @PathVariable("id")
                                        String id,
                                        @ContextOperation(UPDATE)
                                        com.broadleafcommerce.data.tracking.core.context.ContextInfo context)