@(#)web-jsptaglibrary_2_1.xsds 1.1 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. Copyright 2003-2007 Sun Microsystems, Inc. All rights reserved. The contents of this file are subject to the terms of either the GNU General Public License Version 2 only ("GPL") or the Common Development and Distribution License("CDDL") (collectively, the "License"). You may not use this file except in compliance with the License. You can obtain a copy of the License at https://glassfish.dev.java.net/public/CDDL+GPL.html or glassfish/bootstrap/legal/LICENSE.txt. See the License for the specific language governing permissions and limitations under the License. When distributing the software, include this License Header Notice in each file and include the License file at glassfish/bootstrap/legal/LICENSE.txt. Sun designates this particular file as subject to the "Classpath" exception as provided by Sun in the GPL Version 2 section of the License file that accompanied this code. If applicable, add the following below the License Header, with the fields enclosed by brackets [] replaced by your own identifying information: "Portions Copyrighted [year] [name of copyright owner]" Contributor(s): If you wish your version of this file to be governed by only the CDDL or only the GPL Version 2, indicate your decision by adding "[Contributor] elects to include this software in this distribution under the [CDDL or GPL Version 2] license." If you don't indicate a single choice of license, a recipient has the option to distribute your version of this file under either the CDDL, the GPL Version 2 or to extend the choice of license to its licensees as provided above. However, if you add GPL Version 2 code and therefore, elected the GPL Version 2 license, then the option applies only if the new code is made subject to such option by the copyright holder. ... The instance documents may indicate the published version of the schema using xsi:schemaLocation attribute for Java EE namespace with the following location: http://java.sun.com/xml/ns/javaee/web-jsptaglibrary_2_1.xsd ]]> The taglib tag is the document root. The definition of taglib is provided by the tldTaglibType. The taglib element contains, among other things, tag and tag-file elements. The name subelements of these elements must each be unique. The taglib element contains function elements. The name subelements of these elements must each be unique. Specifies the type of body that is valid for a tag. This value is used by the JSP container to validate that a tag invocation has the correct body syntax and by page composition tools to assist the page author in providing a valid tag body. There are currently four values specified: tagdependent The body of the tag is interpreted by the tag implementation itself, and is most likely in a different "language", e.g embedded SQL statements. JSP The body of the tag contains nested JSP syntax. empty The body must be empty scriptless The body accepts only template text, EL Expressions, and JSP action elements. No scripting elements are allowed. The extensibleType is an abstract base type that is used to define the type of extension-elements. Instance documents must substitute a known type to define the extension by using xsi:type attribute to define the actual type of extension-elements. The function element is used to provide information on each function in the tag library that is to be exposed to the EL. The function element may have several subelements defining: description Optional tag-specific information display-name A short name that is intended to be displayed by tools icon Optional icon element that can be used by tools name A unique name for this function function-class Provides the name of the Java class that implements the function function-signature Provides the signature, as in the Java Language Specification, of the Java method that is to be used to implement the function. example Optional informal description of an example of a use of this function function-extension Zero or more extensions that provide extra information about this function, for tool consumption A unique name for this function. Provides the fully-qualified class name of the Java class containing the static method that implements the function. Provides the signature, of the static Java method that is to be used to implement the function. The syntax of the function-signature element is as follows: FunctionSignature ::= ReturnType S MethodName S? '(' S? Parameters? S? ')' ReturnType ::= Type MethodName ::= Identifier Parameters ::= Parameter | ( Parameter S? ',' S? Parameters ) Parameter ::= Type Where: * Type is a basic type or a fully qualified Java class name (including package name), as per the 'Type' production in the Java Language Specification, Second Edition, Chapter 18. * Identifier is a Java identifier, as per the 'Identifier' production in the Java Language Specification, Second Edition, Chapter 18. Example: java.lang.String nickName( java.lang.String, int ) The example element contains an informal description of an example of the use of this function. Function extensions are for tool use only and must not affect the behavior of a container. Defines an action in this tag library that is implemented as a .tag file. The tag-file element has two required subelements: description Optional tag-specific information display-name A short name that is intended to be displayed by tools icon Optional icon element that can be used by tools name The unique action name path Where to find the .tag file implementing this action, relative to the root of the web application or the root of the JAR file for a tag library packaged in a JAR. This must begin with /WEB-INF/tags if the .tag file resides in the WAR, or /META-INF/tags if the .tag file resides in a JAR. example Optional informal description of an example of a use of this tag tag-extension Zero or more extensions that provide extra information about this tag, for tool consumption The example element contains an informal description of an example of the use of a tag. Tag extensions are for tool use only and must not affect the behavior of a container. The tag defines a unique tag in this tag library. It has one attribute, id. The tag element may have several subelements defining: description Optional tag-specific information display-name A short name that is intended to be displayed by tools icon Optional icon element that can be used by tools name The unique action name tag-class The tag handler class implementing javax.servlet.jsp.tagext.JspTag tei-class An optional subclass of javax.servlet.jsp.tagext.TagExtraInfo body-content The body content type variable Optional scripting variable information attribute All attributes of this action that are evaluated prior to invocation. dynamic-attributes Whether this tag supports additional attributes with dynamic names. If true, the tag-class must implement the javax.servlet.jsp.tagext.DynamicAttributes interface. Defaults to false. example Optional informal description of an example of a use of this tag tag-extension Zero or more extensions that provide extra information about this tag, for tool consumption Defines the subclass of javax.serlvet.jsp.tagext.JspTag that implements the request time semantics for this tag. (required) Defines the subclass of javax.servlet.jsp.tagext.TagExtraInfo for this tag. (optional) If this is not given, the class is not consulted at translation time. Specifies the format for the body of this tag. The default in JSP 1.2 was "JSP" but because this is an invalid setting for simple tag handlers, there is no longer a default in JSP 2.0. A reasonable default for simple tag handlers is "scriptless" if the tag can have a body. The example element contains an informal description of an example of the use of a tag. Tag extensions are for tool use only and must not affect the behavior of a container. The attribute element defines an attribute for the nesting tag. The attribute element may have several subelements defining: description a description of the attribute name the name of the attribute required whether the attribute is required or optional rtexprvalue whether the attribute is a runtime attribute type the type of the attributes fragment whether this attribute is a fragment deferred-value present if this attribute is to be parsed as a javax.el.ValueExpression deferred-method present if this attribute is to be parsed as a javax.el.MethodExpression Defines if the nesting attribute is required or optional. If not present then the default is "false", i.e the attribute is optional. Defines if the nesting attribute can have scriptlet expressions as a value, i.e the value of the attribute may be dynamically calculated at request time, as opposed to a static value determined at translation time. If not present then the default is "false", i.e the attribute has a static value Defines the Java type of the attributes value. If this element is omitted, the expected type is assumed to be "java.lang.Object". Present if the value for this attribute is to be passed to the tag handler as a javax.el.ValueExpression. This allows for deferred evaluation of EL expressions. An optional subelement will contain the expected type that the value will be coerced to after evaluation of the expression. The type defaults to Object if one is not provided. Present if the value for this attribute is to be passed to the tag handler as a javax.el.MethodExpression. This allows for deferred evaluation of an EL expression that identifies a method to be invoked on an Object. An optional subelement will contain the expected method signature. The signature defaults to "void method()" if one is not provided. "true" if this attribute is of type javax.jsp.tagext.JspFragment, representing dynamic content that can be re-evaluated as many times as needed by the tag handler. If omitted or "false", the default is still type="java.lang.String" Defines the canonical name of a tag or attribute being defined. The name must conform to the lexical rules for an NMTOKEN. Defines information about how to provide the value for a tag handler attribute that accepts a javax.el.MethodExpression. The deferred-method element has one optional subelement: method-signature Provides the signature, as in the Java Language Specifies, that is expected for the method being identified by the expression. Provides the expected signature of the method identified by the javax.el.MethodExpression. This disambiguates overloaded methods and ensures that the return value is of the expected type. The syntax of the method-signature element is identical to that of the function-signature element. See the documentation for function-signature for more details. The name of the method is for documentation purposes only and is ignored by the JSP container. Example: boolean validate(java.lang.String) Defines information about how to provide the value for a tag handler attribute that accepts a javax.el.ValueExpression. The deferred-value element has one optional subelement: type the expected type of the attribute The fully-qualified name of the Java type that is the expected type for this deferred expression. If this element is omitted, the expected type is assumed to be "java.lang.Object". The tld-extensionType is used to indicate extensions to a specific TLD element. It is used by elements to designate an extension block that is targeted to a specific extension designated by a set of extension elements that are declared by a namespace. The namespace identifies the extension to the tool that processes the extension. The type of the extension-element is abstract. Therefore, a concrete type must be specified by the TLD using xsi:type attribute for each extension-element. The taglib tag is the document root, it defines: description a simple string describing the "use" of this taglib, should be user discernable display-name the display-name element contains a short name that is intended to be displayed by tools icon optional icon that can be used by tools tlib-version the version of the tag library implementation short-name a simple default short name that could be used by a JSP authoring tool to create names with a mnemonic value; for example, the it may be used as the prefered prefix value in taglib directives uri a uri uniquely identifying this taglib validator optional TagLibraryValidator information listener optional event listener specification tag tags in this tag library tag-file tag files in this tag library function zero or more EL functions defined in this tag library taglib-extension zero or more extensions that provide extra information about this taglib, for tool consumption Describes this version (number) of the taglibrary. It is described as a dewey decimal. Defines a simple default name that could be used by a JSP authoring tool to create names with a mnemonicvalue; for example, it may be used as the preferred prefix value in taglib directives. Do not use white space, and do not start with digits or underscore. Defines a public URI that uniquely identifies this version of the taglibrary. Leave it empty if it does not apply. Taglib extensions are for tool use only and must not affect the behavior of a container. Describes the JSP version (number) this taglibrary requires in order to function (dewey decimal) A validator that can be used to validate the conformance of a JSP page to using this tag library is defined by a validatorType. Defines the TagLibraryValidator class that can be used to validate the conformance of a JSP page to using this tag library. The init-param element contains a name/value pair as an initialization param. This type defines scope of the scripting variable. See TagExtraInfo for details. The allowed values are, "NESTED", "AT_BEGIN" and "AT_END". The variableType provides information on the scripting variables defined by using this tag. It is a (translation time) error for a tag that has one or more variable subelements to have a TagExtraInfo class that returns a non-null value from a call to getVariableInfo(). The subelements of variableType are of the form: description Optional description of this variable name-given The variable name as a constant name-from-attribute 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. variable-class Name of the class of the variable. java.lang.String is default. declare Whether the variable is declared or not. True is the default. scope The scope of the scripting varaible defined. NESTED is default. The name for the scripting variable. The name of an attribute whose (translation-time) value will give the name of the variable. The optional name of the class for the scripting variable. The default is java.lang.String. Whether the scripting variable is to be defined or not. See TagExtraInfo for details. This element is optional and "true" is the default. The element is optional and "NESTED" is the default.