javax.faces.application
Class ApplicationWrapper

java.lang.Object
  javax.faces.application.Application
      javax.faces.application.ApplicationWrapper

All Implemented Interfaces:

FacesWrapper<Application>

public abstract class ApplicationWrapper
extends Application
implements FacesWrapper<Application>

Since:

2.0

Version:

$Revision: 1188206 $ $Date: 2011-10-24 11:30:34 -0500 (Mon, 24 Oct 2011) $

Author:

Simon Lessard (latest modification by $Author: struberg $)

Constructor Summary

ApplicationWrapper()

Method Summary

void	addBehavior(String behaviorId, String behaviorClass)
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)
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 5.5.1 of the JavaServer Faces Specification.
void	addValidator(String validatorId, String validatorClass) Register a new mapping of validator id to the name of the corresponding Validator class.
Behavior	createBehavior(String behaviorId)
UIComponent	createComponent(FacesContext context, Resource componentResource) ???
UIComponent	createComponent(FacesContext context, String componentType, String rendererType)
UIComponent	createComponent(String componentType) Create a new UIComponent subclass, using the mappings defined by previous calls to the addComponent method of this class.
UIComponent	createComponent(ValueBinding componentBinding, FacesContext context, String componentType) Create an object which has an associating "binding" expression tying the component to a user property.
UIComponent	createComponent(javax.el.ValueExpression componentExpression, FacesContext contexte, String componentType) Call the getValue() method on the specified ValueExpression.
UIComponent	createComponent(javax.el.ValueExpression componentExpression, FacesContext context, String componentType, String rendererType)
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.
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.
MethodBinding	createMethodBinding(String ref, Class<?>[] params) Create an object which can be used to invoke an arbitrary method via an EL expression at a later time.
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.
ValueBinding	createValueBinding(String ref) Create an object which can be used to invoke an arbitrary method via an EL expression at a later time.
<T> T	evaluateExpressionGet(FacesContext context, String expression, Class<? extends T> expectedType) Get a value by evaluating an expression.
ActionListener	getActionListener() Return the default ActionListener to be registered for all ActionSource<3code> components in this appication.
Iterator<String>	getBehaviorIds()
Iterator<String>	getComponentTypes() Return an Iterator over the set of currently defined component types for this Application.
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 classeshave 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()
javax.el.ELContextListener[]	getELContextListeners() If no calls have been made to 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 EL resolution.
javax.el.ExpressionFactory	getExpressionFactory() Return the ExpressionFactory instance for this application.
String	getMessageBundle() Return the fully qualified class name of the ResourceBundle to be used for JavaServer Faces messages for this application.
NavigationHandler	getNavigationHandler() Return the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application.
ProjectStage	getProjectStage() Return the project stage for the currently running application instance.
PropertyResolver	getPropertyResolver() Get the object used by the VariableResolver to read and write named properties on java beans, Arrays, Lists and Maps.
ResourceBundle	getResourceBundle(FacesContext ctx, String name) Find a ResourceBundle as defined in the application configuration resources under the specified name.
ResourceHandler	getResourceHandler() Return the singleton, stateless, thread-safe ResourceHandler for this 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.
VariableResolver	getVariableResolver() Get the object used to resolve expressions of form "#{...}".
ViewHandler	getViewHandler() Set the ViewHandler instance that will be utilized during the Restore View and Render Response phases of the request processing lifecycle.
abstract Application	getWrapped() A class that implements this interface uses this method to return an instance of the class being wrapped.
void	publishEvent(FacesContext facesContext, Class<? extends SystemEvent> systemEventClass, Class<?> sourceBaseType, Object source)
void	publishEvent(FacesContext facesContext, Class<? extends SystemEvent> systemEventClass, Object source) If 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(ActionListener listener) Set the default ActionListener to be registered for all ActionSource components.
void	setDefaultLocale(Locale locale) Set the default Locale for this application.
void	setDefaultRenderKitId(String renderKitId) Return the renderKitId to be used for rendering this application.
void	setMessageBundle(String bundle) Set the fully qualified class name of the ResourceBundle to be used for JavaServer Faces messages for this application.
void	setNavigationHandler(NavigationHandler handler) Set the NavigationHandler instance that will be passed the outcome returned by any invoked application action for this web application.
void	setPropertyResolver(PropertyResolver resolver) The recommended way to affect the execution of the EL is to provide an element at the right place in the application configuration resources which will be considered in the normal course of expression evaluation.
void	setResourceHandler(ResourceHandler resourceHandler)
void	setStateManager(StateManager manager) 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> locales) Set the Locale instances representing the supported Locales for this application.
void	setVariableResolver(VariableResolver resolver) The recommended way to affect the execution of the EL is to provide an element at the right place in the application configuration resources which will be considered in the normal course of expression evaluation.
void	setViewHandler(ViewHandler handler) 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 SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener)
void	subscribeToEvent(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener)
void	unsubscribeFromEvent(Class<? extends SystemEvent> systemEventClass, Class<?> sourceClass, SystemEventListener listener)
void	unsubscribeFromEvent(Class<? extends SystemEvent> systemEventClass, SystemEventListener listener)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationWrapper

public ApplicationWrapper()

Method Detail

addBehavior

public void addBehavior(String behaviorId,
                        String behaviorClass)

Overrides:

addBehavior in class Application

addComponent

public void addComponent(String componentType,
                         String componentClass)

Description copied from class: 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 Application

Parameters:

componentType - - The component type to be registered

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

addConverter

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

Description copied from class: Application

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

Specified by:

addConverter in class Application

Parameters:

targetClass - - The class for which this converter is registered

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

addConverter

public void addConverter(String converterId,
                         String converterClass)

Description copied from class: 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 Application

Parameters:

converterId - - The converterId to be registered

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

addDefaultValidatorId

public void addDefaultValidatorId(String validatorId)

Overrides:

addDefaultValidatorId in class Application

addELContextListener

public void addELContextListener(javax.el.ELContextListener listener)

Description copied from class: Application

Provide a way for Faces applications to register an ELContextListener that will be notified on creation of ELContext instances.

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

Overrides:

addELContextListener in class Application

addELResolver

public void addELResolver(javax.el.ELResolver resolver)

Description copied from class: Application

Cause an the argument resolver to be added to the resolver chain as specified in section 5.5.1 of the JavaServer 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 JSP 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 Application

addValidator

public void addValidator(String validatorId,
                         String validatorClass)

Description copied from class: 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 Application

Parameters:

validatorId - The validator id to be registered

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

createBehavior

public Behavior createBehavior(String behaviorId)
                        throws FacesException

Overrides:

createBehavior in class Application

Returns:

Throws:

FacesException

createComponent

public UIComponent createComponent(FacesContext context,
                                   Resource componentResource)

Description copied from class: Application

???

Overrides:

createComponent in class Application

Returns:

createComponent

public UIComponent createComponent(FacesContext context,
                                   String componentType,
                                   String rendererType)

Overrides:

createComponent in class Application

Returns:

createComponent

public UIComponent createComponent(String componentType)
                            throws FacesException

Description copied from class: Application

Create a new UIComponent subclass, using the mappings defined by previous calls to the addComponent method of this class.

Specified by:

createComponent in class Application

Throws:

FacesException - if there is no mapping defined for the specified componentType, or if an instance of the specified type could not be created for any reason.

createComponent

public UIComponent createComponent(ValueBinding componentBinding,
                                   FacesContext context,
                                   String componentType)
                            throws FacesException

Description copied from class: Application

Create an object which has an associating "binding" expression tying the component to a user property.

First the specified value-binding is evaluated; if it returns a non-null value then the component "already exists" and so the resulting value is simply returned.

Otherwise a new UIComponent instance is created using the specified componentType, and the new object stored via the provided value-binding before being returned.

Specified by:

createComponent in class Application

Throws:

FacesException

createComponent

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

Overrides:

