User Documentation

One Minute Introduction

Two Minute Introduction

Your own plugin

Coffee Break Introduction

Property substitution

FAQ

IDE Integration

Doclipse

Maven Integration

Maven2 plugin

Maven1 Plugin

Plugins

Project Information

Mailing lists

Source Repositories

Open Issues

Team

Developer Documentation

Feeds
Print
WebTags

@web tags

@jsp.attribute

Declares the specified field a JSP tag

attribute. This tag should be placed on getter methods

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
required false true, false   no   Whether the attribute is required. If not specified, the container

will assume this attribute is not required.
rtexprvalue false true, false   no   Whether the attribute is a runtime attribute. If not specified, the

container will assume this attribute can only take static values (ie

rtexprvalue=false)
type false Any value   no   The type of the attribute.
description false Any value   no   An optional description of the attribute.

@jsp.tag

Declares the class as a class implementing a

JSP tag and specifies various properties of that tag

Unique false

Allowed locations

class method constructor field
true false false false
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the JSP tag.
class false Any value   no   class name to use instead of FQCN
tei-class false Any value   no   The tei class for the JSP.
body-content false tagdependent, JSP, empty, scriptless   no   The body content field for the tag. "JSP" "empty" "tagdependent"
display-name false Any value   no   An optional display name for the tag
small-icon false Any value   no   An optional small icon for the tag
large-icon false Any value   no   An optional large icon for the tag
description false Any value   no   An optional description for the tag

@jsp.validator-init-param

Declares init parameters for the Validator

with the specified parameter name, value and description

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the validator init param
value true Any value   no   The value of the validator init param
description false Any value   no   An optional description for the validator

@jsp.variable

Declares a JSP tag variable and information

on the scripting variables defined.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name-given false Any value   no   The variable name as a constant
name-from-attribute false Any value   no   The name of an attribute whose

(translation time) value will give the name of the variable.

One of name-given or name-from-attribute is required
class false Any value   no   Name of the class of the variable.

java.lang.String is default
declare false true, false   no   Whether the variable is declared or not.
scope false NESTED, AT_BEGIN, AT_END   no   The scope of the scripting variable defined."NESTED" "AT_BEGIN" "AT_END"
description false Any value   no   An optional description of the variable

@web.ejb-local-ref

Defines a local EJB reference with the

specified name, type, home interface name, local interface name,

link name, and description. The value of the link parameter must

be the ejb-name of an enterprise bean in the same J2EE

application unit.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name false Any value   no   The name or the ejb reference
type false Entity, Session   no   The expected type of the referenced

enterprise bean. Must be one of the following: Entity or Session
home false Any value   no   The home interface of the referenced ejb
local false Any value   no   The local interface of the referenced ejb
link false Any value   no   The link to the EJB
description false Any value   no   An optional description for the ejb-ref

@web.ejb-ref

Defines a remote EJB reference with the

specified name, type, home interface name, remote interface name,

link name, and description. The value of the link parameter must

be the ejb-name of an enterprise bean in the same J2EE

application unit

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name false Any value   no   The name or the ejb reference
type false Entity, Session   no   The expected type of the referenced

enterprise bean. Must be one of the following: Entity or Session
home false Any value   no   The home interface of the referenced ejb
remote false Any value   no   The remote interface of the referenced ejb
link false Any value   no   The link to the EJB
description false Any value   no   An optional description for the ejb-ref

@web.env-entry

Defines a environment entry with the specified

description, name, type and value

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
description false Any value   no   A description of the env-entry
name true Any value   no   The name of the env-entry
type true Any value   no   The type of the env-entry
value false Any value   no   The value of the env-entry

@web.filter-init-param

Declares init parameters for the Filter with

the specified parameter name, value and description. Applicable

to Servlet 2.3 only.

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the init parameter
value false Any value   no   The value for the parameter
description false Any value   no   An optional description of the parameter

@web.filter-mapping

Defines the mapping for the Filter. Either

url-pattern or servlet-name should be specified. Applicable to

Servlet 2.3 only

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
url-pattern false Any value   no   The url pattern the filter should match
servlet-name false Any value   no   The servlet name for the filter

@web.filter

Declares the class as a Filter class, with

the specified name, display-name, icon and description.

Applicable to Servlet 2.3 only

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name for the filter. Unique within the application
display-name false Any value   no   The display name of the filter
icon false Any value   no   The icon for the filter
description false Any value   no   A description for the filter
order false Any value   no    

@web.listener

Declares the class as a Listener class

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
order false Any value   no    

@web.resource-env-ref

Defines a resource environment reference with

the specified name, type and description

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the resource environment reference
type true Any value   no   The type of the referenced resource
description false Any value   no   An optional description of the resource reference

@web.resource-ref

Defines a resource reference with the

specified name, type, description, authentication (auth) and scope

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the resource reference
type true Any value   no   The type of the referenced resource
auth true Application, Container   no   The authentication for the resource. "Application" "Container"
description false Any value   no   An optional description for the resource reference
scope false Shareable, Unshareable   no   The scope of the resource. "Shareable" "Unshareable"
jndi-name false Any value   no   The physical jndi-name of the resource. Note: it currently is used only in 1-2

of the app server modules, but those modules will also support this consolidated standard tag soon.

@web.security-role-ref

Defines a security role reference with the

name role-name to a security role link named role-link

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
role-name true Any value   no   The name of the role reference
role-link true Any value   no   The name of the role link
description false Any value   no   A description for the role ref

@web.security-role

Defines a security role with the specified

role-name and description

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
role-name false Any value   no   The role name
description false Any value   no   The description of the role

@web.servlet-init-param

Declares init parameters for the Servlet with

the specified parameter name, value and description

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the init parameter
value false Any value   no   The value for the parameter
description false Any value   no   An optional description of the parameter

@web.servlet-mapping

Defines the mapping for the Servlet to the

specified url-pattern

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
url-pattern false Any value   no   The url pattern the filter should match

@web.servlet

Declares the class as a Servlet class, with

the specified name, display-name, icon and description

Unique false

Allowed locations

class method constructor field
true true true true
Parameter Required Allowed values Default value Array Token separator Description
name true Any value   no   The name of the servlet - unique within the application
display-name false Any value   no   The display name of the servlet
icon false Any value   no   The icon for the servlet
description false Any value   no   A description for the servlet
load-on-startup false Any value   no   Integer indicating order in which the servlet should be loaded.
run-as false Any value   no   Specifies the run-as identity (the name of

a security role) to be used for the execution of the web

application.
Copyright 2003-2006 - The Codehaus. All rights reserved unless otherwise noted.
Powered by Atlassian Confluence