| blob | ca61530782c51213909c9e7e51551531625fba2d |
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.1)
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.1//EN"
14 "http://java.sun.com/dtd/web-facesconfig_1_1.dtd">
16 $Id: web-facesconfig_1_1.dtd,v 1.3 2004/04/27 14:01:47 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, facet*, attribute*, property*, component-extension*)>
175 <!--
176 Extension element for component. May contain implementation
177 specific content.
178 -->
181 <!--
182 Define the name and other design-time information for a facet that is
183 associated with a renderer or a component.
184 -->
188 <!--
189 Extension element for facet. May contain implementation
190 specific content.
191 -->
194 <!--
195 The "facet-name" element represents the facet name under which a
196 UIComponent will be added to its parent. It must be of type
197 "Identifier".
198 -->
201 <!--
202 The "converter" element represents a concrete Converter implementation
203 class that should be registered under the specified converter identifier.
204 Converter identifiers must be unique within the entire web application.
206 Nested "attribute" elements identify generic attributes that may be
207 configured on the corresponding UIComponent in order to affect the
208 operation of the Converter. Nested "property" elements identify JavaBeans
209 properties of the Converter implementation class that may be configured
210 to affect the operation of the Converter.
211 -->
212 <!ELEMENT converter (description*, display-name*, icon*, (converter-id | converter-for-class), converter-class, attribute*, property*)>
215 <!--
216 The "icon" element contains "small-icon" and "large-icon" elements that
217 specify the resoruce paths for small and large GIF or JPG icon images
218 used to represent the parent element in a GUI tool.
219 -->
223 <!--
224 The "lifecycle" element provides a mechanism to specify
225 modifications to the behaviour of the default Lifecycle
226 implementation for this web application.
227 -->
230 <!--
231 The "locale-config" element allows the app developer to declare the
232 supported locales for this application.
233 -->
236 <!--
237 The "managed-bean" element represents a JavaBean, of a particular class,
238 that will be dynamically instantiated at runtime (by the default
239 VariableResolver implementation) if it is referenced as the first element
240 of a value binding expression, and no corresponding bean can be
241 identified in any scope. In addition to the creation of the managed bean,
242 and the optional storing of it into the specified scope, the nested
243 managed-property elements can be used to initialize the contents of
244 settable JavaBeans properties of the created instance.
245 -->
246 <!ELEMENT managed-bean (description*, display-name*, icon*, managed-bean-name, managed-bean-class, managed-bean-scope, (managed-property* | map-entries | list-entries))>
249 <!--
250 The "managed-property" element represents an individual property of a
251 managed bean that will be configured to the specified value (or value set)
252 if the corresponding managed bean is automatically created.
253 -->
254 <!ELEMENT managed-property (description*, display-name*, icon*, property-name, property-class?, (map-entries|null-value|value|list-entries))>
257 <!--
258 The "map-entry" element reprsents a single key-entry pair that
259 will be added to the computed value of a managed property of type
260 java.util.Map.
261 -->
265 <!--
266 The "map-entries' element represents a set of key-entry pairs that
267 will be added to the computed value of a managed property of type
268 java.util.Map. In addition, the Java class types of the key and entry
269 values may be optionally declared.
270 -->
274 <!--
275 The base name of a resource bundle representing the message resources
276 for this application. See the JavaDocs for the "java.util.ResourceBundle"
277 class for more information on the syntax of resource bundle names.
278 -->
283 <!--
284 The "navigation-case" element describes a particular combination of
285 conditions that must match for this case to be executed, and the
286 view id of the component tree that should be selected next.
287 -->
288 <!ELEMENT navigation-case (description*, display-name*, icon*, from-action?, from-outcome?, to-view-id, redirect?)>
291 <!--
292 The "navigation-rule" element represents an individual decision rule
293 that will be utilized by the default NavigationHandler
294 implementation to make decisions on what view should be displayed
295 next, based on the view id being processed.
296 -->
297 <!ELEMENT navigation-rule (description*, display-name*, icon*, from-view-id?, navigation-case*)>
300 <!--
301 The "property" element represents a JavaBean property of the Java class
302 represented by our parent element.
304 Property names must be unique within the scope of the Java class
305 that is represented by the parent element, and must correspond to
306 property names that will be recognized when performing introspection
307 against that class via java.beans.Introspector.
308 -->
309 <!ELEMENT property (description*, display-name*, icon*, property-name, property-class, default-value?, suggested-value?, property-extension*)>
311 <!--
312 Extension element for property. May contain implementation
313 specific content.
314 -->
317 <!--
318 The "referenced-bean" element represents at design time the promise
319 that a Java object of the specified type will exist at runtime in some
320 scope, under the specified key. This can be used by design time tools
321 to construct user interface dialogs based on the properties of the
322 specified class. The presence or absence of a referenced bean
323 element has no impact on the JavaServer Faces runtime environment
324 inside a web application.
325 -->
326 <!ELEMENT referenced-bean (description*, display-name*, icon*, referenced-bean-name, referenced-bean-class)>
329 <!--
330 The "render-kit" element represents a concrete RenderKit implementation
331 that should be registered under the specified render-kit-id. If no
332 render-kit-id is specified, the identifier of the default RenderKit
333 (RenderKitFactory.DEFAULT_RENDER_KIT) is assumed.
334 -->
335 <!ELEMENT render-kit (description*, display-name*, icon*, render-kit-id?, render-kit-class?, renderer*)>
338 <!--
339 The "renderer" element represents a concrete Renderer implementation
340 class that should be registered under the specified component family
341 and renderer type identifiers, in the RenderKit associated with the
342 parent "render-kit" element. Combinations of component family and renderer
343 type must be unique within the RenderKit associated with the parent
344 "render-kit" element.
346 Nested "attribute" elements identify generic component attributes that
347 are recognized by this renderer.
348 -->
349 <!ELEMENT renderer (description*, display-name*, icon*, component-family, renderer-type, renderer-class, facet*, attribute*, renderer-extension*)>
351 <!--
352 Extension element for renderer. May contain implementation
353 specific content.
354 -->
357 <!--
358 The "validator" element represents a concrete Validator implementation
359 class that should be registered under the specified validator identifier.
360 Validator identifiers must be unique within the entire web application.
362 Nested "attribute" elements identify generic attributes that may be
363 configured on the corresponding UIComponent in order to affect the
364 operation of the Validator. Nested "property" elements identify JavaBeans
365 properties of the Validator implementation class that may be configured
366 to affect the operation of the Validator.
367 -->
368 <!ELEMENT validator (description*, display-name*, icon*, validator-id, validator-class, attribute*, property*)>
371 <!--
372 The "list-entries" element represents a set of initialization
373 elements for a managed property that is a java.util.List or an
374 array. In the former case, the "value-class" element can optionally
375 be used to declare the Java type to which each value should be
376 converted before adding it to the Collection.
377 -->
381 <!-- ==================== Subordinate Elements ============================ -->
384 <!--
385 The "action-listener" element contains the fully qualified class name
386 of the concrete ActionListener implementation class that will be called
387 during the Invoke Application phase of the request processing lifecycle.
388 It must be of type "ClassName".
389 -->
392 <!--
393 The "application-factory" element contains the fully qualified class
394 name of the concrete ApplicationFactory implementation class that
395 will be called when FactoryFinder.getFactory(APPLICATION_FACTORY) is
396 called. It must be of type "ClassName".
397 -->
400 <!--
401 The "attribute-class" element represents the Java type of the value
402 associated with this attribute name. It must be of type "ClassName".
403 -->
407 <!--
408 The "attribute-name" element represents the name under which the
409 corresponding value will be stored, in the generic attributes of the
410 UIComponent we are related to.
411 -->
415 <!--
416 The "component-class" element represents the fully qualified class name
417 of a concrete UIComponent implementation class. It must be of
418 type "ClassName".
419 -->
423 <!--
424 The "component-family" element represents the component family for
425 which the Renderer represented by the parent "renderer" element will be
426 used.
427 -->
430 <!--
431 The "component-type" element represents the name under which the
432 corresponding UIComponent class should be registered.
433 -->
437 <!--
438 The "converter-class" element represents the fully qualified class name
439 of a concrete Converter implementation class. It must be of
440 type "ClassName".
441 -->
445 <!--
446 The "converter-for-class" element represents the fully qualified class name
447 for which a Converter class will be registered. It must be of
448 type "ClassName".
449 -->
453 <!--
454 The "converter-id" element represents the identifier under which the
455 corresponding Converter class should be registered.
456 -->
459 <!--
460 The "default-render-kit-id" element allows the application to define
461 a renderkit to be used other than the standard one.
462 -->
465 <!--
466 The "default-locale" element declares the default locale for this
467 application instance. It must be specified as
468 :language:[_:country:[_:variant:]] without the colons, for example
469 "ja_JP_SJIS". The separators between the segments may be '-' or
470 '_'.
471 -->
474 <!--
475 The "default-value" contains the value for the property or attribute
476 in which this element resides. This value differs from the
477 "suggested-value" in that the property or attribute must take the
478 value, whereas in "suggested-value" taking the value is optional.
479 -->
482 <!--
483 The "description" element contains a textual description of the element
484 it is nested in, optionally flagged with a language code using the
485 "xml:lang" attribute.
486 -->
491 <!--
492 The "display-name" element is a short descriptive name describing the
493 entity associated with the element it is nested in, intended to be
494 displayed by tools, and optionally flagged with a language code using
495 the "xml:lang" attribute.
496 -->
500 <!--
501 The "faces-context-factory" element contains the fully qualified
502 class name of the concrete FacesContextFactory implementation class
503 that will be called when
504 FactoryFinder.getFactory(FACES_CONTEXT_FACTORY) is called. It must
505 be of type "ClassName".
506 -->
509 <!--
510 The "from-action" element contains an action reference expression
511 that must have been executed (by the default ActionListener for handling
512 application level events) in order to select this navigation rule. If
513 not specified, this rule will be relevant no matter which action reference
514 was executed (or if no action reference was executed).
516 This value must be of type "Action".
517 -->
521 <!--
522 The "from-outcome" element contains a logical outcome string returned
523 by the execution of an application action method selected via an
524 "actionRef" property (or a literal value specified by an "action"
525 property) of a UICommand component. If specified, this rule will be
526 relevant only if the outcome value matches this element's value. If
527 not specified, this rule will be relevant no matter what the outcome
528 value was.
529 -->
533 <!--
534 The "from-view-id" element contains the view identifier of the view
535 for which the containing navigation rule is relevant. If no
536 "from-view" element is specified, this rule applies to navigation
537 decisions on all views. If this element is not specified, a value
538 of "*" is assumed, meaning that this navigation rule applies to all
539 views.
541 This value must be of type "ViewIdPattern".
542 -->
546 <!--
547 The "key" element is the String representation of a map key that
548 will be stored in a managed property of type java.util.Map.
549 -->
553 <!--
554 The "key-class" element defines the Java type to which each "key"
555 element in a set of "map-entry" elements will be converted to. It
556 must be of type "ClassName". If omitted, "java.lang.String"
557 is assumed.
558 -->
562 <!--
563 The "large-icon" element contains the resource path to a large (32x32)
564 icon image. The image may be in either GIF or JPG format.
565 -->
568 <!--
569 The "lifecycle-factory" element contains the fully qualified class name
570 of the concrete LifecycleFactory implementation class that will be called
571 when FactoryFinder.getFactory(LIFECYCLE_FACTORY) is called. It must be
572 of type "ClassName".
573 -->
576 <!--
577 The "managed-bean-class" element represents the fully qualified class
578 name of the Java class that will be used to instantiate a new instance
579 if creation of the specified managed bean is requested. It must be of
580 type "ClassName".
582 The specified class must conform to standard JavaBeans conventions.
583 In particular, it must have a public zero-arguments constructor, and
584 zero or more public property setters.
585 -->
589 <!--
590 The "managed-bean-name" element represents the attribute name under
591 which a managed bean will be searched for, as well as stored (unless
592 the "managed-bean-scope" value is "none"). It must be of type
593 "Identifier".
594 -->
598 <!--
599 The "managed-bean-scope" element represents the scope into which a newly
600 created instance of the specified managed bean will be stored (unless
601 the value is "none"). It must be of type "ScopeOrNone".
602 -->
605 <!--
606 The "navigation-handler" element contains the fully qualified class name
607 of the concrete NavigationHandler implementation class that will be called
608 during the Invoke Application phase of the request processing lifecycle,
609 if the default ActionListener (provided by the JSF implementation) is used.
610 It must be of type "ClassName".
611 -->
614 <!--
615 The "phase-listener" element contains the fully qualified class
616 name of the concrete PhaseListener implementation class that will be
617 registered on the Lifecycle. It must be of type "ClassName".
618 -->
621 <!--
622 The "redirect" element indicates that navigation to the specified
623 "to-view-id" should be accomplished by performing an HTTP redirect
624 rather than the usual ViewHandler mechanisms.
625 -->
628 <!--
629 The "suggested-value" contains the value for the property or
630 attribute in which this element resides. This value is advisory
631 only and is intended for tools to use when populating pallettes.
632 -->
636 <!--
638 The "view-handler" element contains the fully qualified class name
639 of the concrete ViewHandler implementation class that will be called
640 during the Restore View and Render Response phases of the request
641 processing lifecycle. The faces implementation must provide a
642 default implementation of this class
643 -->
646 <!--
648 The "state-manager" element contains the fully qualified class name
649 of the concrete StateManager implementation class that will be called
650 during the Restore View and Render Response phases of the request
651 processing lifecycle. The faces implementation must provide a
652 default implementation of this class
653 -->
656 <!--
657 The "null-value" element indicates that the managed property in which we
658 are nested will be explicitly set to null if our managed bean is
659 automatically created. This is different from omitting the managed
660 property element entirely, which will cause no property setter to be
661 called for this property.
663 The "null-value" element can only be used when the associated
664 "property-class" identifies a Java class, not a Java primitive.
665 -->
669 <!--
670 The "property-class" element represents the Java type of the value
671 associated with this property name. It must be of type "JavaType".
672 If not specified, it can be inferred from existing classes; however,
673 this element should be specified if the configuration file is going
674 to be the source for generating the corresponding classes.
675 -->
679 <!--
680 The "property-name" element represents the JavaBeans property name
681 under which the corresponding value may be stored.
682 -->
686 <!--
687 The "property-resolver" element contains the fully qualified class name
688 of the concrete PropertyResolver implementation class that will be used
689 during the processing of value binding expressions.
690 It must be of type "ClassName".
691 -->
695 <!--
696 The "referenced-bean-class" element represents the fully qualified class
697 name of the Java class (either abstract or concrete) or Java interface
698 implemented by the corresponding referenced bean. It must be of type
699 "ClassName".
700 -->
704 <!--
705 The "referenced-bean-name" element represents the attribute name under
706 which the corresponding referenced bean may be assumed to be stored,
707 in one of the scopes defined by the "Scope" type. It must be of type
708 "Identifier".
709 -->
713 <!--
714 The "render-kit-id" element represents an identifier for the
715 RenderKit represented by the parent "render-kit" element.
716 -->
720 <!--
721 The "render-kit-class" element represents the fully qualified class name
722 of a concrete RenderKit implementation class. It must be of
723 type "ClassName".
724 -->
728 <!--
729 The "renderer-class" element represents the fully qualified class name
730 of a concrete Renderer implementation class. It must be of
731 type "ClassName".
732 -->
735 <!--
736 The "render-kit-factory" element contains the fully qualified class name
737 of the concrete RenderKitFactory implementation class that will be called
738 when FactoryFinder.getFactory(RENDER_KIT_FACTORY) is called. It must be
739 of type "ClassName".
740 -->
743 <!--
744 The "renderer-type" element represents a renderer type identifier for the
745 Renderer represented by the parent "renderer" element.
746 -->
749 <!--
750 The "small-icon" element contains the resource path to a large (16x16)
751 icon image. The image may be in either GIF or JPG format.
752 -->
755 <!--
756 The "supported-locale" element allows authors to declare which
757 locales are supported in this application instance.
759 It must be specified as :language:[_:country:[_:variant:]] without
760 the colons, for example "ja_JP_SJIS". The separators between the
761 segments may be '-' or '_'.
762 -->
765 <!--
766 The "to-view" element contains the view identifier of the next view
767 that should be displayed if this navigation rule is matched. It
768 must be of type "ViewId".
769 -->
773 <!--
774 The "validator-class" element represents the fully qualified class name
775 of a concrete Validator implementation class. It must be of
776 type "ClassName".
777 -->
781 <!--
782 The "validator-id" element represents the identifier under which the
783 corresponding Validator class should be registered.
784 -->
788 <!--
789 The "value" element is the String representation of a literal
790 value to which a scalar managed property will be set, or a value
791 binding expression ("#{...}") that will be used to calculate the
792 required value. It will be converted as specified for the actual
793 property type.
794 -->
798 <!--
799 The "value-class" element defines the Java type to which each
800 "value" element's value will be converted to, prior to adding it to
801 the "list-entries" list for a managed property that is a
802 java.util.List, or a "map-entries" map for a managed property that
803 is a java.util.Map. It must be of type "ClassName". If omitted,
804 "java.lang.String" is assumed.
805 -->
808 <!--
809 The "variable-resolver" element contains the fully qualified class name
810 of the concrete VariableResolver implementation class that will be used
811 during the processing of value binding expressions.
812 It must be of type "ClassName".
813 -->
817 <!-- ============================ Identifier Attributes ==================== -->