com.sun.faces.application

Class ApplicationImpl

java.lang.Object

javax.faces.application.Application

com.sun.faces.application.ApplicationImpl

public class ApplicationImpl
extends javax.faces.application.Application

Application represents a per-web-application singleton object where applications based on JavaServer Faces (or implementations wishing to provide extended functionality) can register application-wide singletons that provide functionality required by JavaServer Faces.

Field Summary

Fields

Modifier and Type	Field and Description
static String	THIS_LIBRARY

Constructor Summary

Constructors

Constructor and Description
ApplicationImpl() Constructor

Method Summary

Modifier and Type	Method and Description
void	addBehavior(String behaviorId, String behaviorClass) Register a new mapping of behavior id to the name of the corresponding Behavior class.
void	addComponent(String componentType, String componentClass) Register a new mapping of component type to the name of the corresponding UIComponent class.
void	addConverter(Class<?> targetClass, String converterClass) Register a new converter class that is capable of performing conversions for the specified target class.
void	addConverter(String converterId, String converterClass) Register a new mapping of converter id to the name of the corresponding Converter class.
void	addDefaultValidatorId(String validatorId) Register a validator by its id that is applied to all UIInput components in a view.
void	addELContextListener(javax.el.ELContextListener listener) Provide a way for Faces applications to register an ELContextListener that will be notified on creation of ELContext instances.
void	addELResolver(javax.el.ELResolver resolver) Cause an the argument resolver to be added to the resolver chain as specified in section JSF.5.5.1 of the Jakarta Server Faces Specification.
void	addSearchKeywordResolver(javax.faces.component.search.SearchKeywordResolver resolver) Cause the argument resolver to be added to the head of the resolver chain.
void	addValidator(String validatorId, String validatorClass) Register a new mapping of validator id to the name of the corresponding Validator class.
javax.faces.component.behavior.Behavior	createBehavior(String behaviorId) Instantiate and return a new Behavior instance of the class specified by a previous call to addBehavior() for the specified behavior id.
javax.faces.component.UIComponent	createComponent(javax.faces.context.FacesContext context, javax.faces.application.Resource componentResource) Instantiate and return a new UIComponent instance from the argument Resource.
javax.faces.component.UIComponent	createComponent(javax.faces.context.FacesContext context, String componentType, String rendererType) Like Application.createComponent(String) except the Renderer for the component to be returned must be inspected for the annotations mentioned in Application.createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method.
javax.faces.component.UIComponent	createComponent(String componentType) Instantiate and return a new UIComponent instance of the class specified by a previous call to addComponent() for the specified component type.
javax.faces.component.UIComponent	createComponent(javax.faces.el.ValueBinding componentBinding, javax.faces.context.FacesContext context, String componentType) Wrap the argument componentBinding in an implementation of ValueExpression and call through to Application.createComponent(javax.el.ValueExpression,javax.faces.context.FacesContext,java.lang.String).
javax.faces.component.UIComponent	createComponent(javax.el.ValueExpression componentExpression, javax.faces.context.FacesContext context, String componentType) Call the getValue() method on the specified ValueExpression.
javax.faces.component.UIComponent	createComponent(javax.el.ValueExpression componentExpression, javax.faces.context.FacesContext context, String componentType, String rendererType) Like Application.createComponent(ValueExpression, FacesContext, String) except the Renderer for the component to be returned must be inspected for the annotations mentioned in Application.createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method.
javax.faces.convert.Converter<?>	createConverter(Class<?> targetClass) Instantiate and return a new Converter instance of the class that has registered itself as capable of performing conversions for objects of the specified type.
javax.faces.convert.Converter<?>	createConverter(String converterId) Instantiate and return a new Converter instance of the class specified by a previous call to addConverter() for the specified converter id.
javax.faces.el.MethodBinding	createMethodBinding(String ref, Class<?>[] params) Deprecated.
javax.faces.validator.Validator<?>	createValidator(String validatorId) Instantiate and return a new Validator instance of the class specified by a previous call to addValidator() for the specified validator id.
javax.faces.el.ValueBinding	createValueBinding(String ref) Deprecated.
<T> T	evaluateExpressionGet(javax.faces.context.FacesContext context, String expression, Class<? extends T> expectedType) Get a value by evaluating an expression.
javax.faces.event.ActionListener	getActionListener() Return the default ActionListener to be registered for all ActionSource components in this application.
javax.el.CompositeELResolver	getApplicationELResolvers()
Iterator<String>	getBehaviorIds() Return an Iterator over the set of currently registered behavior ids for this Application.
Iterator<String>	getComponentTypes() Return an Iterator over the set of currently defined component types for this Application.
FacesCompositeELResolver	getCompositeELResolver()
Iterator<String>	getConverterIds() Return an Iterator over the set of currently registered converter ids for this Application.
Iterator<Class<?>>	getConverterTypes() Return an Iterator over the set of Class instances for which Converter classes have been explicitly registered.
Locale	getDefaultLocale() Return the default Locale for this application.
String	getDefaultRenderKitId() Return the renderKitId to be used for rendering this application.
Map<String,String>	getDefaultValidatorInfo() Return an immutable Map over the set of currently registered default validator IDs and their class name for this Application.
javax.el.ELContextListener[]	getELContextListeners() If no calls have been made to Application.addELContextListener(javax.el.ELContextListener), this method must return an empty array.
javax.el.ELResolver	getELResolver() Return the singleton ELResolver instance to be used for all Jakarta Expression Language resolution.
javax.el.ExpressionFactory	getExpressionFactory() Return the ExpressionFactory instance for this application.
javax.faces.flow.FlowHandler	getFlowHandler() Return the thread-safe singleton FlowHandler for this application.
String	getMessageBundle() Return the fully qualified class name of the ResourceBundle to be used for Jakarta Server Faces messages for this application.
javax.faces.application.NavigationHandler	getNavigationHandler() Return the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application.
javax.faces.application.ProjectStage	getProjectStage() Return the project stage for the currently running application instance.
javax.faces.el.PropertyResolver	getPropertyResolver() Deprecated.
ResourceBundle	getResourceBundle(javax.faces.context.FacesContext context, String var) Find a ResourceBundle as defined in the application configuration resources under the specified name.
javax.faces.application.ResourceHandler	getResourceHandler() Return the singleton, stateless, thread-safe ResourceHandler for this application.
javax.faces.component.search.SearchExpressionHandler	getSearchExpressionHandler() Return the thread-safe singleton SearchExpressionHandler for this application.
javax.faces.component.search.SearchKeywordResolver	getSearchKeywordResolver() Return the singleton SearchKeywordResolver instance to be used for all search keyword resolution.
javax.faces.application.StateManager	getStateManager() Return the StateManager instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.
Iterator<Locale>	getSupportedLocales() Return an Iterator over the supported Locales for this appication.
Iterator<String>	getValidatorIds() Return an Iterator over the set of currently registered validator ids for this Application.
javax.faces.el.VariableResolver	getVariableResolver() Deprecated.
javax.faces.application.ViewHandler	getViewHandler() Return the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.
void	publishEvent(javax.faces.context.FacesContext context, Class<? extends javax.faces.event.SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source) This method functions exactly like Application.publishEvent(FacesContext,Class,Object), except the run-time must use the argument sourceBaseType to find the matching listener instead of using the Class of the source argument.
void	publishEvent(javax.faces.context.FacesContext context, Class<? extends javax.faces.event.SystemEvent> systemEventClass, Object source) If FacesContext.isProcessingEvents() is true and there are one or more listeners for events of the type represented by systemEventClass, call those listeners, passing source as the source of the event.
void	removeELContextListener(javax.el.ELContextListener listener) Remove the argument listener from the list of ELContextListeners.
void	setActionListener(javax.faces.event.ActionListener actionListener) Set the default ActionListener to be registered for all ActionSource components.
void	setCompositeELResolver(FacesCompositeELResolver compositeELResolver)
void	setDefaultLocale(Locale locale) Set the default Locale for this application.
void	setDefaultRenderKitId(String renderKitId) Set the renderKitId to be used to render this application.
void	setFlowHandler(javax.faces.flow.FlowHandler flowHandler) Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements of the faces flows feature.
void	setMessageBundle(String messageBundle) Set the fully qualified class name of the ResourceBundle to be used for Jakarta Server Faces messages for this application.
void	setNavigationHandler(javax.faces.application.NavigationHandler navigationHandler) Set the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application.
void	setPropertyResolver(javax.faces.el.PropertyResolver resolver) Deprecated.
void	setResourceHandler(javax.faces.application.ResourceHandler resourceHandler) Set the ResourceHandler instance that will be utilized for rendering the markup for resources, and for satisfying client requests to serve up resources.
void	setSearchExpressionHandler(javax.faces.component.search.SearchExpressionHandler searchExpressionHandler) Set the SearchExpressionHandler instance used by the application.
void	setStateManager(javax.faces.application.StateManager stateManager) Set the StateManager instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.
void	setSupportedLocales(Collection<Locale> newLocales) Set the Locale instances representing the supported Locales for this application.
void	setVariableResolver(javax.faces.el.VariableResolver resolver) Deprecated.
void	setViewHandler(javax.faces.application.ViewHandler viewHandler) Set the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.
void	subscribeToEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass, Class<?> sourceClass, javax.faces.event.SystemEventListener listener) Install the listener instance referenced by argument listener into the application as a listener for events of type systemEventClass that originate from objects of type sourceClass.
void	subscribeToEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass, javax.faces.event.SystemEventListener listener) Install the listener instance referenced by argument listener into application as a listener for events of type systemEventClass.
void	unsubscribeFromEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass, Class<?> sourceClass, javax.faces.event.SystemEventListener listener) Remove the listener instance referenced by argument listener from the application as a listener for events of type systemEventClass that originate from objects of type sourceClass.
void	unsubscribeFromEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass, javax.faces.event.SystemEventListener listener) Remove the listener instance referenced by argument listener from the application as a listener for events of type systemEventClass.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

