OpenmrsUtil (OpenMRS 1.8.5-SNAPSHOT API)

java.lang.Object
- org.openmrs.util.OpenmrsUtil

```
public class OpenmrsUtil
extends Object
```
Utility methods used in openmrs

Constructor Summary

Constructors
Constructor and Description

OpenmrsUtil()

Constructors
Constructor and Description
`OpenmrsUtil()`

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static <K,V> void`	`addToListMap(Map<K,List<V>> map, K key, V obj)`
`static <K,V> void`	`addToSetMap(Map<K,Set<V>> map, K key, V obj)` Allows easy manipulation of a Map
`static Integer`	`ageFromBirthdate(Date birthdate)` Deprecated. this method is not currently used within OpenMRS and is a duplicate of `Person.getAge(Date)`
`static void`	`applyLogLevel(String logClass, String logLevel)` Set the log4j log level for class `logClass` to `logLevel`.
`static void`	`applyLogLevels()` Set the org.openmrs log4j logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists.
`static void`	`closeStream(Closeable closableStream)` A null-safe and exception safe way to close an inputstream or an outputstream
`static boolean`	`collectionContains(Collection<?> objects, Object obj)` Loops over the collection to check to see if the given object is in that collection.
`static int`	`compare(Date d1, Date d2)` Compares two java.util.Date objects, but handles java.sql.Timestamp (which is not directly comparable to a date) by dropping its nanosecond value.
`static <E> Collection<Collection<E>>`	`compareLists(Collection<E> origList, Collection<E> newList)` Compares origList to newList returning map of differences
`static int`	`compareWithNullAsEarliest(Date d1, Date d2)` Compares two Date/Timestamp objects, treating null as the earliest possible date.
`static <E extends Comparable<E>> int`	`compareWithNullAsGreatest(E c1, E c2)`
`static int`	`compareWithNullAsLatest(Date d1, Date d2)` Compares two Date/Timestamp objects, treating null as the earliest possible date.
`static <E extends Comparable<E>> int`	`compareWithNullAsLowest(E c1, E c2)`
`static List<Concept>`	`conceptListHelper(String descriptor)`
`static Set<Concept>`	`conceptSetHelper(String descriptor)`
`static <T> boolean`	`containsAny(Collection<T> collection, Collection<T> elements)`
`static boolean`	`containsDigit(String test)`
`static boolean`	`containsOnlyDigits(String test)`
`static boolean`	`containsUpperAndLowerCase(String test)`
`static void`	`copyFile(InputStream inputStream, OutputStream outputStream)` Copy file from inputStream onto the outputStream inputStream is not closed in this method outputStream /is/ closed at completion of this method
`static boolean`	`deleteDirectory(File dir)` Recursively deletes files in the given `dir` folder
`static List<Concept>`	`delimitedStringToConceptList(String delimitedString, String delimiter)` Parses and loads a delimited list of concept ids or names
`static List<Concept>`	`delimitedStringToConceptList(String delimitedString, String delimiter, Context context)` Deprecated. replaced by `delimitedStringToConceptList(String,String)`
`static Map<String,Concept>`	`delimitedStringToConceptMap(String delimitedString, String delimiter)`
`static List<Integer>`	`delimitedStringToIntegerList(String delimitedString, String delimiter)`
`static boolean`	`folderContains(File folder, String filename)` Look for a file named `filename` in folder
`static Date`	`fromDateHelper(Date comparisonDate, Integer withinLastDays, Integer withinLastMonths, Integer untilDaysAgo, Integer untilMonthsAgo, Date sinceDate, Date untilDate)`
`static String`	`generateUid()` Creates a uid of length 20
`static String`	`generateUid(Integer size)` Creates a relatively acceptable unique string of the give size
`static String`	`getApplicationDataDirectory()` Returns the application data directory.
`static int`	`getCheckDigit(String idWithoutCheckdigit)` Deprecated. Use `PatientService.getIdentifierValidator(String)`
`static Concept`	`getConceptByIdOrName(String idOrName)`
`static Map<String,String>`	`getCorePrivileges()` These are the privileges that are required by OpenMRS.
`static Map<String,String>`	`getCoreRoles()` All roles returned by this method are inserted into the database if they do not exist already.
`static SimpleDateFormat`	`getDateFormat()` Deprecated. use `Context.getDateFormat()` or `#getDateFormat(Context#getLocale())` instead
`static SimpleDateFormat`	`getDateFormat(Locale locale)` Get the current user's date format Will look similar to "mm-dd-yyyy".
`static File`	`getDirectoryInApplicationDataDirectory(String folderName)` Find the given folderName in the application data directory.
`static byte[]`	`getFileAsBytes(File file)` Return a byte array representation of the given file
`static String`	`getFileAsString(File file)` Return a string representation of the given file
`static String`	`getMessage(String code, Object... args)` Utility method for getting the translation for the passed code
`static File`	`getOutFile(File dir, Date date, User user)` Gets an out File object.
`static InputStream`	`getResourceInputStream(URL url)` Opens input stream for given resource.
`static Properties`	`getRuntimeProperties(String applicationName)` Finds and loads the runtime properties file for a specific OpenMRS application.
`static org.simpleframework.xml.Serializer`	`getSerializer()` Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion
`static org.simpleframework.xml.Serializer`	`getShortSerializer()` Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion
`static boolean`	`isConceptInList(Concept concept, List<Concept> list)`
`static Boolean`	`isInAbsoluteNumericRange(Float value, ConceptNumeric concept)`
`static Boolean`	`isInCriticalNumericRange(Float value, ConceptNumeric concept)`
`static Boolean`	`isInNormalNumericRange(Float value, ConceptNumeric concept)`
`static boolean`	`isShortSerialization(Map<?,?> sessionMap)` Deprecated. - use SerializationService and OpenmrsSerializer implementation for Serialization
`static boolean`	`isStringInArray(String str, String[] arr)`
`static boolean`	`isValidCheckDigit(String id)` Deprecated. Should be using `PatientService.getIdentifierValidator(String)`
`static Boolean`	`isValidNumericValue(Float value, ConceptNumeric concept)`
`static <E> String`	`join(Collection<E> c, String separator)` Converts a collection to a String with a specified separator between all elements
`static Date`	`lastSecondOfDay(Date date)` Return a date that is the same day as the passed in date, but the hours and seconds are the latest possible for that day.
`static void`	`loadProperties(Properties props, File propertyFile)` Convenience method used to load properties from the given file.
`static void`	`loadProperties(Properties props, InputStream input)` Deprecated. use `loadProperties(Properties, File)`
`static <Arg1,Arg2 extends Arg1> boolean`	`nullSafeEquals(Arg1 d1, Arg2 d2)`
`static boolean`	`nullSafeEqualsIgnoreCase(String s1, String s2)` Performs a case insensitive Comparison of two strings taking care of null values
`static Object`	`parse(String string, Class clazz)` Takes a String (e.g.
`static Map<String,String>`	`parseParameterList(String paramList)` Takes a String like "size=compact\|order=date" and returns a Map from the keys to the values.
`static String`	`postToUrl(String urlString, Map<String,String> dataToPost)` Deprecated. use org.openmrs.util.HttpClient
`static Date`	`safeDate(Date d1)`
`static void`	`saveDocument(Document doc, File outFile)` Save the given xml document to the given outfile
`static String`	`shortenedStackTrace(String stackTrace)` Convert a stack trace into a shortened version for easier viewing and data storage, excluding those lines we are least concerned with; should average about 60% reduction in stack trace length
`static void`	`startup(Properties p)` Initialize global settings Find and load modules
`static void`	`storeProperties(Properties properties, File file, String comment)` Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.
`static void`	`storeProperties(Properties properties, OutputStream outStream, String comment)` Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument.
`static Date`	`toDateHelper(Date comparisonDate, Integer withinLastDays, Integer withinLastMonths, Integer untilDaysAgo, Integer untilMonthsAgo, Date sinceDate, Date untilDate)`
`static PatientFilter`	`toPatientFilter(PatientSearch search, CohortSearchHistory history)` Deprecated. see reportingcompatibility module
`static PatientFilter`	`toPatientFilter(PatientSearch search, CohortSearchHistory history, EvaluationContext evalContext)` Deprecated. see reportingcompatibility module
`static File`	`url2file(URL url)` Utility method to convert local URL to a File object.
`static void`	`validateJavaVersion()` Checks whether the current JVM version is at least Java 6.
`static void`	`validatePassword(String username, String password, String systemId)` Utility to check the validity of a password for a certain `User`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- OpenmrsUtil
```
public OpenmrsUtil()
```

Method Detail

getCheckDigit
```
@Deprecated
public static int getCheckDigit(String idWithoutCheckdigit)
                                     throws Exception
```
Deprecated. Use PatientService.getIdentifierValidator(String)

Parameters:

idWithoutCheckdigit -

Returns:

int - the calculated check digit for the given string

Throws:

Exception

Should:

get valid check digits

isValidCheckDigit
```
@Deprecated
public static boolean isValidCheckDigit(String id)
                                             throws Exception
```
Deprecated. Should be using PatientService.getIdentifierValidator(String)

Parameters:

id -

Returns:

true/false whether id has a valid check digit

Throws:

Exception - on invalid characters and invalid id formation

Should:

validate correct check digits, not validate invalid check digits, throw error if given an invalid character in id

compareLists

public static <E> Collection<Collection<E>> compareLists(Collection<E> origList,
                                                         Collection<E> newList)

Compares origList to newList returning map of differences

Parameters:: origList -; newList -
Returns:: [List toAdd, List toDelete] with respect to origList

isStringInArray

public static boolean isStringInArray(String str,
                                      String[] arr)

isInNormalNumericRange

public static Boolean isInNormalNumericRange(Float value,
                                             ConceptNumeric concept)

isInCriticalNumericRange

public static Boolean isInCriticalNumericRange(Float value,
                                               ConceptNumeric concept)

isInAbsoluteNumericRange

public static Boolean isInAbsoluteNumericRange(Float value,
                                               ConceptNumeric concept)

isValidNumericValue

public static Boolean isValidNumericValue(Float value,
                                          ConceptNumeric concept)

getFileAsString
```
public static String getFileAsString(File file)
                              throws IOException
```
Return a string representation of the given file

Parameters:

file -

Returns:

String file contents

Throws:

IOException

getFileAsBytes
```
public static byte[] getFileAsBytes(File file)
                             throws IOException
```
Return a byte array representation of the given file

Parameters:

file -

Returns:

byte[] file contents

Throws:

IOException

copyFile
```
public static void copyFile(InputStream inputStream,
                            OutputStream outputStream)
                     throws IOException
```
Copy file from inputStream onto the outputStream inputStream is not closed in this method outputStream /is/ closed at completion of this method

Parameters:

inputStream - Stream to copy from

outputStream - Stream/location to copy to

Throws:

IOException - thrown if an error occurs during read/write

folderContains

public static boolean folderContains(File folder,
                                     String filename)

Look for a file named filename in folder

Parameters:: folder -; filename -
Returns:: true/false whether filename exists in folder

getCorePrivileges
```
public static Map<String,String> getCorePrivileges()
```
These are the privileges that are required by OpenMRS. This looks for privileges marked as AddOnStartup to know which privs, upon startup or loading of a module, to insert into the database if they do not exist already. These privileges are not allowed to be deleted. They are marked as 'locked' in the administration screens.

Returns:

privileges core to the system

See Also:

PrivilegeConstants, Context.checkCoreDataset()

getCoreRoles
```
public static Map<String,String> getCoreRoles()
```
All roles returned by this method are inserted into the database if they do not exist already. These roles are also forbidden to be deleted from the administration screens.

Returns:

roles that are core to the system

startup
```
public static void startup(Properties p)
```
Initialize global settings Find and load modules

Parameters:

p - properties from runtime configuration

applyLogLevels
```
public static void applyLogLevels()
```
Set the org.openmrs log4j logger's level if global property log.level.openmrs ( OpenmrsConstants.GLOBAL_PROPERTY_LOG_LEVEL ) exists. Valid values for global property are trace, debug, info, warn, error or fatal.

applyLogLevel
```
public static void applyLogLevel(String logClass,
                                 String logLevel)
```
Set the log4j log level for class logClass to logLevel.

Parameters:

logClass - optional string giving the class level to change. Defaults to OpenmrsConstants.LOG_CLASS_DEFAULT . Should be something like org.openmrs.___

logLevel - one of OpenmrsConstants.LOG_LEVEL_*

parseParameterList
```
public static Map<String,String> parseParameterList(String paramList)
```
Takes a String like "size=compact|order=date" and returns a Map from the keys to the values.

Parameters:

paramList - String with a list of parameters

Returns:

Map of the parameters passed

nullSafeEquals

public static <Arg1,Arg2 extends Arg1> boolean nullSafeEquals(Arg1 d1,
                                                              Arg2 d2)

compare
```
public static int compare(Date d1,
                          Date d2)
```
Compares two java.util.Date objects, but handles java.sql.Timestamp (which is not directly comparable to a date) by dropping its nanosecond value.

compareWithNullAsEarliest

public static int compareWithNullAsEarliest(Date d1,
                                            Date d2)

Compares two Date/Timestamp objects, treating null as the earliest possible date.

compareWithNullAsLatest

public static int compareWithNullAsLatest(Date d1,
                                          Date d2)

Compares two Date/Timestamp objects, treating null as the earliest possible date.

compareWithNullAsLowest

public static <E extends Comparable<E>> int compareWithNullAsLowest(E c1,
                                                                    E c2)

compareWithNullAsGreatest

public static <E extends Comparable<E>> int compareWithNullAsGreatest(E c1,
                                                                      E c2)

ageFromBirthdate
```
@Deprecated
public static Integer ageFromBirthdate(Date birthdate)
```
Deprecated. this method is not currently used within OpenMRS and is a duplicate of Person.getAge(Date)

join
```
public static <E> String join(Collection<E> c,
                              String separator)
```
Converts a collection to a String with a specified separator between all elements

Parameters:

c - Collection to be joined

separator - string to put between all elements

Returns:

a String representing the toString() of all elements in c, separated by separator

conceptSetHelper

public static Set<Concept> conceptSetHelper(String descriptor)

delimitedStringToConceptList

@Deprecated
public static List<Concept> delimitedStringToConceptList(String delimitedString,
                                                                     String delimiter,
                                                                     Context context)

Deprecated. replaced by delimitedStringToConceptList(String,String)

Also see TRUNK-3665

delimitedStringToConceptList
```
public static List<Concept> delimitedStringToConceptList(String delimitedString,
                                                         String delimiter)
```
Parses and loads a delimited list of concept ids or names

Parameters:

delimitedString - the delimited list of concept ids or names

delimiter - the delimiter, e.g. ","

Returns:

the list of concepts

Since:

1.10, 1.9.2, 1.8.5

delimitedStringToConceptMap

public static Map<String,Concept> delimitedStringToConceptMap(String delimitedString,
                                                              String delimiter)

getConceptByIdOrName

public static Concept getConceptByIdOrName(String idOrName)

conceptListHelper

public static List<Concept> conceptListHelper(String descriptor)

lastSecondOfDay
```
public static Date lastSecondOfDay(Date date)
```
Return a date that is the same day as the passed in date, but the hours and seconds are the latest possible for that day.

Parameters:

date - date to adjust

Returns:

a date that is the last possible time in the day

safeDate
```
public static Date safeDate(Date d1)
```

deleteDirectory
```
public static boolean deleteDirectory(File dir)
                               throws IOException
```
Recursively deletes files in the given dir folder

Parameters:

dir - File directory to delete

Returns:

true/false whether the delete was completed successfully

Throws:

IOException - if dir is not a directory

url2file
```
public static File url2file(URL url)
```
Utility method to convert local URL to a File object.

Parameters:

url - an URL

Returns:

file object for given URL or null if URL is not local

Should:

return null given null parameter

getResourceInputStream
```
public static InputStream getResourceInputStream(URL url)
                                          throws IOException
```
Opens input stream for given resource. This method behaves differently for different URL types:
- for local files it returns buffered file input stream;
- for local JAR files it reads resource content into memory buffer and returns byte array input stream that wraps those buffer (this prevents locking JAR file);
- for common URL's this method simply opens stream to that URL using standard URL API.
It is not recommended to use this method for big resources within JAR files.
Parameters:

url - resource URL

Returns:

input stream for given resource

Throws:

IOException - if any I/O error has occurred

getApplicationDataDirectory

public static String getApplicationDataDirectory()

 Returns the application data directory. Searches for the value first 
 in the "application_data_directory" runtime property, then in the servlet
 init parameter "application.data.directory." If not found, returns:
 a) "{user.home}/.OpenMRS" on UNIX-based systems
 b) "{user.home}\Application Data\OpenMRS" on Windows
 
 Path can be set via systemproperty OPENMRS_APPLICATION_DATA_DIRECTORY
 for development purposes.

Returns:: The path to the directory on the file system that will hold miscellaneous data about the application (runtime properties, modules, etc)

validateJavaVersion
```
public static void validateJavaVersion()
```
Checks whether the current JVM version is at least Java 6.

Throws:

org.springframework.context.ApplicationContextException - if the current JVM version is earlier than Java 6

getDirectoryInApplicationDataDirectory
```
public static File getDirectoryInApplicationDataDirectory(String folderName)
                                                   throws APIException
```
Find the given folderName in the application data directory. Or, treat folderName like an absolute url to a directory

Parameters:

folderName -

Returns:

folder capable of storing information

Throws:

APIException

saveDocument
```
public static void saveDocument(Document doc,
                                File outFile)
```
Save the given xml document to the given outfile

Parameters:

doc - Document to be saved

outFile - file pointer to the location the xml file is to be saved to

delimitedStringToIntegerList

public static List<Integer> delimitedStringToIntegerList(String delimitedString,
                                                         String delimiter)

isConceptInList

public static boolean isConceptInList(Concept concept,
                                      List<Concept> list)

fromDateHelper

public static Date fromDateHelper(Date comparisonDate,
                                  Integer withinLastDays,
                                  Integer withinLastMonths,
                                  Integer untilDaysAgo,
                                  Integer untilMonthsAgo,
                                  Date sinceDate,
                                  Date untilDate)

