org.osivia.portal.api.batch

Class AbstractBatch

java.lang.Object

org.osivia.portal.api.batch.AbstractBatch

All Implemented Interfaces:

Batch

public abstract class AbstractBatch
extends Object
implements Batch

Abstract class used to set common behaviors on a batch

Author:

Loïc Billon

Constructor Summary

Constructors

Constructor and Description
AbstractBatch()

Method Summary

Modifier and Type	Method and Description
abstract void	execute(Map<String,Object> parameters) The main execution method.
String	getBatchId() Id a the batch (used to register the job in Quartz scheduler).
abstract String	getJobScheduling() Define the cron used to run the batch periodically
boolean	isRunningOnMasterOnly() Set true if this job should not run on all nodes of the cluster
void	setBatchId(String batchId) Id a the batch (used to register the job in Quartz scheduler).

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBatch

public AbstractBatch()

Method Detail

getBatchId

public String getBatchId()

Description copied from interface: Batch

Id a the batch (used to register the job in Quartz scheduler).

Specified by:

getBatchId in interface Batch

Returns:

setBatchId

public void setBatchId(String batchId)

Description copied from interface: Batch

Id a the batch (used to register the job in Quartz scheduler).

Specified by:

setBatchId in interface Batch

Parameters:

batchId - the identifier of the batch

isRunningOnMasterOnly

public boolean isRunningOnMasterOnly()

Description copied from interface: Batch

Set true if this job should not run on all nodes of the cluster

Specified by:

isRunningOnMasterOnly in interface Batch

Returns:

getJobScheduling

public abstract String getJobScheduling()

Description copied from interface: Batch

Define the cron used to run the batch periodically

Specified by:

getJobScheduling in interface Batch

Returns:

execute

public abstract void execute(Map<String,Object> parameters)
                      throws PortalException

Description copied from interface: Batch

The main execution method.

Specified by:

execute in interface Batch

Throws:

PortalException