THIS_LIBRARY

public static final String THIS_LIBRARY

See Also:

Constant Field Values

Constructor Detail

ApplicationImpl

public ApplicationImpl()

Constructor

Method Detail

publishEvent

public void publishEvent(javax.faces.context.FacesContext context,
                         Class<? extends javax.faces.event.SystemEvent> systemEventClass,
                         Object source)

Description copied from class: javax.faces.application.Application

If FacesContext.isProcessingEvents() is true and there are one or more listeners for events of the type represented by systemEventClass, call those listeners, passing source as the source of the event. The implementation should be as fast as possible in determining whether or not a listener for the given systemEventClass and source has been installed, and should return immediately once such a determination has been made. The implementation of publishEvent must honor the requirements stated in Application.subscribeToEvent(java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Class<?>, javax.faces.event.SystemEventListener) regarding the storage and retrieval of listener instances. Specifically, if Application.subscribeToEvent(Class,Class,SystemEventListener) was called, the sourceClass argument must match exactly the Class of the source argument in the call to publishEvent(). The implementation must not do any inheritance hierarachy inspection when looking for a match between the sourceClass passed to Application.subscribeToEvent(Class,Class,SystemEventListener) and the sourceClass passed to publishEvent() in order to find any listeners to which the event should be published. In the case where the Class of the source argument does not match the Class of the sourceClass used when the listener was subscribed using subscribeToEvent(), Application.publishEvent(FacesContext,Class,Class,Object) can be used to provide the Class used to perform the listener lookup and match.

The default implementation must implement an algorithm semantically equivalent to the following to locate listener instances and to invoke them.

• If the source argument implements SystemEventListenerHolder, call SystemEventListenerHolder.getListenersForEventClass(java.lang.Class<? extends javax.faces.event.SystemEvent>) on it, passing the systemEventClass argument. If the list is not empty, perform algorithm traverseListenerList on the list.

• If any view level listeners have been installed by previous calls to Application.subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener) on the UIViewRoot, perform algorithm traverseListenerList on the list of listeners for that event installed on the UIViewRoot.

• If any Application level listeners have been installed by previous calls to Application.subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener), perform algorithm traverseListenerList on the list.

• If any Application level listeners have been installed by previous calls to Application.subscribeToEvent(Class, javax.faces.event.SystemEventListener), perform algorithm traverseListenerList on the list.

If the act of invoking the processListener method causes an AbortProcessingException to be thrown, processing of the listeners must be aborted, no further processing of the listeners for this event must take place, and the exception must be logged with Level.SEVERE.

Algorithm traverseListenerList: For each listener in the list,

• Call SystemEventListener.isListenerForSource(java.lang.Object), passing the source argument. If this returns false, take no action on the listener.

• Otherwise, if the event to be passed to the listener instances has not yet been constructed, construct the event, passing source as the argument to the one-argument constructor that takes an Object. This same event instance must be passed to all listener instances.

• Call SystemEvent.isAppropriateListener(javax.faces.event.FacesListener), passing the listener instance as the argument. If this returns false, take no action on the listener.

• Call SystemEvent.processListener(javax.faces.event.FacesListener), passing the listener instance.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function

.

Overrides:

publishEvent in class javax.faces.application.Application

Parameters:

context - the FacesContext for the current request

systemEventClass - The Class of event that is being published.

source - The source for the event of type systemEventClass.

See Also:

Application.publishEvent(FacesContext, Class, Object)

publishEvent

public void publishEvent(javax.faces.context.FacesContext context,
                         Class<? extends javax.faces.event.SystemEvent> systemEventClass,
                         Class<?> sourceBaseType,
                         Object source)

Description copied from class: javax.faces.application.Application

This method functions exactly like Application.publishEvent(FacesContext,Class,Object), except the run-time must use the argument sourceBaseType to find the matching listener instead of using the Class of the source argument.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function

.

Overrides:

publishEvent in class javax.faces.application.Application

Parameters:

context - the FacesContext for the current request

systemEventClass - The Class of event that is being published.

sourceBaseType - The Class of the source event that must be used to lookup the listener to which this event must be published. If this argument is null the return from source.getClass() must be used as the sourceBaseType.

source - The source for the event of type systemEventClass.

See Also:

Application.publishEvent(FacesContext, Class, Object)

subscribeToEvent

public void subscribeToEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass,
                             javax.faces.event.SystemEventListener listener)

Description copied from class: javax.faces.application.Application

Install the listener instance referenced by argument listener into application as a listener for events of type systemEventClass. The default implementation simply calls through to Application.subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener) passing null as the sourceClass argument

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function