toDateHelper

public static Date toDateHelper(Date comparisonDate,
                                Integer withinLastDays,
                                Integer withinLastMonths,
                                Integer untilDaysAgo,
                                Integer untilMonthsAgo,
                                Date sinceDate,
                                Date untilDate)

containsAny

public static <T> boolean containsAny(Collection<T> collection,
                                      Collection<T> elements)

Parameters:: collection -; elements -
Returns:: Whether _collection_ contains any of _elements_

addToSetMap

public static <K,V> void addToSetMap(Map<K,Set<V>> map,
                                     K key,
                                     V obj)

Allows easy manipulation of a Map

addToListMap

public static <K,V> void addToListMap(Map<K,List<V>> map,
                                      K key,
                                      V obj)

getDateFormat
```
@Deprecated
public static SimpleDateFormat getDateFormat()
```
Deprecated. use Context.getDateFormat() or #getDateFormat(Context#getLocale()) instead

Get the current user's date format Will look similar to "mm-dd-yyyy". Depends on user's locale.

Returns:

a simple date format

getDateFormat
```
public static SimpleDateFormat getDateFormat(Locale locale)
```
Get the current user's date format Will look similar to "mm-dd-yyyy". Depends on user's locale.

Returns:

a simple date format

Since:

1.5

Should:

