SuperUserFilterTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

org.deltava.taglib.content.SuperUserFilterTag

All Implemented Interfaces:: Serializable, IterationTag, JspTag, Tag

public class SuperUserFilterTag extends TagSupport

A JSP tag to filter out content that is displayed for superusers only.

Since:

1.0

Version:

7.0

Author:

Luke

See Also:

Field Summary

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

Description

SuperUserFilterTag()
Method Summary

Modifier and Type

Method

Description

int

doEndTag()

Renders the JSP closing tag and releases state.

int

doStartTag()

Renders the start of the JSP tag and applies the filter.

void

release()

Releases the tag's state variables.

void

setVar(String name)

Sets the request attribute to save the impersonated user object into.

Methods inherited from class javax.servlet.jsp.tagext.TagSupport
doAfterBody, findAncestorWithClass, getId, getParent, getValue, getValues, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details
- SuperUserFilterTag
  
  public SuperUserFilterTag()
Method Details
- setVar
  
  public void setVar(String name)
  
  Sets the request attribute to save the impersonated user object into.
  
  Parameters:
  
  name - the attribute name
- release
  
  public void release()
  
  Releases the tag's state variables.
  
  Specified by:
  
  release in interface Tag
  
  Overrides:
  
  release in class TagSupport
- doStartTag
  
  public int doStartTag() throws JspException
  
  Renders the start of the JSP tag and applies the filter.
  
  Specified by:
  
  doStartTag in interface Tag
  
  Overrides:
  
  doStartTag in class TagSupport
  
  Returns:
  
  EVAL_BODY_INCLUDE if acting as a superUser, otherwise SKIP_BODY
  
  Throws:
  
  JspException - if an error occurs
- doEndTag
  
  public int doEndTag() throws JspException
  
  Renders the JSP closing tag and releases state.
  
  Specified by:
  
  doEndTag in interface Tag
  
  Overrides:
  
  doEndTag in class TagSupport
  
  Returns:
  
  EVAL_PAGE always
  
  Throws:
  
  JspException - never