Difference between revisions of "Triggers"

From GreenVulcano Wiki
Jump to: navigation, search
(→‎SimpleTriggerBuilder)
Line 14: Line 14:
  
 
A Trigger that is used to fire a Task at a given moment in time, and optionally repeated at a specified interval.
 
A Trigger that is used to fire a Task at a given moment in time, and optionally repeated at a specified interval.
 +
 +
The following table shows the SimpleTriggerBuilder element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''cron-trigger'''
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.scheduler.util.quartz.impl.trigger.SimpleTriggerBuilder'''
 +
|-
 +
| name || required || Trigger name
 +
|-
 +
| startTime || optional || Trigger starting time in ISO format: yyyy-MM-dd HH:mm:ss
 +
|-
 +
| endTime || optional || Trigger ending time in ISO format: yyyy-MM-dd HH:mm:ss.
 +
If not defined is the server starting time rounded to the next minute.
 +
|-
 +
| repeatInterval || optional || The period of repetition of the trigger, in ms.
 +
If not defined the task is executed only once.
 +
|-
 +
| repeatCount || optional || The number of repetitions of the trigger.
 +
If not defined the task is executed only once.
 +
If 'period' == -1, the task is repeated endlessly (or to 'endTime').
 +
|-
 +
| timeZone || optional || Trigger TimeZone.
 +
If not defined is used the TimeZone defined for DateUtils.
 +
|-
 +
| calendarName || optional || Associate the Calendar with the given name with this Trigger.
 +
|}
 +
 +
Might contain the following sub-elements:
 +
* Description
 +
