Class ApplicationConfigurationPopulator
This class defines a java.util.ServiceLoader
service which enables programmatic configuration of the JSF runtime using the existing
Application Configuration Resources schema. See the section "Application Startup
Behavior" in the specification prose document for the specification on when
and how implementations of this service are used.
- Since:
- 2.2
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionabstract void
populateApplicationConfiguration
(Document toPopulate) Service providers that implement this service must be called by the JSF runtime exactly once for each implementation, at startup, before any requests have been serviced.
-
Constructor Details
-
ApplicationConfigurationPopulator
public ApplicationConfigurationPopulator()
-
-
Method Details
-
populateApplicationConfiguration
Service providers that implement this service must be called by the JSF runtime exactly once for each implementation, at startup, before any requests have been serviced. Before calling the
populateApplicationConfiguration(org.w3c.dom.Document)
method, the runtime must ensure that theDocument
argument is empty aside from being pre-configured to be in the proper namespace for an Application Configuration Resources file:http://xmlns.jcp.org/xml/ns/javaee
. Implementations of this service must ensure that any changes made to the argumentDocument
conform to that schema as defined in the specification. The JSF runtime is not required to validate theDocument
after control returns from the service implementation, though it may do so.Ordering of Artifacts
If the document is made to contain an
<ordering>
element, as specified in the section Ordering of Artifacts in the specification prose document, the document will be prioritized accordingly. Otherwise, the runtime must place the document in the list of other Application Configuration Resources documents at the "lowest" priority, meaning any conflicts that may arise between the argument document and any other Application Configuration Resources are resolved in favor of the other document.- Parameters:
toPopulate
- The Document to populate with configuration.- Since:
- 2.2
-