JSF Schema

• Global element and attribute declarations belong to this schema's target namespace.
• By default, local element declarations belong to this schema's target namespace.
• By default, local attribute declarations have no namespace.

• This schema includes components from the following schema document(s):
  • javaee_7.xsd

The XML Schema for the JavaServer Faces Application Configuration File (Version 2.2).

All JavaServer Faces configuration files must indicate the JavaServer Faces schema by indicating the JavaServer Faces namespace:

http://xmlns.jcp.org/xml/ns/javaee

and by indicating the version of the schema by using the version element as shown below:

<faces-config xmlns="http://xmlns.jcp.org/xml/ns/javaee"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="..."
      version="2.2">
      ...
      </faces-config>

The instance documents may indicate the published version of the schema using xsi:schemaLocation attribute for javaee namespace with the following location:

http://xmlns.jcp.org/xml/ns/javaee/web-facesconfig_2_2.xsd

The "faces-config" element is the root of the configuration information hierarchy, and contains nested elements for all of the other configuration settings.

Only relevant if this is placed within the /WEB-INF/faces-config.xml. Please see section JSF.11.4.6 for the specification for details.

Extension element for application. It may contain implementation specific content.

The resource-bundle element inside the application element references a java.util.ResourceBundle instance by name using the var element. ResourceBundles referenced in this manner may be returned by a call to Application.getResourceBundle() passing the current FacesContext for this request and the value of the var element below.

The "contract-mapping" element specifies the mappings between a collection of views in the application and resource library contracts that, if present in the application, must be made available for use as templates of the specified views.

The "resource-library-contracts" element specifies the mappings between views in the application and resource library contracts that, if present in the application, must be made available for use as templates of the specified views.

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.

Extension element for attribute. It may contain implementation specific content.

The "attribute" element represents a named, typed, value associated with the parent UIComponent via the generic attributes mechanism.

Attribute names must be unique within the scope of the parent (or related) component.

Extension element for behavior. It may contain implementation specific content.

The "behavior" element represents a concrete Behavior implementation class that should be registered under the specified behavior identifier. Behavior 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 Behavior. Nested "property" elements identify JavaBeans properties of the Behavior implementation class that may be configured to affect the operation of the Behavior. "attribute" and "property" elements are intended to allow component developers to more completely describe their components to tools and users. These elements have no required runtime semantics.

The "client-behavior-renderer" element represents a concrete ClientBehaviorRenderer implementation class that should be registered under the specified behavior renderer type identifier, in the RenderKit associated with the parent "render-kit" element. Client Behavior 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 component. It may contain implementation specific content.

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 converter. It may contain implementation specific content.

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. "attribute" and "property" elements are intended to allow component developers to more completely describe their components to tools and users. These elements have no required runtime semantics.

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-validators" element allows the app developer to register a set of validators, referenced by identifier, that are automatically assigned to any EditableValueHolder component in the application, unless overridden or disabled locally.

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.

Extension element for faces-config. It may contain implementation specific content.

Extension element for facet. It may contain implementation specific content.

Define the name and other design-time information for a facet that is associated with a renderer or a component.

Extension element for factory. It may contain implementation specific content.

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.

Invoke a method, passing parameters if necessary. The return from the method is used as the outcome for where to go next in the flow. If the method is a void method, the default outcome is used.

A MethodExpression that will be invoked when the flow is exited.

Identifiy the called flow.

A named parameter whose value will be passed to a correspondingly named parameter within an "inbound-parameter" element on the target flow.

A parameter to pass when calling the method identified in the "method" element that is a sibling of this element.

Define a call node in a flow graph.

Define a return node in a flow graph.

A named parameter whose value will be populated with a correspondingly named parameter within an "outbound-parameter" element.

A MethodExpression that will be invoked when the flow is entered.

Defines a case that will be considered in the <switch>.

Define a switch node in a flow graph.

Top level element for a flow definition.

Define a view node in a flow graph.

This element must contain exactly one <vdl-document> element.

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 the 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 value of from-view-id must contain one of the following values:

• The exact match for a view identifier that is recognized by the the ViewHandler implementation being used (such as "/index.jsp" if you are using the default ViewHandler).

• The exact match of a flow node id in the current flow, or a flow id of another flow.

• A proper prefix of a view identifier, plus a trailing "*" character. This pattern indicates that all view identifiers that match the portion of the pattern up to the asterisk will match the surrounding rule. When more than one match exists, the match with the longest pattern is selected.

• An "*" character, which means that this pattern applies to all view identifiers.

The "if" element defines a condition that must resolve to true in order for the navigation case on which it is defined to be matched, with the existing match criteria (action method and outcome) as a prerequiste, if present. The condition is defined declaratively using a value expression in the body of this element. The expression is evaluated at the time the navigation case is being matched. If the "from-outcome" is omitted and this element is present, the navigation handler will match a null outcome and use the condition return value to determine if the case should be considered a match.

Extension element for lifecycle. It may contain implementation specific content.

The "lifecycle" element provides a mechanism to specify modifications to the behaviour of the default Lifecycle implementation for this web application.

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 "locale-config" element allows the app developer to declare the supported locales for this application.

Extension element for managed-bean. It may contain implementation specific content.

Defines the legal values for the element's body content, which includes all of the scopes normally used in a web application, plus the "none" value indicating that a created bean should not be stored into any scope. Alternatively, an EL expression may be used as the value of this element. The result of evaluating this expression must by of type java.util.Map.

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 "map-entry" element reprsents a single key-entry pair that will be added to the computed value of a managed property of type java.util.Map.

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.

Extension element for navigation-rule. It may contain implementation specific content.

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 "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.

This element contains a sequence of "id" elements, each of which refers to an application configuration resource by the "id" declared on its faces-config element. This element can also contain a single "others" element which specifies that this document comes before or after other documents within the application.

This element indicates that the ordering sub-element in which it was placed should take special action regarding the ordering of this application resource relative to other application configuration resources. See section JSF.11.4.6 for the complete specification.

Please see section JSF.11.4.6 for the specification of this element.

Extension element for property. It may contain implementation specific content.

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.

Any view that matches any of the url-patterns in this element may only be reached from another JSF view in the same web application. Because the runtime is aware of which views are protected, any navigation from an unprotected view to a protected view is automatically subject to protection.

The "redirect-param" element, only valid within a "redirect" element, contains child "name" and "value" elements that must be included in the redirect url when the redirect is performed.

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.

This element was introduced due to a specification error, and is now deprecated. The correct name for this element is "redirect-param" and its meaning is documented therein. The "view-param" element is maintained to preserve backwards compatibility. Implementations must treat this element the same as "redirect-param".

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.

Extension element for renderer. It may contain implementation specific content.

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 render-kit. It may contain implementation specific content.