com.aspc.job

Class JobManager

java.lang.Object

com.aspc.job.JobManager

All Implemented Interfaces:

DBClassListener, java.lang.Runnable

public final class JobManager
extends java.lang.Object
implements DBClassListener, java.lang.Runnable

Handles jobs.
THREAD MODE: MULTI-THREADED

Since:

3 April 2004

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static int	GLOBAL_ENVIRONMENT_RUN_LIMIT the environment run limit

Method Summary

Modifier and Type	Method and Description
DBJob	bid(java.lang.String queues, DBJobManagerSession session, long blockMS, java.lang.String[] types) bid for a job in a queue
static int	calulatedRunLimit() get the global run limit.
static void	check() check the configuration
static boolean	checkDependants(DBJob job) check the dependents have completed.
DBJobManagerSession	checkSession() check the session.
void	closeAll() close all the queues.
static void	configure(java.lang.String fileName, int refreshSeconds) load the configuration of the JobManager from an XML file.
void	disableQueue(java.lang.String code) Disable a queue.
void	enableQueue(java.lang.String code) Enable a queue.
void	eventJobCompleted() A job has been completed.
void	eventObjectCreated(GlobalKey createdKey, VirtualDB layer) Watch for jobs being created.
void	eventObjectDeleted(GlobalKey deletedKey, VirtualDB layer) A job has been deleted.
void	eventObjectModified(GlobalKey modifiedKey, VirtualDB layer) A job was modified.
long	executeOrQueue(DBJob job) execute a job
void	filterQueue(java.lang.String code, java.lang.String filter) filter queue
static JobManager	find(VirtualDB layer) Find the JobManager for this layer.
static long	findMaxProcessBeatMS(VirtualDB layer) Get the MaxProcessBeat time in milliseconds.
DBJob[]	getActiveJobsByCode(java.lang.String code) The list of Jobs being processed or waiting to be processed
long	getCheckDeadJobsCount() get the check of the dead job count
java.lang.String	getFilter(java.lang.String queueCode) The filter for this queue.
static int	getGlobalDataBaseRunCount() get the global run count
static int	getGlobalProgramRunCount() get the global program run count
VirtualDB	getLayer() The layer for this job manager.
long	getQueueBidDelayPerJob(java.lang.String queueCode) The max pause time for this queue.
long	getQueueMaxPause(java.lang.String queueCode) The max pause time for this queue.
int	getQueueSlots(java.lang.String queueCode) The number of slots open for this queue.
int	getRunningJobs(java.lang.String queueCode) The number of jobs running for this queue.
boolean	isEnableQueue(java.lang.String code) is a queue enable.
void	join() Join to this job manager
static JobManager[]	list() The list of job managers.
void	loadOtherQueues() load the other queues.
void	openQueue(java.lang.String code, int slots) Open a queue.
void	openQueue(java.lang.String code, int slots, long maxPause, java.lang.String filter, java.lang.String bidDelayPerJob) Open a queue.
void	reanimatePreviousJob() When the job manager restarts it will check for previously running jobs for a job manager with the same name.
void	run() loop checking for jobs.
static int	setGlobalDataBaseRunLimit(int limit) set the global database run limit
static int	setGlobalProgramRunLimit(int limit) set the global program run limit
boolean	startJob(DBJob job) start a job
void	waitForChange(long msecs) wait for a change to the queue

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_ENVIRONMENT_RUN_LIMIT

public static final int GLOBAL_ENVIRONMENT_RUN_LIMIT

the environment run limit

Method Detail

getGlobalDataBaseRunCount

public static int getGlobalDataBaseRunCount()

get the global run count

Returns:

the count

setGlobalDataBaseRunLimit

public static int setGlobalDataBaseRunLimit(int limit)

set the global database run limit

Parameters:

limit - the limit

Returns:

the old limit.

getGlobalProgramRunCount

public static int getGlobalProgramRunCount()

get the global program run count

