Package com.atlassian.confluence.impl.backgroundjob

Class BackgroundJobService

java.lang.Object

com.atlassian.confluence.impl.backgroundjob.BackgroundJobService

public class BackgroundJobService
extends Object

The service that allows to add new background tasks.

Since:

8.1.0

Constructor Summary

Constructors

Constructor	Description
BackgroundJobService(BackgroundJobDAO backgroundJobDAO, List<BackgroundJobProcessor> processors, Supplier<Instant> timeSupplier, Supplier<org.springframework.transaction.support.TransactionTemplate> transactionTemplateSupplier)
BackgroundJobService(BackgroundJobDAO backgroundJobDAO, org.springframework.transaction.PlatformTransactionManager transactionManager, List<BackgroundJobProcessor> processors)

Method Summary

Modifier and Type	Method	Description
Long	addJob(Class<?> processorClass, Map<String,Object> parameters, String description, Instant runAt)	Adds a new background job.
Map<String,Object>	convertToHashMap(String customerInfoJSON)
String	convertToJson(Map<String,Object> map)
int	processNextJobs()	Process a next portion of active jobs.
void	registerBackgroundJobProcessor(BackgroundJobProcessor backgroundJobProcessor)	Registers a background processor.
void	unregisterBackgroundJobProcessor(BackgroundJobProcessor backgroundJobProcessor)	Unregisters a background processor.

Methods inherited from class java.lang.Object

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

Constructor Detail

BackgroundJobService

public BackgroundJobService(BackgroundJobDAO backgroundJobDAO,
                            org.springframework.transaction.PlatformTransactionManager transactionManager,
                            List<BackgroundJobProcessor> processors)

BackgroundJobService

public BackgroundJobService(BackgroundJobDAO backgroundJobDAO,
                            List<BackgroundJobProcessor> processors,
                            Supplier<Instant> timeSupplier,
                            Supplier<org.springframework.transaction.support.TransactionTemplate> transactionTemplateSupplier)

Method Detail

addJob

public Long addJob(Class<?> processorClass,
                   Map<String,Object> parameters,
                   String description,
                   Instant runAt)

Adds a new background job.

Parameters:

processorClass - processor's class

parameters - job parameters

runAt - desired execution time (or Instant.now if it has to be run immediately)

Returns:

job id

processNextJobs

@Internal
public int processNextJobs()

Process a next portion of active jobs.

Returns:

registerBackgroundJobProcessor

public void registerBackgroundJobProcessor(BackgroundJobProcessor backgroundJobProcessor)

Registers a background processor.

Parameters:

backgroundJobProcessor -

unregisterBackgroundJobProcessor

public void unregisterBackgroundJobProcessor(BackgroundJobProcessor backgroundJobProcessor)

Unregisters a background processor.

Parameters:

backgroundJobProcessor -

convertToJson

public String convertToJson(Map<String,Object> map)

convertToHashMap

public Map<String,Object> convertToHashMap(String customerInfoJSON)