createComponent in class Application

Returns:

createComponent

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

Description copied from class: 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 instance of the specified component type, pass the new component to the setValue() method of the specified ValueExpression, and return it.

Overrides:

createComponent in class Application

Parameters:

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

contexte - - FacesContext for the current request

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

Throws:

FacesException - if a UIComponent cannot be created

createConverter

public Converter createConverter(Class<?> targetClass)

Description copied from class: 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. 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.

Specified by:

createConverter in class Application

Parameters:

targetClass - - Target class for which to return a Converter

createConverter

public Converter createConverter(String converterId)

Description copied from class: Application

Instantiate and return a new Converter instance of the class specified by a previous call to addConverter() for the specified converter id. If there is no such registration for this converter id, return null.

Specified by:

createConverter in class Application

Parameters:

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

createMethodBinding

public MethodBinding createMethodBinding(String ref,
                                         Class<?>[] params)
                                  throws ReferenceSyntaxException

Description copied from class: Application

Create an object which can be used to invoke an arbitrary method via an EL expression at a later time. This is similar to createValueBinding except that it can invoke an arbitrary method (with parameters) rather than just get/set a javabean property.

This is used to invoke ActionListener method, and ValueChangeListener methods.

Specified by:

createMethodBinding in class Application

Throws:

ReferenceSyntaxException

createValidator

public Validator createValidator(String validatorId)
                          throws FacesException

Description copied from class: Application

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

Specified by:

createValidator in class Application

Parameters:

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

Throws:

FacesException - if a Validator/ of the specified id cannot be created

createValueBinding

public ValueBinding createValueBinding(String ref)
                                throws ReferenceSyntaxException

Description copied from class: Application

Create an object which can be used to invoke an arbitrary method via an EL expression at a later time. This is similar to createValueBinding except that it can invoke an arbitrary method (with parameters) rather than just get/set a javabean property.

This is used to invoke ActionListener method, and ValueChangeListener methods.

Specified by:

createValueBinding in class Application

Throws:

ReferenceSyntaxException

evaluateExpressionGet

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

Description copied from class: 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 Application

Throws:

javax.el.ELException

getActionListener

public ActionListener getActionListener()

Description copied from class: Application

Return the default ActionListener to be registered for all ActionSource<3code> components in this appication. If not explicitly set, a default implementation must be provided that performs the following functions:

• The processAction() method must first call FacesContext.renderResponse()in order to bypass any intervening lifecycle phases, once the method returns.
• The processAction() method must next determine the logical outcome of this event, as follows:
• If the originating component has a non-null action property, retrieve the MethodBinding from the property, and call invoke() on it. Convert the returned value (if any) to a String, and use it as the logical outcome.
• Otherwise, the logical outcome is null.

• The processAction() method must finally retrieve the NavigationHandler<3code> instance for this application and call NavigationHandler.handleNavigation(javax.faces.context.FacesContext, java.lang.String, java.lang.String) passing:
• the FacesContext for the current request
• If there is a MethodBinding instance for the action property of this component, the result of calling MethodBinding.getExpressionString() on it, null otherwise
• the logical outcome as determined above

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 Application

getBehaviorIds

public Iterator<String> getBehaviorIds()

Overrides:

getBehaviorIds in class Application

Returns:

getComponentTypes

public Iterator<String> getComponentTypes()

Description copied from class: Application

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

Specified by:

getComponentTypes in class Application

getConverterIds

public Iterator<String> getConverterIds()

Description copied from class: Application

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

Specified by:

getConverterIds in class Application

Returns:

getConverterTypes

public Iterator<Class<?>> getConverterTypes()

Description copied from class: Application

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

Specified by:

getConverterTypes in class Application

Returns:

getDefaultLocale

public Locale getDefaultLocale()

Description copied from class: Application

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

Specified by:

getDefaultLocale in class Application

Returns:

getDefaultRenderKitId

public String getDefaultRenderKitId()

Description copied from class: Application

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

Specified by:

getDefaultRenderKitId in class Application