Returns:

the count

setGlobalProgramRunLimit

public static int setGlobalProgramRunLimit(int limit)

set the global program run limit

Parameters:

limit - the limit -1 is NO limit

Returns:

the old limit.

calulatedRunLimit

@CheckReturnValue
 @Nonnegative
public static int calulatedRunLimit()

get the global run limit.

Returns:

the old limit.

getCheckDeadJobsCount

public long getCheckDeadJobsCount()

get the check of the dead job count

Returns:

the check dead job count

filterQueue

public void filterQueue(java.lang.String code,
                        java.lang.String filter)
                 throws java.lang.Exception

filter queue

Parameters:

code - The queue code

filter - the filer to use on this queue.

Throws:

java.lang.Exception - a serious error

openQueue

public void openQueue(@Nonnull
                      java.lang.String code,
                      int slots)
               throws java.lang.Exception

Open a queue.

Parameters:

code - The queue code

slots - The number of slots

Throws:

java.lang.Exception - a serious error

openQueue

public void openQueue(@Nonnull
                      java.lang.String code,
                      int slots,
                      long maxPause,
                      @Nullable
                      java.lang.String filter,
                      @Nullable
                      java.lang.String bidDelayPerJob)
               throws java.lang.Exception

Open a queue.

Parameters:

maxPause - pause for a period of time

code - The queue code

slots - The number of slots

filter - the filter of the queue

bidDelayPerJob - how long to pause

Throws:

java.lang.Exception - a serious error

disableQueue

public void disableQueue(java.lang.String code)
                  throws java.lang.Exception

Disable a queue.

Parameters:

code - The queue code or '*' for all queues currently opened

Throws:

java.lang.Exception - a serious error

enableQueue

public void enableQueue(java.lang.String code)
                 throws java.lang.Exception

Enable a queue.

Parameters:

code - The queue code or '*' for all queues currently opened

Throws:

java.lang.Exception - a serious error

isEnableQueue

public boolean isEnableQueue(java.lang.String code)
                      throws java.lang.Exception

is a queue enable.

Parameters:

code - the queue code

Returns:

true if enabled.

Throws:

java.lang.Exception - a serious error

find

public static JobManager find(@Nonnull
                              VirtualDB layer)
                       throws java.lang.InterruptedException

Find the JobManager for this layer.

Parameters:

layer - The layer to fetch the job manager for.

Returns:

The job manager

Throws:

java.lang.InterruptedException - if we timeout.

eventObjectCreated

public void eventObjectCreated(GlobalKey createdKey,
                               VirtualDB layer)

Watch for jobs being created.

Specified by:

eventObjectCreated in interface DBClassListener

Parameters:

createdKey - The created job

layer - The layer on which is created.

eventObjectDeleted

public void eventObjectDeleted(@Nonnull
                               GlobalKey deletedKey,
                               @Nonnull
                               VirtualDB layer)

A job has been deleted.

Specified by:

eventObjectDeleted in interface DBClassListener

Parameters:

deletedKey - The deleted job

layer - The layer that the job was deleted in.

eventObjectModified

public void eventObjectModified(GlobalKey modifiedKey,
                                VirtualDB layer)

A job was modified.

Specified by:

eventObjectModified in interface DBClassListener

Parameters:

modifiedKey - The modified job

layer - The layer in which the job was modified.

eventJobCompleted

public void eventJobCompleted()

A job has been completed.

getLayer

public VirtualDB getLayer()

The layer for this job manager.

Returns:

The layer.

join

public void join()

Join to this job manager

run

public void run()

loop checking for jobs.

Specified by:

run in interface java.lang.Runnable

waitForChange

public void waitForChange(long msecs)
                   throws java.lang.InterruptedException

wait for a change to the queue

Parameters:

msecs - the milliseconds to wait.

Throws:

java.lang.InterruptedException - a problem

bid

