com.ibm.tivoli.maximo.mfmail

Class MfMailCleanupCronTask

java.lang.Object

psdi.server.SimpleCronTask

com.ibm.tivoli.maximo.mfmail.MfMailCleanupCronTask

All Implemented Interfaces:

CronTask

public class MfMailCleanupCronTask
extends SimpleCronTask

Constructor Summary

Constructors

Constructor and Description
MfMailCleanupCronTask()

Method Summary

Modifier and Type	Method and Description
void	cronAction() This is the CORE METHOD of this class.
MXLogger	getCronTaskLogger() Returns a logger to log messages related to this task.
CrontaskParamInfo[]	getParameters() This method provides an array of CrontaskParamInfo() object to describe all the parameters of the crontask.
void	init() Invoked by the CronTaskManager when the class is instantiated.
boolean	isOKToRun(MXServerRemote server) Default implementation of isOKToRun.

Methods inherited from class psdi.server.SimpleCronTask

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

Methods inherited from class java.lang.Object

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

Constructor Detail

MfMailCleanupCronTask

public MfMailCleanupCronTask()

Method Detail

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

init

public void init()
          throws MXException

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

Throws:

MXException

See Also:

SecurityService.authenticateUser(String, boolean)

isOKToRun

public boolean isOKToRun(MXServerRemote server)

Description copied from class: SimpleCronTask

Default implementation of isOKToRun. It always returns true.

Specified by:

isOKToRun in interface CronTask

Overrides:

isOKToRun in class SimpleCronTask

Returns:

true if it is OK to run, false otherwise.

See Also:

psdi.server.CronTask#isOKToRun();

getCronTaskLogger

public MXLogger getCronTaskLogger()

Description copied from class: SimpleCronTask

Returns a logger to log messages related to this task.

Overrides:

getCronTaskLogger in class SimpleCronTask

Returns:

MXLogger a logger to log messages related to this task.