org.openmrs.api.impl

Class AdministrationServiceImpl

java.lang.Object

org.openmrs.api.impl.BaseOpenmrsService

org.openmrs.api.impl.AdministrationServiceImpl

All Implemented Interfaces:

AdministrationService, GlobalPropertyListener, OpenmrsService

@Transactional
public class AdministrationServiceImpl
extends BaseOpenmrsService
implements AdministrationService, GlobalPropertyListener

Default implementation of the administration services. This class should not be used on its own. The current OpenMRS implementation should be fetched from the Context

See Also:

AdministrationService, Context

Field Summary

Fields

Modifier and Type	Field and Description
protected AdministrationDAO	dao
protected SortedMap<String,String>	systemVariables Static-ish variable used to cache the system variables.

Fields inherited from interface org.openmrs.api.AdministrationService

GP_SERIALIZER_WHITELIST_HIERARCHY_TYPES_PREFIX, GP_SUFFIX_SERIALIZER_WHITELIST_TYPES

Constructor Summary

Constructors

Constructor and Description
AdministrationServiceImpl() Default empty constructor

Method Summary

Modifier and Type	Method and Description
void	addGlobalPropertyListener(GlobalPropertyListener listener) Allows code to be notified when a global property is created/edited/deleted.
List<List<Object>>	executeSQL(String sql, boolean selectOnly) Runs the sql on the database.
List<GlobalProperty>	getAllGlobalProperties() Get a list of all global properties in the system
List<Locale>	getAllowedLocales() Gets the list of locales which the administrator has allowed for use on the system.
List<GlobalProperty>	getGlobalPropertiesByPrefix(String prefix) Gets all global properties that begin with prefix.
List<GlobalProperty>	getGlobalPropertiesBySuffix(String suffix) Gets all global properties that end with suffix.
String	getGlobalProperty(String propertyName) Gets the global property that has the given propertyName.
String	getGlobalProperty(String propertyName, String defaultValue) Gets the global property that has the given propertyName If propertyName is not found in the list of Global Properties currently in the database, a defaultValue is returned This method should not have any authorization check
GlobalProperty	getGlobalPropertyByUuid(String uuid) Get a global property by its uuid.
GlobalProperty	getGlobalPropertyObject(String propertyName) Gets the global property that has the given propertyName
<T> T	getGlobalPropertyValue(String propertyName, T defaultValue) Returns a global property according to the type specified
ImplementationId	getImplementationId() Get the implementation id stored for this server Returns null if no implementation id has been successfully set yet
int	getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass, String fieldName)
Set<Locale>	getPresentationLocales() Gets the list of locales for which localized messages are available for the user interface (presentation layer).
List<Locale>	getSearchLocales() Returns a list of locales used by the user when searching.
List<Locale>	getSearchLocales(Locale currentLocale, User user) Returns a list of locales used by the user when searching.
static List<Class<?>>	getSerializerDefaultWhitelistHierarchyTypes()
List<String>	getSerializerWhitelistTypes() Returns a list of packages and/or individual classes including hierarchy of OpenmrsObject, OpenmmrsMetadata, OpenmrsData and other common OpenMRS classes as well as any whitelists defined through GPs with the '.serializer.whitelist.types' suffix that are considered to be safe for deserializing.
Map<String,Map<String,String>>	getSystemInformation() Get a map of all the System Information.
SortedMap<String,String>	getSystemVariables() Get a listing or important variables used in openmrs
void	globalPropertyChanged(GlobalProperty newValue) Called after a global property is created or updated
void	globalPropertyDeleted(String propertyName) Called after a global property is deleted
boolean	isDatabaseStringComparisonCaseSensitive() Reads a GP which specifies if database string comparison is case sensitive.
void	purgeGlobalProperties(List<GlobalProperty> globalProperties) Completely remove the given global properties from the database
void	purgeGlobalProperty(GlobalProperty globalProperty) Completely remove the given global property from the database
void	removeGlobalPropertyListener(GlobalPropertyListener listener) Removes a GlobalPropertyListener previously registered by AdministrationService.addGlobalPropertyListener(GlobalPropertyListener)
List<GlobalProperty>	saveGlobalProperties(List<GlobalProperty> props) Save the given list of global properties to the database.
GlobalProperty	saveGlobalProperty(GlobalProperty gp) Save the given global property to the database
void	setAdministrationDAO(AdministrationDAO dao) Used by Spring to set the specific/chosen database access implementation
void	setEventListeners(EventListeners eventListeners)
void	setGlobalLocaleList(GlobalLocaleList gll) Used by spring to set the GlobalLocaleList on this implementation
void	setGlobalProperty(String propertyName, String propertyValue) Save the given global property to the database.
void	setImplementationId(ImplementationId implementationId) Set the given implementationId as this implementation's unique id
void	setImplementationIdHttpClient(HttpClient implementationIdHttpClient) Used by Spring to set the http client for accessing the openmrs implementation service
boolean	supportsPropertyName(String propertyName) Asks this listener whether it wants to be notified about the given property name
void	updateGlobalProperty(String propertyName, String propertyValue) Overwrites the value of the global property if it already exists.
void	updatePostgresSequence() Unlike MySQL which uses identifier strategy, PostgreSQL follows sequence strategy So as to bridge the gap between these two strategies, this method has been created.
void	validate(Object object, org.springframework.validation.Errors errors) Performs validation in the manual flush mode to prevent any premature flushes.