.

Overrides:

subscribeToEvent in class javax.faces.application.Application

Parameters:

systemEventClass - the Class of event for which listener must be fired.

listener - the implementation of SystemEventListener whose SystemEventListener.processEvent(javax.faces.event.SystemEvent) method must be called when events of type systemEventClass are fired.

See Application.subscribeToEvent(java.lang.Class,java.lang.Class,javax.faces.event.SystemEventListener) for an additional requirement regarding when it is valid to call this method.

See Also:

Application.subscribeToEvent(Class, javax.faces.event.SystemEventListener)

subscribeToEvent

public void subscribeToEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass,
                             Class<?> sourceClass,
                             javax.faces.event.SystemEventListener listener)

Description copied from class: javax.faces.application.Application

Install the listener instance referenced by argument listener into the application as a listener for events of type systemEventClass that originate from objects of type sourceClass.

If argument sourceClass is non-null, sourceClass and systemEventClass must be used to store the argument listener in the application in such a way that the listener can be quickly looked up by the implementation of Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object) given systemEventClass and an instance of the Class referenced by sourceClass. If argument sourceClass is null, the listener must be discoverable by the implementation of Application.publishEvent(javax.faces.context.FacesContext, java.lang.Class<? extends javax.faces.event.SystemEvent>, java.lang.Object) given only systemEventClass.

It is valid to call this method during the processing of an event which was subscribed to by a previous call to this method.

Overrides:

subscribeToEvent in class javax.faces.application.Application

Parameters:

systemEventClass - the Class of event for which listener must be fired.

sourceClass - the Class of the instance which causes events of type systemEventClass to be fired. May be null.

listener - the implementation of SystemEventListener whose SystemEventListener.processEvent(javax.faces.event.SystemEvent) method must be called when events of type systemEventClass are fired.

See Also:

Application.subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener)

unsubscribeFromEvent

public void unsubscribeFromEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass,
                                 javax.faces.event.SystemEventListener listener)

Description copied from class: javax.faces.application.Application

Remove the listener instance referenced by argument listener from the application as a listener for events of type systemEventClass. The default implementation simply calls through to Application.unsubscribeFromEvent(Class, javax.faces.event.SystemEventListener) passing null as the sourceClass argument

See Application.subscribeToEvent(java.lang.Class,java.lang.Class,javax.faces.event.SystemEventListener) for an additional requirement regarding when it is valid to call this method.

Overrides:

unsubscribeFromEvent in class javax.faces.application.Application

Parameters:

systemEventClass - the Class of event for which listener must be fired.

listener - the implementation of SystemEventListener to remove from the internal data structure.

See Also:

Application.unsubscribeFromEvent(Class, javax.faces.event.SystemEventListener)

unsubscribeFromEvent

public void unsubscribeFromEvent(Class<? extends javax.faces.event.SystemEvent> systemEventClass,
                                 Class<?> sourceClass,
                                 javax.faces.event.SystemEventListener listener)

Description copied from class: javax.faces.application.Application

Remove the listener instance referenced by argument listener from the application as a listener for events of type systemEventClass that originate from objects of type sourceClass. See Application.subscribeToEvent(Class, Class, javax.faces.event.SystemEventListener) for the specification of how the listener is stored, and therefore, how it must be removed.

See Application.subscribeToEvent(java.lang.Class,java.lang.Class,javax.faces.event.SystemEventListener) for an additional requirement regarding when it is valid to call this method.

Overrides:

unsubscribeFromEvent in class javax.faces.application.Application

Parameters:

systemEventClass - the Class of event for which listener must be fired.

sourceClass - the Class of the instance which causes events of type systemEventClass to be fired. May be null.

listener - the implementation of SystemEventListener to remove from the internal data structure.

See Also:

Application.unsubscribeFromEvent(Class, Class, javax.faces.event.SystemEventListener)

addELContextListener

public void addELContextListener(javax.el.ELContextListener listener)

Description copied from class: javax.faces.application.Application

Provide a way for Faces applications to register an ELContextListener that will be notified on creation of ELContext instances. This listener will be called once per request.

An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work.

Overrides:

addELContextListener in class javax.faces.application.Application

Parameters:

listener - the Jakarta Expression Language context listener to add.

See Also:

Application.addELContextListener(javax.el.ELContextListener)

removeELContextListener

public void removeELContextListener(javax.el.ELContextListener listener)

Description copied from class: javax.faces.application.Application

Remove the argument listener from the list of ELContextListeners. If listener is null, no exception is thrown and no action is performed. If listener is not in the list, no exception is thrown and no action is performed.

An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work.

Overrides:

removeELContextListener in class javax.faces.application.Application

Parameters:

listener - the Jakarta Expression Language context listener to remove.

See Also:

Application.removeELContextListener(javax.el.ELContextListener)

getELContextListeners

public javax.el.ELContextListener[] getELContextListeners()

Description copied from class: javax.faces.application.Application

If no calls have been made to Application.addELContextListener(javax.el.ELContextListener), this method must return an empty array.

Otherwise, return an array representing the list of listeners added by calls to Application.addELContextListener(javax.el.ELContextListener).

An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work.

Overrides:

getELContextListeners in class javax.faces.application.Application

Returns:

an array of Jakarta Expression Language context listeners.

See Also:

Application.getELContextListeners()

getExpressionFactory

public javax.el.ExpressionFactory getExpressionFactory()

Description copied from class: javax.faces.application.Application

Return the ExpressionFactory instance for this application. This instance is used by the convenience method Application.evaluateExpressionGet(javax.faces.context.FacesContext, java.lang.String, java.lang.Class<? extends T>).

The implementation must return the ExpressionFactory from the Jakarta Server Pages container by calling JspFactory.getDefaultFactory().getJspApplicationContext(servletContext).getExpressionFactory().

An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work.

Overrides:

getExpressionFactory in class javax.faces.application.Application

Returns:

the expression factory.

See Also:

Application.getExpressionFactory()

evaluateExpressionGet

public <T> T evaluateExpressionGet(javax.faces.context.FacesContext context,
                                   String expression,
                                   Class<? extends T> expectedType)
                            throws javax.el.ELException

Description copied from class: javax.faces.application.Application

Get a value by evaluating an expression.

Call Application.getExpressionFactory() then call ExpressionFactory.createValueExpression(javax.el.ELContext, java.lang.String, java.lang.Class<?>) passing the argument expression and expectedType. Call FacesContext.getELContext() and pass it to ValueExpression.getValue(javax.el.ELContext), returning the result.

An implementation is provided that throws UnsupportedOperationException so that users that decorate the Application continue to work.

Overrides:

evaluateExpressionGet in class javax.faces.application.Application

Type Parameters:

T - the return type.

Parameters:

context - the Faces context.

expression - the expression.

expectedType - the expected type.

Returns:

the result of the evaluation.

Throws:

javax.el.ELException

See Also:

Application.evaluateExpressionGet(javax.faces.context.FacesContext, String, Class)

getELResolver

public javax.el.ELResolver getELResolver()

Description copied from class: javax.faces.application.Application

Return the singleton ELResolver instance to be used for all Jakarta Expression Language resolution. This is actually an instance of CompositeELResolver that must contain the following ELResolver instances in the following order:

1. ELResolver instances declared using the <el-resolver> element in the application configuration resources.

2. An implementation that wraps the head of the legacy VariableResolver chain, as per section VariableResolver ChainWrapper in Chapter JSF.5 in the spec document.

3. An implementation that wraps the head of the legacy PropertyResolver chain, as per section PropertyResolver ChainWrapper in Chapter JSF.5 in the spec document.

4. Any ELResolver instances added by calls to Application.addELResolver(javax.el.ELResolver).

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application.

Overrides:

getELResolver in class javax.faces.application.Application

Returns:

the Jakarta Expression Language resolver.

See Also:

Application.getELResolver()

addELResolver

public void addELResolver(javax.el.ELResolver resolver)

Description copied from class: javax.faces.application.Application

Cause an the argument resolver to be added to the resolver chain as specified in section JSF.5.5.1 of the Jakarta Server Faces Specification.

It is not possible to remove an ELResolver registered with this method, once it has been registered.

It is illegal to register an ELResolver after the application has received any requests from the client. If an attempt is made to register a listener after that time, an IllegalStateException must be thrown. This restriction is in place to allow the Jakarta Server Pages container to optimize for the common case where no additional ELResolvers are in the chain, aside from the standard ones. It is permissible to add ELResolvers before or after initialization to a CompositeELResolver that is already in the chain.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application.

Overrides:

addELResolver in class javax.faces.application.Application

Parameters:

resolver - the Jakarta Expression Language resolver to add.

See Also:

Application.addELResolver(javax.el.ELResolver)

getApplicationELResolvers

public javax.el.CompositeELResolver getApplicationELResolvers()

getCompositeELResolver

public FacesCompositeELResolver getCompositeELResolver()

setCompositeELResolver

public void setCompositeELResolver(FacesCompositeELResolver compositeELResolver)

getViewHandler

public javax.faces.application.ViewHandler getViewHandler()

Description copied from class: javax.faces.application.Application

Return the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle. If not explicitly set, a default implementation must be provided that performs the functions described in the ViewHandler description in the JJakarta Server Faces Specification.

Specified by:

getViewHandler in class javax.faces.application.Application

Returns:

the view handler.

See Also:

Application.getViewHandler()

setViewHandler

public void setViewHandler(javax.faces.application.ViewHandler viewHandler)

Description copied from class: javax.faces.application.Application

Set the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.

Specified by:

setViewHandler in class javax.faces.application.Application

Parameters:

viewHandler - The new ViewHandler instance

See Also:

Application.setViewHandler(javax.faces.application.ViewHandler)

getResourceHandler

public javax.faces.application.ResourceHandler getResourceHandler()

Description copied from class: javax.faces.application.Application

Return the singleton, stateless, thread-safe ResourceHandler for this application. The Jakarta Server Faces implementation must support the following techniques for declaring an alternate implementation of ResourceHandler.

• The ResourceHandler implementation is declared in the application configuration resources by giving the fully qualified class name as the value of the <resource-handler> element within the <application> element.

In all of the above cases, the runtime must employ the decorator pattern as for every other pluggable artifact in Jakarta Server Faces.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function

.

Overrides:

getResourceHandler in class javax.faces.application.Application

Returns:

the resource handler.

See Also:

Application.getResourceHandler()

setResourceHandler

public void setResourceHandler(javax.faces.application.ResourceHandler resourceHandler)

Description copied from class: javax.faces.application.Application

Set the ResourceHandler instance that will be utilized for rendering the markup for resources, and for satisfying client requests to serve up resources.

Overrides:

setResourceHandler in class javax.faces.application.Application

Parameters:

resourceHandler - The new ResourceHandler instance

See Also:

Application.setResourceHandler(javax.faces.application.ResourceHandler)

getStateManager

public javax.faces.application.StateManager getStateManager()

Description copied from class: javax.faces.application.Application

Return the StateManager instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle. If not explicitly set, a default implementation must be provided that performs the functions described in the StateManager description in the Jakarta Server Faces Specification.

Specified by:

getStateManager in class javax.faces.application.Application

Returns:

the state manager.

See Also:

Application.getStateManager()

setStateManager

public void setStateManager(javax.faces.application.StateManager stateManager)

Description copied from class: javax.faces.application.Application

Set the StateManager instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.

Specified by:

setStateManager in class javax.faces.application.Application

Parameters:

stateManager - The new StateManager instance

See Also:

Application.setStateManager(javax.faces.application.StateManager)

getActionListener

public javax.faces.event.ActionListener getActionListener()

Description copied from class: javax.faces.application.Application

Return the default ActionListener to be registered for all ActionSource components in this application. If not explicitly set, a default implementation must be provided that performs the functions as specified in the section titled "ActionListener Property" in the chapter titled "Application Integration" of the spec prose document.

Note that the specification for the default ActionListener contiues to call for the use of a deprecated property (action) and class (MethodBinding). Unfortunately, this is necessary because the default ActionListener must continue to work with components that do not implement ActionSource2, and only implement ActionSource.

Specified by:

getActionListener in class javax.faces.application.Application

Returns:

the action listener.

See Also:

Application.getActionListener()

setActionListener

public void setActionListener(javax.faces.event.ActionListener actionListener)

Description copied from class: javax.faces.application.Application

Set the default ActionListener to be registered for all ActionSource components.

Specified by:

setActionListener in class javax.faces.application.Application

Parameters:

actionListener - The new default ActionListener

See Also:

Application.setActionListener(javax.faces.event.ActionListener)

getNavigationHandler

public javax.faces.application.NavigationHandler getNavigationHandler()

Description copied from class: javax.faces.application.Application

Return the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application. If not explicitly set, a default implementation must be provided that performs the functions described in the NavigationHandler class description.

• The NavigationHandler implementation is declared in the application configuration resources by giving the fully qualified class name as the value of the <navigation-handler> element within the <application> element.

The runtime must employ the decorator pattern as for every other pluggable artifact in Jakarta Server Faces.

Specified by:

getNavigationHandler in class javax.faces.application.Application

Returns:

the navigation handler.

See Also:

Application.getNavigationHandler()

setNavigationHandler

public void setNavigationHandler(javax.faces.application.NavigationHandler navigationHandler)

Description copied from class: javax.faces.application.Application

Set the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application.

Specified by:

setNavigationHandler in class javax.faces.application.Application

Parameters:

navigationHandler - The new NavigationHandler instance

See Also:

Application.setNavigationHandler(javax.faces.application.NavigationHandler)

getFlowHandler

public javax.faces.flow.FlowHandler getFlowHandler()

Description copied from class: javax.faces.application.Application

Return the thread-safe singleton FlowHandler for this application. For implementations declaring compliance with version 2.2 of the specification, this method must never return null, even if the application has no flows. This is necessary to enable dynamic flow creation during the application's lifetime.

All implementations that declare compliance with version 2.2 of the specification must implement this method. For the purpose of backward compatibility with environments that extend Application but do not override this method, an implementation is provided that returns null. Due to the decoratable nature of Application, code calling this method should always check for a null return.

Overrides:

getFlowHandler in class javax.faces.application.Application

Returns:

the flow handler.

setFlowHandler

public void setFlowHandler(javax.faces.flow.FlowHandler flowHandler)

Description copied from class: javax.faces.application.Application