public DBJob bid(java.lang.String queues,
                 DBJobManagerSession session,
                 @Nonnegative
                 long blockMS,
                 java.lang.String[] types)
          throws java.lang.Exception

bid for a job in a queue

Parameters:

types - The types to filter on

blockMS - block for now long ?

session - the session

queues - The queue to bid for

Returns:

the job that was won.

Throws:

java.lang.Exception - a serious problem

getRunningJobs

public int getRunningJobs(java.lang.String queueCode)

The number of jobs running for this queue.

Parameters:

queueCode - The queue code

Returns:

the number of job running in a queue.

getActiveJobsByCode

public DBJob[] getActiveJobsByCode(java.lang.String code)
                            throws java.lang.Exception

The list of Jobs being processed or waiting to be processed

Parameters:

code - Code to search for

Returns:

the list of Jobs with the specified Job code

Throws:

java.lang.Exception - A serious error

closeAll

public void closeAll()

close all the queues.

getFilter

@Nullable
public java.lang.String getFilter(@Nonnull
                                            java.lang.String queueCode)

The filter for this queue.

Parameters:

queueCode - The queue code

Returns:

the filter

getQueueSlots

public int getQueueSlots(@Nonnull
                         java.lang.String queueCode)

The number of slots open for this queue.

Parameters:

queueCode - The queue code

Returns:

the number of slots

getQueueMaxPause

public long getQueueMaxPause(@Nonnull
                             java.lang.String queueCode)

The max pause time for this queue.

Parameters:

queueCode - The queue code

Returns:

the pause time in milliseconds

getQueueBidDelayPerJob

public long getQueueBidDelayPerJob(@Nonnull
                                   java.lang.String queueCode)

The max pause time for this queue.

Parameters:

queueCode - The queue code

Returns:

the pause time in milliseconds

reanimatePreviousJob

public void reanimatePreviousJob()

When the job manager restarts it will check for previously running jobs for a job manager with the same name. If found the job will be restarted.

startJob

public boolean startJob(@Nonnull
                        DBJob job)
                 throws java.lang.Exception

start a job

Parameters:

job - the job to run

Returns:

true if started

Throws:

java.lang.Exception - A serious problem

checkDependants

public static boolean checkDependants(@Nonnull
                                      DBJob job)
                               throws java.lang.Exception

check the dependents have completed.

Parameters:

job - the job to check

Returns:

true if all completed.

Throws:

java.lang.Exception - a serious problem

executeOrQueue

public long executeOrQueue(@Nonnull
                           DBJob job)
                    throws java.lang.Exception

execute a job

Parameters:

job - the job to run

Returns:

true if the job list should be reloaded.

Throws:

java.lang.Exception - A serious problem

configure

public static void configure(java.lang.String fileName,
                             int refreshSeconds)
                      throws java.lang.Exception

load the configuration of the JobManager from an XML file.

    <layer name='aspc_engine' >
        <queue name='default' slots='3' />
    </layer>
 

Parameters:

refreshSeconds - check the configuration file every X seconds.

fileName - configure the job managers.

Throws:

java.lang.Exception - a serious problem

check

public static void check()

check the configuration

list

@Nonnull
public static JobManager[] list()

The list of job managers.

Returns:

The list

loadOtherQueues

public void loadOtherQueues()
                     throws java.lang.Exception

load the other queues.

Throws:

java.lang.Exception - a serious problem

checkSession

public DBJobManagerSession checkSession()
                                 throws java.lang.Exception

check the session. If the session is not null updating the last beat for that session else creates new session

Returns:

Session

Throws:

java.lang.Exception - A serious problem occurs

findMaxProcessBeatMS

public static long findMaxProcessBeatMS(@Nonnull
                                        VirtualDB layer)
                                 throws java.lang.Exception

Get the MaxProcessBeat time in milliseconds.

Parameters:

layer - VirtualDB

Returns:

long time in milliseconds

Throws:

java.lang.Exception - A serious problem occurs