Methods inherited from class org.openmrs.api.impl.BaseOpenmrsService

onShutdown, onStartup

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openmrs.api.OpenmrsService

onShutdown, onStartup

Field Detail

dao

protected AdministrationDAO dao

systemVariables

protected SortedMap<String,String> systemVariables

Static-ish variable used to cache the system variables. This is not static so that every time a module is loaded or removed the variable is destroyed (along with the administration service) and recreated the next time it is called

Constructor Detail

AdministrationServiceImpl

public AdministrationServiceImpl()

Default empty constructor

Method Detail

setAdministrationDAO

public void setAdministrationDAO(AdministrationDAO dao)

Description copied from interface: AdministrationService

Used by Spring to set the specific/chosen database access implementation

Specified by:

setAdministrationDAO in interface AdministrationService

Parameters:

dao - The dao implementation to use

See Also:

AdministrationService.setAdministrationDAO(org.openmrs.api.db.AdministrationDAO)

setEventListeners

public void setEventListeners(EventListeners eventListeners)

getSystemVariables

@Transactional(readOnly=true)
public SortedMap<String,String> getSystemVariables()
                                                                          throws APIException

Description copied from interface: AdministrationService

Get a listing or important variables used in openmrs

Specified by:

getSystemVariables in interface AdministrationService

Returns:

a map from variable name to variable value Should return all registered system variables

Throws:

APIException

See Also:

AdministrationService.getSystemVariables()

getGlobalProperty

@Transactional(readOnly=true)
public String getGlobalProperty(String propertyName)
                                                       throws APIException

Description copied from interface: AdministrationService

Gets the global property that has the given propertyName.

If propertyName is not found in the list of Global Properties currently in the database, a null value is returned. This method should not have any authorization check.

Specified by:

getGlobalProperty in interface AdministrationService

Parameters:

propertyName - property key to look for

Returns:

value of property returned or null if none

Throws:

APIException

See Also:

AdministrationService.getGlobalProperty(java.lang.String)

getGlobalProperty

@Transactional(readOnly=true)
public String getGlobalProperty(String propertyName,
                                                              String defaultValue)
                                                       throws APIException

Description copied from interface: AdministrationService

Gets the global property that has the given propertyName

If propertyName is not found in the list of Global Properties currently in the database, a defaultValue is returned

This method should not have any authorization check

Specified by:

getGlobalProperty in interface AdministrationService

Parameters:

propertyName - property key to look for

defaultValue - value to return if propertyName is not found

Returns:

value of propertyName property or defaultValue if none Should return default value if property name does not exist Should not fail with null default value

Throws:

APIException

See Also:

AdministrationService.getGlobalProperty(java.lang.String, java.lang.String)