Set the FlowHandler instance used by the NavigationHandler to satisfy the requirements of the faces flows feature.

Overrides:

setFlowHandler in class javax.faces.application.Application

Parameters:

flowHandler - the flow handler to set.

getSupportedLocales

public Iterator<Locale> getSupportedLocales()

Description copied from class: javax.faces.application.Application

Return an Iterator over the supported Locales for this appication.

Specified by:

getSupportedLocales in class javax.faces.application.Application

Returns:

an iterator of the supported locales.

See Also:

Application.getSupportedLocales()

setSupportedLocales

public void setSupportedLocales(Collection<Locale> newLocales)

Description copied from class: javax.faces.application.Application

Set the Locale instances representing the supported Locales for this application.

Specified by:

setSupportedLocales in class javax.faces.application.Application

Parameters:

newLocales - The set of supported Locales for this application

See Also:

Application.setSupportedLocales(java.util.Collection)

getDefaultLocale

public Locale getDefaultLocale()

Description copied from class: javax.faces.application.Application

Return the default Locale for this application. If not explicitly set, null is returned.

Specified by:

getDefaultLocale in class javax.faces.application.Application

Returns:

the default Locale, or null.

See Also:

Application.getDefaultLocale()

setDefaultLocale

public void setDefaultLocale(Locale locale)

Description copied from class: javax.faces.application.Application

Set the default Locale for this application.

Specified by:

setDefaultLocale in class javax.faces.application.Application

Parameters:

locale - The new default Locale

See Also:

Application.setDefaultLocale(java.util.Locale)

setMessageBundle

public void setMessageBundle(String messageBundle)

Description copied from class: javax.faces.application.Application

Set the fully qualified class name of the ResourceBundle to be used for Jakarta Server Faces messages for this application. See the JavaDocs for the java.util.ResourceBundle class for more information about the syntax for resource bundle names.

Specified by:

setMessageBundle in class javax.faces.application.Application

Parameters:

messageBundle - Base name of the resource bundle to be used

See Also:

Application.setMessageBundle(String)

getMessageBundle

public String getMessageBundle()

Description copied from class: javax.faces.application.Application

Return the fully qualified class name of the ResourceBundle to be used for Jakarta Server Faces messages for this application. If not explicitly set, null is returned.

Specified by:

getMessageBundle in class javax.faces.application.Application

Returns:

the message bundle class name, or null.

See Also:

Application.getMessageBundle()

getDefaultRenderKitId

public String getDefaultRenderKitId()

Description copied from class: javax.faces.application.Application

Return the renderKitId to be used for rendering this application. If not explicitly set, null is returned.

Specified by:

getDefaultRenderKitId in class javax.faces.application.Application

Returns:

the default render kit id, or null.

See Also:

Application.getDefaultRenderKitId()

setDefaultRenderKitId

public void setDefaultRenderKitId(String renderKitId)

Description copied from class: javax.faces.application.Application

Set the renderKitId to be used to render this application. Unless the client has provided a custom ViewHandler that supports the use of multiple RenderKit instances in the same application, this method must only be called at application startup, before any Faces requests have been processed. This is a limitation of the current Specification, and may be lifted in a future release.

Specified by:

setDefaultRenderKitId in class javax.faces.application.Application

Parameters:

renderKitId - the render kit id to set.

See Also:

Application.setDefaultRenderKitId(String)

getResourceBundle

public ResourceBundle getResourceBundle(javax.faces.context.FacesContext context,
                                        String var)

Description copied from class: javax.faces.application.Application

Find a ResourceBundle as defined in the application configuration resources under the specified name. If a ResourceBundle was defined for the name, return an instance that uses the locale of the current UIViewRoot.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend this class.

Overrides:

getResourceBundle in class javax.faces.application.Application

Parameters:

context - the Faces context.

var - the name of the resource bundle.

Returns:

the resource bundle.

See Also:

Application.getResourceBundle(javax.faces.context.FacesContext, String)

addBehavior

public void addBehavior(String behaviorId,
                        String behaviorClass)

Description copied from class: javax.faces.application.Application

Register a new mapping of behavior id to the name of the corresponding Behavior class. This allows subsequent calls to createBehavior() to serve as a factory for Behavior instances.

Overrides:

addBehavior in class javax.faces.application.Application

Parameters:

behaviorId - The behavior id to be registered

behaviorClass - The fully qualified class name of the corresponding Behavior implementation

See Also:

Application.addBehavior(String, String)

createBehavior

public javax.faces.component.behavior.Behavior createBehavior(String behaviorId)
                                                       throws javax.faces.FacesException

Description copied from class: javax.faces.application.Application

Instantiate and return a new Behavior instance of the class specified by a previous call to addBehavior() for the specified behavior id.

Overrides:

createBehavior in class javax.faces.application.Application

Parameters:

behaviorId - The behavior id for which to create and return a new Behavior instance

Returns:

the behavior.

Throws:

javax.faces.FacesException - if the Behavior cannot be created

See Also:

Application.createBehavior(String)

getBehaviorIds

public Iterator<String> getBehaviorIds()

Description copied from class: javax.faces.application.Application

Return an Iterator over the set of currently registered behavior ids for this Application.

Overrides:

getBehaviorIds in class javax.faces.application.Application

Returns:

an iterator with behavior ids.

See Also:

Application.getBehaviorIds()

createComponent

public javax.faces.component.UIComponent createComponent(String componentType)
                                                  throws javax.faces.FacesException

Description copied from class: javax.faces.application.Application

Instantiate and return a new UIComponent instance of the class specified by a previous call to addComponent() for the specified component type.

Before the component instance is returned, it must be inspected for the presence of a ListenerFor (or ListenersFor) or ResourceDependency (or ResourceDependencies) annotation. If any of these annotations are present, the action listed in ListenerFor or ResourceDependency must be taken on the component, before it is returned from this method. This variant of createComponent must not inspect the Renderer for the component to be returned for any of the afore mentioned annotations. Such inspection is the province of Application.createComponent(ValueExpression, FacesContext, String, String) or Application.createComponent(FacesContext, String, String).

Specified by:

createComponent in class javax.faces.application.Application

Parameters:

componentType - The component type for which to create and return a new UIComponent instance

Returns:

the UI component.

Throws:

javax.faces.FacesException - if a UIComponent of the specified type cannot be created

addComponent

public void addComponent(String componentType,
                         String componentClass)

Description copied from class: javax.faces.application.Application

Register a new mapping of component type to the name of the corresponding UIComponent class. This allows subsequent calls to createComponent() to serve as a factory for UIComponent instances.

Specified by:

addComponent in class javax.faces.application.Application

Parameters:

componentType - The component type to be registered

componentClass - The fully qualified class name of the corresponding UIComponent implementation

See Also:

Application.addComponent(java.lang.String, java.lang.String)

createComponent

public javax.faces.component.UIComponent createComponent(javax.el.ValueExpression componentExpression,
                                                         javax.faces.context.FacesContext context,
                                                         String componentType)
                                                  throws javax.faces.FacesException

Description copied from class: javax.faces.application.Application

Call the getValue() method on the specified ValueExpression. If it returns a UIComponent instance, return it as the value of this method. If it does not, instantiate a new UIComponent instance of the specified component type, pass the new component to the setValue() method of the specified ValueExpression, and return it.

