psdi.iface.jms

Class JMSQueueCronTask

java.lang.Object

psdi.server.SimpleCronTask

psdi.iface.jms.JMSQueueCronTask

All Implemented Interfaces:

CronTask

public class JMSQueueCronTask
extends SimpleCronTask

Author:

Anamitra To change the template for this generated type comment go to Window>Preferences>Java>Code Generation>Code and Comments

Constructor Summary

Constructors

Constructor and Description
JMSQueueCronTask()

Method Summary

Methods

Modifier and Type	Method and Description
void	cronAction() This is the CORE METHOD of this class.
CrontaskParamInfo[]	getParameters() This method provides an array of CrontaskParamInfo() object to describe all the parameters of the crontask.
MboRemote	getParameterValidationMbo(CrontaskInstanceRemote instance) Returns the validation mbo for the crontask parameter
void	init() Invoked by the CronTaskManager when the class is instantiated.
boolean	isOKToRun(MXServerRemote server) This method informs the crontask manager whether the crontask instance associated to this crontask object should be running on the specified server.
void	killConsumer()
void	setCrontaskInstance(CrontaskInstanceRemote inst) Cache the crontask instance this crontask object is instantiated for.
void	start() Default implementation for start().
void	stop() Default implementation for stop().

Methods inherited from class psdi.server.SimpleCronTask

beforeRemoval, getCronTaskHistoryMsg, getCrontaskInstance, getCronTaskLogger, getCronTaskSqlLogger, getDBLastSeed, getEnteredValueVector, getInterval, getIntervalFlag, getLastRunDate, getLastSeed, getName, getParamAsBoolean, getParamAsDate, getParamAsDouble, getParamAsInt, getParamAsString, getParameter, getParameterValidationMbo, getRunasUserInfo, getSleepTime, isShutdown, setCronTaskHistoryMsg, setDBLastSeed, setEnteredValueVector, setInterval, setIntervalFlag, setLastRunDate, setLastSeed, setSleepTime, shutdown

Methods inherited from class java.lang.Object

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

Constructor Detail

JMSQueueCronTask

public JMSQueueCronTask()

Method Detail

init

public void init()

Description copied from class: SimpleCronTask

Invoked by the CronTaskManager when the class is instantiated. Sets value for runAsUserInfo. Performs a silent login via SecurityService.

Specified by:

init in interface CronTask

Overrides:

init in class SimpleCronTask

See Also:

SecurityService.authenticateUser(String, boolean)

start

public void start()

Description copied from class: SimpleCronTask

Default implementation for start(). It does nothing.

Specified by:

start in interface CronTask

Overrides:

start in class SimpleCronTask

See Also:

CronTask.stop(), startup()

killConsumer

public void killConsumer()

cronAction

public void cronAction()

Description copied from class: SimpleCronTask

This is the CORE METHOD of this class. You should invoke whatever logic you want your CronTask to perform from this method. This method should

1. check the shutdown variable before invoking any processing logic.
2. call resetErrorCount() if processing proceeds w/out error.
3. call incErrorCount() if a serious error occurs during the processing logic.

Specified by:

cronAction in interface CronTask

Specified by:

cronAction in class SimpleCronTask

getParameters

public CrontaskParamInfo[] getParameters()
                                  throws MXException,
                                         java.rmi.RemoteException

Description copied from interface: CronTask

This method provides an array of CrontaskParamInfo() object to describe all the parameters of the crontask. Parameter name, default values and the description of the parameter should be set to the CrontaskParamInfo object for each parameter. If default value and description is not set, null will be the values.

Specified by:

getParameters in interface CronTask

Overrides:

getParameters in class SimpleCronTask

Returns:

Throws:

MXException

java.rmi.RemoteException

See Also:

CrontaskParamInfo

isOKToRun

public boolean isOKToRun(MXServerRemote server)

This method informs the crontask manager whether the crontask instance associated to this crontask object should be running on the specified server. If the decision is crontask instance related, then the instance reference passed down to the c crontask by the crontask manager needs to be cached by overwriting the setCrontaskInstance() method. If your class is derived from SimpleCrontask class, this is already implemented.

Specified by:

isOKToRun in interface CronTask

Overrides:

isOKToRun in class SimpleCronTask

Parameters:

server -

Returns:

true if it is OK to run, false otherwise.

See Also:

psdi.server.CronTask#isOKToRun();

stop

public void stop()

Description copied from class: SimpleCronTask

Default implementation for stop(). It does nothing.

Specified by:

stop in interface CronTask

Overrides:

stop in class SimpleCronTask

setCrontaskInstance

public void setCrontaskInstance(CrontaskInstanceRemote inst)

Description copied from class: SimpleCronTask

Cache the crontask instance this crontask object is instantiated for.

Specified by:

setCrontaskInstance in interface CronTask

Overrides:

setCrontaskInstance in class SimpleCronTask

See Also:

CronTask.setCrontaskInstance(CrontaskInstanceRemote)

getParameterValidationMbo

public MboRemote getParameterValidationMbo(CrontaskInstanceRemote instance)
                                    throws MXException,
                                           java.rmi.RemoteException

Returns the validation mbo for the crontask parameter

Specified by:

getParameterValidationMbo in interface CronTask

Overrides:

getParameterValidationMbo in class SimpleCronTask

Returns:

Non-persistent MBO remote

Throws:

MXException

java.rmi.RemoteException

See Also:

CronTask.getParameterValidationMbo(CrontaskInstanceRemote)