BaseTag Class

com.bea.content.manager.servlets.jsp.taglib
BaseTag Class

public abstract class BaseTag

The base class for all content tags.

This provides support for the BaseTag.failOnError, BaseTag.useCache, BaseTag.cacheScope, BaseTag.cacheId, and BaseTag.cacheTimeout parameters.

Hierarchy: Object
TagSupport
BaseTag

All Implemented Interfaces: IterationTag, Serializable, Tag

Direct Known Subclasses: GetNodeTag, GetPropertyTag, SearchTag

Field Summary

`protected String`	`cacheId` The cache id.
`protected String`	`cacheScope` The cache scope.
`protected long`	`cacheTimeout` The cache timeout.
`protected boolean`	`failOnError` Are we supposed to throw an exception on an error.
`protected boolean`	`useCache` Should this try to use the `NodeCache`

Fields from javax.servlet.jsp.tagext.TagSupport

id, pageContext

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

EVAL_BODY_AGAIN

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

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

BaseTag()

Method Summary

`public String`	`getCacheId`() Get the cacheId which should be used.
`public String`	`getCacheScope`() Get the value of `BaseTag.cacheScope`.
`public String`	`getCacheTimeout`() Get the value of `BaseTag.cacheTimeout`.
`public String`	`getFailOnError`() Get the value of `BaseTag.failOnError` as a string.
`public HttpSession`	`getHttpSession`() Get the current HttpSession.
`public String`	`getUseCache`() Get the value of `BaseTag.useCache`.
`public String`	`getUserId`() Get the user id of the current user.
`public void`	`release`() Release the tag by setting everything to the default.
`public void`	`setCacheId`(`String` s) Set the value of `BaseTag.cacheId`.
`public void`	`setCacheScope`(`String` s) Sets the value of `BaseTag.cacheScope`.
`public void`	`setCacheTimeout`(`String` v) Set the value of `BaseTag.cacheTimeout`.
`public void`	`setCacheTimeout`(long l) Set the value of `BaseTag.cacheTimeout`.
`public void`	`setFailOnError`(`String` s) Set the value of `BaseTag.failOnError`.
`public void`	`setFailOnError`(boolean b) Set the value of `BaseTag.failOnError`.
`public void`	`setUseCache`(`String` s) Set the value of `BaseTag.useCache`.
`public void`	`setUseCache`(boolean b) Set the value of `BaseTag.useCache`.
`public static Map`	`toDictionary`(`String` in) Convert a semi-colon separated of "name=value" pairs into a map.

Methods from javax.servlet.jsp.tagext.TagSupport

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

Methods from class java.lang.Object

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

Methods from interface javax.servlet.jsp.tagext.IterationTag

doAfterBody

Methods from interface javax.servlet.jsp.tagext.Tag

doEndTag, doStartTag, getParent, release, setPageContext, setParent

Field Detail

cacheId

protected String cacheId

The cache id.

When accessing the cache, in general, if this is not set, then the ID should be used.

cacheScope

protected String cacheScope

The cache scope.

This should correspond to something which the NodeCache understands. The standard values are "application", "session", "page", and "request". The default is "session".

cacheTimeout

protected long cacheTimeout

The cache timeout.

failOnError

protected boolean failOnError

Are we supposed to throw an exception on an error.

useCache

protected boolean useCache

Should this try to use the NodeCache

Constructor Detail

BaseTag

public BaseTag()

Method Detail

getCacheId() Method

public String getCacheId()

Get the cacheId which should be used.

getCacheScope() Method

public String getCacheScope()

Get the value of BaseTag.cacheScope.

getCacheTimeout() Method

public String getCacheTimeout()

Get the value of BaseTag.cacheTimeout.

getFailOnError() Method

public String getFailOnError()

Get the value of BaseTag.failOnError as a string.

getHttpSession() Method

public HttpSession getHttpSession()

Get the current HttpSession.

getUseCache() Method

public String getUseCache()

Get the value of BaseTag.useCache.

getUserId() Method

public String getUserId()

Get the user id of the current user.

release() Method

public void release()

Release the tag by setting everything to the default.

Overrides: TagSupport.release()

setCacheId(String) Method

public void setCacheId(String s)

Set the value of BaseTag.cacheId.

setCacheScope(String) Method

public void setCacheScope(String s)

Sets the value of BaseTag.cacheScope.

setCacheTimeout(String) Method

public void setCacheTimeout(String v)

Set the value of BaseTag.cacheTimeout.

setCacheTimeout(long) Method

public void setCacheTimeout(long l)