net.bluemind.scheduledjob.service.internal

Class ScheduledJobService

java.lang.Object

net.bluemind.scheduledjob.service.internal.ScheduledJobService

All Implemented Interfaces:

IInCoreJob, IJob

public class ScheduledJobService
extends java.lang.Object
implements IInCoreJob

Constructor Summary

Constructors

Constructor and Description
ScheduledJobService(BmContext context)

Method Summary

Modifier and Type	Method and Description
void	cancel(java.lang.String jobId, java.lang.String domainUid) Cancel running job by its ID
JobExecution	createExecution(JobExecution je)
void	deleteExecution(int jobExecutionId) Removes one execution.
void	deleteExecutions(java.util.List<java.lang.Integer> jobExecutionId) Removes multiple executions.
Job	getJobFromId(java.lang.String jobId) Get job using its id
java.util.Set<LogEntry>	getLogs(JobExecution jobExecution, int offset) Return the logs of a job.
ListResult<JobExecution>	searchExecution(JobExecutionQuery query) Fetch recorded job executions.
ListResult<Job>	searchJob(JobQuery query) List jobs deployed.
void	start(java.lang.String jobId, java.lang.String domainUid) Get active job using its ID force-start a job.
void	storeLogEntries(int jobExecutionid, java.util.Set<LogEntry> entries)
void	update(Job job) Update job planification JobPlanification
void	updateExecution(JobExecution je)

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduledJobService

public ScheduledJobService(BmContext context)

Method Detail

searchJob

public ListResult<Job> searchJob(JobQuery query)
                          throws ServerFault

Description copied from interface: IJob

List jobs deployed. global & non-global admins will get different results.

Specified by:

searchJob in interface IJob

Returns:

Throws:

ServerFault

searchExecution

public ListResult<JobExecution> searchExecution(JobExecutionQuery query)
                                         throws ServerFault

Description copied from interface: IJob

Fetch recorded job executions. Pagination is supported. global & non-global admins will get different results.

Specified by:

searchExecution in interface IJob

Returns:

list of job executions, sorted by start execution date in descending order

Throws:

ServerFault

getJobFromId

public Job getJobFromId(java.lang.String jobId)
                 throws ServerFault

Description copied from interface: IJob

Get job using its id

Specified by:

getJobFromId in interface IJob

Returns:

Throws:

ServerFault

update

public void update(Job job)
            throws ServerFault

Description copied from interface: IJob

Update job planification JobPlanification

Specified by:

update in interface IJob

Throws:

ServerFault

deleteExecution

public void deleteExecution(int jobExecutionId)
                     throws ServerFault

Description copied from interface: IJob

Removes one execution. Removes nothing if your token has no right on this execution (global job, different domain, etc)

Specified by:

deleteExecution in interface IJob

Throws:

ServerFault

deleteExecutions

public void deleteExecutions(java.util.List<java.lang.Integer> jobExecutionId)
                      throws ServerFault

Description copied from interface: IJob

Removes multiple executions.

Specified by:

deleteExecutions in interface IJob

Throws:

ServerFault

start

public void start(java.lang.String jobId,
                  java.lang.String domainUid)
           throws ServerFault

Description copied from interface: IJob

Get active job using its ID force-start a job. Execution is recorded when the job finishes.

Specified by:

start in interface IJob

Throws:

ServerFault

cancel

public void cancel(java.lang.String jobId,
                   java.lang.String domainUid)
            throws ServerFault

Description copied from interface: IJob

Cancel running job by its ID

Specified by:

cancel in interface IJob

Throws:

ServerFault

getLogs

public java.util.Set<LogEntry> getLogs(JobExecution jobExecution,
                                       int offset)
                                throws ServerFault

Description copied from interface: IJob

Return the logs of a job. The offset indicates how much logs you already fetched in a previous call.

Specified by:

getLogs in interface IJob

Returns:

Throws:

ServerFault

createExecution

public JobExecution createExecution(JobExecution je)
                             throws ServerFault

Specified by:

createExecution in interface IInCoreJob

Throws:

ServerFault

updateExecution

public void updateExecution(JobExecution je)
                     throws ServerFault

Specified by:

updateExecution in interface IInCoreJob

Throws:

ServerFault

storeLogEntries

public void storeLogEntries(int jobExecutionid,
                            java.util.Set<LogEntry> entries)
                     throws ServerFault

Specified by:

storeLogEntries in interface IInCoreJob

Throws:

ServerFault