return a pattern with four y characters in it, not allow the returned SimpleDateFormat to be modified

toPatientFilter

@Deprecated
public static PatientFilter toPatientFilter(PatientSearch search,
                                                        CohortSearchHistory history)

Deprecated. see reportingcompatibility module

parse
```
public static Object parse(String string,
                           Class clazz)
```
Takes a String (e.g. a user-entered one) and parses it into an object of the specified class

Parameters:

string -

clazz -

Returns:

Object of type clazz with the data from string

toPatientFilter

@Deprecated
public static PatientFilter toPatientFilter(PatientSearch search,
                                                        CohortSearchHistory history,
                                                        EvaluationContext evalContext)

Deprecated. see reportingcompatibility module

Uses reflection to translate a PatientSearch into a PatientFilter

collectionContains
```
public static boolean collectionContains(Collection<?> objects,
                                         Object obj)
```
Loops over the collection to check to see if the given object is in that collection. This method only uses the .equals() method for comparison. This should be used in the patient/person objects on their collections. Their collections are SortedSets which use the compareTo method for equality as well. The compareTo method is currently optimized for sorting, not for equality. A null obj will return false

Parameters:

objects - collection to loop over

obj - Object to look for in the objects

Returns:

true/false whether the given object is found

Should:

use equals method for comparison instead of compareTo given List collection, use equals method for comparison instead of compareTo given SortedSet collection

