org.openmrs.api.db.hibernate

Class HibernateContextDAO

java.lang.Object

org.openmrs.api.db.hibernate.HibernateContextDAO

All Implemented Interfaces:

ContextDAO

public class HibernateContextDAO
extends Object
implements ContextDAO

Hibernate specific implementation of the ContextDAO. These methods should not be used directly, instead, the methods on the static Context file should be used.

See Also:

ContextDAO, Context

Constructor Summary

Constructors

Constructor and Description
HibernateContextDAO()

Method Summary

Modifier and Type	Method and Description
User	authenticate(String login, String password) Authenticate user with the given username and password.
void	clearEntireCache() Evicts data from all cache regions.
void	clearSession()
void	closeSession() Close session.
User	createUser(User user, String password, List<String> roleNames) Creates a new user.
void	evictAllEntities(Class<?> entityClass) Evicts all entity data of a particular class from the given region.
void	evictEntity(OpenmrsObject obj) Evicts the entity data for a particular entity instance.
void	evictFromSession(Object obj) Used to clear a cached object out of a session in the middle of a unit of work.
void	flushSession()
Connection	getDatabaseConnection()
User	getUserByUsername(String username) Gets a user given the username.
User	getUserByUuid(String uuid) Gets a user given the uuid.
void	mergeDefaultRuntimeProperties(Properties runtimeProperties) Takes the default properties defined in /metadata/api/hibernate/hibernate.default.properties and merges it into the user-defined runtime properties
void	openSession() Open session.
void	refreshEntity(Object obj) Used to re-read the state of the given instance from the underlying database.
void	setSessionFactory(org.hibernate.SessionFactory sessionFactory) Session factory to use for this DAO.
void	setupSearchIndex() Updates the search index if necessary.
void	setUserDAO(UserDAO userDao)
void	shutdown() Stops the OpenMRS System Should be called after all activity has ended and application is closing
void	startup(Properties properties) Starts the OpenMRS System Should be called prior to any kind of activity
void	updateSearchIndex()
Future<?>	updateSearchIndexAsync()
void	updateSearchIndexForObject(Object object)
void	updateSearchIndexForType(Class<?> type)

Methods inherited from class java.lang.Object

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

Constructor Detail

HibernateContextDAO

public HibernateContextDAO()

Method Detail

setSessionFactory

public void setSessionFactory(org.hibernate.SessionFactory sessionFactory)

Session factory to use for this DAO. This is usually injected by spring and its application context.

Parameters:

sessionFactory -

setUserDAO

public void setUserDAO(UserDAO userDao)

authenticate

@Transactional(noRollbackFor=ContextAuthenticationException.class)
public User authenticate(String login,
                                                                                            String password)
                                                                                     throws ContextAuthenticationException

Description copied from interface: ContextDAO

Authenticate user with the given username and password.

Specified by:

authenticate in interface ContextDAO

Parameters:

login - user's username or systemId

password - user's password

Returns:

a valid user if authentication succeeds

Throws:

ContextAuthenticationException - Should authenticate given username and password Should authenticate given systemId and password Should authenticate given systemId without hyphen and password Should not authenticate given username and incorrect password Should not authenticate given systemId and incorrect password Should not authenticate given incorrect username Should not authenticate given incorrect systemId Should not authenticate given null login Should not authenticate given empty login Should not authenticate given null password when password in database is null Should not authenticate given non null password when password in database is null Should not authenticate when password in database is empty Should give identical error messages between username and password mismatch Should lockout user after eight failed attempts Should authenticateWithCorrectHashedPassword Should authenticateWithIncorrectHashedPassword Should set uuid on user property when authentication fails with valid user Should pass regression test for 1580 Should throw a ContextAuthenticationException if username is an empty string Should throw a ContextAuthenticationException if username is white space

See Also:

ContextDAO.authenticate(java.lang.String, java.lang.String)

getUserByUuid

@Transactional(readOnly=true)
public User getUserByUuid(String uuid)

Description copied from interface: ContextDAO

Gets a user given the uuid. Privilege checks are not done here because this is used by the Context.getAuthenticatedUser() method.

Specified by:

getUserByUuid in interface ContextDAO

Parameters:

uuid - uuid of user to fetch

Returns:

the User from the database

See Also:

ContextDAO.getUserByUuid(java.lang.String)

getUserByUsername

@Transactional(readOnly=true)
public User getUserByUsername(String username)

Description copied from interface: ContextDAO

Gets a user given the username. Privilege checks are not done here because this is used by the Context.getAuthenticatedUser() or Context.authenticate(org.openmrs.api.context.Credentials) methods.

Specified by:

getUserByUsername in interface ContextDAO

Parameters:

username - The username of the user to fetch

Returns:

The matched user, null otherwise.

See Also:

ContextDAO.getUserByUsername(String)

createUser

@Transactional
public User createUser(User user,
                                      String password,
                                      List<String> roleNames)
                               throws Exception

Description copied from interface: ContextDAO

