org.openmrs.api.context

Class Daemon

java.lang.Object

org.openmrs.api.context.Daemon

Direct Known Subclasses:

WebDaemon

public class Daemon
extends java.lang.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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	Daemon.DaemonThread Thread class used by the startModule(Module) and executeScheduledTask(Task) methods so that the returned object and the exception thrown can be returned to calling class

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	DAEMON_USER_UUID The uuid defined for the daemon user object
protected static java.lang.ThreadLocal<User>	daemonThreadUser
protected static java.lang.ThreadLocal<java.lang.Boolean>	isDaemonThread

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 User	getDaemonThreadUser()
static boolean	isDaemonThread()
static java.lang.Thread	runInDaemonThread(java.lang.Runnable runnable, DaemonToken token) Executes the given runnable in a new thread that is authenticated as the daemon user.
static void	runInDaemonThreadAndWait(java.lang.Runnable runnable, DaemonToken token) Executes the given runnable in a new thread that is authenticated as the daemon user and wait for the thread to finish.
static java.lang.Thread	runInNewDaemonThread(java.lang.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 void	runStartupForService(OpenmrsService service) Calls the OpenmrsService.onStartup() method, as a daemon, for an instance implementing the OpenmrsService interface.
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 java.lang.String DAEMON_USER_UUID

The uuid defined for the daemon user object

See Also:

Constant Field Values

isDaemonThread

protected static final java.lang.ThreadLocal<java.lang.Boolean> isDaemonThread

daemonThreadUser

protected static final java.lang.ThreadLocal<User> daemonThreadUser

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 java.lang.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:

java.lang.Throwable

runInNewDaemonThread

public static java.lang.Thread runInNewDaemonThread(java.lang.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

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)

getDaemonThreadUser

public static User getDaemonThreadUser()

Returns:

the current thread daemon user or null if not assigned

Since:

2.0.0, 1.12.0, 1.11.6, 1.10.4, 1.9.11

runStartupForService

public static void runStartupForService(OpenmrsService service)
                                 throws ModuleException

Calls the OpenmrsService.onStartup() method, as a daemon, for an instance implementing the OpenmrsService interface.

Parameters:

openmrsService - instance implementing the OpenmrsService interface.

Throws:

ModuleException

Since:

1.9

runInDaemonThread

public static java.lang.Thread runInDaemonThread(java.lang.Runnable runnable,
                                                 DaemonToken token)

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

Parameters:

runnable - an object implementing the Runnable interface.

token - the token required to run code as the daemon user

Returns:

the newly spawned Thread

Since:

1.9.2

runInDaemonThreadAndWait

public static void runInDaemonThreadAndWait(java.lang.Runnable runnable,
                                            DaemonToken token)

Executes the given runnable in a new thread that is authenticated as the daemon user and wait for the thread to finish.

Parameters:

runnable - an object implementing the Runnable interface.

token - the token required to run code as the daemon user

Since:

1.9.2