org.openmrs.web.taglib

Class RequireTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.openmrs.web.taglib.RequireTag

All Implemented Interfaces:

Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag

public class RequireTag
extends javax.servlet.jsp.tagext.TagSupport

Controller for the <openmrs:require> taglib used on jsp pages. This taglib restricts the page view to currently logged in (or anonymous) users that have the given privileges.

Example use case:

 <openmrs:require privilege="Manage Concept Classes" otherwise="/login.htm" redirect="/admin/concepts/conceptClass.form" />
 

This will demand that the user have the "Manage Concept Classes" privilege. If they don't, kick the user back to the "/login.htm" page. Then, after they log in on that page, send the user to "/admin/concepts/conceptClass.form".

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static long	serialVersionUID

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

Constructors

Constructor and Description
RequireTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag()
int	doStartTag() This is where all the magic happens.
String	getAllPrivileges()
String	getAnyPrivilege()
String	getOtherwise()
String	getPrivilege()
String	getRedirect()
void	setAllPrivileges(String allPrivileges)
void	setAnyPrivilege(String anyPrivilege)
void	setOtherwise(String otherwise)
void	setPrivilege(String privilege)
void	setRedirect(String redirect)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

RequireTag

public RequireTag()

Method Detail

doStartTag

public int doStartTag()

This is where all the magic happens. The privileges are checked and the user is redirected if need be.

Returns SKIP_PAGE if the user doesn't have the privilege and SKIP_BODY if it does.

Specified by:

doStartTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doStartTag in class javax.servlet.jsp.tagext.TagSupport

See Also:

TagSupport.doStartTag()

Expected Behavior:

Should allow user with the privilege

Should allow user to have any privilege

Should allow user with all privileges

Should reject user without the privilege

Should reject user without any of the privileges

Should reject user without all of the privileges

Should set the right session attributes if the authenticated user misses some privileges

Should set the referer as the denied page url if no redirect url is specified

doEndTag

public int doEndTag()

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

See Also:

TagSupport.doEndTag()

getPrivilege

public String getPrivilege()

setPrivilege

public void setPrivilege(String privilege)

getAllPrivileges

public String getAllPrivileges()

setAllPrivileges

public void setAllPrivileges(String allPrivileges)

getAnyPrivilege

public String getAnyPrivilege()

setAnyPrivilege

public void setAnyPrivilege(String anyPrivilege)

getOtherwise

public String getOtherwise()

setOtherwise

public void setOtherwise(String otherwise)

getRedirect

public String getRedirect()

setRedirect

public void setRedirect(String redirect)