getGlobalPropertyObject

@Transactional(readOnly=true)
public GlobalProperty getGlobalPropertyObject(String propertyName)

Description copied from interface: AdministrationService

Gets the global property that has the given propertyName

Specified by:

getGlobalPropertyObject in interface AdministrationService

Parameters:

propertyName - property key to look for

Returns:

the global property that matches the given propertyName Should return null when no global property match given property name

See Also:

AdministrationService.getGlobalPropertyObject(java.lang.String)

setGlobalProperty

public void setGlobalProperty(String propertyName,
                              String propertyValue)
                       throws APIException

Description copied from interface: AdministrationService

Save the given global property to the database. If the global property already exists, then it will be overwritten

Specified by:

setGlobalProperty in interface AdministrationService

Parameters:

propertyName - the name of the global property to save

propertyValue - the value of the global property to save Should create global property in database Should overwrite global property if exists Should save a global property whose typed value is handled by a custom datatype

Throws:

APIException

See Also:

AdministrationService.setGlobalProperty(java.lang.String, java.lang.String)

updateGlobalProperty

public void updateGlobalProperty(String propertyName,
                                 String propertyValue)
                          throws IllegalStateException

Description copied from interface: AdministrationService

Overwrites the value of the global property if it already exists. If the global property does not exist, an exception will be thrown

Specified by:

updateGlobalProperty in interface AdministrationService

Parameters:

propertyName - the name of the global property to overwrite

propertyValue - the value of the global property to overwrite

Throws:

IllegalStateException - Should update global property in database Should fail if global property being updated does not already exist Should update a global property whose typed value is handled by a custom datatype

See Also:

AdministrationService.updateGlobalProperty(java.lang.String, java.lang.String)

getAllGlobalProperties

@Transactional(readOnly=true)
public List<GlobalProperty> getAllGlobalProperties()
                                                                          throws APIException

Description copied from interface: AdministrationService

Get a list of all global properties in the system

Specified by:

getAllGlobalProperties in interface AdministrationService

Returns:

list of global properties Should return all global properties in the database

Throws:

APIException

See Also:

AdministrationService.getAllGlobalProperties()

getGlobalPropertiesByPrefix

@Transactional(readOnly=true)
public List<GlobalProperty> getGlobalPropertiesByPrefix(String prefix)

Description copied from interface: AdministrationService

Gets all global properties that begin with prefix.

Specified by:

getGlobalPropertiesByPrefix in interface AdministrationService

Parameters:

prefix - The beginning of the property name to match.

Returns:

a List of GlobalPropertys that match prefix

See Also:

AdministrationService.getGlobalPropertiesByPrefix(java.lang.String)

getGlobalPropertiesBySuffix

@Transactional(readOnly=true)
public List<GlobalProperty> getGlobalPropertiesBySuffix(String suffix)

Description copied from interface: AdministrationService

Gets all global properties that end with suffix.

Specified by:

getGlobalPropertiesBySuffix in interface AdministrationService

Parameters:

suffix - The end of the property name to match.

Returns:

a List of GlobalPropertys that match .*suffix

See Also:

AdministrationService.getGlobalPropertiesBySuffix(java.lang.String)

purgeGlobalProperty

public void purgeGlobalProperty(GlobalProperty globalProperty)
                         throws APIException

Description copied from interface: AdministrationService

Completely remove the given global property from the database

Specified by:

purgeGlobalProperty in interface AdministrationService

Parameters:

globalProperty - the global property to delete/remove from the database

Throws:

APIException - Should delete global property from database

See Also:

AdministrationService.purgeGlobalProperty(org.openmrs.GlobalProperty)

saveGlobalProperties

@CacheEvict(value="userSearchLocales",
            allEntries=true)
public List<GlobalProperty> saveGlobalProperties(List<GlobalProperty> props)
                                                                                                              throws APIException

Description copied from interface: AdministrationService

Save the given list of global properties to the database.

Specified by:

saveGlobalProperties in interface AdministrationService

Parameters:

props - list of GlobalProperty objects to save

