org.finra.herd.service.impl

Class JobServiceImpl

java.lang.Object

org.finra.herd.service.impl.JobServiceImpl

All Implemented Interfaces:

JobService

@Service
 @Transactional(value="herdTransactionManager")
public class JobServiceImpl
extends Object
implements JobService

The job service implementation.

Constructor Summary

Constructors

Constructor and Description
JobServiceImpl()

Method Summary

Modifier and Type	Method and Description
Job	createAndStartJob(JobCreateRequest request) Creates and starts a new job asynchronously.
Job	deleteJob(String jobId, JobDeleteRequest jobDeleteRequest) Deletes a currently running job and preserves the job state in history.
Job	getJob(String jobId, boolean verbose) Gets the details of a previously submitted job.
JobSummaries	getJobs(String namespace, String jobName, JobStatusEnum jobStatus, org.joda.time.DateTime startTime, org.joda.time.DateTime endTime) Gets a list of job executions based on the specified filter parameters.
JobSummaries	getRunningJobsByStartBeforeTime(org.joda.time.DateTime startBeforeTime) Gets a list of running job executions based on the start before time filter.
Job	signalJob(JobSignalRequest request) Signals the job with the receive task.
Job	updateJob(String jobId, JobUpdateRequest jobUpdateRequest) Activates or suspends a job execution.

Methods inherited from class java.lang.Object

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

Constructor Detail

JobServiceImpl

public JobServiceImpl()

Method Detail

createAndStartJob

@NamespacePermission(fields="#request?.namespace",
                     permissions=EXECUTE)
public Job createAndStartJob(JobCreateRequest request)
                                                                                                                   throws Exception

Description copied from interface: JobService

Creates and starts a new job asynchronously.

Specified by:

createAndStartJob in interface JobService

Parameters:

request - the information needed to create the job

Returns:

the created job information

Throws:

Exception - if any problems were encountered

deleteJob

public Job deleteJob(String jobId,
                     JobDeleteRequest jobDeleteRequest)
              throws Exception

Description copied from interface: JobService

Deletes a currently running job and preserves the job state in history. The method calls org.activiti.engine.RuntimeService.deleteProcessInstance(String, String) on the specified jobId.

Specified by:

deleteJob in interface JobService

Parameters:

jobId - the job id

jobDeleteRequest - the delete request

Returns:

the job that has been deleted

Throws:

Exception - if any problems were encountered

getJob

public Job getJob(String jobId,
                  boolean verbose)
           throws Exception

Description copied from interface: JobService

Gets the details of a previously submitted job.

Specified by:

getJob in interface JobService

Parameters:

jobId - the job id

Returns:

the job information

Throws:

Exception - if any problems were encountered

getJobs

public JobSummaries getJobs(String namespace,
                            String jobName,
                            JobStatusEnum jobStatus,
                            org.joda.time.DateTime startTime,
                            org.joda.time.DateTime endTime)
                     throws Exception

Description copied from interface: JobService

Gets a list of job executions based on the specified filter parameters.

Jobs' namespace to which you do not have READ permissions to will be omitted from the result.

Specified by:

getJobs in interface JobService

Parameters:

namespace - an optional namespace filter

jobName - an optional job name filter

jobStatus - an optional job status filter

startTime - an optional job start time filter

endTime - an optional job end time filter

Returns:

the list of job summaries

Throws:

Exception - if any problems were encountered

getRunningJobsByStartBeforeTime

public JobSummaries getRunningJobsByStartBeforeTime(org.joda.time.DateTime startBeforeTime)
                                             throws Exception

Description copied from interface: JobService

Gets a list of running job executions based on the start before time filter.

Specified by:

getRunningJobsByStartBeforeTime in interface JobService

Parameters:

startBeforeTime - the job start before time filter

Returns:

the list of job summaries

Throws:

Exception - if any problems were encountered

signalJob

public Job signalJob(JobSignalRequest request)
              throws Exception

Description copied from interface: JobService

Signals the job with the receive task.

Specified by:

signalJob in interface JobService

Parameters:

request - the information needed to signal the job

Returns:

the created job information

Throws:

Exception

updateJob

public Job updateJob(String jobId,
                     JobUpdateRequest jobUpdateRequest)

Description copied from interface: JobService

Activates or suspends a job execution.

Specified by:

updateJob in interface JobService

Parameters:

jobId - the job id

jobUpdateRequest - the job update request

Returns:

the job