org.mule.runtime.api.source

Interface SchedulerMessageSource

All Superinterfaces:

Startable, Stoppable

@NoImplement
public interface SchedulerMessageSource
extends Stoppable, Startable

Scheduler message source interface.

A scheduler source can be stopped or started at any time. Calling stop while the scheduler is stopped or calling start while the scheduler is started won't have any effect. Method isStarted can be used to know if the scheduler message source is running or not.

A scheduler can be manually triggered using the trigger method. Clients of this interface that want to redefine the scheduling of the flow execution can stop the scheduler message source and call the trigger method whenever the want.

Calling stop method over a source will not affect any ongoing transaction.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static ComponentIdentifier	SCHEDULER_MESSAGE_SOURCE_IDENTIFIER ComponentIdentifier of an scheduler message source.

Fields inherited from interface org.mule.runtime.api.lifecycle.Stoppable

PHASE_NAME

Fields inherited from interface org.mule.runtime.api.lifecycle.Startable

PHASE_NAME

Method Summary

Modifier and Type	Method and Description
SchedulerConfiguration	getConfiguration()
boolean	isStarted()
void	trigger() Triggers the execution of the flow where the scheduler message source is located.

Methods inherited from interface org.mule.runtime.api.lifecycle.Stoppable

stop

Methods inherited from interface org.mule.runtime.api.lifecycle.Startable

start

Field Detail

SCHEDULER_MESSAGE_SOURCE_IDENTIFIER

static final ComponentIdentifier SCHEDULER_MESSAGE_SOURCE_IDENTIFIER

ComponentIdentifier of an scheduler message source.

Method Detail

trigger

void trigger()

Triggers the execution of the flow where the scheduler message source is located.

isStarted

boolean isStarted()

Returns:

true if the scheduler message source is running which means that the configured scheduling will run the flow according to it's configuration, false if the scheduler is not running.

getConfiguration

SchedulerConfiguration getConfiguration()

Returns:

the source scheduler configuration.