org.springframework.dao.annotation
Class PersistenceExceptionTranslationPostProcessor

java.lang.Object
  org.springframework.dao.annotation.PersistenceExceptionTranslationPostProcessor

All Implemented Interfaces:

BeanFactoryAware, BeanPostProcessor, Ordered

public class PersistenceExceptionTranslationPostProcessor
extends Object
implements BeanPostProcessor, BeanFactoryAware, Ordered

Bean post-processor that automatically applies persistence exception translation to any bean that carries the Repository annotation.

Translates native resource exceptions to Spring's DataAccessException hierarchy. Autodetects beans that implement the PersistenceExceptionTranslator interface, which are subsequently asked to translate candidate exceptions.

All of Spring's applicable resource factories implement the PersistenceExceptionTranslator interface out of the box. As a consequence, all that is usually needed to enable automatic exception translation is marking all affected beans (such as DAOs) with the Repository annotation, along with defining this post-processor as bean in the application context.

Since:

2.0

Author:

Rod Johnson, Juergen Hoeller

See Also:

Repository, DataAccessException, PersistenceExceptionTranslator, PersistenceExceptionTranslationAdvisor

Field Summary

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

PersistenceExceptionTranslationPostProcessor()

Method Summary

int	getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.
Object	postProcessAfterInitialization(Object bean, String beanName) Apply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method).
Object	postProcessBeforeInitialization(Object bean, String beanName) Apply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method).
void	setBeanFactory(BeanFactory beanFactory) Callback that supplies the owning factory to a bean instance.
void	setRepositoryAnnotationType(Class<? extends Annotation> repositoryAnnotationType) Set the 'repository' annotation type.
protected List<PersistenceExceptionTranslator>	validateAndFilter(List<PersistenceExceptionTranslator> allPets) Validate and filter the given PersistenceExceptionTranslators.

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistenceExceptionTranslationPostProcessor

public PersistenceExceptionTranslationPostProcessor()

Method Detail

setRepositoryAnnotationType

public void setRepositoryAnnotationType(Class<? extends Annotation> repositoryAnnotationType)

Set the 'repository' annotation type. The default required annotation type is the Repository annotation.

This setter property exists so that developers can provide their own (non-Spring-specific) annotation type to indicate that a class has a repository role.

Parameters:

repositoryAnnotationType - the desired annotation type

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)
                    throws BeansException

Description copied from interface: BeanFactoryAware

Callback that supplies the owning factory to a bean instance.

Invoked after the population of normal bean properties but before an initialization callback such as InitializingBean.afterPropertiesSet() or a custom init-method.

Specified by:

setBeanFactory in interface BeanFactoryAware

Parameters:

beanFactory - owning BeanFactory (may not be null). The bean can immediately call methods on the factory.

Throws:

BeansException - in case of initialization errors

See Also:

BeanInitializationException

getOrder

public int getOrder()

Description copied from interface: Ordered

Return the order value of this object, with a higher value meaning greater in terms of sorting.

Normally starting with 0 or 1, with Ordered.LOWEST_PRECEDENCE indicating greatest. Same order values will result in arbitrary positions for the affected objects.

Higher value can be interpreted as lower priority, consequently the first object has highest priority (somewhat analogous to Servlet "load-on-startup" values).

Note that order values below 0 are reserved for framework purposes. Application-specified values should always be 0 or greater, with only framework components (internal or third-party) supposed to use lower values.

Specified by:

getOrder in interface Ordered

Returns:

the order value

See Also:

Ordered.LOWEST_PRECEDENCE

postProcessBeforeInitialization

public Object postProcessBeforeInitialization(Object bean,
                                              String beanName)
                                       throws BeansException

Description copied from interface: BeanPostProcessor

Apply this BeanPostProcessor to the given new bean instance before any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.

Specified by:

postProcessBeforeInitialization in interface BeanPostProcessor

Parameters:

bean - the new bean instance

beanName - the name of the bean

Returns:

the bean instance to use, either the original or a wrapped one

Throws:

BeansException - in case of errors

See Also:

InitializingBean.afterPropertiesSet()

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
                                             String beanName)
                                      throws BeansException

Description copied from interface: BeanPostProcessor

Apply this BeanPostProcessor to the given new bean instance after any bean initialization callbacks (like InitializingBean's afterPropertiesSet or a custom init-method). The bean will already be populated with property values. The returned bean instance may be a wrapper around the original.

In case of a FactoryBean, this callback will be invoked for both the FactoryBean instance and the objects created by the FactoryBean (as of Spring 2.0). The post-processor can decide whether to apply to either the FactoryBean or created objects or both through corresponding bean instanceof FactoryBean checks.

This callback will also be invoked after a short-circuiting triggered by a InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation(java.lang.Class, java.lang.String) method, in contrast to all other BeanPostProcessor callbacks.

Specified by:

postProcessAfterInitialization in interface BeanPostProcessor

Parameters:

bean - the new bean instance

beanName - the name of the bean

Returns:

the bean instance to use, either the original or a wrapped one

Throws:

BeansException - in case of errors

See Also:

InitializingBean.afterPropertiesSet(), FactoryBean

validateAndFilter

protected List<PersistenceExceptionTranslator> validateAndFilter(List<PersistenceExceptionTranslator> allPets)
                                                          throws IllegalStateException

Validate and filter the given PersistenceExceptionTranslators.

Throws:

IllegalStateException