org.apache.struts.taglib.bean
Class IncludeTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.struts.taglib.bean.IncludeTag

All Implemented Interfaces:

Serializable, IterationTag, Tag

Direct Known Subclasses:

ELIncludeTag

public class IncludeTag
extends TagSupport

Define the contents of a specified intra-application request as a page scope attribute of type java.lang.String. If the current request is part of a session, the session identifier will be included in the generated request, so it will be part of the same session.

FIXME: In a servlet 2.3 environment, we can use a wrapped response passed to RequestDispatcher.include().

Version:

$Rev: 471754 $ $Date: 2005-08-21 19:08:45 -0400 (Sun, 21 Aug 2005) $

See Also:

Serialized Form

Field Summary

protected String	anchor The anchor to be added to the end of the generated hyperlink.
protected static int	BUFFER_SIZE Buffer size to use when reading the input stream.
protected String	forward The name of the global ActionForward that contains a path to our requested resource.
protected String	href The absolute URL to the resource to be included.
protected String	id The name of the scripting variable that will be exposed as a page scope attribute.
protected static MessageResources	messages The message resources for this package.
protected String	page The context-relative URI of the page or servlet to be included.
protected boolean	transaction Include transaction token (if any) in the hyperlink?
protected boolean	useLocalEncoding

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

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

IncludeTag()

Method Summary

protected void	addCookie(URLConnection conn, String urlString, HttpServletRequest request) Add a session id cookie if appropriate.
int	doStartTag() Define the contents returned for the specified resource as a page scope attribute.
String	getAnchor()
String	getForward()
String	getHref()
String	getId()
String	getPage()
boolean	getTransaction()
boolean	isUseLocalEncoding()
void	release() Release all allocated resources.
void	setAnchor(String anchor)
void	setForward(String forward)
void	setHref(String href)
void	setId(String id)
void	setPage(String page)
void	setTransaction(boolean transaction)
void	setUseLocalEncoding(boolean b)

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doEndTag, findAncestorWithClass, getParent, getValue, getValues, removeValue, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

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

Field Detail

BUFFER_SIZE

protected static final int BUFFER_SIZE

Buffer size to use when reading the input stream.

See Also:

Constant Field Values

messages

protected static MessageResources messages

The message resources for this package.

anchor

protected String anchor

The anchor to be added to the end of the generated hyperlink.

forward

protected String forward

The name of the global ActionForward that contains a path to our requested resource.

href

protected String href

The absolute URL to the resource to be included.

id

protected String id

The name of the scripting variable that will be exposed as a page scope attribute.

page

protected String page

The context-relative URI of the page or servlet to be included.

transaction

protected boolean transaction

Include transaction token (if any) in the hyperlink?

useLocalEncoding

protected boolean useLocalEncoding

Constructor Detail

IncludeTag

public IncludeTag()

Method Detail

getAnchor

public String getAnchor()

setAnchor

public void setAnchor(String anchor)

getForward

public String getForward()

setForward

public void setForward(String forward)

getHref

public String getHref()

setHref

public void setHref(String href)

getId

public String getId()

Overrides:

getId in class TagSupport

setId

public void setId(String id)

Overrides:

setId in class TagSupport

getPage

public String getPage()

setPage

public void setPage(String page)

getTransaction

public boolean getTransaction()

setTransaction

public void setTransaction(boolean transaction)

isUseLocalEncoding

public boolean isUseLocalEncoding()

setUseLocalEncoding

public void setUseLocalEncoding(boolean b)

doStartTag

public int doStartTag()
               throws JspException

Define the contents returned for the specified resource as a page scope attribute.

Specified by:

doStartTag in interface Tag

Overrides:

doStartTag in class TagSupport

Throws:

JspException - if a JSP error occurs

addCookie

protected void addCookie(URLConnection conn,
                         String urlString,
                         HttpServletRequest request)

Add a session id cookie if appropriate. Can be overloaded to support a cluster.

Parameters:

conn -

urlString -

request -

Since:

Struts 1.2.0

release

public void release()

Release all allocated resources.

Specified by:

release in interface Tag

Overrides:

release in class TagSupport