getSerializer
```
@Deprecated
public static org.simpleframework.xml.Serializer getSerializer()
```
Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion

Get a serializer that will do the common type of serialization and deserialization. Cycles of objects are taken into account

Returns:

Serializer to do the (de)serialization

getShortSerializer
```
@Deprecated
public static org.simpleframework.xml.Serializer getShortSerializer()
```
Deprecated. - Use OpenmrsSerializer from Context.getSerializationService.getDefaultSerializer() Note, this uses a different Serialization mechanism, so you may need to use this for conversion

Get a short serializer that will only do the very basic serialization necessary. This is controlled by the objects that are being serialized via the @Replace methods

Returns:

Serializer to do the short (de)serialization

See Also:

OpenmrsConstants.SHORT_SERIALIZATION

isShortSerialization
```
@Deprecated
public static boolean isShortSerialization(Map<?,?> sessionMap)
```
Deprecated. - use SerializationService and OpenmrsSerializer implementation for Serialization

True/false whether the current serialization is supposed to be a short serialization. A shortened serialization This should be called from methods marked with the @Replace notation that take in a single Map parameter.

Parameters:

sessionMap - current serialization session

Returns:

true/false whether or not to do the shortened serialization

getOutFile
```
public static File getOutFile(File dir,
                              Date date,
                              User user)
```
Gets an out File object. If date is not provided, the current timestamp is used. If user is not provided, the user id is not put into the filename. Assumes dir is already created