Returns:

the saved global properties Should save all global properties to the database Should not fail with empty list Should assign uuid to all new properties Should save properties with case difference only

Throws:

APIException

See Also:

AdministrationService.saveGlobalProperties(java.util.List)

saveGlobalProperty

@CacheEvict(value="userSearchLocales",
            allEntries=true)
public GlobalProperty saveGlobalProperty(GlobalProperty gp)
                                                                                                      throws APIException

Description copied from interface: AdministrationService

Save the given global property to the database

Specified by:

saveGlobalProperty in interface AdministrationService

Parameters:

gp - global property to save

Returns:

the saved global property

Throws:

APIException - Should create global property in database Should overwrite global property if exists Should not allow different properties to have the same string with different case Should save a global property whose typed value is handled by a custom datatype Should evict all entries of search locale cache

See Also:

AdministrationService.saveGlobalProperty(org.openmrs.GlobalProperty)

executeSQL

public List<List<Object>> executeSQL(String sql,
                                     boolean selectOnly)
                              throws APIException

Description copied from interface: AdministrationService

Runs the sql on the database. If selectOnly is flagged then any non-select sql statements will be rejected.

Specified by:

executeSQL in interface AdministrationService

Returns:

ResultSet

Throws:

APIException - Should execute sql containing group by

See Also:

AdministrationService.executeSQL(java.lang.String, boolean)

addGlobalPropertyListener

public void addGlobalPropertyListener(GlobalPropertyListener listener)

Description copied from interface: AdministrationService

Allows code to be notified when a global property is created/edited/deleted.

Specified by:

addGlobalPropertyListener in interface AdministrationService

Parameters:

listener - The listener to register

See Also:

AdministrationService.addGlobalPropertyListener(GlobalPropertyListener)

removeGlobalPropertyListener

public void removeGlobalPropertyListener(GlobalPropertyListener listener)

Description copied from interface: AdministrationService

Removes a GlobalPropertyListener previously registered by AdministrationService.addGlobalPropertyListener(GlobalPropertyListener)

Specified by:

removeGlobalPropertyListener in interface AdministrationService

See Also:

AdministrationService.removeGlobalPropertyListener(GlobalPropertyListener)

getImplementationId

@Transactional(readOnly=true)
public ImplementationId getImplementationId()
                                                                   throws APIException

Description copied from interface: AdministrationService

Get the implementation id stored for this server Returns null if no implementation id has been successfully set yet

Specified by:

getImplementationId in interface AdministrationService

Returns:

ImplementationId object that is this implementation's unique id Should return null if no implementation id is defined yet

Throws:

APIException

See Also:

AdministrationService.getImplementationId()

setImplementationId

public void setImplementationId(ImplementationId implementationId)
                         throws APIException

Description copied from interface: AdministrationService

Set the given implementationId as this implementation's unique id

Specified by:

setImplementationId in interface AdministrationService

Parameters:

implementationId - the ImplementationId to save

Throws:

APIException - if implementationId is empty or is invalid according to central id server Should create implementation id in database Should overwrite implementation id in database if exists Should not fail if given implementationId is null Should throw APIException if given empty implementationId object Should throw APIException if given a caret in the implementationId code Should throw APIException if given a pipe in the implementationId code Should set uuid on implementation id global property

See Also:

AdministrationService.setImplementationId(org.openmrs.ImplementationId)

getAllowedLocales

@Transactional(readOnly=true)
public List<Locale> getAllowedLocales()

Description copied from interface: AdministrationService

Gets the list of locales which the administrator has allowed for use on the system. This is specified with a global property named OpenmrsConstants.GLOBAL_PROPERTY_LOCALE_ALLOWED_LIST.

Specified by:

getAllowedLocales in interface AdministrationService

Returns:

list of allowed locales Should return at least one locale if no locales defined in database yet Should not fail if not global property for locales allowed defined yet Should not return duplicates even if the global property has them

See Also:

AdministrationService.getAllowedLocales()

setGlobalLocaleList

public void setGlobalLocaleList(GlobalLocaleList gll)

