io.jmix.ui.exception

Class ExceptionHandlers

java.lang.Object

io.jmix.ui.exception.ExceptionHandlers

public class ExceptionHandlers
extends java.lang.Object

Class that holds the collection of exception handlers and delegates unhandled exception processing to them. Handlers form the chain of responsibility.

A set of exception handlers is configured by defining ExceptionHandlersConfiguration beans in spring.xml. If a project needs specific handlers, it should define a bean of such type with its own id, e.g. refapp_ExceptionHandlersConfiguration

An instance of this class is bound to App.

Field Summary

Fields

Modifier and Type	Field and Description
protected App	app
protected org.springframework.context.ApplicationContext	applicationContext
protected ExceptionHandler	defaultHandler
protected java.util.List<UiExceptionHandler>	genericHandlers
protected java.util.List<ExceptionHandler>	handlers

Constructor Summary

Constructors

Constructor and Description
ExceptionHandlers(App app, org.springframework.context.ApplicationContext applicationContext)

Method Summary

Modifier and Type	Method and Description
void	addHandler(ExceptionHandler handler) Adds new Web-level handler if it is not yet registered.
void	addHandler(UiExceptionHandler handler) Adds new GUI-level handler if it is not yet registered.
void	createByConfiguration() Create all Web handlers defined by ExceptionHandlersConfiguration beans in spring.xml and GUI handlers defined as Spring-beans.
ExceptionHandler	getDefaultHandler()
void	handle(com.vaadin.server.ErrorEvent event) Delegates exception handling to registered handlers.
void	removeAll() Remove all handlers.
void	setDefaultHandler(ExceptionHandler defaultHandler) Set the default handler instead of initialized in constructor.

Methods inherited from class java.lang.Object

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

Field Detail

app

protected App app

applicationContext

protected org.springframework.context.ApplicationContext applicationContext

handlers

protected java.util.List<ExceptionHandler> handlers

genericHandlers

protected java.util.List<UiExceptionHandler> genericHandlers

defaultHandler

protected ExceptionHandler defaultHandler

Constructor Detail

ExceptionHandlers

public ExceptionHandlers(App app,
                         org.springframework.context.ApplicationContext applicationContext)

Method Detail

getDefaultHandler

public ExceptionHandler getDefaultHandler()

Returns:

default exception handler which is used when none of registered handlers have handled an exception

setDefaultHandler

public void setDefaultHandler(ExceptionHandler defaultHandler)

Set the default handler instead of initialized in constructor.

Parameters:

defaultHandler - default handler instance

addHandler

public void addHandler(ExceptionHandler handler)

Adds new Web-level handler if it is not yet registered.

Parameters:

handler - handler instance

addHandler

public void addHandler(UiExceptionHandler handler)

Adds new GUI-level handler if it is not yet registered.

Parameters:

handler - handler instance

handle

public void handle(com.vaadin.server.ErrorEvent event)

Delegates exception handling to registered handlers.

Parameters:

event - error event generated by Vaadin

createByConfiguration

public void createByConfiguration()

Create all Web handlers defined by ExceptionHandlersConfiguration beans in spring.xml and GUI handlers defined as Spring-beans.

removeAll

public void removeAll()

Remove all handlers.