CmsScheduledJobInfo (opencms-core 9.0.0 API)

java.lang.Object
- org.opencms.scheduler.CmsScheduledJobInfo

All Implemented Interfaces:: I_CmsConfigurationParameterHandler

public class CmsScheduledJobInfo
extends java.lang.Object
implements I_CmsConfigurationParameterHandler

Describes a scheduled job for the OpenCms scheduler.

The time the scheduled job is executed is defined with Unix 'cron-like' definitions.

For those unfamiliar with "cron", this means being able to create a firing schedule such as: "At 8:00am every Monday through Friday" or "At 1:30am every last Friday of the month".

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 'W' character is allowed for the day-of-month field. This character is used to specify the weekday (Monday-Friday) nearest the given day. As an example, if you were to specify "15W" as the value for the day-of-month field, the meaning is: "the nearest weekday to the 15th of the month". So if the 15th is a Saturday, the trigger will fire on Friday the 14th. If the 15th is a Sunday, the trigger will fire on Monday the 16th. If the 15th is a Tuesday, then it will fire on Tuesday the 15th. However if you specify "1W" as the value for day-of-month, and the 1st is a Saturday, the trigger will fire on Monday the 3rd, as it will not 'jump' over the boundary of a month's days. The 'W' character can only be specified when the day-of-month is a single day, not a range or list of days.

The 'L' and 'W' characters can also be combined for the day-of-month expression to yield 'LW', which translates to "last weekday of the month".

The '#' character is allowed for the day-of-week field. This character is used to specify "the nth" XXX 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!

NOTES:

Support for the features described for the 'C' character is not complete.
Support for specifying both a day-of-week and a day-of-month value is not complete (you'll need to use the '?' character in on of these fields).
Be careful when setting fire times between mid-night and 1:00 AM - "daylight savings" can cause a skip or a repeat depending on whether the time moves back or jumps forward.

Since:: 6.0.0

Field Summary
- Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler
  ADD_PARAMETER_METHOD, INIT_CONFIGURATION_METHOD

Constructor Summary

Constructors
Constructor and Description
`CmsScheduledJobInfo()` Default constructor.
`CmsScheduledJobInfo(java.lang.String id, java.lang.String jobName, java.lang.String className, CmsContextInfo context, java.lang.String cronExpression, boolean reuseInstance, boolean active, java.util.SortedMap<java.lang.String,java.lang.String> parameters)` Constructor for creating a new job with all required parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addConfigurationParameter(java.lang.String paramName, java.lang.String paramValue)` Adds a configuration parameter to this parameter configurable class instance.
`protected void`	`checkFrozen()` Checks if this job info configuration is frozen.
`void`	`clearId()` Clears the id of the job.
`java.lang.Object`	`clone()` Creates a clone of this scheduled job.
`java.lang.String`	`getClassName()` Returns the name of the class to schedule.
`CmsParameterConfiguration`	`getConfiguration()` Returns the parameters of this configurable class instance, or `null` if the class does not need any parameters.
`CmsContextInfo`	`getContextInfo()` Returns the context information for the user executing this job.
`java.lang.String`	`getCronExpression()` Returns the cron expression for this job entry.
`java.util.Date`	`getExecutionTimeAfter(java.util.Date date)` Returns the next time at which this job will be executed, after the given time.
`java.util.Date`	`getExecutionTimeNext()` Returns the next time at which this job will be executed.
`java.util.Date`	`getExecutionTimePrevious()` Returns the previous time at which this job will be executed.
`java.lang.String`	`getId()` Returns the internal id of this job in the scheduler.
`I_CmsScheduledJob`	`getJobInstance()` Returns an instance of the configured job class.
`java.lang.String`	`getJobName()` Returns the job name.
`java.util.SortedMap<java.lang.String,java.lang.String>`	`getParameters()` Returns the parameters.
`protected org.quartz.Trigger`	`getTrigger()` Returns the Quartz trigger used for scheduling this job.
`void`	`initConfiguration()` Finalizes (freezes) the configuration of this scheduler job entry.
`boolean`	`isActive()` Returns `true` if this job is currently active in the scheduler.
`boolean`	`isReuseInstance()` Returns true if the job instance class is reused for this job.
`void`	`setActive(boolean active)` Sets the active state of this job.
`void`	`setClassName(java.lang.String className)` Sets the name of the class to schedule.
`void`	`setContextInfo(CmsContextInfo contextInfo)` Sets the context information for the user executing the job.
`void`	`setCronExpression(java.lang.String cronExpression)` Sets the cron expression for this job entry.
`protected void`	`setFrozen(boolean frozen)` Sets the "frozen" state of this job.
`protected void`	`setId(java.lang.String id)` Sets the is used for scheduling this job.
`void`	`setJobName(java.lang.String jobName)` Sets the job name.
`void`	`setParameters(java.util.SortedMap<java.lang.String,java.lang.String> parameters)` Sets the job parameters.
`void`	`setReuseInstance(boolean reuseInstance)` Controls if the job instance class is reused for this job, of if a new instance is generated every time the job is run.
`protected void`	`setTrigger(org.quartz.Trigger trigger)` Sets the Quartz trigger used for scheduling this job.
`protected void`	`updateContextRequestTime()` Updates the request time in the internal context information of the user with the current system time.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CmsScheduledJobInfo
```
public CmsScheduledJobInfo()
```
    Default constructor.
  - CmsScheduledJobInfo
```
public CmsScheduledJobInfo(java.lang.String id,
                   java.lang.String jobName,
                   java.lang.String className,
                   CmsContextInfo context,
                   java.lang.String cronExpression,
                   boolean reuseInstance,
                   boolean active,
                   java.util.SortedMap<java.lang.String,java.lang.String> parameters)
```
    Constructor for creating a new job with all required parameters.
    
    Parameters:
    id - the id of the job of null if a new id should be automatically generated
    jobName - the display name of the job
    className - the class name of the job, must be an instance of I_CmsScheduledJob
    context - the OpenCms user context information to use when executing the job
    cronExpression - the cron expression for scheduling the job
    reuseInstance - indicates if the job class should be re-used
    active - indicates if the job should be active in the scheduler
    parameters - the job parameters
- Method Detail
  - addConfigurationParameter
```
public void addConfigurationParameter(java.lang.String paramName,
                             java.lang.String paramValue)
```
    Description copied from interface: I_CmsConfigurationParameterHandler
    
    Adds a configuration parameter to this parameter configurable class instance.
    
    Specified by:
    
    addConfigurationParameter in interface I_CmsConfigurationParameterHandler
    
    Parameters:
    paramName - the name of the parameter
    paramValue - the value for the parameter
    See Also:
    I_CmsConfigurationParameterHandler.addConfigurationParameter(java.lang.String, java.lang.String)
  - clearId
```
public void clearId()
```
    Clears the id of the job.
    This is useful if you want to create a copy of a job without keeping the job id. Use clone() first to create the copy, and then clear the id of the clone.
  - clone
```
public java.lang.Object clone()
```
    Creates a clone of this scheduled job.
    The clone will not be active in the scheduler until it is scheduled with CmsScheduleManager.scheduleJob(org.opencms.file.CmsObject, CmsScheduledJobInfo). The job id returned by getId() will be the same. The isActive() flag will be set to false. The clones job instance class will be the same if the isReuseInstance() flag is set.
    
    Overrides:
    
    clone in class java.lang.Object
    
    See Also:
    Object.clone()
  - getClassName
```
public java.lang.String getClassName()
```
    Returns the name of the class to schedule.
    
    Returns:
    the name of the class to schedule
  - getConfiguration
```
public CmsParameterConfiguration getConfiguration()
```
    Description copied from interface: I_CmsConfigurationParameterHandler
    
    Returns the parameters of this configurable class instance, or null if the class does not need any parameters.
    
    Specified by:
    
    getConfiguration in interface I_CmsConfigurationParameterHandler
    
    Returns:
    the parameters of this configurable class instance, or null if the class does not need any parameters
    See Also:
    I_CmsConfigurationParameterHandler.getConfiguration()
  - getContextInfo
```
public CmsContextInfo getContextInfo()
```
    Returns the context information for the user executing this job.
    Please note: The context time returned by CmsRequestContext.getRequestTime() will be set to the time when this job was created. This can be relevant in case you want to perform VFS operations, because it will affect how resources are processed that have date released / date expired attributes set.
    
    Returns:
    the context information for the user executing this job
  - getCronExpression
```
public java.lang.String getCronExpression()
```
    Returns the cron expression for this job entry.
    
    Returns:
    the cron expression for this job entry
  - getExecutionTimeAfter
```
public java.util.Date getExecutionTimeAfter(java.util.Date date)
```
    Returns the next time at which this job will be executed, after the given time.
    If this job will not be executed after the given time, null will be returned..
    
    Parameters:
    date - the after which the next execution time should be calculated
    
    Returns:
    the next time at which this job will be executed, after the given time
  - getExecutionTimeNext
```
public java.util.Date getExecutionTimeNext()
```
    Returns the next time at which this job will be executed.
    If the job will not execute again, null will be returned.
    
    Returns:
    the next time at which this job will be executed
  - getExecutionTimePrevious
```
public java.util.Date getExecutionTimePrevious()
```
    Returns the previous time at which this job will be executed.
    If this job has not yet been executed, null will be returned.
    
    Returns:
    the previous time at which this job will be executed
  - getId
```
public java.lang.String getId()
```
    Returns the internal id of this job in the scheduler.
    Can be used to remove this job from the scheduler with CmsScheduleManager.unscheduleJob(org.opencms.file.CmsObject, String).
    
    Returns:
    the internal id of this job in the scheduler
  - getJobInstance
```
public I_CmsScheduledJob getJobInstance()
```
    Returns an instance of the configured job class.
    If any error occurs during class invocaion, the error is written to the OpenCms log and null is returned.
    
    Returns:
    an instance of the configured job class, or null if an error occurred
  - getJobName
```
public java.lang.String getJobName()
```
    Returns the job name.
    
    Returns:
    the job name
  - getParameters
```
public java.util.SortedMap<java.lang.String,java.lang.String> getParameters()
```
    Returns the parameters.
    
    Returns:
    the parameters
  - initConfiguration
```
public void initConfiguration()
```
    Finalizes (freezes) the configuration of this scheduler job entry.
    After this job entry has been frozen, any attempt to change the configuration of this entry with one of the "set..." methods will lead to a RuntimeException.
    
    Specified by:
    
    initConfiguration in interface I_CmsConfigurationParameterHandler
    
    See Also:
    I_CmsConfigurationParameterHandler.initConfiguration()
  - isActive
```
public boolean isActive()
```
    Returns true if this job is currently active in the scheduler.
    
    Returns:
    true if this job is currently active in the scheduler
  - isReuseInstance
```
public boolean isReuseInstance()
```
    Returns true if the job instance class is reused for this job.
    
    Returns:
    true if the job instance class is reused for this job
  - setActive
```
public void setActive(boolean active)
```
    Sets the active state of this job.
    
    Parameters:
    active - the active state to set
  - setClassName
```
public void setClassName(java.lang.String className)
```
    Sets the name of the class to schedule.
    
    Parameters:
    className - the class name to set
  - setContextInfo
```
public void setContextInfo(CmsContextInfo contextInfo)
```
    Sets the context information for the user executing the job.
    This will also "freeze" the context information that is set.
    
    Parameters:
    contextInfo - the context information for the user executing the job
    See Also:
    CmsContextInfo.freeze()
  - setCronExpression
```
public void setCronExpression(java.lang.String cronExpression)
```
    Sets the cron expression for this job entry.
    
    Parameters:
    cronExpression - the cron expression to set
  - setJobName
```
public void setJobName(java.lang.String jobName)
```
    Sets the job name.
    
    Parameters:
    jobName - the job name to set
  - setParameters
```
public void setParameters(java.util.SortedMap<java.lang.String,java.lang.String> parameters)
```
    Sets the job parameters.
    
    Parameters:
    parameters - the parameters to set
  - setReuseInstance
```
public void setReuseInstance(boolean reuseInstance)
```
    Controls if the job instance class is reused for this job, of if a new instance is generated every time the job is run.
    
    Parameters:
    reuseInstance - must be true if the job instance class is to be reused
  - checkFrozen
```
protected void checkFrozen()
                    throws CmsRuntimeException
```
    Checks if this job info configuration is frozen.
    
    Throws:
    
    CmsRuntimeException - in case the configuration is already frozen
  - getTrigger
```
protected org.quartz.Trigger getTrigger()
```
    Returns the Quartz trigger used for scheduling this job.
    This is an internal operation that should only by performed by the CmsScheduleManager, never by using this API directly.
    
    Returns:
    the Quartz trigger used for scheduling this job
  - setFrozen
```
protected void setFrozen(boolean frozen)
```
    Sets the "frozen" state of this job.
    This is an internal operation to be used only by the CmsScheduleManager.
    
    Parameters:
    frozen - the "frozen" state to set
  - setId
```
protected void setId(java.lang.String id)
```
    Sets the is used for scheduling this job.
    This is an internal operation that should only by performed by the CmsScheduleManager, never by using this API directly.
    
    Parameters:
    id - the id to set
  - setTrigger
```
protected void setTrigger(org.quartz.Trigger trigger)
```
    Sets the Quartz trigger used for scheduling this job.
    This is an internal operation that should only by performed by the CmsScheduleManager, never by using this API directly.
    
    Parameters:
    trigger - the Quartz trigger to set
  - updateContextRequestTime
```
protected void updateContextRequestTime()
```
    Updates the request time in the internal context information of the user with the current system time.
    This is required before executing the job, otherwise the context information request time would be the time the context object was initially created.

Class CmsScheduledJobInfo

Field Summary

Fields inherited from interface org.opencms.configuration.I_CmsConfigurationParameterHandler

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CmsScheduledJobInfo

CmsScheduledJobInfo

Method Detail

addConfigurationParameter

clearId

clone

getClassName

getConfiguration

getContextInfo

getCronExpression

getExecutionTimeAfter

getExecutionTimeNext

getExecutionTimePrevious

getId

getJobInstance

getJobName

getParameters

initConfiguration

isActive

isReuseInstance

setActive

setClassName

setContextInfo

setCronExpression

setJobName

setParameters

setReuseInstance

checkFrozen

getTrigger

setFrozen

setId

setTrigger

updateContextRequestTime