Used by spring to set the GlobalLocaleList on this implementation

Parameters:

gll - the GlobalLocaleList object that is registered to the GlobalPropertyListeners as well

getPresentationLocales

@Transactional(readOnly=true)
public Set<Locale> getPresentationLocales()

Description copied from interface: AdministrationService

Gets the list of locales for which localized messages are available for the user interface (presentation layer). This set includes all the available locales (as indicated by the MessageSourceService) filtered by the allowed locales (as indicated by this AdministrationService).

Specified by:

getPresentationLocales in interface AdministrationService

Returns:

list of allowed presentation locales Should return at least one locale if no locales defined in database yet Should not return more locales than message source service locales Should return only country locale if both country locale and language locale are specified in allowed list Should return all country locales if language locale and no country locales are specified in allowed list Should return language locale if country locale is specified in allowed list but country locale message file is missing Should return language locale if it is specified in allowed list and there are no country locale message files available

See Also:

AdministrationService.getPresentationLocales()

globalPropertyChanged

public void globalPropertyChanged(GlobalProperty newValue)

Description copied from interface: GlobalPropertyListener

Called after a global property is created or updated

Specified by:

globalPropertyChanged in interface GlobalPropertyListener

Parameters:

newValue - the new value of the property that was just saved

See Also:

GlobalPropertyListener.globalPropertyChanged(org.openmrs.GlobalProperty)

globalPropertyDeleted

public void globalPropertyDeleted(String propertyName)

Description copied from interface: GlobalPropertyListener

Called after a global property is deleted

Specified by:

globalPropertyDeleted in interface GlobalPropertyListener

Parameters:

propertyName - the name of the property that was just deleted

See Also:

GlobalPropertyListener.globalPropertyDeleted(java.lang.String)

supportsPropertyName

public boolean supportsPropertyName(String propertyName)

Description copied from interface: GlobalPropertyListener

Asks this listener whether it wants to be notified about the given property name

Specified by:

supportsPropertyName in interface GlobalPropertyListener

Returns:

whether this listener wants its action methods to be notified of properties with the given name

See Also:

GlobalPropertyListener.supportsPropertyName(java.lang.String)

getGlobalPropertyByUuid

@Transactional(readOnly=true)
public GlobalProperty getGlobalPropertyByUuid(String uuid)

Description copied from interface: AdministrationService

Get a global property by its uuid. There should be only one of these in the database (well, in the world actually). If multiple are found, an error is thrown.

Specified by:

getGlobalPropertyByUuid in interface AdministrationService

Returns:

the global property matching the given uuid Should find object given valid uuid Should return null if no object found with given uuid

See Also:

AdministrationService.getGlobalPropertyByUuid(java.lang.String)

getGlobalPropertyValue

public <T> T getGlobalPropertyValue(String propertyName,
                                    T defaultValue)
                             throws APIException

Description copied from interface: AdministrationService

Returns a global property according to the type specified

Specified by:

getGlobalPropertyValue in interface AdministrationService

Parameters:

propertyName - Should get property value in the proper type specified Should return default value if property name does not exist

Returns:

property value in the type of the default value

Throws:

APIException

See Also:

AdministrationService.getGlobalPropertyValue(java.lang.String, java.lang.Object)

getSystemInformation

@Transactional(readOnly=true)
public Map<String,Map<String,String>> getSystemInformation()
                                                                                  throws APIException

Description copied from interface: AdministrationService

Get a map of all the System Information. Java, user, time, runtime properties, etc

Specified by:

getSystemInformation in interface AdministrationService

Returns:

a map from variable name to a map of the information Should return all system information

Throws:

APIException

See Also:

AdministrationService.getSystemInformation()

purgeGlobalProperties

public void purgeGlobalProperties(List<GlobalProperty> globalProperties)
                           throws APIException

Description copied from interface: AdministrationService

Completely remove the given global properties from the database

Specified by:

purgeGlobalProperties in interface AdministrationService

Parameters:

globalProperties - the global properties to delete/remove from the database

Throws:

APIException - Should delete global properties from database

