org.openmrs.module

Class ModuleConstants

java.lang.Object

org.openmrs.module.ModuleConstants

public class ModuleConstants
extends Object

Constants used by the module system in openmrs

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,String>	CORE_MODULES A map from "moduleid" to "required version" for all core modules that are required by openmrs.
static String	IGNORE_CORE_MODULES_PROPERTY Used to determine if the CORE_MODULES list should be used or not.
static String	MESSAGE_PROPERTY_ALLOW_KEYS_OUTSIDE_OF_MODULE_NAMESPACE A module message.properties file containing this key mapped to "true" will be allowed to define messages outside of the module's namespace.
static String	REPOSITORY_FOLDER_PROPERTY Name of the global property that will tell the system where to look for modules to load.
static String	REPOSITORY_FOLDER_PROPERTY_DEFAULT Default name of the folder that holds the currently loaded modules for the system
static String	REPOSITORY_FOLDER_RUNTIME_PROPERTY Name of the runtime property that will tell the system where to look for modules to load.
static String	RUNTIMEPROPERTY_ALLOW_ADMIN Setting either of these properties to "false" will block web administration of modules
static String	RUNTIMEPROPERTY_ALLOW_UPLOAD Setting either of these properties to false will block web administration of modules
static String	RUNTIMEPROPERTY_MODULE_LIST_TO_LOAD Intended to be used by the testing framework in order to set a list of specific files that need to be loaded by the Context.
static String	UPDATE_FILE_NAME Name of the file in the module repository to ping to question for updates to a module

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

CORE_MODULES

public static final Map<String,String> CORE_MODULES

A map from "moduleid" to "required version" for all core modules that are required by openmrs. A module with at least the given version is required to start before openmrs will fully start.

IGNORE_CORE_MODULES_PROPERTY

public static final String IGNORE_CORE_MODULES_PROPERTY

Used to determine if the CORE_MODULES list should be used or not. For unit testing this is set to true to allow for faster runs with less dependencies.

See Also:

Constant Field Values

UPDATE_FILE_NAME

public static final String UPDATE_FILE_NAME

Name of the file in the module repository to ping to question for updates to a module

See Also:

Constant Field Values

REPOSITORY_FOLDER_PROPERTY

public static final String REPOSITORY_FOLDER_PROPERTY

Name of the global property that will tell the system where to look for modules to load. Can be either relative or absolute

See Also:

Constant Field Values

REPOSITORY_FOLDER_PROPERTY_DEFAULT

public static final String REPOSITORY_FOLDER_PROPERTY_DEFAULT

Default name of the folder that holds the currently loaded modules for the system

See Also:

REPOSITORY_FOLDER_PROPERTY, Constant Field Values

RUNTIMEPROPERTY_ALLOW_UPLOAD

public static final String RUNTIMEPROPERTY_ALLOW_UPLOAD

Setting either of these properties to false will block web administration of modules

See Also:

RUNTIMEPROPERTY_ALLOW_ADMIN, Constant Field Values

RUNTIMEPROPERTY_ALLOW_ADMIN

public static final String RUNTIMEPROPERTY_ALLOW_ADMIN

Setting either of these properties to "false" will block web administration of modules

See Also:

RUNTIMEPROPERTY_ALLOW_UPLOAD, Constant Field Values

RUNTIMEPROPERTY_MODULE_LIST_TO_LOAD

public static final String RUNTIMEPROPERTY_MODULE_LIST_TO_LOAD

Intended to be used by the testing framework in order to set a list of specific files that need to be loaded by the Context. Should be space separated. Should be either absolute file paths or classpath loadable file paths.

See Also:

Constant Field Values

REPOSITORY_FOLDER_RUNTIME_PROPERTY

public static final String REPOSITORY_FOLDER_RUNTIME_PROPERTY

Name of the runtime property that will tell the system where to look for modules to load. Can be either relative or absolute

See Also:

Constant Field Values

MESSAGE_PROPERTY_ALLOW_KEYS_OUTSIDE_OF_MODULE_NAMESPACE

public static final String MESSAGE_PROPERTY_ALLOW_KEYS_OUTSIDE_OF_MODULE_NAMESPACE

A module message.properties file containing this key mapped to "true" will be allowed to define messages outside of the module's namespace.

Since:

1.9.3

See Also:

Constant Field Values