org.apache.struts.taglib.logic

Class ConditionalTagBase

Known Direct Subclasses:
CompareTagBase, EmptyTag, MatchTag, MessagesPresentTag, PresentTag

public abstract class ConditionalTagBase
extends TagSupport

Abstract base class for the various conditional evaluation tags.
Version:
$Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

Field Summary

protected String
cookie
The name of the cookie to be used as a variable.
protected String
header
The name of the HTTP request header to be used as a variable.
protected static MessageResources
messages
The message resources for this package.
protected String
name
The name of the JSP bean to be used as a variable (if property is not specified), or whose property is to be accessed (if property is specified).
protected String
parameter
The name of the HTTP request parameter to be used as a variable.
protected String
property
The name of the bean property to be used as a variable.
protected String
role
The name of the security role to be checked for.
protected String
scope
The scope to search for the bean named by the name property, or "any scope" if null.
protected String
user
The user principal name to be checked for.

Method Summary

protected abstract boolean
condition()
Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped.
int
doEndTag()
Evaluate the remainder of the current page normally.
int
doStartTag()
Perform the test required for this particular tag, and either evaluate or skip the body of this tag.
String
getCookie()
String
getHeader()
String
getName()
String
getParameter()
String
getProperty()
String
getRole()
String
getScope()
String
getUser()
void
release()
Release all allocated resources.
void
setCookie(String cookie)
void
setHeader(String header)
void
setName(String name)
void
setParameter(String parameter)
void
setProperty(String property)
void
setRole(String role)
void
setScope(String scope)
void
setUser(String user)

Field Details

cookie

protected String cookie
The name of the cookie to be used as a variable.

header

protected String header
The name of the HTTP request header to be used as a variable.

messages

protected static MessageResources messages
The message resources for this package.

name

protected String name
The name of the JSP bean to be used as a variable (if property is not specified), or whose property is to be accessed (if property is specified).

parameter

protected String parameter
The name of the HTTP request parameter to be used as a variable.

property

protected String property
The name of the bean property to be used as a variable.

role

protected String role
The name of the security role to be checked for.

scope

protected String scope
The scope to search for the bean named by the name property, or "any scope" if null.

user

protected String user
The user principal name to be checked for.

Method Details

condition

protected abstract boolean condition()
            throws JspException
Evaluate the condition that is being tested by this particular tag, and return true if the nested body content of this tag should be evaluated, or false if it should be skipped. This method must be implemented by concrete subclasses.

doEndTag

public int doEndTag()
            throws JspException
Evaluate the remainder of the current page normally.

doStartTag

public int doStartTag()
            throws JspException
Perform the test required for this particular tag, and either evaluate or skip the body of this tag.

getCookie

public String getCookie()

getHeader

public String getHeader()

getName

public String getName()

getParameter

public String getParameter()

getProperty

public String getProperty()

getRole

public String getRole()

getScope

public String getScope()

getUser

public String getUser()

release

public void release()
Release all allocated resources.

setCookie

public void setCookie(String cookie)

setHeader

public void setHeader(String header)

setName

public void setName(String name)

setParameter

public void setParameter(String parameter)

setProperty

public void setProperty(String property)

setRole

public void setRole(String role)

setScope

public void setScope(String scope)

setUser

public void setUser(String user)

Copyright B) 2000-2007 - The Apache Software Foundation