Before the component instance is returned, it must be inspected for the presence of a ListenerFor (or ListenersFor) or ResourceDependency (or ResourceDependencies) annotation. If any of these annotations are present, the action listed in ListenerFor or ResourceDependency must be taken on the component, before it is returned from this method. This variant of createComponent must not inspect the Renderer for the component to be returned for any of the afore mentioned annotations. Such inspection is the province of Application.createComponent(ValueExpression, FacesContext, String, String) or Application.createComponent(FacesContext, String, String).

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function.

Overrides:

createComponent in class javax.faces.application.Application

Parameters:

componentExpression - ValueExpression representing a component value expression (typically specified by the component attribute of a custom tag)

context - FacesContext for the current request

componentType - Component type to create if the ValueExpression does not return a component instance

Returns:

the UI component.

Throws:

javax.faces.FacesException - if a UIComponent cannot be created

createComponent

public javax.faces.component.UIComponent createComponent(javax.el.ValueExpression componentExpression,
                                                         javax.faces.context.FacesContext context,
                                                         String componentType,
                                                         String rendererType)

Description copied from class: javax.faces.application.Application

Like Application.createComponent(ValueExpression, FacesContext, String) except the Renderer for the component to be returned must be inspected for the annotations mentioned in Application.createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method. The Renderer instance to inspect must be obtained by calling FacesContext.getRenderKit() and calling RenderKit.getRenderer(java.lang.String, java.lang.String) on the result, passing the argument componentType as the first argument and the result of calling UIComponent.getFamily() on the newly created component as the second argument. If no such Renderer can be found, a message must be logged with a helpful error message. Otherwise, UIComponent.setRendererType(java.lang.String) must be called on the newly created UIComponent instance, passing the argument rendererType as the argument.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function.

Overrides:

createComponent in class javax.faces.application.Application

Parameters:

componentExpression - ValueExpression representing a component value expression (typically specified by the component attribute of a custom tag)

context - FacesContext for the current request

componentType - Component type to create if the ValueExpression does not return a component instance

rendererType - The renderer-type of the Renderer that will render this component. A null value must be accepted for this parameter.

Returns:

the UI component.

createComponent

public javax.faces.component.UIComponent createComponent(javax.faces.context.FacesContext context,
                                                         String componentType,
                                                         String rendererType)

Description copied from class: javax.faces.application.Application

Like Application.createComponent(String) except the Renderer for the component to be returned must be inspected for the annotations mentioned in Application.createComponent(ValueExpression, FacesContext, String) as specified in the documentation for that method. The Renderer instance to inspect must be obtained by calling FacesContext.getRenderKit() and calling RenderKit.getRenderer(java.lang.String, java.lang.String) on the result, passing the argument componentType as the first argument and the result of calling UIComponent.getFamily() on the newly created component as the second argument. If no such Renderer can be found, a message must be logged with a helpful error message. Otherwise, UIComponent.setRendererType(java.lang.String) must be called on the newly created UIComponent instance, passing the argument rendererType as the argument.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function

.

Overrides:

createComponent in class javax.faces.application.Application

Parameters:

context - FacesContext for the current request

componentType - Component type to create

rendererType - The renderer-type of the Renderer that will render this component. A null value must be accepted for this parameter.

Returns:

the UI component.

createComponent

public javax.faces.component.UIComponent createComponent(javax.faces.context.FacesContext context,
                                                         javax.faces.application.Resource componentResource)
                                                  throws javax.faces.FacesException

Description copied from class: javax.faces.application.Application

Instantiate and return a new UIComponent instance from the argument Resource. An algorithm semantically equivalent to the following must be followed to instantiate the UIComponent to return.

• Obtain a reference to the ViewDeclarationLanguage for this Application instance by calling ViewHandler.getViewDeclarationLanguage(javax.faces.context.FacesContext, java.lang.String), passing the viewId found by calling UIViewRoot.getViewId() on the UIViewRoot in the argument FacesContext.

• Obtain a reference to the composite component metadata for this composite component by calling ViewDeclarationLanguage.getComponentMetadata(javax.faces.context.FacesContext, javax.faces.application.Resource), passing the facesContext and componentResource arguments to this method. This version of the Jakarta Server Faces specification uses JavaBeans as the API to the component metadata.

• Determine if the component author declared a componentType for this component instance by obtaining the BeanDescriptor from the component metadata and calling its getValue() method, passing UIComponent.COMPOSITE_COMPONENT_TYPE_KEY as the argument. If non-null, the result must be a ValueExpression whose value is the component-type of the UIComponent to be created for this Resource component. Call through to Application.createComponent(java.lang.String) to create the component.

• Otherwise, determine if a script based component for this Resource can be found by calling ViewDeclarationLanguage.getScriptComponentResource(javax.faces.context.FacesContext, javax.faces.application.Resource). If the result is non-null, and is a script written in one of the languages listed in JSF.4.3 of the specification prose document, create a UIComponent instance from the script resource.

• Otherwise, let library-name be the return from calling Resource.getLibraryName() on the argument componentResource and resource-name be the return from calling Resource.getResourceName() on the argument componentResource. Create a fully qualified Java class name by removing any file extension from resource-name and let fqcn be library-name + "." + resource-name. If a class with the name of fqcn cannot be found, take no action and continue to the next step. If any of InstantiationException, IllegalAccessException, or ClassCastException are thrown, wrap the exception in a FacesException and re-throw it. If any other exception is thrown, log the exception and continue to the next step.

• If none of the previous steps have yielded a UIComponent instance, call Application.createComponent(java.lang.String) passing "javax.faces.NamingContainer" as the argument.

• Call UIComponent.setRendererType(java.lang.String) on the UIComponent instance, passing "javax.faces.Composite" as the argument.

• Store the argument Resource in the attributes Map of the UIComponent under the key, Resource.COMPONENT_RESOURCE_KEY.

• Store composite component metadata in the attributes Map of the UIComponent under the key, UIComponent.BEANINFO_KEY.

Before the component instance is returned, it must be inspected for the presence of a ListenerFor annotation. If this annotation is present, the action listed in ListenerFor must be taken on the component, before it is returned from this method.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function.

Overrides:

createComponent in class javax.faces.application.Application

Parameters:

context - FacesContext for the current request

componentResource - A Resource that points to a source file that provides an implementation of a component.

Returns:

the UI component.

Throws:

javax.faces.FacesException - if a UIComponent from the Resource cannot be created

createComponent

public javax.faces.component.UIComponent createComponent(javax.faces.el.ValueBinding componentBinding,
                                                         javax.faces.context.FacesContext context,
                                                         String componentType)
                                                  throws javax.faces.FacesException

Description copied from class: javax.faces.application.Application

Wrap the argument componentBinding in an implementation of ValueExpression and call through to Application.createComponent(javax.el.ValueExpression,javax.faces.context.FacesContext,java.lang.String).

Specified by:

createComponent in class javax.faces.application.Application

Parameters:

componentBinding - ValueBinding representing a component value binding expression (typically specified by the component attribute of a custom tag)

context - FacesContext for the current request

componentType - Component type to create if the ValueBinding does not return a component instance

Returns:

the UI component.

Throws:

javax.faces.FacesException - if a UIComponent cannot be created

getComponentTypes

public Iterator<String> getComponentTypes()

