org.openmrs.api.context

Class Daemon

java.lang.Object

org.openmrs.api.context.Daemon

public class Daemon
extends Object

This class allows certain tasks to run with elevated privileges. Primary use is scheduling and module startup when there is no user to authenticate as.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	DAEMON_USER_UUID The uuid defined for the daemon user object

Constructor Summary

Constructors

Constructor and Description
Daemon()

Method Summary

Modifier and Type	Method and Description
static void	executeScheduledTask(Task task) Executes the given task in a new thread that is authenticated as the daemon user.
static boolean	isDaemonThread()
static Thread	runInNewDaemonThread(Runnable runnable) Call this method if you are inside a Daemon thread (for example in a Module activator or a scheduled task) and you want to start up a new parallel Daemon thread.
static Module	startModule(Module module) This method should not be called directly.

Methods inherited from class java.lang.Object

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

Field Detail

DAEMON_USER_UUID

protected static final String DAEMON_USER_UUID

The uuid defined for the daemon user object

See Also:

Constant Field Values

Constructor Detail

Daemon

public Daemon()

Method Detail

startModule

public static Module startModule(Module module)
                          throws ModuleException

This method should not be called directly. The ModuleFactory.startModule(Module) method uses this to start the given module in a new thread that is authenticated as the daemon user

Parameters:

module - the module to start

Throws:

ModuleException

executeScheduledTask

public static void executeScheduledTask(Task task)
                                 throws Throwable

Executes the given task in a new thread that is authenticated as the daemon user.

This can only be called from TimerSchedulerTask during actual task execution

Parameters:

task - the task to run

Throws:

Throwable

Should:

not be called from other methods other than TimerSchedulerTask, not throw error if called from a TimerSchedulerTask class

runInNewDaemonThread

public static Thread runInNewDaemonThread(Runnable runnable)

Call this method if you are inside a Daemon thread (for example in a Module activator or a scheduled task) and you want to start up a new parallel Daemon thread. You may only call this method from a Daemon thread.

Parameters:

runnable - what to run in a new thread

Returns:

the newly spawned Thread

Should:

throw error if called from a non daemon thread, not throw error if called from a daemon thread

isDaemonThread

public static boolean isDaemonThread()

Returns:

true if the current thread was started by this class and so is a daemon thread that has all privileges

See Also:

Context.hasPrivilege(String)