com.exalead.mercury.mami.master.v10

Class TriggerConfig

java.lang.Object

com.exalead.mercury.mami.master.v10.TriggerConfig

All Implemented Interfaces:

com.exalead.util.Checkable, java.io.Serializable

Direct Known Subclasses:

CronTriggerConfig, SimpleTriggerConfig

public abstract class TriggerConfig
extends java.lang.Object
implements com.exalead.util.Checkable, java.io.Serializable

Base class for a trigger.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	calendarName
long	endTime
java.lang.String	jobGroupName
java.lang.String	jobName
java.lang.String	misfireInstruction
java.lang.String	name
long	startTime

Constructor Summary

Constructors

Constructor and Description
TriggerConfig()
TriggerConfig(TriggerConfig o) Copy constructor

Method Summary

Modifier and Type	Method and Description
void	check(boolean deep, java.lang.String errorContext) Checks this TriggerConfig.
static TriggerConfig	fromString(java.lang.String s) String representation of this TriggerConfig.
java.lang.String	getCalendarName() Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers
long	getEndTime() End date for this trigger.
java.lang.String	getJobGroupName() Job group for this trigger.
java.lang.String	getJobName() Job name for this trigger.
java.lang.String	getMisfireInstruction() Action to execute when the trigger couldn't be fired.
java.lang.String	getName() Name of the trigger.
long	getStartTime() Start date for this trigger.
TriggerConfig	makeCopy()
static TriggerConfig	readFrom(java.io.InputStream is) Read this TriggerConfig from an XML fragment.
void	setCalendarName(java.lang.String calendarName) Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers
void	setEndTime(long endTime) End date for this trigger.
void	setJobGroupName(java.lang.String jobGroupName) Job group for this trigger.
void	setJobName(java.lang.String jobName) Job name for this trigger.
void	setMisfireInstruction(java.lang.String misfireInstruction) Action to execute when the trigger couldn't be fired.
void	setName(java.lang.String name) Name of the trigger.
void	setStartTime(long startTime) Start date for this trigger.
java.lang.String	toString() String representation of this TriggerConfig.
TriggerConfig	withCalendarName(java.lang.String calendarName)
TriggerConfig	withEndTime(long endTime)
TriggerConfig	withEndTime(java.lang.Long endTime)
TriggerConfig	withJobGroupName(java.lang.String jobGroupName)
TriggerConfig	withJobName(java.lang.String jobName)
TriggerConfig	withMisfireInstruction(java.lang.String misfireInstruction)
TriggerConfig	withName(java.lang.String name)
TriggerConfig	withStartTime(long startTime)
TriggerConfig	withStartTime(java.lang.Long startTime)
void	writeTo(java.io.OutputStream os)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

startTime

public long startTime

endTime

public long endTime

jobGroupName

public java.lang.String jobGroupName

jobName

public java.lang.String jobName

calendarName

public java.lang.String calendarName

misfireInstruction

public java.lang.String misfireInstruction

Constructor Detail

TriggerConfig

public TriggerConfig()

TriggerConfig

public TriggerConfig(TriggerConfig o)

Copy constructor

Method Detail

setName

public void setName(java.lang.String name)

Name of the trigger.

getName

public java.lang.String getName()

Name of the trigger.

withName

public TriggerConfig withName(java.lang.String name)

setStartTime

public void setStartTime(long startTime)

Start date for this trigger.

getStartTime

public long getStartTime()

Start date for this trigger.

withStartTime

public TriggerConfig withStartTime(long startTime)

withStartTime

public TriggerConfig withStartTime(java.lang.Long startTime)

setEndTime

public void setEndTime(long endTime)

End date for this trigger.

getEndTime

public long getEndTime()

End date for this trigger.

withEndTime

public TriggerConfig withEndTime(long endTime)

withEndTime

public TriggerConfig withEndTime(java.lang.Long endTime)

setJobGroupName

public void setJobGroupName(java.lang.String jobGroupName)

Job group for this trigger.

getJobGroupName

public java.lang.String getJobGroupName()

Job group for this trigger.

withJobGroupName

public TriggerConfig withJobGroupName(java.lang.String jobGroupName)

setJobName

public void setJobName(java.lang.String jobName)

Job name for this trigger.

getJobName

public java.lang.String getJobName()

Job name for this trigger.

withJobName

public TriggerConfig withJobName(java.lang.String jobName)

setCalendarName

public void setCalendarName(java.lang.String calendarName)

Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers

getCalendarName

public java.lang.String getCalendarName()

Optional calendar name for this trigger (to exclude blocks of time), only applies to simple triggers

withCalendarName

public TriggerConfig withCalendarName(java.lang.String calendarName)

setMisfireInstruction

public void setMisfireInstruction(java.lang.String misfireInstruction)

Action to execute when the trigger couldn't be fired.

getMisfireInstruction

public java.lang.String getMisfireInstruction()

Action to execute when the trigger couldn't be fired.

withMisfireInstruction

public TriggerConfig withMisfireInstruction(java.lang.String misfireInstruction)

makeCopy

public TriggerConfig makeCopy()

readFrom

public static TriggerConfig readFrom(java.io.InputStream is)
                              throws javax.xml.bind.JAXBException

Read this TriggerConfig from an XML fragment.

Throws:

javax.xml.bind.JAXBException

writeTo

public void writeTo(java.io.OutputStream os)
             throws javax.xml.bind.JAXBException,
                    java.io.IOException

Throws:

javax.xml.bind.JAXBException

java.io.IOException

fromString

public static TriggerConfig fromString(java.lang.String s)
                                throws javax.xml.bind.JAXBException,
                                       java.io.UnsupportedEncodingException

String representation of this TriggerConfig.

Throws:

javax.xml.bind.JAXBException

java.io.UnsupportedEncodingException

toString

public java.lang.String toString()

String representation of this TriggerConfig.

Overrides:

toString in class java.lang.Object

check

public void check(boolean deep,
                  java.lang.String errorContext)
           throws com.exalead.util.TypedException

Checks this TriggerConfig.

Specified by:

check in interface com.exalead.util.Checkable

Throws:

com.exalead.util.TypedException