Returns:

getDefaultValidatorInfo

public Map<String,String> getDefaultValidatorInfo()

Overrides:

getDefaultValidatorInfo in class Application

Returns:

getELContextListeners

public javax.el.ELContextListener[] getELContextListeners()

Description copied from class: Application

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

.

Otherwise, return an array representing the list of listeners added by calls to 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 Application

getELResolver

public javax.el.ELResolver getELResolver()

Description copied from class: Application

Return the singleton ELResolver instance to be used for all EL resolution. This is actually an instance of CompositeELResolver that must contain the following ELResolver instances in the following order:
• ELResolver instances declared using the element in the application configuration resources.
• An implementation that wraps the head of the legacy VariableResolver chain, as per section VariableResolver ChainWrapper in Chapter 5 in the spec document.
• An implementation that wraps the head of the legacy PropertyResolver chain, as per section PropertyResolver ChainWrapper in Chapter 5 in the spec document.
• 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 Application

getExpressionFactory

public javax.el.ExpressionFactory getExpressionFactory()

Description copied from class: 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).

The implementation must return the ExpressionFactory from the JSP 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 Application

getMessageBundle

public String getMessageBundle()

Description copied from class: Application

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

Specified by:

getMessageBundle in class Application

getNavigationHandler

public NavigationHandler getNavigationHandler()

Description copied from class: 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.

Specified by:

getNavigationHandler in class Application

getProjectStage

public ProjectStage getProjectStage()

Description copied from class: 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 ProjectStage.PROJECT_STAGE_PARAM_NAME
• If a value is found 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.

Overrides:

getProjectStage in class Application

getPropertyResolver

public PropertyResolver getPropertyResolver()

Description copied from class: Application

Get the object used by the VariableResolver to read and write named properties on java beans, Arrays, Lists and Maps. This object is used by the ValueBinding implementation, and during the process of configuring "managed bean" properties.

Specified by:

getPropertyResolver in class Application

getResourceBundle

public ResourceBundle getResourceBundle(FacesContext ctx,
                                        String name)
                                 throws FacesException,
                                        NullPointerException

Description copied from class: 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 Application

Returns:

ResourceBundle for the current UIViewRoot, otherwise null

Throws:

FacesException - if a bundle was defined, but not resolvable

NullPointerException - if ctx == null || name == null

getResourceHandler

public ResourceHandler getResourceHandler()

Description copied from class: Application

Return the singleton, stateless, thread-safe ResourceHandler for this application. The JSF 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 element within the application element.
• RELEASE_PENDING(edburns) It can also be declared via an annotation as specified in [287-ConfigAnnotations].

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

Overrides:

getResourceHandler in class Application

getStateManager

public StateManager getStateManager()

Description copied from class: 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 JavaServer Faces Specification.

Specified by:

getStateManager in class Application

getSupportedLocales

public Iterator<Locale> getSupportedLocales()

Description copied from class: Application

Return an Iterator over the supported Locales for this appication.

Specified by:

getSupportedLocales in class Application

getValidatorIds

public Iterator<String> getValidatorIds()

Description copied from class: Application

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

Specified by:

getValidatorIds in class Application

getVariableResolver

public VariableResolver getVariableResolver()

Description copied from class: Application

Get the object used to resolve expressions of form "#{...}".

Specified by:

getVariableResolver in class Application

getViewHandler

public ViewHandler getViewHandler()

Description copied from class: Application

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

Specified by:

getViewHandler in class Application

Returns:

getWrapped

public abstract Application getWrapped()

Description copied from interface: FacesWrapper

A class that implements this interface uses this method to return an instance of the class being wrapped.

Specified by:

getWrapped in interface FacesWrapper<Application>

Returns:

the instance of the class being wrapped

publishEvent

public void publishEvent(FacesContext facesContext,
                         Class<? extends SystemEvent> systemEventClass,
                         Class<?> sourceBaseType,
                         Object source)

Overrides:

publishEvent in class Application

publishEvent

