org.openmrs.module

Class BaseModuleActivator

java.lang.Object

org.openmrs.module.BaseModuleActivator

All Implemented Interfaces:

ModuleActivator

public abstract class BaseModuleActivator
extends java.lang.Object
implements ModuleActivator

Must be extended by modules and referenced by the Module-Activator property in the module manifest, contains methods that let modules get notifications as the application is executing to allow modules to react in custom ways.

Since:

1.7

Constructor Summary

Constructors

Constructor and Description
BaseModuleActivator()

Method Summary

Modifier and Type	Method and Description
void	contextRefreshed() Called after spring's application context is refreshed , this method is called multiple times i.e.
void	started() Called after a module is started, the application context has been refreshed and the module's service methods are ready to be called.
void	stopped() Called after a module is stopped
void	willRefreshContext() Called just before spring's application context is refreshed, this method is called multiple times i.e.
void	willStart() Called after a module has been loaded but before the application context is refreshed, at this point the module's service methods aren't yet available so they can't be called.
void	willStop() Called just before a module is stopped

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseModuleActivator

public BaseModuleActivator()

Method Detail

contextRefreshed

public void contextRefreshed()

Description copied from interface: ModuleActivator

Called after spring's application context is refreshed , this method is called multiple times i.e. whenever a new module gets started and at application startup.

Specified by:

contextRefreshed in interface ModuleActivator

See Also:

ModuleActivator.contextRefreshed()

started

public void started()

Description copied from interface: ModuleActivator

Called after a module is started, the application context has been refreshed and the module's service methods are ready to be called.

Specified by:

started in interface ModuleActivator

See Also:

ModuleActivator.started()

stopped

public void stopped()

Description copied from interface: ModuleActivator

Called after a module is stopped

Specified by:

stopped in interface ModuleActivator

See Also:

ModuleActivator.stopped()

willRefreshContext

public void willRefreshContext()

Description copied from interface: ModuleActivator

Called just before spring's application context is refreshed, this method is called multiple times i.e. whenever a new module gets started, at application startup or a developer chooses to refresh the context.

Specified by:

willRefreshContext in interface ModuleActivator

See Also:

ModuleActivator.willRefreshContext()

willStart

public void willStart()

Description copied from interface: ModuleActivator

Called after a module has been loaded but before the application context is refreshed, at this point the module's service methods aren't yet available so they can't be called.

This method will be authenticated as the Daemon user and have all privileges.

Specified by:

willStart in interface ModuleActivator

See Also:

ModuleActivator.willStart()

willStop

public void willStop()

Description copied from interface: ModuleActivator

Called just before a module is stopped

Specified by:

willStop in interface ModuleActivator

See Also:

ModuleActivator.willStop()