|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.servlet.jsp.tagext.TagSupport
com.opensymphony.oscache.web.tag.FlushTag
public class FlushTag
FlushTag flushes caches created with <cache>. This tag provides programmatic control over when caches are flushed, and can flush all caches at once.
Usage Examples:
<%@ taglib uri="oscache" prefix="cache" %>
<cache:flush scope="application" />
<cache:flush scope="session" key="foobar" />
Note: If no scope is provided (or scope is null), it will flush
all caches globally - use with care!
Flushing is done by setting an appropriate application level time, which <cache> always looks at before retrieving the cache. If this 'flush time' is > that cache's last update, it will refresh the cache.
As such caches are not all 'flushed', they are all marked to be refreshed at their next access. That is the only way that the content can still be available if the refresh fails.
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 | |
---|---|
FlushTag()
|
Method Summary | |
---|---|
int |
doStartTag()
Process the start of the tag. |
void |
setGroup(String group)
The group to be flushed. |
void |
setKey(String value)
The key to be flushed. |
void |
setLanguage(String value)
Set the ISO-639 language code to distinguish different pages in application scope. |
void |
setPattern(String value)
The key pattern to be flushed. |
void |
setScope(String value)
Set the scope of this flush. |
Methods inherited from class javax.servlet.jsp.tagext.TagSupport |
---|
doAfterBody, doEndTag, 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 |
---|
public FlushTag()
Method Detail |
---|
public void setGroup(String group)
group
- The name of the group to flush.public void setKey(String value)
value
- The key of the specific entry to flush.public void setLanguage(String value)
value
- The language code for this cache entry.public void setPattern(String value)
value
- The key of the specific entry to flush.public void setScope(String value)
value
- The scope - either "application" (default) or "session".public int doStartTag() throws javax.servlet.jsp.JspTagException
doStartTag
in interface javax.servlet.jsp.tagext.Tag
doStartTag
in class javax.servlet.jsp.tagext.TagSupport
javax.servlet.jsp.JspTagException
- The standard tag exception thrown.
|
OSCache Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |