Package org.keycloak.timer.basic

Class BasicTimerProvider

java.lang.Object

org.keycloak.timer.basic.BasicTimerProvider

All Implemented Interfaces:

Provider, TimerProvider

public class BasicTimerProvider
extends Object
implements TimerProvider

Author:

Stian Thorgersen

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.timer.TimerProvider

TimerProvider.TimerTaskContext

Constructor Summary

Constructors

Constructor	Description
BasicTimerProvider(KeycloakSession session, Timer timer, int transactionTimeout, BasicTimerProviderFactory factory)

Method Summary

Modifier and Type	Method	Description
TimerProvider.TimerTaskContext	cancelTask(String taskName)	Cancel task and return the details about it, so it can be eventually restored later
void	close()
Map<String,TimerProvider.TimerTaskContext>	getTasks()
void	schedule(Runnable runnable, long initialDelayMillis, long intervalMillis, String taskName)	Schedule a task with an initial delay that differs from the interval.
void	schedule(Runnable runnable, long intervalMillis, String taskName)
void	scheduleTask(ScheduledTask scheduledTask, long intervalMillis, String taskName)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.keycloak.timer.TimerProvider

schedule, schedule, scheduleTask

Constructor Details

BasicTimerProvider

public BasicTimerProvider(KeycloakSession session,
 Timer timer,
 int transactionTimeout,
 BasicTimerProviderFactory factory)

Method Details

schedule

public void schedule(Runnable runnable,
 long intervalMillis,
 String taskName)

Specified by:

schedule in interface TimerProvider

schedule

public void schedule(Runnable runnable,
 long initialDelayMillis,
 long intervalMillis,
 String taskName)

Description copied from interface: TimerProvider

Schedule a task with an initial delay that differs from the interval.

Specified by:

schedule in interface TimerProvider

Parameters:

runnable - the task to run

initialDelayMillis - delay before the first execution

intervalMillis - interval between subsequent executions

taskName - unique name for the task

scheduleTask

public void scheduleTask(ScheduledTask scheduledTask,
 long intervalMillis,
 String taskName)

Specified by:

scheduleTask in interface TimerProvider

cancelTask

public TimerProvider.TimerTaskContext cancelTask(String taskName)

Description copied from interface: TimerProvider

Cancel task and return the details about it, so it can be eventually restored later

Specified by:

cancelTask in interface TimerProvider

Returns:

existing task or null if task under this name doesn't exist

close

public void close()

Specified by:

close in interface Provider

getTasks

public Map<String,TimerProvider.TimerTaskContext> getTasks()

Specified by:

getTasks in interface TimerProvider