Parameters:

dir - directory to make the random filename in

date - optional Date object used for the name

user - optional User creating this file object

Returns:

file new file that is able to be written to

generateUid
```
public static String generateUid(Integer size)
```
Creates a relatively acceptable unique string of the give size

Returns:

unique string

generateUid
```
public static String generateUid()
```
Creates a uid of length 20

See Also:

generateUid(Integer)

postToUrl
```
@Deprecated
public static String postToUrl(String urlString,
                                           Map<String,String> dataToPost)
```
Deprecated. use org.openmrs.util.HttpClient

Post the given map of variables to the given url string

Parameters:

urlString - valid http url to post data to

dataToPost - Map of key value pairs to post to urlString

Returns:

response from urlString after posting

storeProperties
```
public static void storeProperties(Properties properties,
                                   File file,
                                   String comment)
```
Convenience method to replace Properties.store(), which isn't UTF-8 compliant
NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecessary.

Parameters:

properties -

file -

comment -

storeProperties
```
public static void storeProperties(Properties properties,
                                   OutputStream outStream,
                                   String comment)
```
Convenience method to replace Properties.store(), which isn't UTF-8 compliant NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument.

Parameters:

properties -

file -

comment - (which appears in comments in properties file)

loadProperties
```
public static void loadProperties(Properties props,
                                  InputStream input)
```
Deprecated. use loadProperties(Properties, File)