public void publishEvent(FacesContext facesContext,
                         Class<? extends SystemEvent> systemEventClass,
                         Object source)

Description copied from class: Application

If 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, java.lang.Class, javax.faces.event.SystemEventListener)

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) on it, passing the systemEventClass argument. If the list is not empty, perform algorithm traverseListenerList on the list.
• If any Application level listeners have been installed by previous calls to Application.subscribeToEvent(java.lang.Class, java.lang.Class, SystemEventListener), perform algorithm traverseListenerList on the list.
• If any Application level listeners have been installed by previous calls to Application.subscribeToEvent(java.lang.Class, 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.

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.

Overrides:

publishEvent in class Application

systemEventClass - - The Class of event that is being published. Must be non-null.

source - - The source for the event of type systemEventClass. Must be non- null, and must implement SystemEventListenerHolder.

removeELContextListener

public void removeELContextListener(javax.el.ELContextListener listener)

Description copied from class: 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 Application

setActionListener

public void setActionListener(ActionListener listener)

Description copied from class: Application

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

Specified by:

setActionListener in class Application

Parameters:

listener - - The new default ActionListener

setDefaultLocale

public void setDefaultLocale(Locale locale)

Description copied from class: Application

Set the default Locale for this application.

Specified by:

setDefaultLocale in class Application

Parameters:

locale - - The new default Locale

setDefaultRenderKitId

public void setDefaultRenderKitId(String renderKitId)

Description copied from class: Application

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

Specified by:

setDefaultRenderKitId in class Application

setMessageBundle

public void setMessageBundle(String bundle)

Description copied from class: Application

Set the fully qualified class name of the ResourceBundle to be used for JavaServer 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 Application

Parameters:

bundle - - Base name of the resource bundle to be used

setNavigationHandler

public void setNavigationHandler(NavigationHandler handler)

Description copied from class: 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 Application

Parameters:

handler - - The new NavigationHandler instance

setPropertyResolver

public void setPropertyResolver(PropertyResolver resolver)

Description copied from class: Application

The recommended way to affect the execution of the EL is to provide an element at the right place in the application configuration resources which will be considered in the normal course of expression evaluation. This method now will cause the argument resolver to be wrapped inside an implementation of ELResolver and exposed to the EL resolution system as if the user had called addELResolver(javax.el.ELResolver).

Specified by:

setPropertyResolver in class Application

setResourceHandler

public void setResourceHandler(ResourceHandler resourceHandler)

Overrides:

setResourceHandler in class Application

setStateManager

public void setStateManager(StateManager manager)

Description copied from class: 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 Application

Parameters:

manager - The new StateManagerinstance

setSupportedLocales

public void setSupportedLocales(Collection<Locale> locales)

Description copied from class: Application

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

Specified by:

setSupportedLocales in class Application

Parameters:

locales - The set of supported Locales for this application

setVariableResolver

public void setVariableResolver(VariableResolver resolver)

Description copied from class: Application

The recommended way to affect the execution of the EL is to provide an element at the right place in the application configuration resources which will be considered in the normal course of expression evaluation. This method now will cause the argument resolver to be wrapped inside an implementation of ELResolver and exposed to the EL resolution system as if the user had called addELResolver(javax.el.ELResolver).

Specified by:

setVariableResolver in class Application

setViewHandler

public void setViewHandler(ViewHandler handler)

Description copied from class: 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 Application

Parameters:

handler - - The new ViewHandler instance

subscribeToEvent

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

Overrides:

subscribeToEvent in class Application

subscribeToEvent

public void subscribeToEvent(Class<? extends SystemEvent> systemEventClass,
                             SystemEventListener listener)

Overrides:

subscribeToEvent in class Application

unsubscribeFromEvent

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

Overrides:

unsubscribeFromEvent in class Application

unsubscribeFromEvent

public void unsubscribeFromEvent(Class<? extends SystemEvent> systemEventClass,
                                 SystemEventListener listener)

Overrides:

unsubscribeFromEvent in class Application