01: /*
02: * Copyright 2002-2007 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.springframework.beans.factory.config;
18:
19: import org.springframework.beans.BeansException;
20:
21: /**
22: * Factory hook that allows for custom modification of new bean instances,
23: * e.g. checking for marker interfaces or wrapping them with proxies.
24: *
25: * <p>ApplicationContexts can autodetect BeanPostProcessor beans in their
26: * bean definitions and apply them to any beans subsequently created.
27: * Plain bean factories allow for programmatic registration of post-processors,
28: * applying to all beans created through this factory.
29: *
30: * <p>Typically, post-processors that populate beans via marker interfaces
31: * or the like will implement {@link #postProcessBeforeInitialization},
32: * while post-processors that wrap beans with proxies will normally
33: * implement {@link #postProcessAfterInitialization}.
34: *
35: * @author Juergen Hoeller
36: * @since 10.10.2003
37: * @see InstantiationAwareBeanPostProcessor
38: * @see DestructionAwareBeanPostProcessor
39: * @see ConfigurableBeanFactory#addBeanPostProcessor
40: * @see BeanFactoryPostProcessor
41: */
42: public interface BeanPostProcessor {
43:
44: /**
45: * Apply this BeanPostProcessor to the given new bean instance <i>before</i> any bean
46: * initialization callbacks (like InitializingBean's <code>afterPropertiesSet</code>
47: * or a custom init-method). The bean will already be populated with property values.
48: * The returned bean instance may be a wrapper around the original.
49: * @param bean the new bean instance
50: * @param beanName the name of the bean
51: * @return the bean instance to use, either the original or a wrapped one
52: * @throws org.springframework.beans.BeansException in case of errors
53: * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
54: */
55: Object postProcessBeforeInitialization(Object bean, String beanName)
56: throws BeansException;
57:
58: /**
59: * Apply this BeanPostProcessor to the given new bean instance <i>after</i> any bean
60: * initialization callbacks (like InitializingBean's <code>afterPropertiesSet</code>
61: * or a custom init-method). The bean will already be populated with property values.
62: * The returned bean instance may be a wrapper around the original.
63: * <p>In case of a FactoryBean, this callback will be invoked for both the FactoryBean
64: * instance and the objects created by the FactoryBean (as of Spring 2.0). The
65: * post-processor can decide whether to apply to either the FactoryBean or created
66: * objects or both through corresponding <code>bean instanceof FactoryBean</code> checks.
67: * <p>This callback will also be invoked after a short-circuiting triggered by a
68: * {@link InstantiationAwareBeanPostProcessor#postProcessBeforeInstantiation} method,
69: * in contrast to all other BeanPostProcessor callbacks.
70: * @param bean the new bean instance
71: * @param beanName the name of the bean
72: * @return the bean instance to use, either the original or a wrapped one
73: * @throws org.springframework.beans.BeansException in case of errors
74: * @see org.springframework.beans.factory.InitializingBean#afterPropertiesSet
75: * @see org.springframework.beans.factory.FactoryBean
76: */
77: Object postProcessAfterInitialization(Object bean, String beanName)
78: throws BeansException;
79:
80: }
|