com.sun.appserv.web.taglibs.cache

Class FlushTag

java.lang.Object

javax.servlet.jsp.tagext.TagSupport

com.sun.appserv.web.taglibs.cache.FlushTag

All Implemented Interfaces:

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

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

FlushTag is a JSP tag that is used with the CacheTag. The FlushTag allows you to invalidate a complete cache or a particular cache element identified by the key. Usage Example: <%@ taglib prefix="ias" uri="Sun ONE Application Server Tags" %>

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

Constructors

Constructor and Description
FlushTag()

Method Summary

Modifier and Type	Method and Description
int	doEndTag() doEndTag just resets all the valiables in case the tag is reused
int	doStartTag() doStartTag is called when the flush tag is encountered.
void	setKey(String key) This is set a key for the cache element that needs to be cleared
void	setScope(String scope) Sets the scope of the cache.

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

Constructor Detail

FlushTag

public FlushTag()

Method Detail

doStartTag

public int doStartTag()
               throws javax.servlet.jsp.JspException

doStartTag is called when the flush tag is encountered. By the time this is called, the tag attributes are already set.

Specified by:

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

Overrides:

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

Returns:

SKIP_BODY since the tag should be empty

Throws:

javax.servlet.jsp.JspException - the standard exception thrown

doEndTag

public int doEndTag()
             throws javax.servlet.jsp.JspException

doEndTag just resets all the valiables in case the tag is reused

Specified by:

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

Overrides:

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

Returns:

always returns EVAL_PAGE since we want the entire jsp evaluated

Throws:

javax.servlet.jsp.JspException - the standard exception thrown

setKey

public void setKey(String key)

This is set a key for the cache element that needs to be cleared

setScope

public void setScope(String scope)

Sets the scope of the cache.

Parameters:

scope - the scope of the cache

Throws:

IllegalArgumentException - if the specified scope is different from request, session, and application