Description copied from class: javax.faces.application.Application

Return an Iterator over the set of currently defined component types for this Application.

Specified by:

getComponentTypes in class javax.faces.application.Application

Returns:

an iterator with component types.

See Also:

Application.getComponentTypes()

addConverter

public void addConverter(String converterId,
                         String converterClass)

Description copied from class: javax.faces.application.Application

Register a new mapping of converter id to the name of the corresponding Converter class. This allows subsequent calls to createConverter() to serve as a factory for Converter instances.

Specified by:

addConverter in class javax.faces.application.Application

Parameters:

converterId - The converter id to be registered

converterClass - The fully qualified class name of the corresponding Converter implementation

See Also:

Application.addConverter(String, String)

addConverter

public void addConverter(Class<?> targetClass,
                         String converterClass)

Description copied from class: javax.faces.application.Application

Register a new converter class that is capable of performing conversions for the specified target class.

Specified by:

addConverter in class javax.faces.application.Application

Parameters:

targetClass - The class for which this converter is registered

converterClass - The fully qualified class name of the corresponding Converter implementation

See Also:

Application.addConverter(Class, String)

createConverter

public javax.faces.convert.Converter<?> createConverter(String converterId)

Description copied from class: javax.faces.application.Application

Instantiate and return a new Converter instance of the class specified by a previous call to addConverter() for the specified converter id.

If the toLowerCase() of the String represenation of the value of the "javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE" application configuration parameter is "true" (without the quotes) and the Converter instance to be returned is an instance of DateTimeConverter, DateTimeConverter.setTimeZone(java.util.TimeZone) must be called, passing the return from TimeZone.getDefault().

The argument converter must be inspected for the presence of the ResourceDependency annotation. If the ResourceDependency annotation is present, the action described in ResourceDependency must be taken. If the ResourceDependency annotation is not present, the argument converter must be inspected for the presence of the ResourceDependencies annotation. If the ResourceDependencies annotation is present, the action described in ResourceDependencies must be taken.

Specified by:

createConverter in class javax.faces.application.Application

Parameters:

converterId - The converter id for which to create and return a new Converter instance

Returns:

the converter.

See Also:

Application.createConverter(String)

createConverter

public javax.faces.convert.Converter<?> createConverter(Class<?> targetClass)

Description copied from class: javax.faces.application.Application

Instantiate and return a new Converter instance of the class that has registered itself as capable of performing conversions for objects of the specified type. If no such Converter class can be identified, return null.

To locate an appropriate Converter class, the following algorithm is performed, stopping as soon as an appropriate Converter class is found:

• Locate a Converter registered for the target class itself.
• Locate a Converter registered for interfaces that are implemented by the target class (directly or indirectly).
• Locate a Converter registered for the superclass (if any) of the target class, recursively working up the inheritance hierarchy.

If the Converter has a single argument constructor that accepts a Class, instantiate the Converter using that constructor, passing the argument targetClass as the sole argument. Otherwise, simply use the zero-argument constructor.

If the toLowerCase() of the String represenation of the value of the "javax.faces.DATETIMECONVERTER_DEFAULT_TIMEZONE_IS_SYSTEM_TIMEZONE" application configuration parameter is "true" (without the quotes) and the Converter instance to be returned is an instance of DateTimeConverter, DateTimeConverter.setTimeZone(java.util.TimeZone) must be called, passing the return from TimeZone.getDefault().

Specified by:

createConverter in class javax.faces.application.Application

Parameters:

targetClass - Target class for which to return a Converter

Returns:

the converter.

See Also:

Application.createConverter(Class)

getConverterIds

public Iterator<String> getConverterIds()

Description copied from class: javax.faces.application.Application

Return an Iterator over the set of currently registered converter ids for this Application.

Specified by:

getConverterIds in class javax.faces.application.Application

Returns:

an iterator with converter ids.

See Also:

Application.getConverterIds()

getConverterTypes

public Iterator<Class<?>> getConverterTypes()

Description copied from class: javax.faces.application.Application

Return an Iterator over the set of Class instances for which Converter classes have been explicitly registered.

Specified by:

getConverterTypes in class javax.faces.application.Application

Returns:

an iterator with converter types.

See Also:

Application.getConverterTypes()

addValidator

public void addValidator(String validatorId,
                         String validatorClass)

Description copied from class: javax.faces.application.Application

Register a new mapping of validator id to the name of the corresponding Validator class. This allows subsequent calls to createValidator() to serve as a factory for Validator instances.

Specified by:

addValidator in class javax.faces.application.Application

Parameters:

validatorId - The validator id to be registered

validatorClass - The fully qualified class name of the corresponding Validator implementation

See Also:

Application.addValidator(String, String)

createValidator

public javax.faces.validator.Validator<?> createValidator(String validatorId)
                                                   throws javax.faces.FacesException

Description copied from class: javax.faces.application.Application

Instantiate and return a new Validator instance of the class specified by a previous call to addValidator() for the specified validator id.

The argument validator must be inspected for the presence of the ResourceDependency annotation. If the ResourceDependency annotation is present, the action described in ResourceDependency must be taken. If the ResourceDependency annotation is not present, the argument validator must be inspected for the presence of the ResourceDependencies annotation. If the ResourceDependencies annotation is present, the action described in ResourceDependencies must be taken.

Specified by:

createValidator in class javax.faces.application.Application

Parameters:

validatorId - The validator id for which to create and return a new Validator instance

Returns:

the validator.

Throws:

javax.faces.FacesException - if a Validator of the specified id cannot be created

See Also:

Application.createValidator(String)

getValidatorIds

public Iterator<String> getValidatorIds()

Description copied from class: javax.faces.application.Application

Return an Iterator over the set of currently registered validator ids for this Application.

Specified by:

getValidatorIds in class javax.faces.application.Application

Returns:

an iterator of validator ids.

See Also:

Application.getValidatorIds()

addDefaultValidatorId

public void addDefaultValidatorId(String validatorId)

Description copied from class: javax.faces.application.Application

Register a validator by its id that is applied to all UIInput components in a view. The validator to most often serve this role is the BeanValidator. The usage contract for this method assumes that the validator has been registered using the normal “by-id” registration mechanism.

An implementation is provided that takes no action so that users that decorate the Application continue to work.

Overrides:

addDefaultValidatorId in class javax.faces.application.Application

Parameters:

validatorId - the validator id.

See Also:

Application.addDefaultValidatorId(String)

getDefaultValidatorInfo

public Map<String,String> getDefaultValidatorInfo()

Description copied from class: javax.faces.application.Application

Return an immutable Map over the set of currently registered default validator IDs and their class name for this Application.

An implementation is provided that returns Collections.emptyMap so that users that decorate the Application continue to work.

Overrides:

getDefaultValidatorInfo in class javax.faces.application.Application

Returns:

a map of default validator information.

See Also:

Application.getDefaultValidatorInfo()

getProjectStage

public javax.faces.application.ProjectStage getProjectStage()

Description copied from class: javax.faces.application.Application

Return the project stage for the currently running application instance. The default value is ProjectStage.Production

The implementation of this method must perform the following algorithm or an equivalent with the same end result to determine the value to return.

If the value has already been determined by a previous call to this method, simply return that value.

