org.bonitasoft.engine.scheduler.impl

Class JobServiceImpl

java.lang.Object

org.bonitasoft.engine.scheduler.impl.JobServiceImpl

All Implemented Interfaces:

JobService

public class JobServiceImpl
extends Object
implements JobService

Author:

Celine Souchet, Matthieu Chaffotte

Field Summary

Fields inherited from interface org.bonitasoft.engine.scheduler.JobService

JOB_DESCRIPTOR, JOB_LOG, JOB_PARAMETER

Constructor Summary

Constructors

Constructor and Description
JobServiceImpl(EventService eventService, Recorder recorder, org.bonitasoft.engine.persistence.ReadPersistenceService readPersistenceService, TechnicalLoggerService logger)

Method Summary

Modifier and Type	Method and Description
SJobDescriptor	createJobDescriptor(SJobDescriptor sJobDescriptor, long tenantId) Create a new job descriptor for a specific tenant
void	createJobLog(Exception jobException, Long jobDescriptorId)
SJobLog	createJobLog(SJobLog sJobLog) Create a new job log for a specific tenant
SJobParameter	createJobParameter(SJobParameter sJobParameter, long tenantId, long jobDescriptorId) Create a new job parameter for a specific tenant
List<SJobParameter>	createJobParameters(List<SJobParameter> sJobParameters, long tenantId, long jobDescriptorId) Create new job parameters for a specific tenant
void	deleteAllJobDescriptors() Delete all job descriptors for a specific tenant
protected void	deleteAllJobParameters(long jobDescriptorId)
void	deleteJobDescriptor(long id) Delete the specified job descriptor
void	deleteJobDescriptor(SJobDescriptor sJobDescriptor) Delete the specified job descriptor
void	deleteJobDescriptorByJobName(String jobName) Delete a job descriptor corresponding to the given job name
void	deleteJobLog(long id) Delete the specified job log
void	deleteJobLog(SJobLog sJobLog) Delete the specified job log
void	deleteJobLogs(long jobDescriptorId) Delete all SJobLog of a specific SJobDescriptor
void	deleteJobParameter(long id) Delete the specified job parameter
void	deleteJobParameter(SJobParameter sJobParameter) Delete the specified job parameter
List<SFailedJob>	getFailedJobs(int startIndex, int maxResults) Get list of failed jobs
SJobDescriptor	getJobDescriptor(long id) Get a specific job descriptor
SJobLog	getJobLog(long id) Get a specific job log
List<SJobLog>	getJobLogs(long jobDescriptorId, int fromIndex, int maxResults) Get all SJobLog of a specific SJobDescriptor
SJobParameter	getJobParameter(long id) Get a specific job parameter
long	getNumberOfJobDescriptors(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Get total number of job descriptors
long	getNumberOfJobLogs(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Get total number of job logs
void	logJobError(Exception jobException, Long jobDescriptorId) log an error on a job
List<SJobDescriptor>	searchJobDescriptors(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Search all job descriptors according to specific criteria
List<SJobLog>	searchJobLogs(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Search all job logs according to specific criteria
List<SJobParameter>	searchJobParameters(org.bonitasoft.engine.persistence.QueryOptions queryOptions) Search all job parameters according to specific criteria
List<SJobParameter>	setJobParameters(long tenantId, long jobDescriptorId, List<SJobParameter> parameters) Delete jobs parameters corresponding to tenant and job descriptor, if exist.
void	updateJobLog(SJobLog jobLog, EntityUpdateDescriptor descriptor) Update a SJobLog

Methods inherited from class java.lang.Object

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

Constructor Detail

JobServiceImpl

public JobServiceImpl(EventService eventService,
                      Recorder recorder,
                      org.bonitasoft.engine.persistence.ReadPersistenceService readPersistenceService,
                      TechnicalLoggerService logger)

Method Detail

createJobDescriptor

public SJobDescriptor createJobDescriptor(SJobDescriptor sJobDescriptor,
                                          long tenantId)
                                   throws SJobDescriptorCreationException

Description copied from interface: JobService

Create a new job descriptor for a specific tenant

Specified by:

createJobDescriptor in interface JobService

Parameters:

sJobDescriptor - JobDescriptor to create

tenantId - Identifier of tenant

Returns:

The created jobDescriptor

Throws:

SJobDescriptorCreationException

deleteJobDescriptor

public void deleteJobDescriptor(long id)
                         throws SJobDescriptorReadException,
                                SJobDescriptorDeletionException

Description copied from interface: JobService

Delete the specified job descriptor

Specified by:

deleteJobDescriptor in interface JobService

Parameters:

id - Identifier of job descriptor to delete

Throws:

SJobDescriptorReadException

SJobDescriptorDeletionException

deleteJobDescriptor

public void deleteJobDescriptor(SJobDescriptor sJobDescriptor)
                         throws SJobDescriptorDeletionException

Description copied from interface: JobService

Delete the specified job descriptor

Specified by:

deleteJobDescriptor in interface JobService

Parameters:

sJobDescriptor - JobDescriptor to delete

Throws:

SJobDescriptorDeletionException

getJobDescriptor

public SJobDescriptor getJobDescriptor(long id)
                                throws SJobDescriptorReadException

Description copied from interface: JobService

Get a specific job descriptor

Specified by:

getJobDescriptor in interface JobService

Parameters:

id - Identifier of job descriptor

Returns:

Null if the job descriptor doesn't exist, else the SJobDescriptor corresponding to the identifier

Throws:

SJobDescriptorReadException

getNumberOfJobDescriptors

public long getNumberOfJobDescriptors(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                               throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Get total number of job descriptors

Specified by:

getNumberOfJobDescriptors in interface JobService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

total number of job logs

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchJobDescriptors

public List<SJobDescriptor> searchJobDescriptors(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                          throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Search all job descriptors according to specific criteria

Specified by:

searchJobDescriptors in interface JobService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

A list of SJobParameter objects

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

createJobParameters

public List<SJobParameter> createJobParameters(List<SJobParameter> sJobParameters,
                                               long tenantId,
                                               long jobDescriptorId)
                                        throws SJobParameterCreationException

Description copied from interface: JobService

Create new job parameters for a specific tenant

Specified by:

createJobParameters in interface JobService

Parameters:

sJobParameters - JobParameters to create

tenantId - Identifier of tenant

jobDescriptorId - Identifier of job descriptor

Returns:

Throws:

SJobParameterCreationException

setJobParameters

public List<SJobParameter> setJobParameters(long tenantId,
                                            long jobDescriptorId,
                                            List<SJobParameter> parameters)
                                     throws SJobParameterCreationException

Description copied from interface: JobService

Delete jobs parameters corresponding to tenant and job descriptor, if exist. After, create new job parameters for a specific tenant

Specified by:

setJobParameters in interface JobService

Returns:

A list of new SJobParameter objects

Throws:

SJobParameterCreationException

deleteAllJobParameters

protected void deleteAllJobParameters(long jobDescriptorId)
                               throws SJobParameterCreationException

Throws:

SJobParameterCreationException

createJobParameter

public SJobParameter createJobParameter(SJobParameter sJobParameter,
                                        long tenantId,
                                        long jobDescriptorId)
                                 throws SJobParameterCreationException

Description copied from interface: JobService

Create a new job parameter for a specific tenant

Specified by:

createJobParameter in interface JobService

Parameters:

sJobParameter - JobParameter to create

tenantId - Identifier of tenant

jobDescriptorId - Identifier of job descriptor

Returns:

Throws:

SJobParameterCreationException

deleteJobParameter

public void deleteJobParameter(long id)
                        throws SJobParameterNotFoundException,
                               SJobParameterReadException,
                               SJobParameterDeletionException

Description copied from interface: JobService

Delete the specified job parameter

Specified by:

deleteJobParameter in interface JobService

Parameters:

id - Identifier of job parameter to delete

Throws:

SJobParameterNotFoundException

SJobParameterReadException

SJobParameterDeletionException

deleteJobParameter

public void deleteJobParameter(SJobParameter sJobParameter)
                        throws SJobParameterDeletionException

Description copied from interface: JobService

Delete the specified job parameter

Specified by:

deleteJobParameter in interface JobService

Parameters:

sJobParameter - JobParameter to delete

Throws:

SJobParameterDeletionException

getJobParameter

public SJobParameter getJobParameter(long id)
                              throws SJobParameterNotFoundException,
                                     SJobParameterReadException

Description copied from interface: JobService

Get a specific job parameter

Specified by:

getJobParameter in interface JobService

Parameters:

id - Identifier of job parameter

Returns:

Throws:

SJobParameterNotFoundException

SJobParameterReadException

searchJobParameters

public List<SJobParameter> searchJobParameters(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                                        throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Search all job parameters according to specific criteria

Specified by:

searchJobParameters in interface JobService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

A list of SJobParameter objects

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

createJobLog

public SJobLog createJobLog(SJobLog sJobLog)
                     throws SJobLogCreationException

Description copied from interface: JobService

Create a new job log for a specific tenant

Specified by:

createJobLog in interface JobService

Parameters:

sJobLog - JobLog to create

Returns:

Throws:

SJobLogCreationException

deleteJobLog

public void deleteJobLog(long id)
                  throws SJobLogDeletionException,
                         org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Delete the specified job log

Specified by:

deleteJobLog in interface JobService

Parameters:

id - Identifier of job log to delete

Throws:

SJobLogDeletionException

org.bonitasoft.engine.persistence.SBonitaReadException

deleteJobLog

public void deleteJobLog(SJobLog sJobLog)
                  throws SJobLogDeletionException

Description copied from interface: JobService

Delete the specified job log

Specified by:

deleteJobLog in interface JobService

Parameters:

sJobLog - JobLog to delete

Throws:

SJobLogDeletionException

deleteJobLogs

public void deleteJobLogs(long jobDescriptorId)
                   throws SJobLogDeletionException,
                          org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Delete all SJobLog of a specific SJobDescriptor

Specified by:

deleteJobLogs in interface JobService

Parameters:

jobDescriptorId - The identifier of the SJobDescriptor

Throws:

SJobLogDeletionException

org.bonitasoft.engine.persistence.SBonitaReadException

getJobLogs

public List<SJobLog> getJobLogs(long jobDescriptorId,
                                int fromIndex,
                                int maxResults)
                         throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Get all SJobLog of a specific SJobDescriptor

Specified by:

getJobLogs in interface JobService

Parameters:

jobDescriptorId - The identifier of the SJobDescriptor

fromIndex - The index of the first element of the list

maxResults - The nulber max of elements of the list

Returns:

A list of SJobLog

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getJobLog

public SJobLog getJobLog(long id)
                  throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Get a specific job log

Specified by:

getJobLog in interface JobService

Parameters:

id - Identifier of job log

Returns:

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getNumberOfJobLogs

public long getNumberOfJobLogs(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                        throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Get total number of job logs

Specified by:

getNumberOfJobLogs in interface JobService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

total number of job logs

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

searchJobLogs

public List<SJobLog> searchJobLogs(org.bonitasoft.engine.persistence.QueryOptions queryOptions)
                            throws org.bonitasoft.engine.persistence.SBonitaReadException

Description copied from interface: JobService

Search all job logs according to specific criteria

Specified by:

searchJobLogs in interface JobService

Parameters:

queryOptions - a map of specific parameters of a query

Returns:

A list of SJobLog objects

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

getFailedJobs

public List<SFailedJob> getFailedJobs(int startIndex,
                                      int maxResults)
                               throws SFailedJobReadException

Description copied from interface: JobService

Get list of failed jobs

Specified by:

getFailedJobs in interface JobService

Returns:

A list of SFailedJob objects

Throws:

SFailedJobReadException

deleteJobDescriptorByJobName

public void deleteJobDescriptorByJobName(String jobName)
                                  throws SJobDescriptorDeletionException

Description copied from interface: JobService

Delete a job descriptor corresponding to the given job name

Specified by:

deleteJobDescriptorByJobName in interface JobService

Parameters:

jobName - name of job we want the jobDsecriptor to be deleted

Throws:

SJobDescriptorDeletionException

deleteAllJobDescriptors

public void deleteAllJobDescriptors()
                             throws SJobDescriptorDeletionException

Description copied from interface: JobService

Delete all job descriptors for a specific tenant

Specified by:

deleteAllJobDescriptors in interface JobService

Throws:

SJobDescriptorDeletionException

updateJobLog

public void updateJobLog(SJobLog jobLog,
                         EntityUpdateDescriptor descriptor)
                  throws SJobLogUpdatingException

Description copied from interface: JobService

Update a SJobLog

Specified by:

updateJobLog in interface JobService

Parameters:

jobLog - The log to update

Throws:

SJobLogUpdatingException

logJobError

public void logJobError(Exception jobException,
                        Long jobDescriptorId)
                 throws org.bonitasoft.engine.persistence.SBonitaReadException,
                        SJobLogUpdatingException,
                        SJobLogCreationException,
                        SJobDescriptorReadException

Description copied from interface: JobService

log an error on a job

Specified by:

logJobError in interface JobService

Parameters:

jobException - the exception

jobDescriptorId - the id of the job

Throws:

org.bonitasoft.engine.persistence.SBonitaReadException

SJobLogUpdatingException

SJobLogCreationException

SJobDescriptorReadException

createJobLog

public void createJobLog(Exception jobException,
                         Long jobDescriptorId)
                  throws SJobLogCreationException,
                         SJobDescriptorReadException

Throws:

SJobLogCreationException

SJobDescriptorReadException