AdministrationService (OpenMRS 2.7.0-SNAPSHOT API)

All Superinterfaces:

OpenmrsService

All Known Implementing Classes:

AdministrationServiceImpl
```
public interface AdministrationService
extends OpenmrsService
```
Contains methods pertaining to doing some administrative tasks in OpenMRS
Use:
```
 
 List<GlobalProperty> globalProperties = Context.getAdministrationService().getGlobalProperties();
 
```
See Also:

Context

Field Summary

Fields
Modifier and Type Field and Description

static String GP_SERIALIZER_WHITELIST_HIERARCHY_TYPES_PREFIX

static String GP_SUFFIX_SERIALIZER_WHITELIST_TYPES

Fields
Modifier and Type	Field and Description
`static String`	`GP_SERIALIZER_WHITELIST_HIERARCHY_TYPES_PREFIX`
`static String`	`GP_SUFFIX_SERIALIZER_WHITELIST_TYPES`

Method Summary

All Methods Instance Methods Abstract Methods
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.
`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
`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 `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`	`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 implementationHttpClient)` Used by Spring to set the http client for accessing the openmrs implementation service
`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 interface org.openmrs.api.OpenmrsService
onShutdown, onStartup

- Field Detail
  - GP_SUFFIX_SERIALIZER_WHITELIST_TYPES
```
static final String GP_SUFFIX_SERIALIZER_WHITELIST_TYPES
```
    See Also:
    
    Constant Field Values
  - GP_SERIALIZER_WHITELIST_HIERARCHY_TYPES_PREFIX
```
static final String GP_SERIALIZER_WHITELIST_HIERARCHY_TYPES_PREFIX
```
    See Also:
    
    Constant Field Values
- Method Detail
  - setAdministrationDAO
```
void setAdministrationDAO(AdministrationDAO dao)
```
    Used by Spring to set the specific/chosen database access implementation
    
    Parameters:
    
    dao - The dao implementation to use
  - getGlobalPropertyByUuid
```
@Authorized(value="Get Global Properties")
GlobalProperty getGlobalPropertyByUuid(String uuid)
```
    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.
    
    Returns:
    
    the global property matching the given uuid Should find object given valid uuid Should return null if no object found with given uuid
  - getSystemVariables
```
@Authorized(value="View Administration Functions")
SortedMap<String,String> getSystemVariables()
```
    Get a listing or important variables used in openmrs
    
    Returns:
    
    a map from variable name to variable value Should return all registered system variables
  - getSystemInformation
```
@Authorized(value="View Administration Functions")
Map<String,Map<String,String>> getSystemInformation()
```
    Get a map of all the System Information. Java, user, time, runtime properties, etc
    
    Returns:
    
    a map from variable name to a map of the information Should return all system information
  - getGlobalProperty
```
@Authorized(value="Get Global Properties")
String getGlobalProperty(String propertyName)
```
    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.
    
    Parameters:
    
    propertyName - property key to look for
    
    Returns:
    
    value of property returned or null if none
    
    See Also:
    
    Should not fail with null propertyName Should get property value given valid property name Should get property in case insensitive way
  - getGlobalProperty
```
@Authorized(value="Get Global Properties")
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
    
    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
  - getGlobalPropertyObject
```
@Authorized(value="Get Global Properties")
GlobalProperty getGlobalPropertyObject(String propertyName)
```
    Gets the global property that has the given propertyName
    
    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
  - getGlobalPropertiesByPrefix
```
@Authorized(value="Get Global Properties")
List<GlobalProperty> getGlobalPropertiesByPrefix(String prefix)
```
    Gets all global properties that begin with prefix.
    
    Parameters:
    
    prefix - The beginning of the property name to match.
    
    Returns:
    
    a List of GlobalPropertys that match prefix
    
    Since:
    
    1.5 Should return all relevant global properties in the database
  - getGlobalPropertiesBySuffix
```
@Authorized(value="Get Global Properties")
List<GlobalProperty> getGlobalPropertiesBySuffix(String suffix)
```
    Gets all global properties that end with suffix.
    
    Parameters:
    
    suffix - The end of the property name to match.
    
    Returns:
    
    a List of GlobalPropertys that match .*suffix
    
    Since:
    
    1.6 Should return all relevant global properties in the database
  - getAllGlobalProperties
```
@Authorized(value="Get Global Properties")
List<GlobalProperty> getAllGlobalProperties()
```
    Get a list of all global properties in the system
    
    Returns:
    
    list of global properties Should return all global properties in the database
  - saveGlobalProperties
```
@Authorized(value="Manage Global Properties")
List<GlobalProperty> saveGlobalProperties(List<GlobalProperty> props)
```
    Save the given list of global properties to the database.
    
    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
  - purgeGlobalProperty
```
@Authorized(value="Purge Global Properties")
void purgeGlobalProperty(GlobalProperty globalProperty)
```
    Completely remove the given global property from the database
    
    Parameters:
    
    globalProperty - the global property to delete/remove from the database
    
    Throws:
    
    APIException - Should delete global property from database
  - purgeGlobalProperties
```
@Authorized(value="Purge Global Properties")
void purgeGlobalProperties(List<GlobalProperty> globalProperties)
```
    Completely remove the given global properties from the database
    
    Parameters:
    
    globalProperties - the global properties to delete/remove from the database
    
    Throws:
    
    APIException - Should delete global properties from database
  - setGlobalProperty
```
@Authorized(value="Manage Global Properties")
void setGlobalProperty(String propertyName,
                                                                     String propertyValue)
```
    Save the given global property to the database. If the global property already exists, then it will be overwritten
    
    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
  - updateGlobalProperty
