org.openmrs.api.context

Class Daemon

java.lang.Object

org.openmrs.api.context.Daemon

Direct Known Subclasses:

WebDaemon

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.

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 String	DAEMON_USER_UUID The uuid defined for the daemon user object
protected static ThreadLocal<User>	daemonThreadUser
protected static ThreadLocal<Boolean>	isDaemonThread

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Daemon() Protected constructor to override the default constructor to prevent it from being instantiated.

Method Summary

Modifier and Type	Method and Description
static User	createUser(User user, String password, List<String> roleNames) This method should not be called directly, only ContextDAO.createUser(User, String, List) can legally invoke createUser(User, String, List).
static void	executeScheduledTask(Task task) Executes the given task in a new thread that is authenticated as the daemon user.
static User	getDaemonThreadUser()
static String	getDaemonUserUuid()
static boolean	isDaemonThread()
static boolean	isDaemonUser(User user) Checks whether user is Daemon.
static Thread	runInDaemonThread(Runnable runnable, DaemonToken token) Executes the given runnable in a new thread that is authenticated as the daemon user.
static void	runInDaemonThreadAndWait(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 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 void	runStartupForService(OpenmrsService service) Calls the OpenmrsService.onStartup() method, as a daemon, for an instance implementing the OpenmrsService interface.
static Module	startModule(Module module)
static Module	startModule(Module module, boolean isOpenmrsStartup, org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext) 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

isDaemonThread

protected static final ThreadLocal<Boolean> isDaemonThread

daemonThreadUser

protected static final ThreadLocal<User> daemonThreadUser

Constructor Detail

Daemon

protected Daemon()

Protected constructor to override the default constructor to prevent it from being instantiated.

Method Detail

startModule

public static Module startModule(Module module)
                          throws ModuleException

Throws:

ModuleException

See Also:

startModule(Module, boolean, AbstractRefreshableApplicationContext)

startModule

public static Module startModule(Module module,
                                 boolean isOpenmrsStartup,
                                 org.springframework.context.support.AbstractRefreshableApplicationContext applicationContext)
                          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.
If a non null application context is passed in, it gets refreshed to make the module's services available

Parameters:

module - the module to start

isOpenmrsStartup - Specifies whether this module is being started at application startup or not

applicationContext - the spring application context instance to refresh

Returns:

the module returned from ModuleFactory.startModuleInternal(Module)

Throws:

ModuleException

createUser

public static User createUser(User user,
                              String password,
                              List<String> roleNames)
                       throws Exception

This method should not be called directly, only ContextDAO.createUser(User, String, List) can legally invoke createUser(User, String, List).

Parameters:

user - A new user to be created.

password - The password to set for the new user.

roleNames - A list of role names to fetch the roles to add to the user.

Returns:

The newly created user Should only allow the creation of new users, not the edition of existing ones

Throws:

Exception

Since:

2.3.0

executeScheduledTask

public static void executeScheduledTask(Task task)
                                 throws Exception

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 Should not be called from other methods other than TimerSchedulerTask Should not throw error if called from a TimerSchedulerTask class

Throws:

Exception

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 Should 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)

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:

service - instance implementing the OpenmrsService interface.

Throws:

ModuleException

Since:

1.9

runInDaemonThread

public static Thread runInDaemonThread(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(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

isDaemonUser

public static boolean isDaemonUser(User user)

Checks whether user is Daemon. However this is not the preferred method for checking to see if the current thread is a daemon thread, rather use Daemon.isDeamonThread(). isDaemonThread is preferred for checking to see if you are in that thread or if the current thread is daemon.

Parameters:

user - user whom we are checking if daemon

Returns:

true if user is Daemon Should return true for a daemon user Should return false if the user is not a daemon

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

getDaemonUserUuid

public static String getDaemonUserUuid()