Creates a new user. When the users are managed by a third-party authentication provider, it will happen that a successfully authenticated user still needs to be created in OpenMRS. This method is made available to authentication schemes to create new users on the fly.

Specified by:

createUser in interface ContextDAO

Parameters:

user - A new user to be created.

password - The password for the new user.

roleNames - A list of role names to add to the user.

Returns:

The newly created user

Throws:

Exception

See Also:

org.openmrs.api.db.ContextDAO#createUser(User, String)

openSession

public void openSession()

Description copied from interface: ContextDAO

Open session.

Specified by:

openSession in interface ContextDAO

closeSession

public void closeSession()

Description copied from interface: ContextDAO

Close session.

Specified by:

closeSession in interface ContextDAO

See Also:

Context.closeSession()

clearSession

@Transactional
public void clearSession()

Specified by:

clearSession in interface ContextDAO

See Also:

ContextDAO.clearSession()

evictFromSession

public void evictFromSession(Object obj)

Description copied from interface: ContextDAO

Used to clear a cached object out of a session in the middle of a unit of work. Future updates to this object will not be saved. Future gets of this object will not fetch this cached copy

Specified by:

evictFromSession in interface ContextDAO

Parameters:

obj - The object to evict/remove from the session

See Also:

ContextDAO.evictFromSession(java.lang.Object)

evictEntity

public void evictEntity(OpenmrsObject obj)

Description copied from interface: ContextDAO

Evicts the entity data for a particular entity instance.

Specified by:

evictEntity in interface ContextDAO

Parameters:

obj - entity instance to evict from the DB cache

See Also:

ContextDAO.evictEntity(OpenmrsObject)

evictAllEntities

public void evictAllEntities(Class<?> entityClass)

Description copied from interface: ContextDAO

Evicts all entity data of a particular class from the given region.

Specified by:

evictAllEntities in interface ContextDAO

Parameters:

entityClass - entity class to evict from the DB cache

See Also:

ContextDAO.evictAllEntities(Class)

clearEntireCache

public void clearEntireCache()

Description copied from interface: ContextDAO

Evicts data from all cache regions.

Specified by:

clearEntireCache in interface ContextDAO

See Also:

ContextDAO.clearEntireCache()

refreshEntity

public void refreshEntity(Object obj)

Description copied from interface: ContextDAO

Used to re-read the state of the given instance from the underlying database.

Specified by:

refreshEntity in interface ContextDAO

Parameters:

obj - The object to refresh from the database in the session

See Also:

ContextDAO.refreshEntity(Object)

flushSession

@Transactional
public void flushSession()

Specified by:

flushSession in interface ContextDAO

See Also:

ContextDAO.flushSession()

startup

@Transactional
public void startup(Properties properties)

Description copied from interface: ContextDAO

Starts the OpenMRS System

Should be called prior to any kind of activity

Specified by:

startup in interface ContextDAO

Parameters:

properties - Properties

See Also:

Context.startup(Properties)

shutdown

public void shutdown()

Description copied from interface: ContextDAO

Stops the OpenMRS System Should be called after all activity has ended and application is closing

Specified by:

shutdown in interface ContextDAO

See Also:

Context.shutdown()

mergeDefaultRuntimeProperties

public void mergeDefaultRuntimeProperties(Properties runtimeProperties)

Takes the default properties defined in /metadata/api/hibernate/hibernate.default.properties and merges it into the user-defined runtime properties

Specified by:

mergeDefaultRuntimeProperties in interface ContextDAO

Parameters:

runtimeProperties - The current user specific runtime properties

See Also:

Should merge default runtime properties

updateSearchIndexForType

@Transactional
public void updateSearchIndexForType(Class<?> type)

Specified by:

updateSearchIndexForType in interface ContextDAO

See Also:

Context.updateSearchIndexForType(Class)

updateSearchIndexForObject

@Transactional
public void updateSearchIndexForObject(Object object)

Specified by:

updateSearchIndexForObject in interface ContextDAO

See Also:

ContextDAO.updateSearchIndexForObject(java.lang.Object)

setupSearchIndex

public void setupSearchIndex()

Description copied from interface: ContextDAO

Updates the search index if necessary.

The update is triggered if OpenmrsConstants.GP_SEARCH_INDEX_VERSION is blank or the value does not match OpenmrsConstants.SEARCH_INDEX_VERSION.

Specified by:

setupSearchIndex in interface ContextDAO

See Also:

ContextDAO.setupSearchIndex()

updateSearchIndex

public void updateSearchIndex()

Specified by:

updateSearchIndex in interface ContextDAO

See Also:

ContextDAO.updateSearchIndex()

updateSearchIndexAsync

public Future<?> updateSearchIndexAsync()

Specified by:

updateSearchIndexAsync in interface ContextDAO

See Also:

ContextDAO.updateSearchIndexAsync()

getDatabaseConnection

public Connection getDatabaseConnection()

Specified by:

getDatabaseConnection in interface ContextDAO

Returns:

a Connection from the OpenMRS database connection pool

See Also:

ContextDAO.getDatabaseConnection()