com.webobjects.jspservlet
Class WOExtraHeaderTag

java.lang.Object
  |
  +--javax.servlet.jsp.tagext.TagSupport
        |
        +--com.webobjects.jspservlet.WOExtraHeaderTag

All Implemented Interfaces:

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

public class WOExtraHeaderTag

extends javax.servlet.jsp.tagext.TagSupport

This is a sub-tag of both WOComponentTag WODirectActionTag used to pass HTTP headers. WebObjects supports the use of WOComponents and DirectActions in JSP through the use of a Tag Library. While WOComponentTag and WODirectActionTag specify the WOComponent or DirectAction that is used in a JSP, this specifies an additional key-value pair to be passed as an HTTP header. This tag has no body but has the following attributes:

• key. The key of the header. Required.
• value. The value of the header. Optional. If this is not passed in, the header key will be removed from the HTTP request passed to the component.

See Also:

WOComponent, WODirectAction, WODirectActionTag, WOComponentTag, 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

WOExtraHeaderTag()

Method Summary

int	doStartTag() Standard method to start using the tag.
void	setKey(String key) Sets the attribute key for this tag.
void	setValue(String value) Sets the attribute value for this tag.

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

WOExtraHeaderTag

public WOExtraHeaderTag()

Method Detail

doStartTag

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

Standard method to start using the tag. Calls its parent WOTag to set the extra header.

Specified by:

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

Overrides:

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

Returns:

SKIP_BODY, as this tag has no body

javax.servlet.jsp.JspException

See Also:

WOTag

setKey

public void setKey(String key)

Sets the attribute key for this tag. See the class description for more details. This is called by the servlet container framework to pass in the value given the JSP.

Parameters:

key - the key of the header

setValue

public void setValue(String value)

Sets the attribute value for this tag. See the class description for more details. This is called by the servlet container framework to pass in the value given the JSP. If this is not passed in, the header key will be removed from the HTTP request passed to the component.

Parameters:

value - the value of the header