ContextDAO (OpenMRS 2.7.0-SNAPSHOT API)

All Known Implementing Classes:

HibernateContextDAO
```
public interface ContextDAO
```
Defines the functions that the Context needs to access the database

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`User`	`authenticate(String username, 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 object)` 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)` Merge in the default properties defined for this database connection
`void`	`openSession()` Open session.
`void`	`refreshEntity(Object obj)` Used to re-read the state of the given instance from the underlying database.
`void`	`setupSearchIndex()` Updates the search index if necessary.
`void`	`shutdown()` Stops the OpenMRS System Should be called after all activity has ended and application is closing
`void`	`startup(Properties props)` 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)`

- Method Detail
  - authenticate
```
User authenticate(String username,
                  String password)
           throws ContextAuthenticationException
```
    Authenticate user with the given username and password.
    
    Parameters:
    
    username - 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
  - getUserByUuid
```
User getUserByUuid(String uuid)
            throws ContextAuthenticationException
```
    Gets a user given the uuid. Privilege checks are not done here because this is used by the Context.getAuthenticatedUser() method.
    
    Parameters:
    
    uuid - uuid of user to fetch
    
    Returns:
    
    the User from the database
    
    Throws:
    
    ContextAuthenticationException
  - getUserByUsername
```
User getUserByUsername(String username)
```
    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.
    
    Parameters:
    
    username - The username of the user to fetch
    
    Returns:
    
    The matched user, null otherwise.
    
    Since:
    
    2.3.0
  - createUser
```
User createUser(User user,
                String password,
                List<String> roleNames)
         throws Exception
```
    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.
    
    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
    
    Since:
    
    2.3.0
  - openSession
```
void openSession()
```
    Open session.
  - closeSession
```
void closeSession()
```
    Close session.
  - clearSession
```
void clearSession()
```
    See Also:
    
    Context.clearSession()
  - flushSession
```
void flushSession()
```
    See Also:
    
    Context.flushSession()
  - evictFromSession
```
void evictFromSession(Object obj)
```
    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
    
    Parameters:
    
    obj - The object to evict/remove from the session
    
    See Also:
    
    Context.evictFromSession(Object)
  - evictEntity
```
void evictEntity(OpenmrsObject object)
```
    Evicts the entity data for a particular entity instance.
    
    Parameters:
    
    object - entity instance to evict from the DB cache
    
    See Also:
    
    Context.evictEntity(OpenmrsObject)
  - evictAllEntities
```
void evictAllEntities(Class<?> entityClass)
```
    Evicts all entity data of a particular class from the given region.
    
    Parameters:
    
    entityClass - entity class to evict from the DB cache
    
    See Also:
    
    Context.evictAllEntities(Class)
  - clearEntireCache
```
void clearEntireCache()
```
    Evicts data from all cache regions.
    
    See Also:
    
    Context.clearEntireCache()
  - refreshEntity
```
void refreshEntity(Object obj)
```
    Used to re-read the state of the given instance from the underlying database.
    
    Parameters:
    
    obj - The object to refresh from the database in the session
    
    Since:
    
    2.0
    
    See Also:
    
    Context.refreshEntity(Object)
  - startup
```
void startup(Properties props)
```
    Starts the OpenMRS System
    Should be called prior to any kind of activity
    
    Parameters:
    
    props - Properties
  - shutdown
```
void shutdown()
```
    Stops the OpenMRS System Should be called after all activity has ended and application is closing
  - mergeDefaultRuntimeProperties
```
void mergeDefaultRuntimeProperties(Properties runtimeProperties)
```
    Merge in the default properties defined for this database connection
    
    Parameters:
    
    runtimeProperties - The current user specific runtime properties
  - setupSearchIndex
```
void setupSearchIndex()
```
    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.
  - updateSearchIndex
```
void updateSearchIndex()
```
    See Also:
    
    Context.updateSearchIndex()
  - updateSearchIndexAsync
```
Future<?> updateSearchIndexAsync()
```
    See Also:
    
    Context.updateSearchIndexAsync()
  - updateSearchIndexForObject
```
void updateSearchIndexForObject(Object object)
```
    See Also:
    
    Context.updateSearchIndexForObject(Object)
  - updateSearchIndexForType
```
void updateSearchIndexForType(Class<?> type)
```
    See Also:
    
    Context.updateSearchIndexForType(Class)
  - getDatabaseConnection
```
Connection getDatabaseConnection()
```
    Returns:
    
    a Connection from the OpenMRS database connection pool
    
    Since:
    
    2.5.7

Interface ContextDAO

Method Summary

Method Detail

authenticate

getUserByUuid

getUserByUsername

createUser

openSession

closeSession

clearSession

flushSession

evictFromSession

evictEntity

evictAllEntities

clearEntireCache

refreshEntity

startup

shutdown

mergeDefaultRuntimeProperties

setupSearchIndex

updateSearchIndex

updateSearchIndexAsync

updateSearchIndexForObject

updateSearchIndexForType

getDatabaseConnection