org.apache.taglibs.request
Class ExistsHeaderTag

java.lang.Object
  extended byjavax.servlet.jsp.tagext.TagSupport
      extended byorg.apache.taglibs.request.ExistsHeaderTag
All Implemented Interfaces:
javax.servlet.jsp.tagext.IterationTag, java.io.Serializable, javax.servlet.jsp.tagext.Tag

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

JSP Tag existsHeader, used to determine if an HttpServletRequest header exists.

Includes the body of the tag if the header exists.

You can set the optional tag header value to true or false. The body of the tag is included if existsHeader matches the value.

JSP Tag Lib Descriptor

 <name>existsHeader</name>
 <tagclass>org.apache.taglibs.request.ExistsHeaderTag</tagclass>
 <bodycontent>JSP</bodycontent>
 <info>Includes the body of the tag if the request header exists.</info>
   <attribute>
     <name>name</name>
     <required>true</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
   <attribute>
     <name>value</name>
     <required>false</required>
     <rtexprvalue>false</rtexprvalue>
   </attribute>
 

Author:
Glenn Nielsen
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
ExistsHeaderTag()
           
 
Method Summary
 int doStartTag()
          Includes the body of the tag if the request header exists.
 void setName(java.lang.String str)
          Set the required tag attribute name.
 void setValue(boolean value)
          Set the optional tag attribute value to true or false.
 
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

ExistsHeaderTag

public ExistsHeaderTag()
Method Detail

doStartTag

public final int doStartTag()
                     throws javax.servlet.jsp.JspException
Includes the body of the tag if the request header exists.

Returns:
SKIP_BODY if existsHeader doesn't match value, EVAL_BODY_include if existsHeader matches value
Throws:
javax.servlet.jsp.JspException

setName

public final void setName(java.lang.String str)
Set the required tag attribute name.


setValue

public final void setValue(boolean value)
Set the optional tag attribute value to true or false.



Copyright ? 2000-2004 The Apache Software Foundation. All Rights Reserved.