org.openmrs.web.filter.update

Class UpdateFilter

java.lang.Object

org.openmrs.web.filter.StartupFilter

org.openmrs.web.filter.update.UpdateFilter

All Implemented Interfaces:

javax.servlet.Filter

public class UpdateFilter
extends StartupFilter

This is the second filter that is processed. It is only active when OpenMRS has some liquibase updates that need to be run. If updates are needed, this filter/wizard asks for a super user to authenticate and review the updates before continuing.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	log

Fields inherited from class org.openmrs.web.filter.StartupFilter

AUTO_RUN_OPENMRS, errors, filterConfig, msgs, velocityEngine

Constructor Summary

Constructors

Constructor and Description
UpdateFilter()

Method Summary

Modifier and Type	Method and Description
protected boolean	authenticateAsSuperUser(String usernameOrSystemId, String password) Look in the users table for a user with this username and password and see if they have a role of RoleConstants.SUPERUSER.
void	checkLocaleAttributesForFirstTime(javax.servlet.http.HttpServletRequest httpRequest) It sets locale attribute for current session when user is making first GET http request to application.
protected void	doGet(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on GET requests
protected void	doPost(javax.servlet.http.HttpServletRequest httpRequest, javax.servlet.http.HttpServletResponse httpResponse) Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on POST requests
protected String	getTemplatePrefix() This string is prepended to all templateNames passed to StartupFilter.renderTemplate(String, Map, HttpServletResponse)
protected Object	getUpdateFilterModel() The model that is used as the backer for all pages in this startup wizard.
void	init(javax.servlet.FilterConfig filterConfig)
static Boolean	isLockReleased() Indicates if database lock was released.
protected boolean	isSuperUser(Connection connection, Integer userId) Checks the given user to see if they have been given the RoleConstants.SUPERUSER role.
static void	setLockReleased(Boolean lockReleased)
static void	setUpdatesRequired(boolean updatesRequired)
boolean	skipFilter(javax.servlet.http.HttpServletRequest httpRequest) If this returns true, this filter fails early and quickly.
static boolean	updatesRequired() Used by the Listener to know if this filter wants to do its magic

Methods inherited from class org.openmrs.web.filter.StartupFilter

addLogLinesToResponse, destroy, doFilter, getToolContext, renderTemplate, toJSONString

Methods inherited from class java.lang.Object

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

Field Detail

log

protected final org.slf4j.Logger log

Constructor Detail

UpdateFilter

public UpdateFilter()

Method Detail

doGet

protected void doGet(javax.servlet.http.HttpServletRequest httpRequest,
                     javax.servlet.http.HttpServletResponse httpResponse)
              throws IOException,
                     javax.servlet.ServletException

Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on GET requests

Specified by:

doGet in class StartupFilter

Parameters:

httpRequest -

httpResponse -

Throws:

IOException

javax.servlet.ServletException

doPost

protected void doPost(javax.servlet.http.HttpServletRequest httpRequest,
                      javax.servlet.http.HttpServletResponse httpResponse)
               throws IOException,
                      javax.servlet.ServletException

Called by StartupFilter.doFilter(ServletRequest, ServletResponse, FilterChain) on POST requests

Specified by:

doPost in class StartupFilter

Throws:

IOException

javax.servlet.ServletException

See Also:

StartupFilter.doPost(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)

checkLocaleAttributesForFirstTime

public void checkLocaleAttributesForFirstTime(javax.servlet.http.HttpServletRequest httpRequest)

It sets locale attribute for current session when user is making first GET http request to application. It retrieves user locale from request object and checks if this locale is supported by application. If not, it tries to load system default locale. If it's not specified it uses Locale.ENGLISH by default

Parameters:

httpRequest - the http request object

authenticateAsSuperUser

protected boolean authenticateAsSuperUser(String usernameOrSystemId,
                                          String password)
                                   throws javax.servlet.ServletException

Look in the users table for a user with this username and password and see if they have a role of RoleConstants.SUPERUSER.

Parameters:

usernameOrSystemId - user entered username

password - user entered password

Returns:

true if this user has the super user role

Throws:

javax.servlet.ServletException

See Also:

Should return false if given invalid credentials Should return false if given user is not superuser Should return true if given user is superuser Should not authorize retired superusers Should authenticate with systemId

isSuperUser

protected boolean isSuperUser(Connection connection,
                              Integer userId)
                       throws SQLException

Checks the given user to see if they have been given the RoleConstants.SUPERUSER role. This method does not look at child roles.

Parameters:

connection - the java sql connection to use

userId - the user id to look at

Returns:

true if the given user is a super user

Throws:

SQLException - Should return true if given user has superuser role Should return false if given user does not have the super user role

init

public void init(javax.servlet.FilterConfig filterConfig)
          throws javax.servlet.ServletException

Specified by:

init in interface javax.servlet.Filter

Overrides:

init in class StartupFilter

Throws:

javax.servlet.ServletException

See Also:

Filter.init(javax.servlet.FilterConfig)

getUpdateFilterModel

protected Object getUpdateFilterModel()

Description copied from class: StartupFilter

The model that is used as the backer for all pages in this startup wizard. Should never return null.

Specified by:

getUpdateFilterModel in class StartupFilter

Returns:

the stored formbacking/model object

See Also:

StartupFilter.getUpdateFilterModel()

skipFilter

public boolean skipFilter(javax.servlet.http.HttpServletRequest httpRequest)

Description copied from class: StartupFilter

If this returns true, this filter fails early and quickly. All logic is skipped and startup and usage continue normally.

Specified by:

skipFilter in class StartupFilter

Returns:

true if this filter can be skipped

See Also:

StartupFilter.skipFilter(HttpServletRequest)

updatesRequired

public static boolean updatesRequired()

Used by the Listener to know if this filter wants to do its magic

Returns:

true if updates have been determined to be required

See Also:

init(FilterConfig), Listener.isSetupNeeded(), Listener.contextInitialized(ServletContextEvent)

setUpdatesRequired

public static void setUpdatesRequired(boolean updatesRequired)

Parameters:

updatesRequired - the updatesRequired to set

isLockReleased

public static Boolean isLockReleased()

Indicates if database lock was released. It will also used to prevent releasing existing lock of liquibasechangeloglock table by another user, when he also tries to run database update when another user is currently running it

setLockReleased

public static void setLockReleased(Boolean lockReleased)

getTemplatePrefix

protected String getTemplatePrefix()

Description copied from class: StartupFilter

This string is prepended to all templateNames passed to StartupFilter.renderTemplate(String, Map, HttpServletResponse)

Overrides:

getTemplatePrefix in class StartupFilter

Returns:

string to prepend as the path for the templates

See Also:

StartupFilter.getTemplatePrefix()