This method is a replacement for Properties.load(InputStream) so that we can load in utf-8 characters. Currently the load method expects the inputStream to point to a latin1 encoded file.
NOTE: In Java 6, you will be able to pass the load() and store() methods a UTF-8 Reader/Writer object as an argument, making this method unnecesary.

Parameters:

props - the properties object to write into

input - the input stream to read from

loadProperties
```
public static void loadProperties(Properties props,
                                  File propertyFile)
```
Convenience method used to load properties from the given file.

Parameters:

props - the properties object to be loaded into

propertyFile - the properties file to read

getMessage
```
public static String getMessage(String code,
                                Object... args)
```
Utility method for getting the translation for the passed code

Parameters:

code - the message key to lookup

args - the replacement values for the translation string

Returns:

the message, or if not found, the code

validatePassword

public static void validatePassword(String username,
                                    String password,
                                    String systemId)
                             throws PasswordException

Utility to check the validity of a password for a certain User. Passwords must be non-null. Their required strength is configured via global properties:

Description	Property	Default Value
Require that it not match the `User`'s username or system id	`OpenmrsConstants.GP_PASSWORD_CANNOT_MATCH_USERNAME_OR_SYSTEMID`	true
Require a minimum length	`OpenmrsConstants.GP_PASSWORD_MINIMUM_LENGTH`	8
Require both an upper and lower case character	`OpenmrsConstants.GP_PASSWORD_REQUIRES_UPPER_AND_LOWER_CASE`	true
Require at least one numeric character	`OpenmrsConstants.GP_PASSWORD_REQUIRES_DIGIT`	true
Require at least one non-numeric character	`OpenmrsConstants.GP_PASSWORD_REQUIRES_NON_DIGIT`	true
Require a match on the specified regular expression	`OpenmrsConstants.GP_PASSWORD_CUSTOM_REGEX`	null

Parameters:: username - user name of the user with password to validated; password - string that will be validated; systemId - system id of the user with password to be validated
Throws:: PasswordException
Since:: 1.5
Should:: fail with short password by default, fail with short password if not allowed, pass with short password if allowed, fail with digit only password by default, fail with digit only password if not allowed, pass with digit only password if allowed, fail with char only password by default, fail with char only password if not allowed, pass with char only password if allowed, fail without both upper and lower case password by default, fail without both upper and lower case password if not allowed, pass without both upper and lower case password if allowed, fail with password equals to user name by default, fail with password equals to user name if not allowed, pass with password equals to user name if allowed, fail with password equals to system id by default, fail with password equals to system id if not allowed, pass with password equals to system id if allowed, fail with password not matching configured regex, pass with password matching configured regex, allow password to contain non alphanumeric characters, allow password to contain white spaces, still work without an open session

containsUpperAndLowerCase
```
public static boolean containsUpperAndLowerCase(String test)
```
Parameters:

test - the string to test

Returns:

