com.webobjects.jspservlet
Class WODirectActionTag

com.webobjects.jspservlet.WOTag
  |
  +--com.webobjects.jspservlet.WODirectActionTag

public class WODirectActionTag

extends com.webobjects.jspservlet.WOTag

This is a regular JSP taglib handler that enables the use of a WOComponent within a JSP. Please see WOtaglib_1_0.tld for the most authoritative definition of the tag library, including the description of this class. This tag handler has the following tag attributes:

• actionName. The Direct Action to be invoked. Required.
• className. The Direct Action class name. Optional.
• contentStream. The InputStream representing to content of the request for the Direct Action. Optional.
• bodyContentOnly. Indicates if only the WOResponse body content is required. The HTML headers will be stripped off if this is true. Default is true. Optional.
• mergeHeader. Indicates if only the WOResponse headers should be merged with the ServletResponse's headers. Default is false. Optional.

This tag's body content is labelled "jsp". What this means is that its body should be parsed for additional tags. For this version, the body contains one or more WOExtraHeaderTag or WOFormValueTag.

See Also:

WODirectAction, WOExtraHeaderTag, WOFormValueTag

Constructor Summary

WODirectActionTag()

Method Summary

int	doEndTag() Standard method to end the tag.
int	doStartTag() Standard method to start using the tag.
void	setActionName(String name) Sets the attribute actionName for this tag.
void	setBodyContentOnly(boolean bodyContentOnly) Sets the attribute bodyContentOnly for this tag.
void	setClassname(String className) Sets the attribute className for this tag.
void	setClassName(String className) Sets the attribute className for this tag.
void	setContentStream(InputStream is) Sets the content of the WOResponse as seen by the Direct Action.
void	setExtraHeader(String key, String value) Sets a key-value pair to be set as an extra HTTP header to either the WOComponent or the Direct Action.
void	setFormValue(String key, String value) Sets a key-value pair to be passed to the Direct Action as a form value in the queryString.
void	setMergeResponseHeaders(boolean mergeResponseHeaders) Sets the attribute mergeResponseHeaders for this tag.

Constructor Detail

WODirectActionTag

public WODirectActionTag()

Method Detail

doEndTag

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

Standard method to end the tag.

Overrides:

doEndTag in class com.webobjects.jspservlet.WOTag

Returns:

EVAL_PAGE, to ensure that the rest of the JSP gets evaluated

doStartTag

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

Standard method to start using the tag.

Overrides:

doStartTag in class com.webobjects.jspservlet.WOTag

Returns:

EVAL_BODY_TAG, to ensure that the tag body is evaluated, as it might contain one or more formValues or extraHeaders

See Also:

WOFormValueTag, WOExtraHeaderTag

setActionName

public void setActionName(String name)

Sets the attribute actionName 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:

className - the Direct Action name

setContentStream

public void setContentStream(InputStream is)

Sets the content of the WOResponse as seen by the Direct Action. This is optional.

Parameters:

is - the InputStream representing the content

setFormValue

public void setFormValue(String key,
                         String value)

Sets a key-value pair to be passed to the Direct Action as a form value in the queryString.

Parameters:

key - the key of the form value

value - the value of the form value

setBodyContentOnly

public void setBodyContentOnly(boolean bodyContentOnly)

Sets the attribute bodyContentOnly for this tag. This is called by the servlet container framework to pass in the value given the JSP.

Parameters:

bodyContentOnly - indicates if only the WOResponse body content is required; the HTML headers will be stripped off if this is true; default is true

setClassName

public void setClassName(String className)

Sets the attribute className 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:

className - the class name of the WOComponent or Direct Action

setClassname

public void setClassname(String className)

Sets the attribute className 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:

className - the class name of the WOComponent or Direct Action

setExtraHeader

public void setExtraHeader(String key,
                           String value)

Sets a key-value pair to be set as an extra HTTP header to either the WOComponent or the Direct Action. Passing a null object will cause the appropriate existing header to be removed from the request.

Parameters:

key - the header key

value - the value of the header

setMergeResponseHeaders

public void setMergeResponseHeaders(boolean mergeResponseHeaders)

Sets the attribute mergeResponseHeaders 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:

mergeHeader - indicates if only the WOResponse headers should be merged with the ServletResponse's headers; default is false