META-INF.tld.struts-bean.tld Maven / Gradle / Ivy
Note: Some of the features in this taglib are also
available in the JavaServer Pages Standard Tag Library (JSTL).
The Struts team encourages the use of the standard tags over the Struts
specific tags when possible.
This tag library contains tags useful in accessing beans and their
properties, as well as defining new beans (based on these accesses)
that are accessible to the remainder of the page via scripting variables
and page scope attributes. Convenient mechanisms to create new beans
based on the value of request cookies, headers, and parameters are also
provided.
Many of the tags in this tag library will throw a
JspException at runtime when they are utilized incorrectly
(such as when you specify an invalid combination of tag attributes). JSP
allows you to declare an "error page" in the <%@ page %>
directive. If you wish to process the actual exception that caused the
problem, it is passed to the error page as a request attribute under key
org.apache.struts.action.EXCEPTION.
]]>
1.4
bean
http://struts.apache.org/tags-bean
Define a scripting variable based on the value(s) of the specified
request cookie.
Retrieve the value of the specified request cookie (as a single
value or multiple values, depending on the multiple attribute),
and define the result as a page scope attribute of type Cookie
(if multiple is not specified) or Cookie[]
(if multiple is specified).
If no cookie with the specified name can be located, and no default
value is specified, a request time exception will be thrown.
]]>
cookie
org.apache.struts.taglib.bean.CookieTag
org.apache.struts.taglib.bean.CookieTei
empty
Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified request cookie.
]]>
id
true
false
java.lang.String
If any arbitrary value for this attribute is specified, causes all
matching cookies to be accumulated and stored into a bean of type
Cookie[]. If not specified, the first value for the
specified cookie will be retrieved as a value of type
Cookie.
]]>
multiple
false
true
java.lang.String
Specifies the name of the request cookie whose value, or values,
is to be retrieved.
]]>
name
true
true
java.lang.String
The default cookie value to return if no cookie with the
specified name was included in this request.
]]>
value
false
true
java.lang.String
Define a scripting variable based on the value(s) of the specified
bean property.
Create a new attribute (in the scope specified by the
toScope property, if any), and a corresponding scripting
variable, both of which are named by the value of the id
attribute. The corresponding value to which this new attribute (and
scripting variable) is set are specified via use of exactly one of the
following approaches (trying to use more than one will result in a
JspException being thrown):
- Specify a
name attribute (plus optional
property and scope attributes) -
The created attribute and scripting variable will be of the type of the
retrieved JavaBean property, unless it is a Java primitive type,
in which case it will be wrapped in the appropriate wrapper class
(i.e. int is wrapped by java.lang.Integer).
- Specify a
value attribute - The created attribute and
scripting variable will be of type java.lang.String,
set to the value of this attribute.
- Specify nested body content - The created attribute and scripting
variable will be of type
java.lang.String, set to
the value of the nested body content.
If a problem occurs while retrieving the specified bean property, a
request time exception will be thrown.
The <bean:define> tag differs from
<jsp:useBean> in several ways, including:
- Unconditionally creates (or replaces) a bean under the
specified identifier.
- Can create a bean with the value returned by a property getter
of a different bean (including properties referenced with a
nested and/or indexed property name).
- Can create a bean whose contents is a literal string (or the result
of a runtime expression) specified by the
value
attribute.
- Does not support nested content (such as
<jsp:setProperty> tags) that are only executed
if a bean was actually created.
USAGE NOTE - There is a restriction in the JSP 1.1
Specification that disallows using the same value for an id
attribute more than once in a single JSP page. Therefore, you will not
be able to use <bean:define> for the same bean
name more than once in a single page.
USAGE NOTE - If you use another tag to create the
body content (e.g. bean:write), that tag must return a non-empty String.
An empty String equates to an empty body or a null String, and a new
scripting variable cannot be defined as null. Your bean must return a
non-empty String, or the define tag must be wrapped within a logic tag
to test for an empty or null value.
USAGE NOTE - You cannot use bean:define to instantiate
a DynaActionForm (type="org.apache.struts.action.DynaActionForm") with
the properties specified in the struts-config. The mechanics of creating
the dyna-properties is complex and cannot be handled by a no-argument
constructor. If you need to create an ActionForm this way, you must use
a conventional ActionForm.
See the Bean Developer's Guide section on
bean creation for more information about these differences, as well
as alternative approaches to introducing beans into a JSP page.
]]>
define
org.apache.struts.taglib.bean.DefineTag
org.apache.struts.taglib.bean.DefineTei
JSP
Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified property.
]]>
id
true
false
java.lang.String
Specifies the attribute name of the bean whose property is accessed
to define a new page scope attribute (if property is also
specified) or the attribute name of the bean that is duplicated with
the new reference created by this tag (if property is not
also specified). This attribute is required unless you specify
a value attribute or nested body content.
]]>
name
false
true
java.lang.String
Specifies the name of the property to be accessed on the bean
specified by name. This value may be a simple, indexed,
or nested property reference expression. If not specified, the bean
identified by name is given a new reference identified by
id.
]]>
property
false
true
java.lang.String
Specifies the variable scope searched to retrieve the bean specified
by name. If not specified, the default rules applied by
PageContext.findAttribute() are applied.
]]>
scope
false
true
java.lang.String
Specifies the variable scope into which the newly defined bean will
be created. If not specified, the bean will be created in
page scope.
]]>
toScope
false
true
java.lang.String
Specifies the fully qualified class name of the value to be exposed
as the id attribute.
]]>
type
false
true
java.lang.String
The java.lang.String value to which the exposed bean
should be set. This attribute is required unless you specify the
name attribute or nested body content.
]]>
value
false
true
java.lang.String
Define a scripting variable based on the value(s) of the specified
request header.
Retrieve the value of the specified request header (as a single
value or multiple values, depending on the multiple attribute),
and define the result as a page scope attribute of type String
(if multiple is not specified) or String[]
(if multiple is specified).
If no header with the specified name can be located, and no default
value is specified, a request time exception will be thrown.
]]>
header
org.apache.struts.taglib.bean.HeaderTag
org.apache.struts.taglib.bean.HeaderTei
empty
Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified request header.
]]>
id
true
false
java.lang.String
If any arbitrary value for this attribute is specified, causes a call
to HttpServletRequest.getHeaders() and a definition of the
result as a bean of type String[]. Otherwise,
HttpServletRequest.getHeader() will be called, and a
definition of the result as a bean of type String
will be performed.
]]>
multiple
false
true
java.lang.String
Specifies the name of the request header whose value, or values,
is to be retrieved.
]]>
name
true
true
java.lang.String
The default header value to return if no header with the
specified name was included in this request.
]]>
value
false
true
java.lang.String
Load the response from a dynamic application request and make it available
as a bean.
Perform an internal dispatch to the specified application component
(or external URL)
and make the response data from that request available as a bean of
type String. This tag has a function similar to that of
the standard <jsp:include> tag, except that the
response data is stored in a page scope attribute instead of being
written to the output stream. If the current request is part of a
session, the generated request for the include will also include the
session identifier (and thus be part of the same session).
The URL used to access the specified application component is
calculated based on which of the following attributes you specify
(you must specify exactly one of them):
- forward - Use the value of this attribute as the name
of a global
ActionForward to be looked up, and
use the module-relative or context-relative URI found there.
- href - Use the value of this attribute unchanged (since
this might link to a resource external to the application, the
session identifier is not included.
- page - Use the value of this attribute as an
module-relative URI to the desired resource.
]]>
include
org.apache.struts.taglib.bean.IncludeTag
org.apache.struts.taglib.bean.IncludeTei
empty
Optional anchor tag ("#xxx") to be added to the generated
hyperlink. Specify this value without any
"#" character.
]]>
anchor
false
true
java.lang.String
Logical name of a global ActionForward that contains
the actual content-relative URI of the resource to be included.
]]>
forward
false
true
java.lang.String
Absolute URL (including the appropriate protocol prefix such as
"http:") of the resource to be included. Because this URL could be
external to the current web application, the session identifier will
not be included in the request.
]]>
href
false
true
java.lang.String
Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified web application resource.
]]>
id
true
false
java.lang.String
Module-relative URI (starting with a '/') of the web application
resource to be included.
]]>
page
false
true
java.lang.String
Set to true if you want the current
transaction control token included in the generated
URL for this include.
]]>
transaction
false
true
boolean
Render an internationalized message string to the response.
Retrieves an internationalized message for the specified locale,
using the specified message key, and write it to the output stream.
Up to five parametric replacements (such as "{0}") may be specified.
The message key may be specified directly, using the key
attribute, or indirectly, using the name and
property attributes to obtain it from a bean.
JSTL: The equivalent JSTL tag is <fmt:message>. For example,
<fmt:message key="my.msg.key">
<fmt:param value="replacement text"/>
</fmt:message>
]]>
message
org.apache.struts.taglib.bean.MessageTag
empty
First parametric replacement value, if any.
]]>
arg0
false
true
java.lang.String
Second parametric replacement value, if any.
]]>
arg1
false
true
java.lang.String
Third parametric replacement value, if any.
]]>
arg2
false
true
java.lang.String
Fourth parametric replacement value, if any.
]]>
arg3
false
true
java.lang.String
Fifth parametric replacement value, if any.
]]>
arg4
false
true
java.lang.String
The name of the application scope bean under which the
MessageResources object containing our messages
is stored.
]]>
bundle
false
true
java.lang.String
The message key of the requested message, which must have
a corresponding value in the message resources. If not specified,
the key is obtained from the name and
property attributes.
]]>
key
false
true
java.lang.String
The name of the session scope bean under which our currently
selected Locale object is stored.
]]>
locale
false
true
java.lang.String
Specifies the attribute name of the bean whose property is accessed
to retrieve the value specified by property (if
specified). If property is not specified, the value of
this bean itself will be used as the message resource key.
]]>
name
false
true
java.lang.String
Specifies the name of the property to be accessed on the bean
specified by name. This value may be a simple, indexed,
or nested property reference expression. If not specified, the value
of the bean identified by name will itself be used as the
message resource key.
]]>
property
false
true
java.lang.String
Specifies the variable scope searched to retrieve the bean specified
by name. If not specified, the default rules applied by
PageContext.findAttribute() are applied.
]]>
scope
false
true
java.lang.String
Expose a specified item from the page context as a bean.
Retrieve the value of the specified item from the page context
for this page, and define it as a scripting variable, and a page scope
attribute accessible to the remainder of the current page.
If a problem occurs while retrieving the specified configuration
object, a request time exception will be thrown.
]]>
page
org.apache.struts.taglib.bean.PageTag
org.apache.struts.taglib.bean.PageTei
empty
Specifies the name of the scripting variable (and associated
page scope attribute) that will be made available with the value of
the specified page context property.
]]>
id
true
false
java.lang.String
Name of the property from our page context to be retrieved and
exposed. Must be one of application, config,
request, response, or session.
]]>
property
true
true
java.lang.String
Define a scripting variable based on the value(s) of the specified
request parameter.
Retrieve the value of the specified request parameter (as a single
value or multiple values, depending on the multiple attribute),
and define the result as a page scope attribute of type String
(if multiple is not specified) or String[]
(if multiple is specified).
If no request parameter with the specified name can be located, and
no default value is specified, a request time exception will be thrown.
]]>
parameter
org.apache.struts.taglib.bean.ParameterTag
org.apache.struts.taglib.bean.ParameterTei
empty
Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified request parameter.
]]>
id
true
false
java.lang.String
If any arbitrary value for this attribute is specified, causes a call
to ServletRequest.getParameterValues() and a definition of
the result as a bean of type String[]. Otherwise,
ServletRequest.getParameter() will be called, and a
definition of the result as a bean of type String
will be performed.
]]>
multiple
false
true
java.lang.String
Specifies the name of the request parameter whose value, or values,
is to be retrieved.
]]>
name
true
true
java.lang.String
The default parameter value to return if no parameter with the
specified name was included in this request.
]]>
value
false
true
java.lang.String
Load a web application resource and make it available as a bean.
Retrieve the value of the specified web application resource, and make
it available as either a InputStream or a String,
depending on the value of the input attribute.
If a problem occurs while retrieving the specified resource, a
request time exception will be thrown.
]]>
resource
org.apache.struts.taglib.bean.ResourceTag
org.apache.struts.taglib.bean.ResourceTei
empty
Specifies the name of the scripting variable (and associated page
scope attribute) that will be made available with the value of the
specified web application resource.
]]>
id
true
false
java.lang.String
If any arbitrary value for this attribute is specified, the resource
will be made available as an InputStream. If this
attribute is not specified, the resource will be made available
as a String.
]]>
input
false
true
java.lang.String
Module-relative name (starting with a '/') of the web application
resource to be loaded and made available.
]]>
name
true
true
java.lang.String
Define a bean containing the number of elements in a Collection or Map.
Given a reference to an array, Collection or Map, creates a new bean, of
type java.lang.Integer, whose value is the number of elements
in that collection. You can specify the collection to be counted in any
one of the following ways:
- As a runtime expression specified as the value of the
collection attribute.
- As a JSP bean specified by the
name attribute.
- As the property, specified by the
property attribute,
of the JSP bean specified by the name attribute.
]]>
size
org.apache.struts.taglib.bean.SizeTag
org.apache.struts.taglib.bean.SizeTei
empty
A runtime expression that evaluates to an array, a Collection, or
a Map.
]]>
collection
false
true
java.lang.Object
The name of a page scope JSP bean, of type
java.lang.Integer, that will be created to contain the
size of the underlying collection being counted.
]]>
id
true
false
java.lang.String
The name of the JSP bean (optionally constrained to the scope
specified by the scope attribute) that contains the
collection to be counted (if property is not specified),
or whose property getter is called to return the collection to be
counted (if property is specified.
]]>
name
false
true
java.lang.String
The name of the property, of the bean specified by the
name attribute, whose getter method will return the
collection to be counted.
]]>
property
false
true
java.lang.String
The bean scope within which to search for the JSP bean specified
by the name attribute. If not specified, the available
scopes are searched in ascending sequence.
]]>
scope
false
true
java.lang.String
Expose a named Struts internal configuration object as a bean.
Retrieve the value of the specified Struts internal configuration
object, and define it as a scripting variable and as a page scope
attribute accessible to the remainder of the current page. You must
specify exactly one of the formBean, forward,
and mapping attributes to select the configuration object
to be exposed.
If a problem occurs while retrieving the specified configuration
object, a request time exception will be thrown.
]]>
struts
org.apache.struts.taglib.bean.StrutsTag
org.apache.struts.taglib.bean.StrutsTei
empty
Specifies the name of the scripting variable (and associated
page scope attribute) that will be made available with the value of
the specified Struts internal configuration object.
]]>
id
true
false
java.lang.String
Specifies the name of the Struts ActionFormBean
definition object to be exposed.
]]>
formBean
false
true
java.lang.String
Specifies the name of the global Struts ActionForward
definition object to be exposed.
]]>
forward
false
true
java.lang.String
Specifies the matching path of the Struts ActionMapping
definition object to be exposed.
]]>
mapping
false
true
java.lang.String
Render the value of the specified bean property to the current
JspWriter.
Retrieve the value of the specified bean property, and render it to the
current JspWriter as a String by the ways:
- If
format attribute exists then value will be formatted on base of format
string from format attribute and default system locale.
- If in resources exists format string for value data type (view
format
attribute description) then value will be formatted on base of format string
from resources. Resources bundle and target locale can be specified with
bundle and locale attributes. If nothing specified then
default resource bundle and current user locale will be used.
- If there is a PropertyEditor configured for the property value's class, the
getAsText() method will be called.
- Otherwise, the usual
toString() conversions will be applied.
When a format string is provided, numeric values are formatted using the
java.text.DecimalFormat class; if the format string came from
a resource, the applyLocalisedPattern() method is used, and
applyPattern() is used otherwise. Dates are formatted using
the SimpleDateFormat class. For details of the specific format
patterns, please see the Javadocs for those classes.
If a problem occurs while retrieving the specified bean property, a
request time exception will be thrown.
]]>
write
org.apache.struts.taglib.bean.WriteTag
empty
The name of the application scope bean under which the
MessageResources object containing our messages
is stored.
]]>
bundle
false
true
java.lang.String
If this attribute is set to true, the rendered property
value will be filtered for characters that are sensitive in HTML, and any
such characters will be replaced by their entity equivalents.
]]>
filter
false
true
boolean
Specifies the format string to use to convert bean or property value
to the String. If nothing specified, then default format
string for value data type will be searched in message resources by
according key.
]]>
format
false
true
java.lang.String
Specifies the key to search format string in application resources.
]]>
formatKey
false
true
java.lang.String
If this attribute is set to true, and the bean specified
by the name and scope attributes does not
exist, simply return without writing anything. If this attribute is
set to false, a runtime exception to be thrown,
consistent with the other tags in this tag library.
]]>
ignore
false
true
boolean
The name of the session scope bean under which our currently
selected Locale object is stored.
]]>
locale
false
true
java.lang.String
Specifies the attribute name of the bean whose property is accessed
to retrieve the value specified by property (if
specified). If property is not specified, the value of
this bean itself will be rendered.
]]>
name
true
true
java.lang.String
Specifies the name of the property to be accessed on the bean
specified by name. This value may be a simple, indexed,
or nested property reference expression. If not specified, the bean
identified by name will itself be rendered. If the
specified property returns null, no output will be rendered.
]]>
property
false
true
java.lang.String
Specifies the variable scope searched to retrieve the bean specified
by name. If not specified, the default rules applied by
PageContext.findAttribute() are applied.
]]>
scope
false
true
java.lang.String