javax.servlet.resources.j2ee_1_4.xsd Maven / Gradle / Ivy
The following definitions that appear in the common
shareable schema(s) of J2EE deployment descriptors should be
interpreted with respect to the context they are included:
Deployment Component may indicate one of the following:
j2ee application;
application client;
web application;
enterprise bean;
resource adapter;
Deployment File may indicate one of the following:
ear file;
war file;
jar file;
rar file;
This group keeps the usage of the contained description related
elements consistent across J2EE deployment descriptors.
All elements may occur multiple times with different languages,
to support localization of the content.
The description type is used by a description element to
provide text describing the parent element. The elements
that use this type should include any information that the
Deployment Component's Deployment File file producer wants
to provide to the consumer of the Deployment Component's
Deployment File (i.e., to the Deployer). Typically, the
tools used by such a Deployment File consumer will display
the description when processing the parent element that
contains the description.
The lang attribute defines the language that the
description is provided in. The default value is "en" (English).
This type defines a dewey decimal which is used
to describe versions of documents.
Employee Self Service
The value of the xml:lang attribute is "en" (English) by default.
]]>
EmployeeRecord
../products/product.jar#ProductEJB
]]>
The ejb-local-refType is used by ejb-local-ref elements for
the declaration of a reference to an enterprise bean's local
home. The declaration consists of:
- an optional description
- the EJB reference name used in the code of the Deployment
Component that's referencing the enterprise bean
- the expected type of the referenced enterprise bean
- the expected local home and local interfaces of the
referenced enterprise bean
- optional ejb-link information, used to specify the
referenced enterprise bean
ejb/Payroll
]]>
The ejb-ref-typeType contains the expected type of the
referenced enterprise bean.
The ejb-ref-type designates a value
that must be one of the following:
Entity
Session
The ejb-refType is used by ejb-ref elements for the
declaration of a reference to an enterprise bean's home. The
declaration consists of:
- an optional description
- the EJB reference name used in the code of
the Deployment Component that's referencing the enterprise
bean
- the expected type of the referenced enterprise bean
- the expected home and remote interfaces of the referenced
enterprise bean
- optional ejb-link information, used to specify the
referenced enterprise bean
This type is used to designate an empty
element when used.
java.lang.Boolean
]]>
The env-entryType is used to declare an application's
environment entry. The declaration consists of an optional
description, the name of the environment entry, and an
optional value. If a value is not specified, one must be
supplied during deployment.
It is used by env-entry elements.
minAmount
]]>
100.00
]]>
The elements that use this type designate the name of a
Java class or interface. The name is in the form of a
"binary name", as defined in the JLS. This is the form
of name used in Class.forName(). Tools that need the
canonical name (the name used in source code) will need
to convert this binary name to the canonical name.
This type defines four different values which can designate
boolean values. This includes values yes and no which are
not designated by xsd:boolean
com.aardvark.payroll.PayrollHome
]]>
The icon type contains small-icon and large-icon elements
that specify the file names for small and large GIF or
JPEG icon images used to represent the parent element in a
GUI tool.
The xml:lang attribute defines the language that the
icon file names are provided in. Its value is "en" (English)
by default.
employee-service-icon16x16.jpg
]]>
employee-service-icon32x32.jpg
]]>
The java-identifierType defines a Java identifier.
The users of this type should further verify that
the content does not contain Java reserved keywords.
This is a generic type that designates a Java primitive
type or a fully qualified name of a Java interface/type,
or an array of such types.
The jndi-nameType type designates a JNDI name in the
Deployment Component's environment and is relative to the
java:comp/env context. A JNDI name must be unique within the
Deployment Component.
This group keeps the usage of the contained JNDI environment
reference elements consistent across J2EE deployment descriptors.
The listenerType indicates the deployment properties for a web
application listener bean.
The listener-class element declares a class in the
application must be registered as a web
application listener bean. The value is the fully
qualified classname of the listener class.
The local-homeType defines the fully-qualified
name of an enterprise bean's local home interface.
The localType defines the fully-qualified name of an
enterprise bean's local interface.
The message-destination-linkType is used to link a message
destination reference or message-driven bean to a message
destination.
The Assembler sets the value to reflect the flow of messages
between producers and consumers in the application.
The value must be the message-destination-name of a message
destination in the same Deployment File or in another
Deployment File in the same J2EE application unit.
Alternatively, the value may be composed of a path name
specifying a Deployment File containing the referenced
message destination with the message-destination-name of the
destination appended and separated from the path name by
"#". The path name is relative to the Deployment File
containing Deployment Component that is referencing the
message destination. This allows multiple message
destinations with the same name to be uniquely identified.
jms/StockQueue
javax.jms.Queue
Consumes
CorporateStocks
]]>
The message-destination-ref-name element specifies
the name of a message destination reference; its
value is the environment entry name used in
Deployment Component code. The name is a JNDI name
relative to the java:comp/env context and must be
unique within an ejb-jar (for enterprise beans) or a
Deployment File (for others).
javax.jms.Queue
]]>
The message-destination-usageType specifies the use of the
message destination indicated by the reference. The value
indicates whether messages are consumed from the message
destination, produced for the destination, or both. The
Assembler makes use of this information in linking producers
of a destination with its consumers.
The value of the message-destination-usage element must be
one of the following:
Consumes
Produces
ConsumesProduces
CorporateStocks
]]>
The message-destination-name element specifies a
name for a message destination. This name must be
unique among the names of message destinations
within the Deployment File.
This type is a general type that can be used to declare
parameter/value lists.
The param-name element contains the name of a
parameter.
The param-value element contains the value of a
parameter.
The elements that use this type designate either a relative
path or an absolute path starting with a "/".
In elements that specify a pathname to a file within the
same Deployment File, relative filenames (i.e., those not
starting with "/") are considered relative to the root of
the Deployment File's namespace. Absolute filenames (i.e.,
those starting with "/") also specify names in the root of
the Deployment File's namespace. In general, relative names
are preferred. The exception is .war files where absolute
names are preferred for consistency with the Servlet API.
com.wombat.empl.EmployeeService
]]>
The res-authType specifies whether the Deployment Component
code signs on programmatically to the resource manager, or
whether the Container will sign on to the resource manager
on behalf of the Deployment Component. In the latter case,
the Container uses information that is supplied by the
Deployer.
The value must be one of the two following:
Application
Container
The res-sharing-scope type specifies whether connections
obtained through the given resource manager connection
factory reference can be shared. The value, if specified,
must be one of the two following:
Shareable
Unshareable
The default value is Shareable.
jms/StockQueue
javax.jms.Queue
]]>
The resource-env-ref-name element specifies the name
of a resource environment reference; its value is
the environment entry name used in
the Deployment Component code. The name is a JNDI
name relative to the java:comp/env context and must
be unique within a Deployment Component.
The resource-env-ref-type element specifies the type
of a resource environment reference. It is the
fully qualified name of a Java language class or
interface.
jdbc/EmployeeAppDB
javax.sql.DataSource
Container
Shareable
]]>
The res-ref-name element specifies the name of a
resource manager connection factory reference.
The name is a JNDI name relative to the
java:comp/env context.
The name must be unique within a Deployment File.
The res-type element specifies the type of the data
source. The type is specified by the fully qualified
Java language class or interface
expected to be implemented by the data source.
The role-nameType designates the name of a security role.
The name must conform to the lexical rules for a token.
The run-asType specifies the run-as identity to be
used for the execution of a component. It contains an
optional description, and the name of a security role.
The security-role-refType contains the declaration of a
security role reference in a component's or a
Deployment Component's code. The declaration consists of an
optional description, the security role name used in the
code, and an optional link to a security role. If the
security role is not specified, the Deployer must choose an
appropriate security role.
The value of the role-name element must be the String used
as the parameter to the
EJBContext.isCallerInRole(String roleName) method or the
HttpServletRequest.isUserInRole(String role) method.
The role-link element is a reference to a defined
security role. The role-link element must contain
the name of one of the security roles defined in the
security-role elements.
This role includes all employees who are authorized
to access the employee service application.
employee
]]>
This is a special string datatype that is defined by J2EE as
a base type for defining collapsed strings. When schemas
require trailing/leading space elimination as well as
collapsing the existing whitespace, this base type may be
used.
This simple type designates a boolean with only two
permissible values
- true
- false
The url-patternType contains the url pattern of the mapping.
It must follow the rules specified in Section 11.2 of the
Servlet API Specification. This pattern is assumed to be in
URL-decoded form and must not contain CR(#xD) or LF(#xA).
If it contains those characters, the container must inform
the developer with a descriptive error message.
The container must preserve all characters including whitespaces.
This type adds an "id" attribute to xsd:anyURI.
This type adds an "id" attribute to xsd:boolean.
This type adds an "id" attribute to xsd:integer.
This type adds an "id" attribute to xsd:NMTOKEN.
This type adds an "id" attribute to xsd:nonNegativeInteger.
This type adds an "id" attribute to xsd:positiveInteger.
This type adds an "id" attribute to xsd:QName.
This type adds an "id" attribute to xsd:string.