Class AbstractJobDef
- All Implemented Interfaces:
FrankElement
,HasApplicationContext
,HasName
,HasTransactionAttribute
,IConfigurable
,IScopeProvider
,NameAware
,ConfigurableLifecycle
,IJob
,org.springframework.beans.factory.Aware
,org.springframework.context.ApplicationContextAware
,org.springframework.context.Lifecycle
,org.springframework.context.Phased
,org.springframework.context.SmartLifecycle
- Direct Known Subclasses:
ActionJob
,CheckReloadJob
,CleanupDatabaseJob
,CleanupFileSystemJob
,ExecuteQueryJob
,Job
,LoadDatabaseSchedulesJob
,RecoverAdaptersJob
,SendMessageJob
Possible cron expressions:
A "Cron-Expression" is a string comprised of 6 or 7 fields separated by
white space. The 6 mandatory and 1 optional fields are as follows:
Field Name | Allowed Values | Allowed Special Characters | ||
---|---|---|---|---|
Seconds |
0-59 | , - * / |
||
Minutes |
0-59 | , - * / |
||
Hours |
0-23 | , - * / |
||
Day-of-month |
1-31 | , - * ? / L C |
||
Month |
1-12 or JAN-DEC | , - * / |
||
Day-of-Week |
1-7 or SUN-SAT | , - * ? / L C # |
||
Year (Optional) |
>empty, 1970-2099 | , - * / |
The '*' character is used to specify all values. For example, "*" in the minute field means "every minute".
The '?' character is allowed for the day-of-month and day-of-week fields. It is used to specify 'no specific value'. This is useful when you need to specify something in one of the two fields, but not the other. See the examples below for clarification.
The '-' character is used to specify ranges For example "10-12" in the hour field means "the hours 10, 11 and 12".
The ',' character is used to specify additional values. For example "MON,WED,FRI" in the day-of-week field means "the days Monday, Wednesday, and Friday".
The '/' character is used to specify increments. For example "0/15" in the seconds field means "the seconds 0, 15, 30, and 45". And "5/15" in the seconds field means "the seconds 5, 20, 35, and 50". You can also specify '/' after the '*' character - in this case '*' is equivalent to having '0' before the '/'.
The 'L' character is allowed for the day-of-month and day-of-week fields. This character is short-hand for "last", but it has different meaning in each of the two fields. For example, the value "L" in the day-of-month field means "the last day of the month" - day 31 for January, day 28 for February on non-leap years. If used in the day-of-week field by itself, it simply means "7" or "SAT". But if used in the day-of-week field after another value, it means "the last xxx day of the month" - for example "6L" means "the last Friday of the month". When using the 'L' option, it is important not to specify lists, or ranges of values, as you'll get confusing results.
The '#' character is allowed for the day-of-week field. This character is used to specify "the nth" XX day of the month. For example, the value of "6#3" in the day-of-week field means the third Friday of the month (day 6 = Friday and "#3" = the 3rd one in the month). Other examples: "2#1" = the first Monday of the month and "4#5" = the fifth Wednesday of the month. Note that if you specify "#5" and there is not 5 of the given day-of-week in the month, then no firing will occur that month.
The 'C' character is allowed for the day-of-month and day-of-week fields. This character is short-hand for "calendar". This means values are calculated against the associated calendar, if any. If no calendar is associated, then it is equivalent to having an all-inclusive calendar. A value of "5C" in the day-of-month field means "the first day included by the calendar on or after the 5th". A value of "1C" in the day-of-week field means "the first day included by the calendar on or after Sunday".
The legal characters and the names of months and days of the week are not case sensitive.
Here are some full examples:
Expression | Meaning | |
---|---|---|
"0 0 12 * * ?" |
Fire at 12pm (noon) every day | |
"0 15 10 ? * *" |
Fire at 10:15am every day | |
"0 15 10 * * ?" |
Fire at 10:15am every day | |
"0 15 10 * * ? *" |
Fire at 10:15am every day | |
"0 15 10 * * ? 2005" |
Fire at 10:15am every day during the year 2005 | |
"0 * 14 * * ?" |
Fire every minute starting at 2pm and ending at 2:59pm, every day | |
"0 0/5 14 * * ?" |
Fire every 5 minutes starting at 2pm and ending at 2:55pm, every day | |
"0 0/5 14,18 * * ?" |
Fire every 5 minutes starting at 2pm and ending at 2:55pm, AND fire every 5 minutes starting at 6pm and ending at 6:55pm, every day | |
"0 0-5 14 * * ?" |
Fire every minute starting at 2pm and ending at 2:05pm, every day | |
"0 10,44 14 ? 3 WED" |
Fire at 2:10pm and at 2:44pm every Wednesday in the month of March. | |
"0 15 10 ? * MON-FRI" |
Fire at 10:15am every Monday, Tuesday, Wednesday, Thursday and Friday | |
"0 15 10 15 * ?" |
Fire at 10:15am on the 15th day of every month | |
"0 15 10 L * ?" |
Fire at 10:15am on the last day of every month | |
"0 15 10 ? * 6L" |
Fire at 10:15am on the last Friday of every month | |
"0 15 10 ? * 6L" |
Fire at 10:15am on the last Friday of every month | |
"0 15 10 ? * 6L 2002-2005" |
Fire at 10:15am on every last friday of every month during the years 2002, 2003, 2004 and 2005 | |
"0 15 10 ? * 6#3" |
Fire at 10:15am on the third Friday of every month |
Pay attention to the effects of '?' and '*' in the day-of-week and day-of-month fields!
-
Field Summary
Fields inherited from class org.frankframework.core.TransactionAttributes
log
Fields inherited from interface org.springframework.context.SmartLifecycle
DEFAULT_PHASE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
Called before executeJob to prepare resources for executeJob method.void
Configure this component.void
protected abstract void
execute()
Is wrapped around aLocker
andexceptions
will be managed automatically.final void
Called fromConfiguredJob
which should trigger this job definition.protected final IbisManager
final org.quartz.JobDetail
boolean
final boolean
void
setCronExpression
(String cronExpression) CRON expression that determines the frequency of execution.void
setDescription
(String description) Description of the jobvoid
setInterval
(long interval) Triggers the Job at the specified number of milliseconds.void
setJobGroup
(String jobGroup) Group in which to sort multiple jobs.void
Optional element to avoid parallel execution of the Job, by multiple threads or servers.void
setMessageKeeperSize
(int size) Number of messages displayed in ibisconsolevoid
Name of the jobvoid
setNumThreads
(int newNumThreads) Number of threads that may execute concurrentlyfinal void
start()
final void
stop()
toString()
Methods inherited from class org.frankframework.core.TransactionAttributes
configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.springframework.context.ApplicationContextAware
setApplicationContext
Methods inherited from interface org.frankframework.lifecycle.ConfigurableLifecycle
getPhase, isAutoStartup
Methods inherited from interface org.frankframework.core.HasApplicationContext
getApplicationContext, getConfigurationClassLoader
Methods inherited from interface org.frankframework.core.HasTransactionAttribute
getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute
Methods inherited from interface org.frankframework.scheduler.job.IJob
getCronExpression, getInterval, getJobGroup, getLocker, getName, isConfigured
Methods inherited from interface org.springframework.context.SmartLifecycle
stop
-
Constructor Details
-
AbstractJobDef
public AbstractJobDef()
-
-
Method Details
-
configure
Description copied from interface:IConfigurable
Configure this component.configure()
is called once at startup of the framework in the configure method of the owner of thisIConfigurable
. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in theconfigure()
, to improve performance.In the case of a container, this will propagate the configure signal to all components that apply.
- Specified by:
configure
in interfaceIConfigurable
- Overrides:
configure
in classTransactionAttributes
- Throws:
ConfigurationException
- in case it was not able to configure the component.
-
start
public final void start()- Specified by:
start
in interfaceorg.springframework.context.Lifecycle
-
isRunning
public final boolean isRunning()- Specified by:
isRunning
in interfaceorg.springframework.context.Lifecycle
-
stop
public final void stop()- Specified by:
stop
in interfaceorg.springframework.context.Lifecycle
-
getJobDetail
public final org.quartz.JobDetail getJobDetail()- Specified by:
getJobDetail
in interfaceIJob
-
incrementCountThreads
public boolean incrementCountThreads() -
decrementCountThreads
public void decrementCountThreads() -
beforeExecuteJob
public boolean beforeExecuteJob()Called before executeJob to prepare resources for executeJob method. Returns false if job does not need to run -
executeJob
public final void executeJob()Called fromConfiguredJob
which should trigger this job definition.- Specified by:
executeJob
in interfaceIJob
-
execute
Is wrapped around aLocker
andexceptions
will be managed automatically.- Throws:
TimeoutException
- when the TransactionTimeout has been reachedJobExecutionException
- when the implementation fails to execute
-
getIbisManager
-
toString
-
setJobGroup
Group in which to sort multiple jobs.- Default value
- Name of the Configuration this job has been specified in.
-
setName
Name of the job -
setDescription
Description of the job -
setCronExpression
Description copied from interface:IJob
CRON expression that determines the frequency of execution. Can not be used in combination with Interval.- Specified by:
setCronExpression
in interfaceIJob
-
setInterval
public void setInterval(long interval) Description copied from interface:IJob
Triggers the Job at the specified number of milliseconds. Keep cronExpression empty in order to use interval. Value0
may be used to run once at startup of the application. A value of 0 in combination with function 'sendMessage' will set dependencyTimeout on the IbisLocalSender to -1 to keep waiting indefinitely instead of 60 seconds for the adapter to start.- Specified by:
setInterval
in interfaceIJob
-
setLocker
Description copied from interface:IJob
Optional element to avoid parallel execution of the Job, by multiple threads or servers. The Job is NOT executed when the lock cannot be obtained! In case another thread, potentially on another server, holds the lock and does not release it in a timely manner, it will not trigger the job. -
setNumThreads
public void setNumThreads(int newNumThreads) Number of threads that may execute concurrently- Default value
- 1
-
getMessageKeeper
- Specified by:
getMessageKeeper
in interfaceIJob
-
setMessageKeeperSize
public void setMessageKeeperSize(int size) Number of messages displayed in ibisconsole- Default value
- 10
-