GrepCode: org.springframework.beans.factory.config.AutowireCapableBeanFactory (.java) - Interface

Maven-Central
/
org.springframework / spring-beans
/
2.5.6.SEC02

3.1.1.RELEASE
3.0.4.RELEASE
3.0.3.RELEASE
3.0.2.RELEASE
3.0.1.RELEASE
3.0.0.RELEASE
2.5.6
2.5.6.SEC03
2.5.6.SEC02
2.5.6.SEC01
2.5.5
2.5.4
2.5.3
2.5.2
2.5.1
2.5
1.2.1
/
org.springframework.beans.factory.config.AutowireCapableBeanFactory
Find Usages
Diff
Raw
Download
HTML Widget
Stack Overflow Questions
1
  /*
2
   * Copyright 2002-2008 the original author or authors.
3
   *
4
   * Licensed under the Apache License, Version 2.0 (the "License");
5
   * you may not use this file except in compliance with the License.
6
   * You may obtain a copy of the License at
7
   *
8
   *      http://www.apache.org/licenses/LICENSE-2.0
9
   *
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 java.util.Set;
20
 
21
 import org.springframework.beans.BeansException;
22
 import org.springframework.beans.TypeConverter;
23
 import org.springframework.beans.factory.BeanFactory;

 Extension of the org.springframework.beans.factory.BeanFactory
 interface to be implemented by bean factories that are capable of
 autowiring, provided that they want to expose this functionality for
 existing bean instances.

 This subinterface of BeanFactory is not meant to be used in normal
 application code: stick to org.springframework.beans.factory.BeanFactory
 or org.springframework.beans.factory.ListableBeanFactory for
 typical use cases.

 
Integration code for other frameworks can leverage this interface to
 wire and populate existing bean instances that Spring does not control
 the lifecycle of. This is particularly useful for WebWork Actions and
 Tapestry Page objects, for example.

 
Note that this interface is not implemented by
 org.springframework.context.ApplicationContext facades,
 as it is hardly ever used by application code. That said, it is available
 from an application context too, accessible through ApplicationContext's
 org.springframework.context.ApplicationContext#getAutowireCapableBeanFactory()
 method.

 
You may also implement the org.springframework.beans.factory.BeanFactoryAware
 interface, which exposes the internal BeanFactory even when running in an
 ApplicationContext, to get access to an AutowireCapableBeanFactory:
 simply cast the passed-in BeanFactory to AutowireCapableBeanFactory.

 
 Author(s):Juergen Hoeller Since:04.12.2003 See also:org.springframework.beans.factory.BeanFactoryAwareConfigurableListableBeanFactoryorg.springframework.context.ApplicationContext#getAutowireCapableBeanFactory()
58
 
59
 public interface AutowireCapableBeanFactory extends BeanFactory {

	
 Constant that indicates no externally defined autowiring. Note that
 BeanFactoryAware etc and annotation-driven injection will still be applied.
 
 See also:createBean(java.lang.Class)autowire(java.lang.Class,int,boolean)autowireBeanProperties(java.lang.Object,int,boolean)
67
 
68
 	int AUTOWIRE_NO = 0;

	
 Constant that indicates autowiring bean properties by name
 (applying to all bean property setters).
 
 See also:createBean(java.lang.Class)autowire(java.lang.Class,int,boolean)autowireBeanProperties(java.lang.Object,int,boolean)
76
 
77
 	int AUTOWIRE_BY_NAME = 1;

	
 Constant that indicates autowiring bean properties by type
 (applying to all bean property setters).
 
 See also:createBean(java.lang.Class)autowire(java.lang.Class,int,boolean)autowireBeanProperties(java.lang.Object,int,boolean)
85
 
86
 	int AUTOWIRE_BY_TYPE = 2;

	
 Constant that indicates autowiring the greediest constructor that
 can be satisfied (involves resolving the appropriate constructor).
 
 See also:createBean(java.lang.Class)autowire(java.lang.Class,int,boolean)
93
 
94
 	int AUTOWIRE_CONSTRUCTOR = 3;

	
 Constant that indicates determining an appropriate autowire strategy
 through introspection of the bean class.
 
 See also:createBean(java.lang.Class)autowire(java.lang.Class,int,boolean)
101
102
	int AUTOWIRE_AUTODETECT = 4;
103
104
105
	//-------------------------------------------------------------------------
106
	// Typical methods for creating and populating external bean instances
107
	//-------------------------------------------------------------------------
108

	
 Fully create a new bean instance of the given class.
 Performs full initialization of the bean, including all applicable
 BeanPostProcessors.
 
Note: This is intended for creating a fresh instance, populating annotated
 fields and methods as well as applying all standard bean initialiation callbacks.
 It does not</> imply traditional by-name or by-type autowiring of properties;
 use createBean(java.lang.Class,int,boolean) for that purposes.
 
 Parameters:beanClass the class of the bean to create Returns:the new bean instance Throws:org.springframework.beans.BeansException if instantiation or wiring failed
120
121
	Object createBean(Class beanClass) throws BeansException;

	
 Populate the given bean instance through applying after-instantiation callbacks
 and bean property post-processing (e.g. for annotation-driven injection).
 Note: This is essentially intended for (re-)populating annotated fields and
 methods, either for new instances or for deserialized instances. It does
 not imply traditional by-name or by-type autowiring of properties;
 use autowireBeanProperties(java.lang.Object,int,boolean) for that purposes.
 
 Parameters:existingBean the existing bean instance Throws:org.springframework.beans.BeansException if wiring failed
132
133
	void autowireBean(Object existingBean) throws BeansException;

	
 Configure the given raw bean: autowiring bean properties, applying
 bean property values, applying factory callbacks such as setBeanName
 and setBeanFactory, and also applying all bean post processors
 (including ones which might wrap the given raw bean).
 This is effectively a superset of what initializeBean(java.lang.Object,java.lang.String) provides,
 fully applying the configuration specified by the corresponding bean definition.
 Note: This method requires a bean definition for the given name!
 
 Parameters:existingBean the existing bean instancebeanName the name of the bean, to be passed to it if necessary
 (a bean definition of that name has to be available) Returns:the bean instance to use, either the original or a wrapped one Throws:org.springframework.beans.factory.NoSuchBeanDefinitionException
 if there is no bean definition with the given nameorg.springframework.beans.BeansException if the initialization failed See also:initializeBean(java.lang.Object,java.lang.String)
151
152
	Object configureBean(Object existingBean, String beanName) throws BeansException;

	
 Resolve the specified dependency against the beans defined in this factory.
 
 Parameters:descriptor the descriptor for the dependencybeanName the name of the bean which declares the present dependency Returns:the resolved object, or null if none found Throws:org.springframework.beans.BeansException in dependency resolution failed
160
161
	Object resolveDependency(DependencyDescriptor descriptor, String beanName) throws BeansException;
162
163
164
	//-------------------------------------------------------------------------
165
	// Specialized methods for fine-grained control over the bean lifecycle
166
	//-------------------------------------------------------------------------
167

	
 Fully create a new bean instance of the given class with the specified
 autowire strategy. All constants defined in this interface are supported here.
 Performs full initialization of the bean, including all applicable
 BeanPostProcessors. This is effectively a superset
 of what autowire(java.lang.Class,int,boolean) provides, adding initializeBean(java.lang.Object,java.lang.String) behavior.
 
 Parameters:beanClass the class of the bean to createautowireMode by name or type, using the constants in this interfacedependencyCheck whether to perform a dependency check for objects
 (not applicable to autowiring a constructor, thus ignored there) Returns:the new bean instance Throws:org.springframework.beans.BeansException if instantiation or wiring failed See also:AUTOWIRE_NOAUTOWIRE_BY_NAMEAUTOWIRE_BY_TYPEAUTOWIRE_CONSTRUCTORAUTOWIRE_AUTODETECT
185
186
	Object createBean(Class beanClass, int autowireMode, boolean dependencyCheck) throws BeansException;

	
 Instantiate a new bean instance of the given class with the specified autowire
 strategy. All constants defined in this interface are supported here.
 Can also be invoked with AUTOWIRE_NO in order to just apply
 before-instantiation callbacks (e.g. for annotation-driven injection).
 Does not apply standard BeanPostProcessors
 callbacks or perform any further initialization of the bean. This interface
 offers distinct, fine-grained operations for those purposes, for example
 initializeBean(java.lang.Object,java.lang.String). However, InstantiationAwareBeanPostProcessor
 callbacks are applied, if applicable to the construction of the instance.
 
 Parameters:beanClass the class of the bean to instantiateautowireMode by name or type, using the constants in this interfacedependencyCheck whether to perform a dependency check for object
 references in the bean instance (not applicable to autowiring a constructor,
 thus ignored there) Returns:the new bean instance Throws:org.springframework.beans.BeansException if instantiation or wiring failed See also:AUTOWIRE_NOAUTOWIRE_BY_NAMEAUTOWIRE_BY_TYPEAUTOWIRE_CONSTRUCTORAUTOWIRE_AUTODETECTinitializeBean(java.lang.Object,java.lang.String)applyBeanPostProcessorsBeforeInitialization(java.lang.Object,java.lang.String)applyBeanPostProcessorsAfterInitialization(java.lang.Object,java.lang.String)
213
214
	Object autowire(Class beanClass, int autowireMode, boolean dependencyCheck) throws BeansException;

	
 Autowire the bean properties of the given bean instance by name or type.
 Can also be invoked with AUTOWIRE_NO in order to just apply
 after-instantiation callbacks (e.g. for annotation-driven injection).
 Does not apply standard BeanPostProcessors
 callbacks or perform any further initialization of the bean. This interface
 offers distinct, fine-grained operations for those purposes, for example
 initializeBean(java.lang.Object,java.lang.String). However, InstantiationAwareBeanPostProcessor
 callbacks are applied, if applicable to the configuration of the instance.
 
 Parameters:existingBean the existing bean instanceautowireMode by name or type, using the constants in this interfacedependencyCheck whether to perform a dependency check for object
 references in the bean instance Throws:org.springframework.beans.BeansException if wiring failed See also:AUTOWIRE_BY_NAMEAUTOWIRE_BY_TYPEAUTOWIRE_NO
233
234
	void autowireBeanProperties(Object existingBean, int autowireMode, boolean dependencyCheck)
235
			throws BeansException;

	
 Apply the property values of the bean definition with the given name to
 the given bean instance. The bean definition can either define a fully
 self-contained bean, reusing its property values, or just property values
 meant to be used for existing bean instances.
 This method does not autowire bean properties; it just applies
 explicitly defined property values. Use the autowireBeanProperties(java.lang.Object,int,boolean)
 method to autowire an existing bean instance.
 Note: This method requires a bean definition for the given name!
 
Does not apply standard BeanPostProcessors
 callbacks or perform any further initialization of the bean. This interface
 offers distinct, fine-grained operations for those purposes, for example
 initializeBean(java.lang.Object,java.lang.String). However, InstantiationAwareBeanPostProcessor
 callbacks are applied, if applicable to the configuration of the instance.
 
 Parameters:existingBean the existing bean instancebeanName the name of the bean definition in the bean factory
 (a bean definition of that name has to be available) Throws:org.springframework.beans.factory.NoSuchBeanDefinitionException
 if there is no bean definition with the given nameorg.springframework.beans.BeansException if applying the property values failed See also:autowireBeanProperties(java.lang.Object,int,boolean)
258
259
	void applyBeanPropertyValues(Object existingBean, String beanName) throws BeansException;

	
 Initialize the given raw bean, applying factory callbacks
 such as setBeanName and setBeanFactory,
 also applying all bean post processors (including ones which
 might wrap the given raw bean).
 Note that no bean definition of the given name has to exist
 in the bean factory. The passed-in bean name will simply be used
 for callbacks but not checked against the registered bean definitions.
 
 Parameters:existingBean the existing bean instancebeanName the name of the bean, to be passed to it if necessary
 (only passed to BeanPostProcessors) Returns:the bean instance to use, either the original or a wrapped one Throws:org.springframework.beans.BeansException if the initialization failed
274
275
	Object initializeBean(Object existingBean, String beanName) throws BeansException;

	
 Apply BeanPostProcessors to the given existing bean
 instance, invoking their postProcessBeforeInitialization methods.
 The returned bean instance may be a wrapper around the original.
 
 Parameters:existingBean the new bean instancebeanName the name of the bean Returns:the bean instance to use, either the original or a wrapped one Throws:org.springframework.beans.BeansException if any post-processing failed See also:BeanPostProcessor.postProcessBeforeInitialization(java.lang.Object,java.lang.String)
286
287
	Object applyBeanPostProcessorsBeforeInitialization(Object existingBean, String beanName)
288
			throws BeansException;

	
 Apply BeanPostProcessors to the given existing bean
 instance, invoking their postProcessAfterInitialization methods.
 The returned bean instance may be a wrapper around the original.
 
 Parameters:existingBean the new bean instancebeanName the name of the bean Returns:the bean instance to use, either the original or a wrapped one Throws:org.springframework.beans.BeansException if any post-processing failed See also:BeanPostProcessor.postProcessAfterInitialization(java.lang.Object,java.lang.String)
299
300
	Object applyBeanPostProcessorsAfterInitialization(Object existingBean, String beanName)
301
			throws BeansException;

	
 Resolve the specified dependency against the beans defined in this factory.
 
 Parameters:descriptor the descriptor for the dependencybeanName the name of the bean which declares the present dependencyautowiredBeanNames a Set that all names of autowired beans (used for
 resolving the present dependency) are supposed to be added totypeConverter the TypeConverter to use for populating arrays and
 collections Returns:the resolved object, or null if none found Throws:org.springframework.beans.BeansException in dependency resolution failed
313
314
	Object resolveDependency(DependencyDescriptor descriptor, String beanName,
315
			Set autowiredBeanNames, TypeConverter typeConverter) throws BeansException;
316
317
}