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()
AbstractBatch(String batchId)

Method Summary

Modifier and Type	Method and Description
abstract void	execute(Map<String,Object> parameters) The main execution method.
String	getBatchId()
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

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractBatch

public AbstractBatch()

AbstractBatch

public AbstractBatch(String batchId)

Method Detail

getBatchId

public String getBatchId()

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