See Also:

AdministrationService.purgeGlobalProperties(java.util.List)

getMaximumPropertyLength

@Transactional(readOnly=true)
public int getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass,
                                                                  String fieldName)

Specified by:

getMaximumPropertyLength in interface AdministrationService

Parameters:

aClass - class of object getting length for

fieldName - name of the field to get the length for

Returns:

the max field length of a property

See Also:

AdministrationService.getMaximumPropertyLength(Class, String)

validate

@Transactional(readOnly=true)
public void validate(Object object,
                                                   org.springframework.validation.Errors errors)
                                            throws APIException

Description copied from interface: AdministrationService

Performs validation in the manual flush mode to prevent any premature flushes.

Used by ValidateUtil.validate(Object).

Specified by:

validate in interface AdministrationService

errors - Should pass for a valid object Should fail for an invalid object Should throw throw APIException if the input is null

Throws:

APIException

See Also:

AdministrationService.validate(java.lang.Object, Errors)

getSearchLocales

@Cacheable(value="userSearchLocales")
public List<Locale> getSearchLocales(Locale currentLocale,
                                                                           User user)
                                                                    throws APIException

Description copied from interface: AdministrationService

Returns a list of locales used by the user when searching.

Specified by:

getSearchLocales in interface AdministrationService

Parameters:

currentLocale - currently selected locale

user - authenticated user

Returns:

Throws:

APIException

getSearchLocales

@Transactional(readOnly=true)
public List<Locale> getSearchLocales()

Description copied from interface: AdministrationService

Returns a list of locales used by the user when searching.

The list is constructed from a currently selected locale and allowed user proficient locales.

Specified by:

getSearchLocales in interface AdministrationService

Returns:

locales

See Also:

AdministrationService.getSearchLocales()

setImplementationIdHttpClient

public void setImplementationIdHttpClient(HttpClient implementationIdHttpClient)

Description copied from interface: AdministrationService

Used by Spring to set the http client for accessing the openmrs implementation service

Specified by:

setImplementationIdHttpClient in interface AdministrationService

Parameters:

implementationIdHttpClient - The implementation http client

isDatabaseStringComparisonCaseSensitive

public boolean isDatabaseStringComparisonCaseSensitive()

Description copied from interface: AdministrationService

Reads a GP which specifies if database string comparison is case sensitive.

It is an optimisation parameter for MySQL, which can speed up searching if set to false. See http://dev.mysql.com/doc/refman/5.7/en/case-sensitivity.html

It is set to true by default.

Specified by:

isDatabaseStringComparisonCaseSensitive in interface AdministrationService

Returns:

true if database string comparison is case sensitive

See Also:

AdministrationService.isDatabaseStringComparisonCaseSensitive()

updatePostgresSequence

public void updatePostgresSequence()

Description copied from interface: AdministrationService

• Unlike MySQL which uses identifier strategy, PostgreSQL follows sequence strategy
• So as to bridge the gap between these two strategies, this method has been created.
• It will perform task of updating the sequence values after insertions are done from core data or concepts are inserted (present in Reference Metadata Module)

Specified by:

updatePostgresSequence in interface AdministrationService

See Also:

AdministrationService.updatePostgresSequence()

getSerializerWhitelistTypes

public List<String> getSerializerWhitelistTypes()

Description copied from interface: AdministrationService

Returns a list of packages and/or individual classes including hierarchy of OpenmrsObject, OpenmmrsMetadata, OpenmrsData and other common OpenMRS classes as well as any whitelists defined through GPs with the '.serializer.whitelist.types' suffix that are considered to be safe for deserializing. It is the responsibility of the serializer to block any unlisted classes from being deserialized and posing security risk. It is especially important for serializers using XStream.

Specified by:

getSerializerWhitelistTypes in interface AdministrationService

Returns:

a list of packages and/or classes Should return packages and individual classes defined in GPs Should return default common classes if no GPs defined

getSerializerDefaultWhitelistHierarchyTypes

public static List<Class<?>> getSerializerDefaultWhitelistHierarchyTypes()