```
@Authorized(value="Manage Global Properties")
void updateGlobalProperty(String propertyName,
                                                                        String propertyValue)
```
    Overwrites the value of the global property if it already exists. If the global property does not exist, an exception will be thrown
    
    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
    
    Since:
    
    1.10
  - saveGlobalProperty
```
@Authorized(value="Manage Global Properties")
GlobalProperty saveGlobalProperty(GlobalProperty gp)
```
    Save the given global property to the database
    
    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
  - addGlobalPropertyListener
```
void addGlobalPropertyListener(GlobalPropertyListener listener)
```
    Allows code to be notified when a global property is created/edited/deleted.
    
    Parameters:
    
    listener - The listener to register
    
    See Also:
    
    GlobalPropertyListener
  - removeGlobalPropertyListener
```
void removeGlobalPropertyListener(GlobalPropertyListener listener)
```
    Removes a GlobalPropertyListener previously registered by addGlobalPropertyListener(GlobalPropertyListener)
    
    Parameters:
    
    listener -
  - executeSQL
```
@Authorized(value="SQL Level Access")
List<List<Object>> executeSQL(String sql,
                                                                    boolean selectOnly)
```
    Runs the sql on the database. If selectOnly is flagged then any non-select sql statements will be rejected.
    
    Parameters:
    
    sql -
    
    selectOnly -
    
    Returns:
    
    ResultSet
    
    Throws:
    
    APIException - Should execute sql containing group by
  - getImplementationId
```
@Authorized(value="Manage Implementation Id")
ImplementationId getImplementationId()
```
    Get the implementation id stored for this server Returns null if no implementation id has been successfully set yet
    
    Returns:
    
    ImplementationId object that is this implementation's unique id Should return null if no implementation id is defined yet
  - setImplementationId
```
@Authorized(value="Manage Implementation Id")
void setImplementationId(ImplementationId implementationId)
```
    Set the given implementationId as this implementation's unique id
    
    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
  - getAllowedLocales
```
List<Locale> getAllowedLocales()
```
    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.
    
    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
  - getPresentationLocales
```
Set<Locale> getPresentationLocales()
```
    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).
    
    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
  - getGlobalPropertyValue
```
@Authorized(value="Get Global Properties")
<T> T getGlobalPropertyValue(String propertyName,
                                                                        T defaultValue)
```
    Returns a global property according to the type specified
    
    Type Parameters:
    
    T -
    
    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
    
    Since:
    
    1.7
  - getMaximumPropertyLength
```
int getMaximumPropertyLength(Class<? extends OpenmrsObject> aClass,
                             String fieldName)
```
    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
  - validate
```
void validate(Object object,
              org.springframework.validation.Errors errors)
```
    Performs validation in the manual flush mode to prevent any premature flushes.
    Used by ValidateUtil.validate(Object).
    
    Parameters:
    
    object -
    
    errors - Should pass for a valid object Should fail for an invalid object Should throw throw APIException if the input is null
    
    Since:
    
    1.9
  - getSearchLocales
```
List<Locale> getSearchLocales(Locale currentLocale,
                              User user)
```
    Returns a list of locales used by the user when searching.
    
    Parameters:
    
    currentLocale - currently selected locale
    
    user - authenticated user
    
    Returns:
    
    Throws:
    
    APIException
  - getSearchLocales
```
List<Locale> getSearchLocales()
```
    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.
    
    Returns:
    
    locales
    
    Throws:
    
    APIException
    
    Since:
    
    1.8.4, 1.9.1, 1.10 Should include currently selected full locale and language Should include users proficient locales Should exclude not allowed locales Should cache results for a user
  - setImplementationIdHttpClient
```
void setImplementationIdHttpClient(HttpClient implementationHttpClient)
```
    Used by Spring to set the http client for accessing the openmrs implementation service
    
    Parameters:
    
    implementationHttpClient - The implementation http client
  - isDatabaseStringComparisonCaseSensitive
```
boolean isDatabaseStringComparisonCaseSensitive()
```
    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.
    
    Returns:
    
    true if database string comparison is case sensitive
    
    Since:
    
    1.9.9, 1.10.2, 1.11
  - updatePostgresSequence
```
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.
    - 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)
    Since:
    
    2.4
  - getSerializerWhitelistTypes
```
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. 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.
    
    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
    
    Since:
    
    2.7.0, 2.6.2, 2.5.13

Interface AdministrationService

Field Summary

Method Summary

Methods inherited from interface org.openmrs.api.OpenmrsService

Field Detail

GP_SUFFIX_SERIALIZER_WHITELIST_TYPES

GP_SERIALIZER_WHITELIST_HIERARCHY_TYPES_PREFIX

Method Detail

setAdministrationDAO

getGlobalPropertyByUuid

getSystemVariables

getSystemInformation

getGlobalProperty

getGlobalProperty

getGlobalPropertyObject

getGlobalPropertiesByPrefix

getGlobalPropertiesBySuffix

getAllGlobalProperties

saveGlobalProperties

purgeGlobalProperty

purgeGlobalProperties

setGlobalProperty

updateGlobalProperty

saveGlobalProperty

addGlobalPropertyListener

removeGlobalPropertyListener

executeSQL

getImplementationId

setImplementationId

getAllowedLocales

getPresentationLocales

getGlobalPropertyValue

getMaximumPropertyLength

validate

getSearchLocales

getSearchLocales

setImplementationIdHttpClient

isDatabaseStringComparisonCaseSensitive

updatePostgresSequence

getSerializerWhitelistTypes