| blob | 1a119104038e8226e3fdd17c2eef7a6281d8f37a |
1 <!--
2 Copyright 2004 Sun Microsystems, Inc. All rights reserved.
3 SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
4 -->
6 <!--
7 DTD for the JavaServer Faces Application Configuration File (Version 1.0)
9 To support validation of your configuration file(s), include the following
10 DOCTYPE element at the beginning (after the "xml" declaration):
12 <!DOCTYPE faces-config PUBLIC
13 "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"
14 "http://java.sun.com/dtd/web-facesconfig_1_0.dtd">
16 $Id: web-facesconfig_1_0.dtd,v 1.31 2004/02/26 20:30:16 eburns Exp $
18 -->
21 <!-- ==================== Defined Types =================================== -->
24 <!--
25 An "Action" is a String that represents a method binding
26 expression that points at a method with no arguments that returns a
27 String. It must be bracketed with "#{}", for example,
28 "#{cardemo.buyCar}".
29 -->
33 <!--
34 A "ClassName" is the fully qualified name of a Java class that is
35 instantiated to provide the functionality of the enclosing element.
36 -->
40 <!--
41 An "Identifier" is a string of characters that conforms to the variable
42 naming conventions of the Java programming language (JLS Section ?.?.?).
43 -->
47 <!--
48 A "JavaType" is either the fully qualified name of a Java class that is
49 instantiated to provide the functionality of the enclosing element, or
50 the name of a Java primitive type (such as int or char). The class name
51 or primitive type may optionally be followed by "[]" to indicate that
52 the underlying data must be an array, rather than a scalar variable.
53 -->
57 <!--
58 A "Language" is a lower case two-letter code for a language as defined
59 by ISL-639.
60 -->
64 <!--
65 A "ResourcePath" is the relative or absolute path to a resource file
66 (such as a logo image).
67 -->
71 <!--
72 A "Scope" is the well-known name of a scope in which managed beans may
73 optionally be defined to be created in.
74 -->
79 <!--
80 A "ScopeOrNone" element defines the legal values for the
81 <managed-bean-scope> element's body content, which includes
82 all of the scopes respresented by the "Scope" type, plus the
83 "none" value indicating that a created bean should not be
84 stored into any scope.
85 -->
89 <!--
90 A "ViewIdPattern" is a pattern for matching view identifiers in
91 order to determine whether a particular navigation rule should be
92 fired. It must contain one of the following values:
94 - The exact match for a view identifier that is recognized
95 by the the ViewHandler implementation being used (such as
96 "/index.jsp" if you are using the default ViewHandler).
98 - A proper prefix of a view identifier, plus a trailing "*"
99 character. This pattern indicates that all view identifiers that
100 match the portion of the pattern up to the asterisk will match the
101 surrounding rule. When more than one match exists, the match with
102 the longest pattern is selected.
104 - An "*" character, which means that this pattern applies to all
105 view identifiers.
106 -->
110 <!-- ==================== Top Level Elements ============================== -->
113 <!--
114 The "faces-config" element is the root of the configuration information
115 hierarchy, and contains nested elements for all of the other configuration
116 settings.
117 -->
118 <!ELEMENT faces-config ((application|factory|component|converter|managed-bean|navigation-rule|referenced-bean|render-kit|lifecycle|validator)*)>
119 <!ATTLIST faces-config
124 <!-- ==================== Definition Elements ============================= -->
127 <!--
128 The "application" element provides a mechanism to define the various
129 per-application-singleton implementation artifacts for a particular web
130 application that is utilizing JavaServer Faces. For nested elements
131 that are not specified, the JSF implementation must provide a suitable
132 default.
133 -->
134 <!ELEMENT application ((action-listener|default-render-kit-id|message-bundle|navigation-handler|view-handler|state-manager|property-resolver|variable-resolver|locale-config)*)>
137 <!--
138 The "factory" element provides a mechanism to define the various
139 Factories that comprise parts of the implementation of JavaServer
140 Faces. For nested elements that are not specified, the JSF
141 implementation must provide a suitable default.
142 -->
143 <!ELEMENT factory ((application-factory|faces-context-factory|lifecycle-factory|render-kit-factory)*)>
146 <!--
147 The "attribute" element represents a named, typed, value associated with
148 the parent UIComponent via the generic attributes mechanism.
150 Attribute names must be unique within the scope of the parent (or related)
151 component.
152 -->
153 <!ELEMENT attribute (description*, display-name*, icon*, attribute-name, attribute-class, default-value?, suggested-value?, attribute-extension*)>
155 <!--
156 Extension element for attribute. May contain implementation
157 specific content.
158 -->
162 <!--
163 The "component" element represents a concrete UIComponent implementation
164 class that should be registered under the specified type identifier,
165 along with its associated properties and attributes. Component types must
166 be unique within the entire web application.
168 Nested "attribute" elements identify generic attributes that are recognized
169 by the implementation logic of this component. Nested "property" elements
170 identify JavaBeans properties of the component class that may be exposed
171 for manipulation via tools.
172 -->
173 <!ELEMENT component (description*, display-name*, icon*, component-type, component-class, attribute*, property*, component-extension*)>
175 <!--
176 Extension element for component. May contain implementation
177 specific content.
178 -->
183 <!--
184 The "converter" element represents a concrete Converter implementation
185 class that should be registered under the specified converter identifier.
186 Converter identifiers must be unique within the entire web application.
188 Nested "attribute" elements identify generic attributes that may be
189 configured on the corresponding UIComponent in order to affect the
190 operation of the Converter. Nested "property" elements identify JavaBeans
191 properties of the Converter implementation class that may be configured
192 to affect the operation of the Converter.
193 -->
194 <!ELEMENT converter (description*, display-name*, icon*, (converter-id | converter-for-class), converter-class, attribute*, property*)>
197 <!--
198 The "icon" element contains "small-icon" and "large-icon" elements that
199 specify the resoruce paths for small and large GIF or JPG icon images
200 used to represent the parent element in a GUI tool.
201 -->
205 <!--
206 The "lifecycle" element provides a mechanism to specify
207 modifications to the behaviour of the default Lifecycle
208 implementation for this web application.
209 -->
212 <!--
213 The "locale-config" element allows the app developer to declare the
214 supported locales for this application.
215 -->
218 <!--
219 The "managed-bean" element represents a JavaBean, of a particular class,
220 that will be dynamically instantiated at runtime (by the default
221 VariableResolver implementation) if it is referenced as the first element
222 of a value binding expression, and no corresponding bean can be
223 identified in any scope. In addition to the creation of the managed bean,
224 and the optional storing of it into the specified scope, the nested
225 managed-property elements can be used to initialize the contents of
226 settable JavaBeans properties of the created instance.
227 -->
228 <!ELEMENT managed-bean (description*, display-name*, icon*, managed-bean-name, managed-bean-class, managed-bean-scope, (managed-property* | map-entries | list-entries))>
231 <!--
232 The "managed-property" element represents an individual property of a
233 managed bean that will be configured to the specified value (or value set)
234 if the corresponding managed bean is automatically created.
235 -->
236 <!ELEMENT managed-property (description*, display-name*, icon*, property-name, property-class?, (map-entries|null-value|value|list-entries))>
239 <!--
240 The "map-entry" element reprsents a single key-entry pair that
241 will be added to the computed value of a managed property of type
242 java.util.Map.
243 -->
247 <!--
248 The "map-entries' element represents a set of key-entry pairs that
249 will be added to the computed value of a managed property of type
250 java.util.Map. In addition, the Java class types of the key and entry
251 values may be optionally declared.
252 -->
256 <!--
257 The base name of a resource bundle representing the message resources
258 for this application. See the JavaDocs for the "java.util.ResourceBundle"
259 class for more information on the syntax of resource bundle names.
260 -->
265 <!--
266 The "navigation-case" element describes a particular combination of
267 conditions that must match for this case to be executed, and the
268 view id of the component tree that should be selected next.
269 -->
270 <!ELEMENT navigation-case (description*, display-name*, icon*, from-action?, from-outcome?, to-view-id, redirect?)>
273 <!--
274 The "navigation-rule" element represents an individual decision rule
275 that will be utilized by the default NavigationHandler
276 implementation to make decisions on what view should be displayed
277 next, based on the view id being processed.
278 -->
279 <!ELEMENT navigation-rule (description*, display-name*, icon*, from-view-id?, navigation-case*)>
282 <!--
283 The "property" element represents a JavaBean property of the Java class
284 represented by our parent element.
286 Property names must be unique within the scope of the Java class
287 that is represented by the parent element, and must correspond to
288 property names that will be recognized when performing introspection
289 against that class via java.beans.Introspector.
290 -->
291 <!ELEMENT property (description*, display-name*, icon*, property-name, property-class, default-value?, suggested-value?, property-extension*)>
293 <!--
294 Extension element for property. May contain implementation
295 specific content.
296 -->
299 <!--
300 The "referenced-bean" element represents at design time the promise
301 that a Java object of the specified type will exist at runtime in some
302 scope, under the specified key. This can be used by design time tools
303 to construct user interface dialogs based on the properties of the
304 specified class. The presence or absence of a referenced bean
305 element has no impact on the JavaServer Faces runtime environment
306 inside a web application.
307 -->
308 <!ELEMENT referenced-bean (description*, display-name*, icon*, referenced-bean-name, referenced-bean-class)>
311 <!--
312 The "render-kit" element represents a concrete RenderKit implementation
313 that should be registered under the specified render-kit-id. If no
314 render-kit-id is specified, the identifier of the default RenderKit
315 (RenderKitFactory.DEFAULT_RENDER_KIT) is assumed.
316 -->
317 <!ELEMENT render-kit (description*, display-name*, icon*, render-kit-id?, render-kit-class?, renderer*)>
320 <!--
321 The "renderer" element represents a concrete Renderer implementation
322 class that should be registered under the specified component family
323 and renderer type identifiers, in the RenderKit associated with the
324 parent "render-kit" element. Combinations of component family and renderer
325 type must be unique within the RenderKit associated with the parent
326 "render-kit" element.
328 Nested "attribute" elements identify generic component attributes that
329 are recognized by this renderer.
330 -->
331 <!ELEMENT renderer (description*, display-name*, icon*, component-family, renderer-type, renderer-class, attribute*, renderer-extension*)>
333 <!--
334 Extension element for renderer. May contain implementation
335 specific content.
336 -->
339 <!--
340 The "validator" element represents a concrete Validator implementation
341 class that should be registered under the specified validator identifier.
342 Validator identifiers must be unique within the entire web application.
344 Nested "attribute" elements identify generic attributes that may be
345 configured on the corresponding UIComponent in order to affect the
346 operation of the Validator. Nested "property" elements identify JavaBeans
347 properties of the Validator implementation class that may be configured
348 to affect the operation of the Validator.
349 -->
350 <!ELEMENT validator (description*, display-name*, icon*, validator-id, validator-class, attribute*, property*)>
353 <!--
354 The "list-entries" element represents a set of initialization
355 elements for a managed property that is a java.util.List or an
356 array. In the former case, the "value-class" element can optionally
357 be used to declare the Java type to which each value should be
358 converted before adding it to the Collection.
359 -->
363 <!-- ==================== Subordinate Elements ============================ -->
366 <!--
367 The "action-listener" element contains the fully qualified class name
368 of the concrete ActionListener implementation class that will be called
369 during the Invoke Application phase of the request processing lifecycle.
370 It must be of type "ClassName".
371 -->
374 <!--
375 The "application-factory" element contains the fully qualified class
376 name of the concrete ApplicationFactory implementation class that
377 will be called when FactoryFinder.getFactory(APPLICATION_FACTORY) is
378 called. It must be of type "ClassName".
379 -->
382 <!--
383 The "attribute-class" element represents the Java type of the value
384 associated with this attribute name. It must be of type "ClassName".
385 -->
389 <!--
390 The "attribute-name" element represents the name under which the
391 corresponding value will be stored, in the generic attributes of the
392 UIComponent we are related to.
393 -->
397 <!--
398 The "component-class" element represents the fully qualified class name
399 of a concrete UIComponent implementation class. It must be of
400 type "ClassName".
401 -->
405 <!--
406 The "component-family" element represents the component family for
407 which the Renderer represented by the parent "renderer" element will be
408 used.
409 -->
412 <!--
413 The "component-type" element represents the name under which the
414 corresponding UIComponent class should be registered.
415 -->
419 <!--
420 The "converter-class" element represents the fully qualified class name
421 of a concrete Converter implementation class. It must be of
422 type "ClassName".
423 -->
427 <!--
428 The "converter-for-class" element represents the fully qualified class name
429 for which a Converter class will be registered. It must be of
430 type "ClassName".
431 -->
435 <!--
436 The "converter-id" element represents the identifier under which the
437 corresponding Converter class should be registered.
438 -->
441 <!--
442 The "default-render-kit-id" element allows the application to define
443 a renderkit to be used other than the standard one.
444 -->
447 <!--
448 The "default-locale" element declares the default locale for this
449 application instance. It must be specified as
450 :language:[_:country:[_:variant:]] without the colons, for example
451 "ja_JP_SJIS". The separators between the segments may be '-' or
452 '_'.
453 -->
456 <!--
457 The "default-value" contains the value for the property or attribute
458 in which this element resides. This value differs from the
459 "suggested-value" in that the property or attribute must take the
460 value, whereas in "suggested-value" taking the value is optional.
461 -->
464 <!--
465 The "description" element contains a textual description of the element
466 it is nested in, optionally flagged with a language code using the
467 "xml:lang" attribute.
468 -->
473 <!--
474 The "display-name" element is a short descriptive name describing the
475 entity associated with the element it is nested in, intended to be
476 displayed by tools, and optionally flagged with a language code using
477 the "xml:lang" attribute.
478 -->
482 <!--
483 The "faces-context-factory" element contains the fully qualified
484 class name of the concrete FacesContextFactory implementation class
485 that will be called when
486 FactoryFinder.getFactory(FACES_CONTEXT_FACTORY) is called. It must
487 be of type "ClassName".
488 -->
491 <!--
492 The "from-action" element contains an action reference expression
493 that must have been executed (by the default ActionListener for handling
494 application level events) in order to select this navigation rule. If
495 not specified, this rule will be relevant no matter which action reference
496 was executed (or if no action reference was executed).
498 This value must be of type "Action".
499 -->
503 <!--
504 The "from-outcome" element contains a logical outcome string returned
505 by the execution of an application action method selected via an
506 "actionRef" property (or a literal value specified by an "action"
507 property) of a UICommand component. If specified, this rule will be
508 relevant only if the outcome value matches this element's value. If
509 not specified, this rule will be relevant no matter what the outcome
510 value was.
511 -->
515 <!--
516 The "from-view-id" element contains the view identifier of the view
517 for which the containing navigation rule is relevant. If no
518 "from-view" element is specified, this rule applies to navigation
519 decisions on all views. If this element is not specified, a value
520 of "*" is assumed, meaning that this navigation rule applies to all
521 views.
523 This value must be of type "ViewIdPattern".
524 -->
528 <!--
529 The "key" element is the String representation of a map key that
530 will be stored in a managed property of type java.util.Map.
531 -->
535 <!--
536 The "key-class" element defines the Java type to which each "key"
537 element in a set of "map-entry" elements will be converted to. It
538 must be of type "ClassName". If omitted, "java.lang.String"
539 is assumed.
540 -->
544 <!--
545 The "large-icon" element contains the resource path to a large (32x32)
546 icon image. The image may be in either GIF or JPG format.
547 -->
550 <!--
551 The "lifecycle-factory" element contains the fully qualified class name
552 of the concrete LifecycleFactory implementation class that will be called
553 when FactoryFinder.getFactory(LIFECYCLE_FACTORY) is called. It must be
554 of type "ClassName".
555 -->
558 <!--
559 The "managed-bean-class" element represents the fully qualified class
560 name of the Java class that will be used to instantiate a new instance
561 if creation of the specified managed bean is requested. It must be of
562 type "ClassName".
564 The specified class must conform to standard JavaBeans conventions.
565 In particular, it must have a public zero-arguments constructor, and
566 zero or more public property setters.
567 -->
571 <!--
572 The "managed-bean-name" element represents the attribute name under
573 which a managed bean will be searched for, as well as stored (unless
574 the "managed-bean-scope" value is "none"). It must be of type
575 "Identifier".
576 -->
580 <!--
581 The "managed-bean-scope" element represents the scope into which a newly
582 created instance of the specified managed bean will be stored (unless
583 the value is "none"). It must be of type "ScopeOrNone".
584 -->
587 <!--
588 The "navigation-handler" element contains the fully qualified class name
589 of the concrete NavigationHandler implementation class that will be called
590 during the Invoke Application phase of the request processing lifecycle,
591 if the default ActionListener (provided by the JSF implementation) is used.
592 It must be of type "ClassName".
593 -->
596 <!--
597 The "phase-listener" element contains the fully qualified class
598 name of the concrete PhaseListener implementation class that will be
599 registered on the Lifecycle. It must be of type "ClassName".
600 -->
603 <!--
604 The "redirect" element indicates that navigation to the specified
605 "to-view-id" should be accomplished by performing an HTTP redirect
606 rather than the usual ViewHandler mechanisms.
607 -->
610 <!--
611 The "suggested-value" contains the value for the property or
612 attribute in which this element resides. This value is advisory
613 only and is intended for tools to use when populating pallettes.
614 -->
618 <!--
620 The "view-handler" element contains the fully qualified class name
621 of the concrete ViewHandler implementation class that will be called
622 during the Restore View and Render Response phases of the request
623 processing lifecycle. The faces implementation must provide a
624 default implementation of this class
625 -->
628 <!--
630 The "state-manager" element contains the fully qualified class name
631 of the concrete StateManager implementation class that will be called
632 during the Restore View and Render Response phases of the request
633 processing lifecycle. The faces implementation must provide a
634 default implementation of this class
635 -->
638 <!--
639 The "null-value" element indicates that the managed property in which we
640 are nested will be explicitly set to null if our managed bean is
641 automatically created. This is different from omitting the managed
642 property element entirely, which will cause no property setter to be
643 called for this property.
645 The "null-value" element can only be used when the associated
646 "property-class" identifies a Java class, not a Java primitive.
647 -->
651 <!--
652 The "property-class" element represents the Java type of the value
653 associated with this property name. It must be of type "JavaType".
654 If not specified, it can be inferred from existing classes; however,
655 this element should be specified if the configuration file is going
656 to be the source for generating the corresponding classes.
657 -->
661 <!--
662 The "property-name" element represents the JavaBeans property name
663 under which the corresponding value may be stored.
664 -->
668 <!--
669 The "property-resolver" element contains the fully qualified class name
670 of the concrete PropertyResolver implementation class that will be used
671 during the processing of value binding expressions.
672 It must be of type "ClassName".
673 -->
677 <!--
678 The "referenced-bean-class" element represents the fully qualified class
679 name of the Java class (either abstract or concrete) or Java interface
680 implemented by the corresponding referenced bean. It must be of type
681 "ClassName".
682 -->
686 <!--
687 The "referenced-bean-name" element represents the attribute name under
688 which the corresponding referenced bean may be assumed to be stored,
689 in one of the scopes defined by the "Scope" type. It must be of type
690 "Identifier".
691 -->
695 <!--
696 The "render-kit-id" element represents an identifier for the
697 RenderKit represented by the parent "render-kit" element.
698 -->
702 <!--
703 The "render-kit-class" element represents the fully qualified class name
704 of a concrete RenderKit implementation class. It must be of
705 type "ClassName".
706 -->
710 <!--
711 The "renderer-class" element represents the fully qualified class name
712 of a concrete Renderer implementation class. It must be of
713 type "ClassName".
714 -->
717 <!--
718 The "render-kit-factory" element contains the fully qualified class name
719 of the concrete RenderKitFactory implementation class that will be called
720 when FactoryFinder.getFactory(RENDER_KIT_FACTORY) is called. It must be
721 of type "ClassName".
722 -->
725 <!--
726 The "renderer-type" element represents a renderer type identifier for the
727 Renderer represented by the parent "renderer" element.
728 -->
731 <!--
732 The "small-icon" element contains the resource path to a large (16x16)
733 icon image. The image may be in either GIF or JPG format.
734 -->
737 <!--
738 The "supported-locale" element allows authors to declare which
739 locales are supported in this application instance.
741 It must be specified as :language:[_:country:[_:variant:]] without
742 the colons, for example "ja_JP_SJIS". The separators between the
743 segments may be '-' or '_'.
744 -->
747 <!--
748 The "to-view" element contains the view identifier of the next view
749 that should be displayed if this navigation rule is matched. It
750 must be of type "ViewId".
751 -->
755 <!--
756 The "validator-class" element represents the fully qualified class name
757 of a concrete Validator implementation class. It must be of
758 type "ClassName".
759 -->
763 <!--
764 The "validator-id" element represents the identifier under which the
765 corresponding Validator class should be registered.
766 -->
770 <!--
771 The "value" element is the String representation of a literal
772 value to which a scalar managed property will be set, or a value
773 binding expression ("#{...}") that will be used to calculate the
774 required value. It will be converted as specified for the actual
775 property type.
776 -->
780 <!--
781 The "value-class" element defines the Java type to which each
782 "value" element's value will be converted to, prior to adding it to
783 the "list-entries" list for a managed property that is a
784 java.util.List, or a "map-entries" map for a managed property that
785 is a java.util.Map. It must be of type "ClassName". If omitted,
786 "java.lang.String" is assumed.
787 -->
790 <!--
791 The "variable-resolver" element contains the fully qualified class name
792 of the concrete VariableResolver implementation class that will be used
793 during the processing of value binding expressions.
794 It must be of type "ClassName".
795 -->
799 <!-- ============================ Identifier Attributes ==================== -->