* [[#TgProperties|TgProperties]]
 +
 +
====TgProperties====
 +
 +
This element defines additional properties of the Trigger.
 +
 +
Might contain the following sub-elements:
 +
* Description
 +
* [[PropertyDef]]
 +
 +
 +
===DateIntervalTriggerBuilder===
 +
 +
This element represents a Trigger that is used to fire a Task based upon repeating calendar time intervals.
 +
 +
 +
The following table shows the DateIntervalTriggerBuilder element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''cron-trigger'''
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.scheduler.util.quartz.impl.trigger.DateIntervalTriggerBuilder'''
 +
|-
 +
| name || required || Trigger name.
 +
|-
 +
| startTime || optional || Trigger starting time in ISO format: yyyy-MM-dd HH:mm:ss
 +
If not defined is the server starting time rounded to the nex minute.
 +
|-
 +
| endTime || optional || Trigger ending time in ISO format: yyyy-MM-dd HH:mm:ss
 +
|-
 +
| repeatIntervalUnit || optional || The period of repetition of the trigger, in time unit.
 +
The attribute admitted values are:
 +
* SECOND
 +
* MINUTE
 +
* HOUR
 +
* DAY
 +
* WEEK
 +
* MONTH
 +
* YEAR
 +
|-
 +
| repeatInterval || optional || The number of repeatIntervalUnit for repetitions of the trigger.
 +
If not defined the default is 1.
 +
|-
 +
| timeZone || optional || Trigger TimeZone.
 +
If not defined is used the TimeZone defined for DateUtils.
 +
|-
 +
| calendarName || optional || Associate the Calendar with the given name with this Trigger.
 +
|}
 +
 +
Might contain the following sub-elements:
 +
* Description
 +
* [[#TgProperties|TgProperties]]
 +
 +
===CronTriggerBuilder===
 +
 +
This element represents a Trigger that is used to fire a Task at given moments in time, defined with Unix ''cron-like'' definitions.
 +
 +
The following table shows the CronTriggerBuilder element's attributes:
 +
{|class="gvtable"
 +
! Attribute !! Type !! Description
 +
|-
 +
| type || fixed || This attribute must assume the value '''cron-trigger'''
 +
|-
 +
| class || fixed || This attribute must assume the value '''it.greenvulcano.scheduler.util.quartz.impl.trigger.CronTriggerBuilder'''
 +
|-
 +
| name || required || Trigger name.
 +
|-
 +
| cronExpression || required || Defines a cron expression.
 +
Reference: [[http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger]]
 +
|-
 +
| startTime || optional || Trigger starting time in ISO format: yyyy-MM-dd HH:mm:ss
 +
If not defined is the server starting time rounded to the nex minute.
 +
|-
 +
| endTime || optional || Trigger ending time in ISO format: yyyy-MM-dd HH:mm:ss
 +
|-
 +
| timeZone || optional || Trigger TimeZone.
 +
If not defined is used the TimeZone defined for DateUtils.
 +
|-
 +
| calendarName || optional || Associate the Calendar with the given name with this Trigger.
 +
|}
 +
 +
Might contain the following sub-elements:
 +
* Description
 +
* [[#TgProperties|TgProperties]]

Revision as of 10:57, 27 February 2012

Description

GreenVulcano® ESB uses this element to define a group of Timer Tasks.

VulCon / GV Console Configuration

The Triggers Element is used by: RSHTask, ServiceCallerTask, ShellTask and TestTask.

Might contain the following subelements:

SimpleTriggerBuilder

A Trigger that is used to fire a Task at a given moment in time, and optionally repeated at a specified interval.

The following table shows the SimpleTriggerBuilder element's attributes:

Attribute Type Description
type fixed This attribute must assume the value cron-trigger
class fixed This attribute must assume the value it.greenvulcano.scheduler.util.quartz.impl.trigger.SimpleTriggerBuilder
name required Trigger name
startTime optional Trigger starting time in ISO format: yyyy-MM-dd HH:mm:ss
endTime optional Trigger ending time in ISO format: yyyy-MM-dd HH:mm:ss.

If not defined is the server starting time rounded to the next minute.

repeatInterval optional The period of repetition of the trigger, in ms.

If not defined the task is executed only once.

repeatCount optional The number of repetitions of the trigger.

If not defined the task is executed only once. If 'period' == -1, the task is repeated endlessly (or to 'endTime').

timeZone optional Trigger TimeZone.

If not defined is used the TimeZone defined for DateUtils.

calendarName optional Associate the Calendar with the given name with this Trigger.

Might contain the following sub-elements:

TgProperties

This element defines additional properties of the Trigger.

Might contain the following sub-elements:


DateIntervalTriggerBuilder

This element represents a Trigger that is used to fire a Task based upon repeating calendar time intervals.


The following table shows the DateIntervalTriggerBuilder element's attributes:

Attribute Type Description
type fixed This attribute must assume the value cron-trigger
class fixed This attribute must assume the value it.greenvulcano.scheduler.util.quartz.impl.trigger.DateIntervalTriggerBuilder
name required Trigger name.
startTime optional Trigger starting time in ISO format: yyyy-MM-dd HH:mm:ss

If not defined is the server starting time rounded to the nex minute.

endTime optional Trigger ending time in ISO format: yyyy-MM-dd HH:mm:ss
repeatIntervalUnit optional The period of repetition of the trigger, in time unit.

The attribute admitted values are:

  • SECOND
  • MINUTE
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • YEAR
repeatInterval optional The number of repeatIntervalUnit for repetitions of the trigger.

If not defined the default is 1.

timeZone optional Trigger TimeZone.

If not defined is used the TimeZone defined for DateUtils.

calendarName optional Associate the Calendar with the given name with this Trigger.

Might contain the following sub-elements:

CronTriggerBuilder

This element represents a Trigger that is used to fire a Task at given moments in time, defined with Unix cron-like definitions.

The following table shows the CronTriggerBuilder element's attributes:

Attribute Type Description
type fixed This attribute must assume the value cron-trigger
class fixed This attribute must assume the value it.greenvulcano.scheduler.util.quartz.impl.trigger.CronTriggerBuilder
name required Trigger name.
cronExpression required Defines a cron expression.

Reference: [[1]]

startTime optional Trigger starting time in ISO format: yyyy-MM-dd HH:mm:ss

If not defined is the server starting time rounded to the nex minute.

endTime optional Trigger ending time in ISO format: yyyy-MM-dd HH:mm:ss
timeZone optional Trigger TimeZone.

If not defined is used the TimeZone defined for DateUtils.

calendarName optional Associate the Calendar with the given name with this Trigger.

Might contain the following sub-elements:

Retrieved from "https://gvwiki.greenvulcano.com/gvwiki/index.php?title=Triggers&oldid=2698"