jakarta.faces.context

Class ExceptionHandlerFactory

java.lang.Object

jakarta.faces.context.ExceptionHandlerFactory

All Implemented Interfaces:

FacesWrapper<ExceptionHandlerFactory>

Direct Known Subclasses:

PreJsf2ExceptionHandlerFactory

public abstract class ExceptionHandlerFactory
extends Object
implements FacesWrapper<ExceptionHandlerFactory>

ExceptionHandlerFactory is a factory object that creates (if needed) and returns a new ExceptionHandler instance.

There must be one ExceptionHandlerFactory instance per web application that is utilizing Jakarta Server Faces. This instance can be acquired, in a portable manner, by calling:

 
   ExceptionHandlerFactory factory = (ExceptionHandlerFactory)
    FactoryFinder.getFactory(FactoryFinder.EXCEPTION_HANDLER_FACTORY);
 
 

Usage: extend this class and push the implementation being wrapped to the constructor and use getWrapped() to access the instance being wrapped.

Since:

2.0

Constructor Summary

Constructors

Constructor and Description
ExceptionHandlerFactory() Deprecated. Use the other constructor taking the implementation being wrapped.
ExceptionHandlerFactory(ExceptionHandlerFactory wrapped) If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor.

Method Summary

Modifier and Type	Method and Description
abstract ExceptionHandler	getExceptionHandler() Create and return a A new ExceptionHandler instance.
ExceptionHandlerFactory	getWrapped() If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Methods inherited from class java.lang.Object

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

Constructor Detail

ExceptionHandlerFactory

@Deprecated
public ExceptionHandlerFactory()

Deprecated. Use the other constructor taking the implementation being wrapped.

ExceptionHandlerFactory

public ExceptionHandlerFactory(ExceptionHandlerFactory wrapped)

If this factory has been decorated, the implementation doing the decorating should push the implementation being wrapped to this constructor. The getWrapped() will then return the implementation being wrapped.

Parameters:

wrapped - The implementation being wrapped.

Method Detail

getWrapped

public ExceptionHandlerFactory getWrapped()

If this factory has been decorated, the implementation doing the decorating may override this method to provide access to the implementation being wrapped.

Specified by:

getWrapped in interface FacesWrapper<ExceptionHandlerFactory>

Returns:

the wrapped instance.

getExceptionHandler

public abstract ExceptionHandler getExceptionHandler()

Create and return a A new ExceptionHandler instance. The implementation must return an ExceptionHandler instance suitable for the environment. For example, in some cases it may be desirable for an ExceptionHandler to write error information to the response instead of throwing exceptions as in the case of Ajax applications.

Returns:

newly created ExceptionHandler.