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: import org.springframework.beans.factory.ListableBeanFactory;
21: import org.springframework.beans.factory.NoSuchBeanDefinitionException;
22:
23: /**
24: * Configuration interface to be implemented by most listable bean factories.
25: * In addition to {@link ConfigurableBeanFactory}, it provides facilities to
26: * analyze and modify bean definitions, and to pre-instantiate singletons.
27: *
28: * <p>This subinterface of {@link org.springframework.beans.factory.BeanFactory}
29: * is not meant to be used in normal application code: Stick to
30: * {@link org.springframework.beans.factory.BeanFactory} or
31: * {@link org.springframework.beans.factory.ListableBeanFactory} for typical
32: * use cases. This interface is just meant to allow for framework-internal
33: * plug'n'play even when needing access to bean factory configuration methods.
34: *
35: * @author Juergen Hoeller
36: * @since 03.11.2003
37: * @see org.springframework.context.support.AbstractApplicationContext#getBeanFactory()
38: */
39: public interface ConfigurableListableBeanFactory extends
40: ListableBeanFactory, AutowireCapableBeanFactory,
41: ConfigurableBeanFactory {
42:
43: /**
44: * Ignore the given dependency type for autowiring:
45: * for example, String. Default is none.
46: * @param type the dependency type to ignore
47: */
48: void ignoreDependencyType(Class type);
49:
50: /**
51: * Ignore the given dependency interface for autowiring.
52: * <p>This will typically be used by application contexts to register
53: * dependencies that are resolved in other ways, like BeanFactory through
54: * BeanFactoryAware or ApplicationContext through ApplicationContextAware.
55: * <p>By default, only the BeanFactoryAware interface is ignored.
56: * For further types to ignore, invoke this method for each type.
57: * @param ifc the dependency interface to ignore
58: * @see org.springframework.beans.factory.BeanFactoryAware
59: * @see org.springframework.context.ApplicationContextAware
60: */
61: void ignoreDependencyInterface(Class ifc);
62:
63: /**
64: * Return the registered BeanDefinition for the given bean, allowing access
65: * to its property values and constructor argument value (which can be
66: * modified during bean factory post-processing).
67: * <p>A returned BeanDefinition object should not be a copy but the original
68: * definition object as registered in the factory. This means that it should
69: * be castable to a more specific implementation type, if necessary.
70: * @param beanName name of the bean
71: * @return the registered BeanDefinition
72: * @throws NoSuchBeanDefinitionException if there is no bean with the given name
73: */
74: BeanDefinition getBeanDefinition(String beanName)
75: throws NoSuchBeanDefinitionException;
76:
77: /**
78: * Ensure that all non-lazy-init singletons are instantiated, also considering
79: * {@link org.springframework.beans.factory.FactoryBean FactoryBeans}.
80: * Typically invoked at the end of factory setup, if desired.
81: * @throws BeansException if one of the singleton beans could not be created.
82: * Note: This may have left the factory with some beans already initialized!
83: * Call {@link #destroySingletons()} for full cleanup in this case.
84: * @see #destroySingletons()
85: */
86: void preInstantiateSingletons() throws BeansException;
87:
88: }
|