Copyright 2004 Sun Microsystems, Inc. All rights reserved.
SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
<faces-config>
The "faces-config" element is the root of the configuration information
hierarchy, and contains nested elements for all of the other configuration
settings.
The "application" element provides a mechanism to define the various
per-application-singleton implementation artifacts for a particular web
application that is utilizing JavaServer Faces. For nested elements
that are not specified, the JSF implementation must provide a suitable
default.
The "factory" element provides a mechanism to define the various
Factories that comprise parts of the implementation of JavaServer
Faces. For nested elements that are not specified, the JSF
implementation must provide a suitable default.
Extension element for attribute. May contain implementation
specific content.
type= com.wutka.dtd.DTDAny is unsupported !
<component>
The "component" element represents a concrete UIComponent implementation
class that should be registered under the specified type identifier,
along with its associated properties and attributes. Component types must
be unique within the entire web application.
Nested "attribute" elements identify generic attributes that are recognized
by the implementation logic of this component. Nested "property" elements
identify JavaBeans properties of the component class that may be exposed
for manipulation via tools.
Extension element for component. May contain implementation
specific content.
type= com.wutka.dtd.DTDAny is unsupported !
<converter>
The "converter" element represents a concrete Converter implementation
class that should be registered under the specified converter identifier.
Converter identifiers must be unique within the entire web application.
Nested "attribute" elements identify generic attributes that may be
configured on the corresponding UIComponent in order to affect the
operation of the Converter. Nested "property" elements identify JavaBeans
properties of the Converter implementation class that may be configured
to affect the operation of the Converter.
The "icon" element contains "small-icon" and "large-icon" elements that
specify the resoruce paths for small and large GIF or JPG icon images
used to represent the parent element in a GUI tool.
The "lifecycle" element provides a mechanism to specify
modifications to the behaviour of the default Lifecycle
implementation for this web application.
The "managed-bean" element represents a JavaBean, of a particular class,
that will be dynamically instantiated at runtime (by the default
VariableResolver implementation) if it is referenced as the first element
of a value binding expression, and no corresponding bean can be
identified in any scope. In addition to the creation of the managed bean,
and the optional storing of it into the specified scope, the nested
managed-property elements can be used to initialize the contents of
settable JavaBeans properties of the created instance.
The "managed-property" element represents an individual property of a
managed bean that will be configured to the specified value (or value set)
if the corresponding managed bean is automatically created.
The "map-entries' element represents a set of key-entry pairs that
will be added to the computed value of a managed property of type
java.util.Map. In addition, the Java class types of the key and entry
values may be optionally declared.
The base name of a resource bundle representing the message resources
for this application. See the JavaDocs for the "java.util.ResourceBundle"
class for more information on the syntax of resource bundle names.
The "navigation-case" element describes a particular combination of
conditions that must match for this case to be executed, and the
view id of the component tree that should be selected next.
The "navigation-rule" element represents an individual decision rule
that will be utilized by the default NavigationHandler
implementation to make decisions on what view should be displayed
next, based on the view id being processed.
The "property" element represents a JavaBean property of the Java class
represented by our parent element.
Property names must be unique within the scope of the Java class
that is represented by the parent element, and must correspond to
property names that will be recognized when performing introspection
against that class via java.beans.Introspector.
Extension element for property. May contain implementation
specific content.
type= com.wutka.dtd.DTDAny is unsupported !
<referenced-bean>
The "referenced-bean" element represents at design time the promise
that a Java object of the specified type will exist at runtime in some
scope, under the specified key. This can be used by design time tools
to construct user interface dialogs based on the properties of the
specified class. The presence or absence of a referenced bean
element has no impact on the JavaServer Faces runtime environment
inside a web application.
The "render-kit" element represents a concrete RenderKit implementation
that should be registered under the specified render-kit-id. If no
render-kit-id is specified, the identifier of the default RenderKit
(RenderKitFactory.DEFAULT_RENDER_KIT) is assumed.
The "renderer" element represents a concrete Renderer implementation
class that should be registered under the specified component family
and renderer type identifiers, in the RenderKit associated with the
parent "render-kit" element. Combinations of component family and renderer
type must be unique within the RenderKit associated with the parent
"render-kit" element.
Nested "attribute" elements identify generic component attributes that
are recognized by this renderer.
Extension element for renderer. May contain implementation
specific content.
type= com.wutka.dtd.DTDAny is unsupported !
<validator>
The "validator" element represents a concrete Validator implementation
class that should be registered under the specified validator identifier.
Validator identifiers must be unique within the entire web application.
Nested "attribute" elements identify generic attributes that may be
configured on the corresponding UIComponent in order to affect the
operation of the Validator. Nested "property" elements identify JavaBeans
properties of the Validator implementation class that may be configured
to affect the operation of the Validator.
The "list-entries" element represents a set of initialization
elements for a managed property that is a java.util.List or an
array. In the former case, the "value-class" element can optionally
be used to declare the Java type to which each value should be
converted before adding it to the Collection.
The "action-listener" element contains the fully qualified class name
of the concrete ActionListener implementation class that will be called
during the Invoke Application phase of the request processing lifecycle.
It must be of type "ClassName".
The "application-factory" element contains the fully qualified class
name of the concrete ApplicationFactory implementation class that
will be called when FactoryFinder.getFactory(APPLICATION_FACTORY) is
called. It must be of type "ClassName".
The "attribute-name" element represents the name under which the
corresponding value will be stored, in the generic attributes of the
UIComponent we are related to.
The "component-class" element represents the fully qualified class name
of a concrete UIComponent implementation class. It must be of
type "ClassName".
The "converter-for-class" element represents the fully qualified class name
for which a Converter class will be registered. It must be of
type "ClassName".
The "default-locale" element declares the default locale for this
application instance. It must be specified as
:language:[_:country:[_:variant:]] without the colons, for example
"ja_JP_SJIS". The separators between the segments may be '-' or
'_'.
The "default-value" contains the value for the property or attribute
in which this element resides. This value differs from the
"suggested-value" in that the property or attribute must take the
value, whereas in "suggested-value" taking the value is optional.
The "description" element contains a textual description of the element
it is nested in, optionally flagged with a language code using the
"xml:lang" attribute.
The "display-name" element is a short descriptive name describing the
entity associated with the element it is nested in, intended to be
displayed by tools, and optionally flagged with a language code using
the "xml:lang" attribute.
The "faces-context-factory" element contains the fully qualified
class name of the concrete FacesContextFactory implementation class
that will be called when
FactoryFinder.getFactory(FACES_CONTEXT_FACTORY) is called. It must
be of type "ClassName".
The "from-action" element contains an action reference expression
that must have been executed (by the default ActionListener for handling
application level events) in order to select this navigation rule. If
not specified, this rule will be relevant no matter which action reference
was executed (or if no action reference was executed).
The "from-outcome" element contains a logical outcome string returned
by the execution of an application action method selected via an
"actionRef" property (or a literal value specified by an "action"
property) of a UICommand component. If specified, this rule will be
relevant only if the outcome value matches this element's value. If
not specified, this rule will be relevant no matter what the outcome
value was.
The "from-view-id" element contains the view identifier of the view
for which the containing navigation rule is relevant. If no
"from-view" element is specified, this rule applies to navigation
decisions on all views. If this element is not specified, a value
of "*" is assumed, meaning that this navigation rule applies to all
views.
The "key-class" element defines the Java type to which each "key"
element in a set of "map-entry" elements will be converted to. It
must be of type "ClassName". If omitted, "java.lang.String"
is assumed.
The "lifecycle-factory" element contains the fully qualified class name
of the concrete LifecycleFactory implementation class that will be called
when FactoryFinder.getFactory(LIFECYCLE_FACTORY) is called. It must be
of type "ClassName".
The "managed-bean-class" element represents the fully qualified class
name of the Java class that will be used to instantiate a new instance
if creation of the specified managed bean is requested. It must be of
type "ClassName".
The specified class must conform to standard JavaBeans conventions.
In particular, it must have a public zero-arguments constructor, and
zero or more public property setters.
The "managed-bean-name" element represents the attribute name under
which a managed bean will be searched for, as well as stored (unless
the "managed-bean-scope" value is "none"). It must be of type
"Identifier".
The "managed-bean-scope" element represents the scope into which a newly
created instance of the specified managed bean will be stored (unless
the value is "none"). It must be of type "ScopeOrNone".
The "navigation-handler" element contains the fully qualified class name
of the concrete NavigationHandler implementation class that will be called
during the Invoke Application phase of the request processing lifecycle,
if the default ActionListener (provided by the JSF implementation) is used.
It must be of type "ClassName".
The "phase-listener" element contains the fully qualified class
name of the concrete PhaseListener implementation class that will be
registered on the Lifecycle. It must be of type "ClassName".
The "redirect" element indicates that navigation to the specified
"to-view-id" should be accomplished by performing an HTTP redirect
rather than the usual ViewHandler mechanisms.
The "suggested-value" contains the value for the property or
attribute in which this element resides. This value is advisory
only and is intended for tools to use when populating pallettes.
The "view-handler" element contains the fully qualified class name
of the concrete ViewHandler implementation class that will be called
during the Restore View and Render Response phases of the request
processing lifecycle. The faces implementation must provide a
default implementation of this class
The "state-manager" element contains the fully qualified class name
of the concrete StateManager implementation class that will be called
during the Restore View and Render Response phases of the request
processing lifecycle. The faces implementation must provide a
default implementation of this class
The "null-value" element indicates that the managed property in which we
are nested will be explicitly set to null if our managed bean is
automatically created. This is different from omitting the managed
property element entirely, which will cause no property setter to be
called for this property.
The "null-value" element can only be used when the associated
"property-class" identifies a Java class, not a Java primitive.
The "property-class" element represents the Java type of the value
associated with this property name. It must be of type "JavaType".
If not specified, it can be inferred from existing classes; however,
this element should be specified if the configuration file is going
to be the source for generating the corresponding classes.
The "property-resolver" element contains the fully qualified class name
of the concrete PropertyResolver implementation class that will be used
during the processing of value binding expressions.
It must be of type "ClassName".
The "referenced-bean-class" element represents the fully qualified class
name of the Java class (either abstract or concrete) or Java interface
implemented by the corresponding referenced bean. It must be of type
"ClassName".
The "referenced-bean-name" element represents the attribute name under
which the corresponding referenced bean may be assumed to be stored,
in one of the scopes defined by the "Scope" type. It must be of type
"Identifier".
The "render-kit-factory" element contains the fully qualified class name
of the concrete RenderKitFactory implementation class that will be called
when FactoryFinder.getFactory(RENDER_KIT_FACTORY) is called. It must be
of type "ClassName".
The "supported-locale" element allows authors to declare which
locales are supported in this application instance.
It must be specified as :language:[_:country:[_:variant:]] without
the colons, for example "ja_JP_SJIS". The separators between the
segments may be '-' or '_'.
The "to-view" element contains the view identifier of the next view
that should be displayed if this navigation rule is matched. It
must be of type "ViewId".
The "value" element is the String representation of a literal
value to which a scalar managed property will be set, or a value
binding expression ("#{...}") that will be used to calculate the
required value. It will be converted as specified for the actual
property type.
The "value-class" element defines the Java type to which each
"value" element's value will be converted to, prior to adding it to
the "list-entries" list for a managed property that is a
java.util.List, or a "map-entries" map for a managed property that
is a java.util.Map. It must be of type "ClassName". If omitted,
"java.lang.String" is assumed.
The "variable-resolver" element contains the fully qualified class name
of the concrete VariableResolver implementation class that will be used
during the processing of value binding expressions.
It must be of type "ClassName".