salto.batch.apiconsole.scheduler
Class BatchSchedulerWrapper

java.lang.Object
  salto.batch.apiconsole.scheduler.BatchSchedulerWrapper

public class BatchSchedulerWrapper
extends java.lang.Object

This class must be used in batches to access to BatchScheduler is required instead of using it directly.

Since:

3.0.0.7 Copyright Ubik-Ingenierie

Author:

David Degardin, Philippe Mouawad

Method Summary

void	addGlobalBatchListener(java.lang.String barId, BatchListener batchListener) Add to Batch scheduler a global job listener
BatchListener	getGlobalBatchListener(java.lang.String barId, java.lang.String batchListenerName)
static BatchSchedulerWrapper	getInstance()
java.lang.String[]	getRunningBatches() Get the list of actual running batches
boolean	removeGlobalBatchListener(java.lang.String barId, BatchListener listener) Removes a global job listener from Quartz scheduler
void	startBatch(java.lang.String fullBatchName) Starts a batch immediatly knowing its full name

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static BatchSchedulerWrapper getInstance()

Returns:

BatchSchedulerWrapper the singleton

addGlobalBatchListener

public final void addGlobalBatchListener(java.lang.String barId,
                                         BatchListener batchListener)
                                  throws BatchException

Add to Batch scheduler a global job listener

Parameters:

barId - String BAR Id

batchListener - BatchListener to add

Throws:

BatchException

Since:

4.0.0.1

getGlobalBatchListener

public final BatchListener getGlobalBatchListener(java.lang.String barId,
                                                  java.lang.String batchListenerName)
                                           throws BatchException

Parameters:

barId - String BAR Id

batchListenerName - BatchListener name

Returns:

BatchListener

Throws:

BatchException

Since:

4.0.0.1

removeGlobalBatchListener

public final boolean removeGlobalBatchListener(java.lang.String barId,
                                               BatchListener listener)
                                        throws BatchException

Removes a global job listener from Quartz scheduler

Parameters:

barId - String BAR Id

listener - BatchListener the listener to remove

Returns:

boolean true if removal success

Throws:

BatchException

Since:

4.0.0.1

getRunningBatches

public final java.lang.String[] getRunningBatches()

Get the list of actual running batches

Returns:

the list as a String array of batches that are running now

startBatch

public final void startBatch(java.lang.String fullBatchName)
                      throws BatchException,
                             SchedulerException

Starts a batch immediatly knowing its full name

Parameters:

fullBatchName - the full name of the batch (with launch family name if any)

Throws:

BatchException

SchedulerException