Package org.apache.activemq.artemis.core.server

Class ActiveMQScheduledComponent

java.lang.Object

org.apache.activemq.artemis.core.server.ActiveMQScheduledComponent

All Implemented Interfaces:

Runnable, ActiveMQComponent

Direct Known Subclasses:

NetworkHealthCheck

public abstract class ActiveMQScheduledComponent
extends Object
implements ActiveMQComponent, Runnable

This is for components with a scheduled at a fixed rate.

Field Summary

Fields

Modifier and Type	Field	Description
protected Executor	executor
protected ScheduledExecutorService	scheduledExecutorService

Constructor Summary

Constructors

Constructor	Description
ActiveMQScheduledComponent(long initialDelay, long checkPeriod, TimeUnit timeUnit, boolean onDemand)	It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.
ActiveMQScheduledComponent(long checkPeriod, TimeUnit timeUnit, boolean onDemand)	It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.
ActiveMQScheduledComponent(ScheduledExecutorService scheduledExecutorService, long initialDelay, long checkPeriod, TimeUnit timeUnit, boolean onDemand)	It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.
ActiveMQScheduledComponent(ScheduledExecutorService scheduledExecutorService, Executor executor, long initialDelay, long checkPeriod, TimeUnit timeUnit, boolean onDemand)	It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.
ActiveMQScheduledComponent(ScheduledExecutorService scheduledExecutorService, Executor executor, long checkPeriod, TimeUnit timeUnit, boolean onDemand)	It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.

Method Summary

Modifier and Type	Method	Description
boolean	delay()	A delay request can succeed only if: there is no other pending delay request there is no pending execution request
long	getInitialDelay()
long	getPeriod()
protected ActiveMQThreadFactory	getThreadFactory()
TimeUnit	getTimeUnit()
boolean	isStarted()
ActiveMQScheduledComponent	setInitialDelay(long initialDelay)
ActiveMQScheduledComponent	setInitialDelayAndPeriod(long initialDelay, long period)	Useful to change a running schedule and avoid multiple restarts.
ActiveMQScheduledComponent	setInitialDelayAndPeriod(long initialDelay, long period, TimeUnit timeUnit)	Useful to change a running schedule and avoid multiple restarts.
ActiveMQScheduledComponent	setPeriod(long period)
ActiveMQScheduledComponent	setPeriod(long period, TimeUnit unit)
ActiveMQScheduledComponent	setTimeUnit(TimeUnit timeUnit)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.activemq.artemis.core.server.ActiveMQComponent

asyncStop

Methods inherited from interface java.lang.Runnable

run

Field Detail

scheduledExecutorService

protected ScheduledExecutorService scheduledExecutorService

executor

protected final Executor executor

Constructor Detail

ActiveMQScheduledComponent

public ActiveMQScheduledComponent(ScheduledExecutorService scheduledExecutorService,
                                  Executor executor,
                                  long initialDelay,
                                  long checkPeriod,
                                  TimeUnit timeUnit,
                                  boolean onDemand)

It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.

Parameters:

scheduledExecutorService - the ScheduledExecutorService that periodically trigger Runnable.run() on the configured executor

executor - the Executor that execute Runnable.run() when triggered

initialDelay - the time to delay first execution

checkPeriod - the delay between the termination of one execution and the start of the next

timeUnit - the time unit of the initialDelay and checkPeriod parameters

onDemand - if true the task won't be scheduled on start(), false otherwise

ActiveMQScheduledComponent

public ActiveMQScheduledComponent(ScheduledExecutorService scheduledExecutorService,
                                  long initialDelay,
                                  long checkPeriod,
                                  TimeUnit timeUnit,
                                  boolean onDemand)

It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.

Parameters:

scheduledExecutorService - the ScheduledExecutorService that periodically trigger Runnable.run() on the configured executor

initialDelay - the time to delay first execution

checkPeriod - the delay between the termination of one execution and the start of the next

timeUnit - the time unit of the initialDelay and checkPeriod parameters

onDemand - if true the task won't be scheduled on start(), false otherwise

ActiveMQScheduledComponent

public ActiveMQScheduledComponent(ScheduledExecutorService scheduledExecutorService,
                                  Executor executor,
                                  long checkPeriod,
                                  TimeUnit timeUnit,
                                  boolean onDemand)

It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.

The component created will have initialDelay defaulted to checkPeriod.

Parameters:

scheduledExecutorService - the ScheduledExecutorService that periodically trigger Runnable.run() on the configured executor

executor - the Executor that execute Runnable.run() when triggered

checkPeriod - the delay between the termination of one execution and the start of the next

timeUnit - the time unit of the initialDelay and checkPeriod parameters

onDemand - if true the task won't be scheduled on start(), false otherwise

ActiveMQScheduledComponent

public ActiveMQScheduledComponent(long initialDelay,
                                  long checkPeriod,
                                  TimeUnit timeUnit,
                                  boolean onDemand)

It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.

This is useful for cases where we want our own scheduler executor: on start() it will create a fresh new single-threaded ScheduledExecutorService using getThreadFactory() and getThisClassLoader(), while on stop() it will garbage it.

Parameters:

initialDelay - the time to delay first execution

checkPeriod - the delay between the termination of one execution and the start of the next

timeUnit - the time unit of the initialDelay and checkPeriod parameters

onDemand - if true the task won't be scheduled on start(), false otherwise

ActiveMQScheduledComponent

public ActiveMQScheduledComponent(long checkPeriod,
                                  TimeUnit timeUnit,
                                  boolean onDemand)

It creates a scheduled component that can trigger Runnable.run() with a fixed checkPeriod on a configured executor.

This is useful for cases where we want our own scheduler executor. The component created will have initialDelay defaulted to checkPeriod.

Parameters:

checkPeriod - the delay between the termination of one execution and the start of the next

timeUnit - the time unit of the initialDelay and checkPeriod parameters

onDemand - if true the task won't be scheduled on start(), false otherwise

Method Detail

start

public void start()

Specified by:

start in interface ActiveMQComponent

getThreadFactory

protected ActiveMQThreadFactory getThreadFactory()

delay

public boolean delay()

A delay request can succeed only if:

• there is no other pending delay request
• there is no pending execution request

When a delay request succeed it schedule a new execution to happen in getPeriod().

getPeriod

public long getPeriod()

setPeriod

public ActiveMQScheduledComponent setPeriod(long period)

setPeriod

public ActiveMQScheduledComponent setPeriod(long period,
                                            TimeUnit unit)

getInitialDelay

public long getInitialDelay()

setInitialDelay

public ActiveMQScheduledComponent setInitialDelay(long initialDelay)

setInitialDelayAndPeriod

public ActiveMQScheduledComponent setInitialDelayAndPeriod(long initialDelay,
                                                           long period)

Useful to change a running schedule and avoid multiple restarts.

setInitialDelayAndPeriod

public ActiveMQScheduledComponent setInitialDelayAndPeriod(long initialDelay,
                                                           long period,
                                                           TimeUnit timeUnit)

Useful to change a running schedule and avoid multiple restarts.

getTimeUnit

public TimeUnit getTimeUnit()

setTimeUnit

public ActiveMQScheduledComponent setTimeUnit(TimeUnit timeUnit)

stop

public void stop()

Specified by:

stop in interface ActiveMQComponent

isStarted

public boolean isStarted()

Specified by:

isStarted in interface ActiveMQComponent