Look for a JNDI environment entry under the key given by the value of ProjectStage.PROJECT_STAGE_JNDI_NAME (return type of java.lang.String). If found, continue with the algorithm below, otherwise, look for an entry in the initParamMap of the ExternalContext from the current FacesContext with the key given by the value of ProjectStage.PROJECT_STAGE_PARAM_NAME

If a value is found, see if an enum constant can be obtained by calling ProjectStage.valueOf(), passing the value from the initParamMap. If this succeeds without exception, save the value and return it.

If not found, or any of the previous attempts to discover the enum constant value have failed, log a descriptive error message, assign the value as ProjectStage.Production and return it.

A default implementation is provided that throws UnsupportedOperationException so that users that decorate Application can continue to function

.

Overrides:

getProjectStage in class javax.faces.application.Application

Returns:

the project stage.

See Also:

Application.getProjectStage()

getSearchExpressionHandler

public javax.faces.component.search.SearchExpressionHandler getSearchExpressionHandler()

Description copied from class: javax.faces.application.Application

Return the thread-safe singleton SearchExpressionHandler for this application.

Overrides:

getSearchExpressionHandler in class javax.faces.application.Application

Returns:

the SearchExpressionHandler.

setSearchExpressionHandler

public void setSearchExpressionHandler(javax.faces.component.search.SearchExpressionHandler searchExpressionHandler)

Description copied from class: javax.faces.application.Application

Set the SearchExpressionHandler instance used by the application.

Overrides:

setSearchExpressionHandler in class javax.faces.application.Application

Parameters:

searchExpressionHandler - the SearchExpressionHandler.

addSearchKeywordResolver

public void addSearchKeywordResolver(javax.faces.component.search.SearchKeywordResolver resolver)

Description copied from class: javax.faces.application.Application

Cause the argument resolver to be added to the head of the resolver chain.

It is not possible to remove a SearchKeywordResolver registered with this method, once it has been registered.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application.

Overrides:

addSearchKeywordResolver in class javax.faces.application.Application

Parameters:

resolver - the SearchKeywordResolver to add.

getSearchKeywordResolver

public javax.faces.component.search.SearchKeywordResolver getSearchKeywordResolver()

Description copied from class: javax.faces.application.Application

Return the singleton SearchKeywordResolver instance to be used for all search keyword resolution. This is actually an instance of a composite SearchKeywordResolver that must contain the following SearchKeywordResolver instances in the following order:

1. SearchKeywordResolver instances declared using the <search-keyword-resolver> element in the application configuration resources.

2. Any SearchKeywordResolver instances added by calls to Application.addSearchKeywordResolver(javax.faces.component.search.SearchKeywordResolver).

3. The SearchKeywordResolver implementations for @all, @child(n), @form, @id(...), @namingcontainer, @next, @none, @parent, @previous, @root and @this.

The default implementation throws UnsupportedOperationException and is provided for the sole purpose of not breaking existing applications that extend Application.

Overrides:

getSearchKeywordResolver in class javax.faces.application.Application

Returns:

the SearchKeywordResolver.

getPropertyResolver

@Deprecated
public javax.faces.el.PropertyResolver getPropertyResolver()

Deprecated.

Description copied from class: javax.faces.application.Application

Return a PropertyResolver instance that wraps the ELResolver instance that Faces provides to the Jakarta Expression Language for the resolution of expressions that appear programmatically in an application.

Note that this no longer returns the default PropertyResolver since that class is now a no-op that aids in allowing custom PropertyResolvers to affect the EL resolution process.

Specified by:

getPropertyResolver in class javax.faces.application.Application

Returns:

the property resolver.

See Also:

Application.setPropertyResolver(javax.faces.el.PropertyResolver)

setPropertyResolver

@Deprecated
public void setPropertyResolver(javax.faces.el.PropertyResolver resolver)

Deprecated.

Description copied from class: javax.faces.application.Application

Set the PropertyResolver instance that will be utilized to resolve method and value bindings.

This method is now deprecated but the implementation must cause the argument to be set as the head of the legacy PropertyResolver chain, replacing any existing value that was set from the application configuration resources.

It is illegal to call this method after the application has received any requests from the client. If an attempt is made to register a listener after that time it must have no effect.

Specified by:

setPropertyResolver in class javax.faces.application.Application

Parameters:

resolver - The new PropertyResolver instance

See Also:

Application.setPropertyResolver(javax.faces.el.PropertyResolver)

createMethodBinding

@Deprecated
public javax.faces.el.MethodBinding createMethodBinding(String ref,
                                                                    Class<?>[] params)

Deprecated.

Description copied from class: javax.faces.application.Application

Call Application.getExpressionFactory() then call ExpressionFactory.createMethodExpression(javax.el.ELContext, java.lang.String, java.lang.Class<?>, java.lang.Class<?>[]), passing the given arguments, and wrap the result in a MethodBinding implementation, returning it.

Specified by:

createMethodBinding in class javax.faces.application.Application

Parameters:

ref - Method binding expression for which to return a MethodBinding instance

params - Parameter signatures that must be compatible with those of the method to be invoked, or a zero-length array or null for a method that takes no parameters

Returns:

the method binding.

See Also:

Application.createMethodBinding(String, Class[])

createValueBinding

@Deprecated
public javax.faces.el.ValueBinding createValueBinding(String ref)
                                                           throws javax.faces.el.ReferenceSyntaxException

Deprecated.

Description copied from class: javax.faces.application.Application

Call Application.getExpressionFactory() then call ExpressionFactory.createValueExpression(javax.el.ELContext, java.lang.String, java.lang.Class<?>), passing the argument ref, Object.class for the expectedType, and null, for the fnMapper.

Specified by:

createValueBinding in class javax.faces.application.Application

Parameters:

ref - Value binding expression for which to return a ValueBinding instance

Returns:

the value binding.

Throws:

javax.faces.el.ReferenceSyntaxException - if the specified ref has invalid syntax

See Also:

Application.createValueBinding(String)

getVariableResolver

@Deprecated
public javax.faces.el.VariableResolver getVariableResolver()

Deprecated.

Description copied from class: javax.faces.application.Application

Return the VariableResolver that wraps the ELResolver instance that Faces provides to the Jakarta Expression Language for the resolution of expressions that appear programmatically in an application. The implementation of the VariableResolvermust pass null as the base argument for any methods invoked on the underlying ELResolver.

Note that this method no longer returns the default VariableResolver, since that class now is a no-op that aids in allowing custom VariableResolvers to affect the Jakarta Expression Language resolution process.

Specified by:

getVariableResolver in class javax.faces.application.Application

Returns:

the variable resolver.

See Also:

Application.getVariableResolver()

setVariableResolver

@Deprecated
public void setVariableResolver(javax.faces.el.VariableResolver resolver)

Deprecated.

Description copied from class: javax.faces.application.Application

Set the VariableResolver instance that will be consulted to resolve method and value bindings.

This method is now deprecated but the implementation must cause the argument to be set as the head of the legacy VariableResolver chain, replacing any existing value that was set from the application configuration resources.

It is illegal to call this method after the application has received any requests from the client. If an attempt is made to register a listener after that time it must have no effect.

Specified by:

setVariableResolver in class javax.faces.application.Application

Parameters:

resolver - The new VariableResolver instance

See Also:

Application.setVariableResolver(javax.faces.el.VariableResolver)