|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.core.io.DefaultResourceLoader
org.springframework.context.support.AbstractApplicationContext
org.springframework.context.support.GenericApplicationContext
public class GenericApplicationContext
Generic ApplicationContext implementation that holds a single internal
DefaultListableBeanFactory
instance and does not assume a specific bean definition format. Implements
the BeanDefinitionRegistry
interface in order to allow for applying any bean definition readers to it.
Typical usage is to register a variety of bean definitions via the
BeanDefinitionRegistry
interface and then call AbstractApplicationContext.refresh() to initialize those beans
with application context semantics (handling
ApplicationContextAware, auto-detecting
BeanFactoryPostProcessors,
etc).
In contrast to other ApplicationContext implementations that create a new
internal BeanFactory instance for each refresh, the internal BeanFactory of
this context is available right from the start, to be able to register bean
definitions on it. AbstractApplicationContext.refresh() may only be called once.
Usage example:
GenericApplicationContext ctx = new GenericApplicationContext();
XmlBeanDefinitionReader xmlReader = new XmlBeanDefinitionReader(ctx);
xmlReader.loadBeanDefinitions(new ClassPathResource("applicationContext.xml"));
PropertiesBeanDefinitionReader propReader = new PropertiesBeanDefinitionReader(ctx);
propReader.loadBeanDefinitions(new ClassPathResource("otherBeans.properties"));
ctx.refresh();
MyBean myBean = (MyBean) ctx.getBean("myBean");
...
For the typical case of XML bean definitions, simply use
ClassPathXmlApplicationContext or FileSystemXmlApplicationContext,
which are easier to set up - but less flexible, since you can just use standard
resource locations for XML bean definitions, rather than mixing arbitrary bean
definition formats. The equivalent in a web environment is
XmlWebApplicationContext.
For custom application context implementations that are supposed to read
special bean definition formats in a refreshable manner, consider deriving
from the AbstractRefreshableApplicationContext base class.
registerBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition),
AbstractApplicationContext.refresh(),
XmlBeanDefinitionReader,
PropertiesBeanDefinitionReader| Field Summary |
|---|
| Fields inherited from class org.springframework.context.support.AbstractApplicationContext |
|---|
APPLICATION_EVENT_MULTICASTER_BEAN_NAME, LIFECYCLE_PROCESSOR_BEAN_NAME, logger, MESSAGE_SOURCE_BEAN_NAME |
| Fields inherited from interface org.springframework.context.ConfigurableApplicationContext |
|---|
CONFIG_LOCATION_DELIMITERS, CONVERSION_SERVICE_BEAN_NAME, ENVIRONMENT_BEAN_NAME, LOAD_TIME_WEAVER_BEAN_NAME, SYSTEM_ENVIRONMENT_BEAN_NAME, SYSTEM_PROPERTIES_BEAN_NAME |
| Fields inherited from interface org.springframework.beans.factory.BeanFactory |
|---|
FACTORY_BEAN_PREFIX |
| Fields inherited from interface org.springframework.core.io.support.ResourcePatternResolver |
|---|
CLASSPATH_ALL_URL_PREFIX |
| Fields inherited from interface org.springframework.core.io.ResourceLoader |
|---|
CLASSPATH_URL_PREFIX |
| Constructor Summary | |
|---|---|
GenericApplicationContext()
Create a new GenericApplicationContext. |
|
GenericApplicationContext(ApplicationContext parent)
Create a new GenericApplicationContext with the given parent. |
|
GenericApplicationContext(DefaultListableBeanFactory beanFactory)
Create a new GenericApplicationContext with the given DefaultListableBeanFactory. |
|
GenericApplicationContext(DefaultListableBeanFactory beanFactory,
ApplicationContext parent)
Create a new GenericApplicationContext with the given DefaultListableBeanFactory. |
|
| Method Summary | |
|---|---|
protected void |
cancelRefresh(BeansException ex)
Cancel this context's refresh attempt, resetting the active flag
after an exception got thrown. |
protected void |
closeBeanFactory()
Not much to do: We hold a single internal BeanFactory that will never get released. |
BeanDefinition |
getBeanDefinition(String beanName)
Return the BeanDefinition for the given bean name. |
ConfigurableListableBeanFactory |
getBeanFactory()
Return the single internal BeanFactory held by this context (as ConfigurableListableBeanFactory). |
DefaultListableBeanFactory |
getDefaultListableBeanFactory()
Return the underlying bean factory of this context, available for registering bean definitions. |
Resource |
getResource(String location)
This implementation delegates to this context's ResourceLoader if set, falling back to the default superclass behavior else. |
Resource[] |
getResources(String locationPattern)
This implementation delegates to this context's ResourceLoader if it implements the ResourcePatternResolver interface, falling back to the default superclass behavior else. |
boolean |
isAlias(String beanName)
Determine whether this given name is defines as an alias (as opposed to the name of an actually registered component). |
boolean |
isBeanNameInUse(String beanName)
Determine whether the given bean name is already in use within this registry, i.e. |
protected void |
refreshBeanFactory()
Do nothing: We hold a single internal BeanFactory and rely on callers to register beans through our public methods (or the BeanFactory's). |
void |
registerAlias(String beanName,
String alias)
Given a name, register an alias for it. |
void |
registerBeanDefinition(String beanName,
BeanDefinition beanDefinition)
Register a new bean definition with this registry. |
void |
removeAlias(String alias)
Remove the specified alias from this registry. |
void |
removeBeanDefinition(String beanName)
Remove the BeanDefinition for the given name. |
void |
setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding)
Set whether it should be allowed to override bean definitions by registering a different definition with the same name, automatically replacing the former. |
void |
setAllowCircularReferences(boolean allowCircularReferences)
Set whether to allow circular references between beans - and automatically try to resolve them. |
void |
setId(String id)
Set the unique id of this application context. |
void |
setParent(ApplicationContext parent)
Set the parent of this application context, also setting the parent of the internal BeanFactory accordingly. |
void |
setResourceLoader(ResourceLoader resourceLoader)
Set a ResourceLoader to use for this context. |
| Methods inherited from class org.springframework.core.io.DefaultResourceLoader |
|---|
getClassLoader, getResourceByPath, setClassLoader |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
| Methods inherited from interface org.springframework.beans.factory.support.BeanDefinitionRegistry |
|---|
containsBeanDefinition, getBeanDefinitionCount, getBeanDefinitionNames |
| Methods inherited from interface org.springframework.core.AliasRegistry |
|---|
getAliases |
| Methods inherited from interface org.springframework.core.io.ResourceLoader |
|---|
getClassLoader |
| Constructor Detail |
|---|
public GenericApplicationContext()
registerBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition),
AbstractApplicationContext.refresh()public GenericApplicationContext(DefaultListableBeanFactory beanFactory)
beanFactory - the DefaultListableBeanFactory instance to use for this contextregisterBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition),
AbstractApplicationContext.refresh()public GenericApplicationContext(ApplicationContext parent)
parent - the parent application contextregisterBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition),
AbstractApplicationContext.refresh()
public GenericApplicationContext(DefaultListableBeanFactory beanFactory,
ApplicationContext parent)
beanFactory - the DefaultListableBeanFactory instance to use for this contextparent - the parent application contextregisterBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition),
AbstractApplicationContext.refresh()| Method Detail |
|---|
public void setParent(ApplicationContext parent)
setParent in interface ConfigurableApplicationContextsetParent in class AbstractApplicationContextparent - the parent contextConfigurableBeanFactory.setParentBeanFactory(org.springframework.beans.factory.BeanFactory)public void setId(String id)
AbstractApplicationContextDefault is the object id of the context instance, or the name of the context bean if the context is itself defined as a bean.
setId in interface ConfigurableApplicationContextsetId in class AbstractApplicationContextid - the unique id of the contextpublic void setAllowBeanDefinitionOverriding(boolean allowBeanDefinitionOverriding)
DefaultListableBeanFactory.setAllowBeanDefinitionOverriding(boolean)public void setAllowCircularReferences(boolean allowCircularReferences)
Default is "true". Turn this off to throw an exception when encountering a circular reference, disallowing them completely.
AbstractAutowireCapableBeanFactory.setAllowCircularReferences(boolean)public void setResourceLoader(ResourceLoader resourceLoader)
getResource calls to the given ResourceLoader.
If not set, default resource loading will apply.
The main reason to specify a custom ResourceLoader is to resolve resource paths (without URL prefix) in a specific fashion. The default behavior is to resolve such paths as class path locations. To resolve resource paths as file system locations, specify a FileSystemResourceLoader here.
You can also pass in a full ResourcePatternResolver, which will
be autodetected by the context and used for getResources
calls as well. Else, default resource pattern matching will apply.
getResource(java.lang.String),
DefaultResourceLoader,
FileSystemResourceLoader,
ResourcePatternResolver,
getResources(java.lang.String)public Resource getResource(String location)
getResource in interface ResourceLoadergetResource in class DefaultResourceLoaderlocation - the resource location
setResourceLoader(org.springframework.core.io.ResourceLoader)
public Resource[] getResources(String locationPattern)
throws IOException
getResources in interface ResourcePatternResolvergetResources in class AbstractApplicationContextlocationPattern - the location pattern to resolve
IOException - in case of I/O errorssetResourceLoader(org.springframework.core.io.ResourceLoader)
protected final void refreshBeanFactory()
throws IllegalStateException
refreshBeanFactory in class AbstractApplicationContextIllegalStateException - if already initialized and multiple refresh
attempts are not supportedregisterBeanDefinition(java.lang.String, org.springframework.beans.factory.config.BeanDefinition)protected void cancelRefresh(BeansException ex)
AbstractApplicationContextactive flag
after an exception got thrown.
cancelRefresh in class AbstractApplicationContextex - the exception that led to the cancellationprotected final void closeBeanFactory()
closeBeanFactory in class AbstractApplicationContextpublic final ConfigurableListableBeanFactory getBeanFactory()
getBeanFactory in interface ConfigurableApplicationContextgetBeanFactory in class AbstractApplicationContextnull)AbstractApplicationContext.refreshBeanFactory(),
AbstractApplicationContext.closeBeanFactory()public final DefaultListableBeanFactory getDefaultListableBeanFactory()
NOTE: You need to call AbstractApplicationContext.refresh() to initialize the
bean factory and its contained beans with application context semantics
(autodetecting BeanFactoryPostProcessors, etc).
public void registerBeanDefinition(String beanName,
BeanDefinition beanDefinition)
throws BeanDefinitionStoreException
BeanDefinitionRegistry
registerBeanDefinition in interface BeanDefinitionRegistrybeanName - the name of the bean instance to registerbeanDefinition - definition of the bean instance to register
BeanDefinitionStoreException - if the BeanDefinition is invalid
or if there is already a BeanDefinition for the specified bean name
(and we are not allowed to override it)RootBeanDefinition,
ChildBeanDefinition
public void removeBeanDefinition(String beanName)
throws NoSuchBeanDefinitionException
BeanDefinitionRegistry
removeBeanDefinition in interface BeanDefinitionRegistrybeanName - the name of the bean instance to register
NoSuchBeanDefinitionException - if there is no such bean definition
public BeanDefinition getBeanDefinition(String beanName)
throws NoSuchBeanDefinitionException
BeanDefinitionRegistry
getBeanDefinition in interface BeanDefinitionRegistrybeanName - name of the bean to find a definition for
null)
NoSuchBeanDefinitionException - if there is no such bean definitionpublic boolean isBeanNameInUse(String beanName)
BeanDefinitionRegistry
isBeanNameInUse in interface BeanDefinitionRegistrybeanName - the name to check
public void registerAlias(String beanName,
String alias)
AliasRegistry
registerAlias in interface AliasRegistrybeanName - the canonical namealias - the alias to be registeredpublic void removeAlias(String alias)
AliasRegistry
removeAlias in interface AliasRegistryalias - the alias to removepublic boolean isAlias(String beanName)
AliasRegistry
isAlias in interface AliasRegistrybeanName - the bean name to check
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||