org.deltava.taglib.content
Class AuthenticatedUserFilterTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.deltava.taglib.content.AuthenticatedUserFilterTag

All Implemented Interfaces:

Serializable, IterationTag, JspTag, Tag

public class AuthenticatedUserFilterTag
extends TagSupport

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

Since:

1.0

Version:

1.0

Author:

Luke

See Also:

Serialized Form

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

AuthenticatedUserFilterTag()

Method Summary

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	setAnonymous(boolean isAnon) Toggles the reverse switch for this tag and includes content for anonymous users only.
void	setVar(String name) Sets the request attribute to save the 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 Detail

AuthenticatedUserFilterTag

public AuthenticatedUserFilterTag()

Method Detail

setVar

public void setVar(String name)

Sets the request attribute to save the user object into.

Parameters:

name - the attribute name

setAnonymous

public void setAnonymous(boolean isAnon)

Toggles the reverse switch for this tag and includes content for anonymous users only.

Parameters:

isAnon - TRUE if tag behavior should be reversed, otherwise FALSE

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 authenticated, 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