org.openmrs.web.filter.util

Class FilterUtil

java.lang.Object

org.openmrs.web.filter.util.FilterUtil

public class FilterUtil
extends java.lang.Object

This class contains convenient methods for storing/retrieving locale parameters into/from DB as admin's user property and as default locale property for OpenMRS system

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADMIN_USERNAME
static java.lang.String	LOCALE_ATTRIBUTE
static java.lang.String	REMEMBER_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
FilterUtil()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getGlobalPropertyValue(java.lang.String globalPropertyName) Gets the value of a global Property as a string from the database using sql, this method is useful when you want to get a value of a global property before the application context has been setup
static java.lang.Integer	getUserIdByName(java.lang.String userNameOrSystemId, java.sql.Connection connection) This is a utility method that can be used for retrieving user id by given user name and sql connection
static java.lang.String	readSystemDefaultLocale(java.sql.Connection connection) This method uses passed in connection to load system default locale.
static java.lang.String	restoreLocale(java.lang.String username) Tries to retrieve location parameter.
static boolean	storeLocale(java.lang.String locale) Stores selected by user locale into DB as admin's user property and as system default locale

Methods inherited from class java.lang.Object

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

Field Detail

LOCALE_ATTRIBUTE

public static final java.lang.String LOCALE_ATTRIBUTE

See Also:

Constant Field Values

REMEMBER_ATTRIBUTE

public static final java.lang.String REMEMBER_ATTRIBUTE

See Also:

Constant Field Values

ADMIN_USERNAME

public static final java.lang.String ADMIN_USERNAME

See Also:

Constant Field Values

Constructor Detail

FilterUtil

public FilterUtil()

Method Detail

restoreLocale

public static java.lang.String restoreLocale(java.lang.String username)

Tries to retrieve location parameter. First this method makes an attempt to load locale parameter as user's property. And next, if user's property is empty it tries to retrieve default system locale (i.e system global property). If it also is empty it uses default value for system locale

Parameters:

username - the name of the administrative user whose default locale property will be restored

Returns:

string with stored location parameter or default OpenMRS locale property's value

readSystemDefaultLocale

public static java.lang.String readSystemDefaultLocale(java.sql.Connection connection)

This method uses passed in connection to load system default locale. If connection is passed as null it creates separate connection that should be closed before return from method

Parameters:

connection - (optional) the jdbc connection to be used for extracting default locale

Returns:

the string that contains system default locale or null

storeLocale

public static boolean storeLocale(java.lang.String locale)

Stores selected by user locale into DB as admin's user property and as system default locale

Parameters:

locale - the selected by user language

Returns:

true if locale was stored successfully

getUserIdByName

public static java.lang.Integer getUserIdByName(java.lang.String userNameOrSystemId,
                                                java.sql.Connection connection)
                                         throws java.sql.SQLException

This is a utility method that can be used for retrieving user id by given user name and sql connection

Parameters:

userNameOrSystemId - the name of user

connection - the java sql connection to use

Returns:

not null id of given user in case of success or null otherwise

Throws:

java.sql.SQLException

getGlobalPropertyValue

public static java.lang.String getGlobalPropertyValue(java.lang.String globalPropertyName)

Gets the value of a global Property as a string from the database using sql, this method is useful when you want to get a value of a global property before the application context has been setup

Parameters:

globalPropertyName - the name of the global property

Returns:

the global property value