true if the passed string contains both upper and lower case characters

Should:

return true if string contains upper and lower case, return false if string does not contain lower case characters, return false if string does not contain upper case characters

containsOnlyDigits
```
public static boolean containsOnlyDigits(String test)
```
Parameters:

test - the string to test

Returns:

true if the passed string contains only numeric characters

Should:

return true if string contains only digits, return false if string contains any non-digits

containsDigit
```
public static boolean containsDigit(String test)
```
Parameters:

test - the string to test

Returns:

true if the passed string contains any numeric characters

Should:

return true if string contains any digits, return false if string contains no digits

closeStream
```
public static void closeStream(Closeable closableStream)
```
A null-safe and exception safe way to close an inputstream or an outputstream

Parameters:

closableStream - an InputStream or OutputStream to close

shortenedStackTrace
```
public static String shortenedStackTrace(String stackTrace)
```
Convert a stack trace into a shortened version for easier viewing and data storage, excluding those lines we are least concerned with; should average about 60% reduction in stack trace length

Parameters:

stackTrace - original stack trace from an error

Returns:

shortened stack trace

Since:

1.7

Should:

return null if stackTrace is null, remove springframework and reflection related lines

getRuntimeProperties

public static Properties getRuntimeProperties(String applicationName)

 Finds and loads the runtime properties file for a specific OpenMRS application.
 Searches for the file in this order:
 1) an environment variable called "{APPLICATIONNAME}_RUNTIME_PROPERTIES_FILE"
 2) {openmrs_app_dir}/{applicationName}_runtime.properties   // openmrs_app_dir is typically {user_home}/.OpenMRS
 3) {current directory}/{applicationname}_runtime.properties

Parameters:: applicationName - (defaults to "openmrs") the name of the running OpenMRS application, e.g. if you have deployed OpenMRS as a web application you would give the deployed context path here
Returns:: runtime properties, or null if none can be found
Since:: 1.8
See Also:: getApplicationDataDirectory()

nullSafeEqualsIgnoreCase
```
public static boolean nullSafeEqualsIgnoreCase(String s1,
                                               String s2)
```
Performs a case insensitive Comparison of two strings taking care of null values

Parameters:

s1 - the string to compare

s2 - the string to compare

Returns:

Since:

1.8

Should:

return false if only one of the strings is null, be case insensitive

Class OpenmrsUtil

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

OpenmrsUtil

Method Detail

getCheckDigit

isValidCheckDigit

compareLists

isStringInArray

isInNormalNumericRange

isInCriticalNumericRange

isInAbsoluteNumericRange

isValidNumericValue

getFileAsString

getFileAsBytes

copyFile

folderContains

getCorePrivileges

getCoreRoles

startup

applyLogLevels

applyLogLevel

parseParameterList

nullSafeEquals

compare

compareWithNullAsEarliest

compareWithNullAsLatest

compareWithNullAsLowest

compareWithNullAsGreatest

ageFromBirthdate

join

conceptSetHelper

delimitedStringToConceptList

delimitedStringToConceptList

delimitedStringToConceptMap

getConceptByIdOrName

conceptListHelper

lastSecondOfDay

safeDate

deleteDirectory

url2file

getResourceInputStream

getApplicationDataDirectory

validateJavaVersion

getDirectoryInApplicationDataDirectory

saveDocument

delimitedStringToIntegerList

isConceptInList

fromDateHelper

toDateHelper

containsAny

addToSetMap

addToListMap

getDateFormat

getDateFormat

toPatientFilter

parse

toPatientFilter

collectionContains

getSerializer

getShortSerializer

isShortSerialization

getOutFile

generateUid

generateUid

postToUrl

storeProperties

storeProperties

loadProperties

loadProperties

getMessage

validatePassword

containsUpperAndLowerCase

containsOnlyDigits

containsDigit

closeStream

shortenedStackTrace

getRuntimeProperties