org.springframework.test.web.servlet.setup

Class StubWebApplicationContext

java.lang.Object

org.springframework.test.web.servlet.setup.StubWebApplicationContext

All Implemented Interfaces:

BeanFactory, HierarchicalBeanFactory, ListableBeanFactory, ApplicationContext, ApplicationEventPublisher, MessageSource, EnvironmentCapable, ResourceLoader, ResourcePatternResolver, WebApplicationContext

class StubWebApplicationContext
extends java.lang.Object
implements WebApplicationContext

A stub WebApplicationContext that accepts registrations of object instances.

As registered object instances are instantiated and initialized externally, there is no wiring, bean initialization, lifecycle events, as well as no pre-processing and post-processing hooks typically associated with beans managed by an ApplicationContext. Just a simple lookup into a StaticListableBeanFactory.

Since:

3.2

Author:

Rossen Stoyanchev, Juergen Hoeller

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	StubWebApplicationContext.StubBeanFactory An extension of StaticListableBeanFactory that implements AutowireCapableBeanFactory in order to allow bean initialization of ApplicationContextAware singletons.

Field Summary

Fields

Modifier and Type	Field and Description
private StubWebApplicationContext.StubBeanFactory	beanFactory
private java.lang.String	displayName
private Environment	environment
private java.lang.String	id
private MessageSource	messageSource
private ResourcePatternResolver	resourcePatternResolver
private ServletContext	servletContext
private long	startupDate

Fields inherited from interface org.springframework.web.context.WebApplicationContext

CONTEXT_ATTRIBUTES_BEAN_NAME, CONTEXT_PARAMETERS_BEAN_NAME, ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, SCOPE_APPLICATION, SCOPE_GLOBAL_SESSION, SCOPE_REQUEST, SCOPE_SESSION, SERVLET_CONTEXT_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

Constructors

Constructor and Description
StubWebApplicationContext(ServletContext servletContext)

Method Summary

Modifier and Type	Method and Description
void	addBean(java.lang.String name, java.lang.Object bean)
void	addBeans(java.util.List<?> beans)
boolean	containsBean(java.lang.String name) Does this bean factory contain a bean definition or externally registered singleton instance with the given name?
boolean	containsBeanDefinition(java.lang.String beanName) Check if this bean factory contains a bean definition with the given name.
boolean	containsLocalBean(java.lang.String name) Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.
<A extends java.lang.annotation.Annotation> A	findAnnotationOnBean(java.lang.String beanName, java.lang.Class<A> annotationType) Find an Annotation of annotationType on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.
java.lang.String[]	getAliases(java.lang.String name) Return the aliases for the given bean name, if any.
java.lang.String	getApplicationName() Return a name for the deployed application that this context belongs to.
AutowireCapableBeanFactory	getAutowireCapableBeanFactory() Returns an instance that can initialize ApplicationContextAware beans.
<T> T	getBean(java.lang.Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
<T> T	getBean(java.lang.Class<T> requiredType, java.lang.Object... args) Return an instance, which may be shared or independent, of the specified bean.
java.lang.Object	getBean(java.lang.String name) Return an instance, which may be shared or independent, of the specified bean.
<T> T	getBean(java.lang.String name, java.lang.Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
java.lang.Object	getBean(java.lang.String name, java.lang.Object... args) Return an instance, which may be shared or independent, of the specified bean.
int	getBeanDefinitionCount() Return the number of beans defined in the factory.
java.lang.String[]	getBeanDefinitionNames() Return the names of all beans defined in this factory.
java.lang.String[]	getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Find all names of beans whose Class has the supplied Annotation type, without creating any bean instances yet.
java.lang.String[]	getBeanNamesForType(java.lang.Class<?> type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.
java.lang.String[]	getBeanNamesForType(java.lang.Class<?> type, boolean includeNonSingletons, boolean allowEagerInit) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.
java.lang.String[]	getBeanNamesForType(ResolvableType type) Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.
<T> java.util.Map<java.lang.String,T>	getBeansOfType(java.lang.Class<T> type) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.
<T> java.util.Map<java.lang.String,T>	getBeansOfType(java.lang.Class<T> type, boolean includeNonSingletons, boolean allowEagerInit) Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.
java.util.Map<java.lang.String,java.lang.Object>	getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType) Find all beans whose Class has the supplied Annotation type, returning a Map of bean names with corresponding bean instances.
java.lang.ClassLoader	getClassLoader() Expose the ClassLoader used by this ResourceLoader.
java.lang.String	getDisplayName() Return a friendly name for this context.
Environment	getEnvironment() Return the Environment associated with this component.
java.lang.String	getId() Return the unique id of this application context.
java.lang.String	getMessage(MessageSourceResolvable resolvable, java.util.Locale locale) Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.util.Locale locale) Try to resolve the message.
java.lang.String	getMessage(java.lang.String code, java.lang.Object[] args, java.lang.String defaultMessage, java.util.Locale locale) Try to resolve the message.
ApplicationContext	getParent() Return the parent context, or null if there is no parent and this is the root of the context hierarchy.
BeanFactory	getParentBeanFactory() Return the parent bean factory, or null if there is none.
Resource	getResource(java.lang.String location) Return a Resource handle for the specified resource.
Resource[]	getResources(java.lang.String locationPattern) Resolve the given location pattern into Resource objects.
ServletContext	getServletContext() Return the standard Servlet API ServletContext for this application.
long	getStartupDate() Return the timestamp when this context was first loaded.
java.lang.Class<?>	getType(java.lang.String name) Determine the type of the bean with the given name.
boolean	isPrototype(java.lang.String name) Is this bean a prototype? That is, will BeanFactory.getBean(java.lang.String) always return independent instances?
boolean	isSingleton(java.lang.String name) Is this bean a shared singleton? That is, will BeanFactory.getBean(java.lang.String) always return the same instance?
boolean	isTypeMatch(java.lang.String name, java.lang.Class<?> typeToMatch) Check whether the bean with the given name matches the specified type.
boolean	isTypeMatch(java.lang.String name, ResolvableType typeToMatch) Check whether the bean with the given name matches the specified type.
void	publishEvent(ApplicationEvent event) Notify all matching listeners registered with this application of an application event.
void	publishEvent(java.lang.Object event) Notify all matching listeners registered with this application of an event.

Methods inherited from class java.lang.Object

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

Field Detail

servletContext

private final ServletContext servletContext

beanFactory

private final StubWebApplicationContext.StubBeanFactory beanFactory

id

private final java.lang.String id

displayName

private final java.lang.String displayName

startupDate

private final long startupDate

environment

private final Environment environment

messageSource

private final MessageSource messageSource

resourcePatternResolver

private final ResourcePatternResolver resourcePatternResolver

Constructor Detail

StubWebApplicationContext

public StubWebApplicationContext(ServletContext servletContext)

Method Detail

getAutowireCapableBeanFactory

public AutowireCapableBeanFactory getAutowireCapableBeanFactory()
                                                         throws java.lang.IllegalStateException

Returns an instance that can initialize ApplicationContextAware beans.

Specified by:

getAutowireCapableBeanFactory in interface ApplicationContext

Returns:

the AutowireCapableBeanFactory for this context

Throws:

java.lang.IllegalStateException - if the context does not support the AutowireCapableBeanFactory interface, or does not hold an autowire-capable bean factory yet (e.g. if refresh() has never been called), or if the context has been closed already

See Also:

ConfigurableApplicationContext.refresh(), ConfigurableApplicationContext.getBeanFactory()

getServletContext

public ServletContext getServletContext()

Description copied from interface: WebApplicationContext

Return the standard Servlet API ServletContext for this application.

Also available for a Portlet application, in addition to the PortletContext.

Specified by:

getServletContext in interface WebApplicationContext

getId

public java.lang.String getId()

Description copied from interface: ApplicationContext

Return the unique id of this application context.

Specified by:

getId in interface ApplicationContext

Returns:

the unique id of the context, or null if none

getApplicationName

public java.lang.String getApplicationName()

Description copied from interface: ApplicationContext

Return a name for the deployed application that this context belongs to.

Specified by:

getApplicationName in interface ApplicationContext

Returns:

a name for the deployed application, or the empty String by default

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: ApplicationContext

Return a friendly name for this context.

Specified by:

getDisplayName in interface ApplicationContext

Returns:

a display name for this context (never null)

getStartupDate

public long getStartupDate()

Description copied from interface: ApplicationContext

Return the timestamp when this context was first loaded.

Specified by:

getStartupDate in interface ApplicationContext

Returns:

the timestamp (ms) when this context was first loaded

getParent

public ApplicationContext getParent()

Description copied from interface: ApplicationContext

Return the parent context, or null if there is no parent and this is the root of the context hierarchy.

Specified by:

getParent in interface ApplicationContext

Returns:

the parent context, or null if there is no parent

getEnvironment

public Environment getEnvironment()

Description copied from interface: EnvironmentCapable

Return the Environment associated with this component.

Specified by:

getEnvironment in interface EnvironmentCapable

addBean

public void addBean(java.lang.String name,
                    java.lang.Object bean)

addBeans

public void addBeans(java.util.List<?> beans)

getBean

public java.lang.Object getBean(java.lang.String name)
                         throws BeansException

Description copied from interface: BeanFactory

Return an instance, which may be shared or independent, of the specified bean.

This method allows a Spring BeanFactory to be used as a replacement for the Singleton or Prototype design pattern. Callers may retain references to returned objects in the case of Singleton beans.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

getBean in interface BeanFactory

Parameters:

name - the name of the bean to retrieve

Returns:

an instance of the bean

Throws:

NoSuchBeanDefinitionException - if there is no bean definition with the specified name

BeansException - if the bean could not be obtained

getBean

public <T> T getBean(java.lang.String name,
                     java.lang.Class<T> requiredType)
              throws BeansException

Description copied from interface: BeanFactory

Return an instance, which may be shared or independent, of the specified bean.

Behaves the same as BeanFactory.getBean(String), but provides a measure of type safety by throwing a BeanNotOfRequiredTypeException if the bean is not of the required type. This means that ClassCastException can't be thrown on casting the result correctly, as can happen with BeanFactory.getBean(String).

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

getBean in interface BeanFactory

Parameters:

name - the name of the bean to retrieve

requiredType - type the bean must match. Can be an interface or superclass of the actual class, or null for any match. For example, if the value is Object.class, this method will succeed whatever the class of the returned instance.

Returns:

an instance of the bean

Throws:

NoSuchBeanDefinitionException - if there is no such bean definition

BeanNotOfRequiredTypeException - if the bean is not of the required type

BeansException - if the bean could not be created

getBean

public <T> T getBean(java.lang.Class<T> requiredType)
              throws BeansException

Description copied from interface: BeanFactory

Return the bean instance that uniquely matches the given object type, if any.

Specified by:

getBean in interface BeanFactory

Parameters:

requiredType - type the bean must match; can be an interface or superclass. null is disallowed.

This method goes into ListableBeanFactory by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, use ListableBeanFactory and/or BeanFactoryUtils.

Returns:

an instance of the single bean matching the required type

Throws:

NoSuchBeanDefinitionException - if no bean of the given type was found

NoUniqueBeanDefinitionException - if more than one bean of the given type was found

BeansException - if the bean could not be created

See Also:

ListableBeanFactory

getBean

public java.lang.Object getBean(java.lang.String name,
                                java.lang.Object... args)
                         throws BeansException

Description copied from interface: BeanFactory

Return an instance, which may be shared or independent, of the specified bean.

Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

Specified by:

getBean in interface BeanFactory

Parameters:

name - the name of the bean to retrieve

args - arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)

Returns:

an instance of the bean

Throws:

NoSuchBeanDefinitionException - if there is no such bean definition

BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype

BeansException - if the bean could not be created

getBean

public <T> T getBean(java.lang.Class<T> requiredType,
                     java.lang.Object... args)
              throws BeansException

Description copied from interface: BeanFactory

Return an instance, which may be shared or independent, of the specified bean.

Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.

Specified by:

getBean in interface BeanFactory

Parameters:

requiredType - type the bean must match; can be an interface or superclass. null is disallowed.

This method goes into ListableBeanFactory by-type lookup territory but may also be translated into a conventional by-name lookup based on the name of the given type. For more extensive retrieval operations across sets of beans, use ListableBeanFactory and/or BeanFactoryUtils.

args - arguments to use when creating a bean instance using explicit arguments (only applied when creating a new instance as opposed to retrieving an existing one)

Returns:

an instance of the bean

Throws:

NoSuchBeanDefinitionException - if there is no such bean definition

BeanDefinitionStoreException - if arguments have been given but the affected bean isn't a prototype

BeansException - if the bean could not be created

containsBean

public boolean containsBean(java.lang.String name)

Description copied from interface: BeanFactory

Does this bean factory contain a bean definition or externally registered singleton instance with the given name?

If the given name is an alias, it will be translated back to the corresponding canonical bean name.

If this factory is hierarchical, will ask any parent factory if the bean cannot be found in this factory instance.

If a bean definition or singleton instance matching the given name is found, this method will return true whether the named bean definition is concrete or abstract, lazy or eager, in scope or not. Therefore, note that a true return value from this method does not necessarily indicate that BeanFactory.getBean(java.lang.String) will be able to obtain an instance for the same name.

Specified by:

containsBean in interface BeanFactory

Parameters:

name - the name of the bean to query

Returns:

whether a bean with the given name is present

isSingleton

public boolean isSingleton(java.lang.String name)
                    throws NoSuchBeanDefinitionException

Description copied from interface: BeanFactory

Is this bean a shared singleton? That is, will BeanFactory.getBean(java.lang.String) always return the same instance?

Note: This method returning false does not clearly indicate independent instances. It indicates non-singleton instances, which may correspond to a scoped bean as well. Use the BeanFactory.isPrototype(java.lang.String) operation to explicitly check for independent instances.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

isSingleton in interface BeanFactory

Parameters:

name - the name of the bean to query

Returns:

whether this bean corresponds to a singleton instance

Throws:

NoSuchBeanDefinitionException - if there is no bean with the given name

See Also:

BeanFactory.getBean(java.lang.String), BeanFactory.isPrototype(java.lang.String)

isPrototype

public boolean isPrototype(java.lang.String name)
                    throws NoSuchBeanDefinitionException

Description copied from interface: BeanFactory

Is this bean a prototype? That is, will BeanFactory.getBean(java.lang.String) always return independent instances?

Note: This method returning false does not clearly indicate a singleton object. It indicates non-independent instances, which may correspond to a scoped bean as well. Use the BeanFactory.isSingleton(java.lang.String) operation to explicitly check for a shared singleton instance.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

isPrototype in interface BeanFactory

Parameters:

name - the name of the bean to query

Returns:

whether this bean will always deliver independent instances

Throws:

NoSuchBeanDefinitionException - if there is no bean with the given name

See Also:

BeanFactory.getBean(java.lang.String), BeanFactory.isSingleton(java.lang.String)

isTypeMatch

public boolean isTypeMatch(java.lang.String name,
                           ResolvableType typeToMatch)
                    throws NoSuchBeanDefinitionException

Description copied from interface: BeanFactory

Check whether the bean with the given name matches the specified type. More specifically, check whether a BeanFactory.getBean(java.lang.String) call for the given name would return an object that is assignable to the specified target type.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

isTypeMatch in interface BeanFactory

Parameters:

name - the name of the bean to query

typeToMatch - the type to match against (as a ResolvableType)

Returns:

true if the bean type matches, false if it doesn't match or cannot be determined yet

Throws:

NoSuchBeanDefinitionException - if there is no bean with the given name

See Also:

BeanFactory.getBean(java.lang.String), BeanFactory.getType(java.lang.String)

isTypeMatch

public boolean isTypeMatch(java.lang.String name,
                           java.lang.Class<?> typeToMatch)
                    throws NoSuchBeanDefinitionException

Description copied from interface: BeanFactory

Check whether the bean with the given name matches the specified type. More specifically, check whether a BeanFactory.getBean(java.lang.String) call for the given name would return an object that is assignable to the specified target type.

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

isTypeMatch in interface BeanFactory

Parameters:

name - the name of the bean to query

typeToMatch - the type to match against (as a Class)

Returns:

true if the bean type matches, false if it doesn't match or cannot be determined yet

Throws:

NoSuchBeanDefinitionException - if there is no bean with the given name

See Also:

BeanFactory.getBean(java.lang.String), BeanFactory.getType(java.lang.String)

getType

public java.lang.Class<?> getType(java.lang.String name)
                           throws NoSuchBeanDefinitionException

Description copied from interface: BeanFactory

Determine the type of the bean with the given name. More specifically, determine the type of object that BeanFactory.getBean(java.lang.String) would return for the given name.

For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by FactoryBean.getObjectType().

Translates aliases back to the corresponding canonical bean name. Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

getType in interface BeanFactory

Parameters:

name - the name of the bean to query

Returns:

the type of the bean, or null if not determinable

Throws:

NoSuchBeanDefinitionException - if there is no bean with the given name

See Also:

BeanFactory.getBean(java.lang.String), BeanFactory.isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)

getAliases

public java.lang.String[] getAliases(java.lang.String name)

Description copied from interface: BeanFactory

Return the aliases for the given bean name, if any. All of those aliases point to the same bean when used in a BeanFactory.getBean(java.lang.String) call.

If the given name is an alias, the corresponding original bean name and other aliases (if any) will be returned, with the original bean name being the first element in the array.

Will ask the parent factory if the bean cannot be found in this factory instance.

Specified by:

getAliases in interface BeanFactory

Parameters:

name - the bean name to check for aliases

Returns:

the aliases, or an empty array if none

See Also:

BeanFactory.getBean(java.lang.String)

containsBeanDefinition

public boolean containsBeanDefinition(java.lang.String beanName)

Description copied from interface: ListableBeanFactory

Check if this bean factory contains a bean definition with the given name.

Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.

Specified by:

containsBeanDefinition in interface ListableBeanFactory

Parameters:

beanName - the name of the bean to look for

Returns:

if this bean factory contains a bean definition with the given name

See Also:

BeanFactory.containsBean(java.lang.String)

getBeanDefinitionCount

public int getBeanDefinitionCount()

Description copied from interface: ListableBeanFactory

Return the number of beans defined in the factory.

Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.

Specified by:

getBeanDefinitionCount in interface ListableBeanFactory

Returns:

the number of beans defined in the factory

getBeanDefinitionNames

public java.lang.String[] getBeanDefinitionNames()

Description copied from interface: ListableBeanFactory

Return the names of all beans defined in this factory.

Does not consider any hierarchy this factory may participate in, and ignores any singleton beans that have been registered by other means than bean definitions.

Specified by:

getBeanDefinitionNames in interface ListableBeanFactory

Returns:

the names of all beans defined in this factory, or an empty array if none defined

getBeanNamesForType

public java.lang.String[] getBeanNamesForType(ResolvableType type)

Description copied from interface: ListableBeanFactory

Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.

Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

This version of getBeanNamesForType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for getBeanNamesForType(type, true, true).

Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

Specified by:

getBeanNamesForType in interface ListableBeanFactory

Parameters:

type - the class or interface to match, or null for all bean names

Returns:

the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, ResolvableType)

getBeanNamesForType

public java.lang.String[] getBeanNamesForType(java.lang.Class<?> type)

Description copied from interface: ListableBeanFactory

Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.

Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

This version of getBeanNamesForType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for getBeanNamesForType(type, true, true).

Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

Specified by:

getBeanNamesForType in interface ListableBeanFactory

Parameters:

type - the class or interface to match, or null for all bean names

Returns:

the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class)

getBeanNamesForType

public java.lang.String[] getBeanNamesForType(java.lang.Class<?> type,
                                              boolean includeNonSingletons,
                                              boolean allowEagerInit)

Description copied from interface: ListableBeanFactory

Return the names of beans matching the given type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).

Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beanNamesForTypeIncludingAncestors to include beans in ancestor factories too.

Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

Bean names returned by this method should always return bean names in the order of definition in the backend configuration, as far as possible.

Specified by:

getBeanNamesForType in interface ListableBeanFactory

Parameters:

type - the class or interface to match, or null for all bean names

includeNonSingletons - whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)

allowEagerInit - whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.

Returns:

the names of beans (or objects created by FactoryBeans) matching the given object type (including subclasses), or an empty array if none

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)

getBeansOfType

public <T> java.util.Map<java.lang.String,T> getBeansOfType(java.lang.Class<T> type)
                                                     throws BeansException

Description copied from interface: ListableBeanFactory

Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

Does consider objects created by FactoryBeans, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type.

Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beansOfTypeIncludingAncestors to include beans in ancestor factories too.

Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

This version of getBeansOfType matches all kinds of beans, be it singletons, prototypes, or FactoryBeans. In most implementations, the result will be the same as for getBeansOfType(type, true, true).

The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.

Specified by:

getBeansOfType in interface ListableBeanFactory

Parameters:

type - the class or interface to match, or null for all concrete beans

Returns:

a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values

Throws:

BeansException - if a bean could not be created

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class)

getBeansOfType

public <T> java.util.Map<java.lang.String,T> getBeansOfType(java.lang.Class<T> type,
                                                            boolean includeNonSingletons,
                                                            boolean allowEagerInit)
                                                     throws BeansException

Description copied from interface: ListableBeanFactory

Return the bean instances that match the given object type (including subclasses), judging from either bean definitions or the value of getObjectType in the case of FactoryBeans.

NOTE: This method introspects top-level beans only. It does not check nested beans which might match the specified type as well.

Does consider objects created by FactoryBeans if the "allowEagerInit" flag is set, which means that FactoryBeans will get initialized. If the object created by the FactoryBean doesn't match, the raw FactoryBean itself will be matched against the type. If "allowEagerInit" is not set, only raw FactoryBeans will be checked (which doesn't require initialization of each FactoryBean).

Does not consider any hierarchy this factory may participate in. Use BeanFactoryUtils' beansOfTypeIncludingAncestors to include beans in ancestor factories too.

Note: Does not ignore singleton beans that have been registered by other means than bean definitions.

The Map returned by this method should always return bean names and corresponding bean instances in the order of definition in the backend configuration, as far as possible.

Specified by:

getBeansOfType in interface ListableBeanFactory

Parameters:

type - the class or interface to match, or null for all concrete beans

includeNonSingletons - whether to include prototype or scoped beans too or just singletons (also applies to FactoryBeans)

allowEagerInit - whether to initialize lazy-init singletons and objects created by FactoryBeans (or by factory methods with a "factory-bean" reference) for the type check. Note that FactoryBeans need to be eagerly initialized to determine their type: So be aware that passing in "true" for this flag will initialize FactoryBeans and "factory-bean" references.

Returns:

a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values

Throws:

BeansException - if a bean could not be created

See Also:

FactoryBean.getObjectType(), BeanFactoryUtils.beansOfTypeIncludingAncestors(ListableBeanFactory, Class, boolean, boolean)

getBeanNamesForAnnotation

public java.lang.String[] getBeanNamesForAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)

Description copied from interface: ListableBeanFactory

Find all names of beans whose Class has the supplied Annotation type, without creating any bean instances yet.

Specified by:

getBeanNamesForAnnotation in interface ListableBeanFactory

Parameters:

annotationType - the type of annotation to look for

Returns:

the names of all matching beans

getBeansWithAnnotation

public java.util.Map<java.lang.String,java.lang.Object> getBeansWithAnnotation(java.lang.Class<? extends java.lang.annotation.Annotation> annotationType)
                                                                        throws BeansException

Description copied from interface: ListableBeanFactory

Find all beans whose Class has the supplied Annotation type, returning a Map of bean names with corresponding bean instances.

Specified by:

getBeansWithAnnotation in interface ListableBeanFactory

Parameters:

annotationType - the type of annotation to look for

Returns:

a Map with the matching beans, containing the bean names as keys and the corresponding bean instances as values

Throws:

BeansException - if a bean could not be created

findAnnotationOnBean

public <A extends java.lang.annotation.Annotation> A findAnnotationOnBean(java.lang.String beanName,
                                                                          java.lang.Class<A> annotationType)
                                                                   throws NoSuchBeanDefinitionException

Description copied from interface: ListableBeanFactory

Find an Annotation of annotationType on the specified bean, traversing its interfaces and super classes if no annotation can be found on the given class itself.

Specified by:

findAnnotationOnBean in interface ListableBeanFactory

Parameters:

beanName - the name of the bean to look for annotations on

annotationType - the annotation class to look for

Returns:

the annotation of the given type if found, or null

Throws:

NoSuchBeanDefinitionException - if there is no bean with the given name

getParentBeanFactory

public BeanFactory getParentBeanFactory()

Description copied from interface: HierarchicalBeanFactory

Return the parent bean factory, or null if there is none.

Specified by:

getParentBeanFactory in interface HierarchicalBeanFactory

containsLocalBean

public boolean containsLocalBean(java.lang.String name)

Description copied from interface: HierarchicalBeanFactory

Return whether the local bean factory contains a bean of the given name, ignoring beans defined in ancestor contexts.

This is an alternative to containsBean, ignoring a bean of the given name from an ancestor bean factory.

Specified by:

containsLocalBean in interface HierarchicalBeanFactory

Parameters:

name - the name of the bean to query

Returns:

whether a bean with the given name is defined in the local factory

See Also:

BeanFactory.containsBean(java.lang.String)

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   java.lang.Object[] args,
                                   java.lang.String defaultMessage,
                                   java.util.Locale locale)

Description copied from interface: MessageSource

Try to resolve the message. Return default message if no message was found.

Specified by:

getMessage in interface MessageSource

Parameters:

code - the code to lookup up, such as 'calculator.noRateSet'. Users of this class are encouraged to base message names on the relevant fully qualified class name, thus avoiding conflict and ensuring maximum clarity.

args - array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), or null if none.

defaultMessage - String to return if the lookup fails

locale - the Locale in which to do the lookup

Returns:

the resolved message if the lookup was successful; otherwise the default message passed as a parameter

See Also:

MessageFormat

getMessage

public java.lang.String getMessage(java.lang.String code,
                                   java.lang.Object[] args,
                                   java.util.Locale locale)
                            throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message. Treat as an error if the message can't be found.

Specified by:

getMessage in interface MessageSource

Parameters:

code - the code to lookup up, such as 'calculator.noRateSet'

args - Array of arguments that will be filled in for params within the message (params look like "{0}", "{1,date}", "{2,time}" within a message), or null if none.

locale - the Locale in which to do the lookup

Returns:

the resolved message

Throws:

NoSuchMessageException - if the message wasn't found

See Also:

MessageFormat

getMessage

public java.lang.String getMessage(MessageSourceResolvable resolvable,
                                   java.util.Locale locale)
                            throws NoSuchMessageException

Description copied from interface: MessageSource

Try to resolve the message using all the attributes contained within the MessageSourceResolvable argument that was passed in.

NOTE: We must throw a NoSuchMessageException on this method since at the time of calling this method we aren't able to determine if the defaultMessage property of the resolvable is null or not.

Specified by:

getMessage in interface MessageSource

Parameters:

resolvable - value object storing attributes required to properly resolve a message

locale - the Locale in which to do the lookup

Returns:

the resolved message

Throws:

NoSuchMessageException - if the message wasn't found

See Also:

MessageFormat

getClassLoader

public java.lang.ClassLoader getClassLoader()

Description copied from interface: ResourceLoader

Expose the ClassLoader used by this ResourceLoader.

Clients which need to access the ClassLoader directly can do so in a uniform manner with the ResourceLoader, rather than relying on the thread context ClassLoader.

Specified by:

getClassLoader in interface ResourceLoader

Returns:

the ClassLoader (only null if even the system ClassLoader isn't accessible)

See Also:

ClassUtils.getDefaultClassLoader()

getResource

public Resource getResource(java.lang.String location)

Description copied from interface: ResourceLoader

Return a Resource handle for the specified resource. The handle should always be a reusable resource descriptor, allowing for multiple InputStreamSource.getInputStream() calls.

• Must support fully qualified URLs, e.g. "file:C:/test.dat".
• Must support classpath pseudo-URLs, e.g. "classpath:test.dat".
• Should support relative file paths, e.g. "WEB-INF/test.dat". (This will be implementation-specific, typically provided by an ApplicationContext implementation.)

Note that a Resource handle does not imply an existing resource; you need to invoke Resource.exists() to check for existence.

Specified by:

getResource in interface ResourceLoader

Parameters:

location - the resource location

Returns:

a corresponding Resource handle

See Also:

ResourceLoader.CLASSPATH_URL_PREFIX, Resource.exists(), InputStreamSource.getInputStream()

publishEvent

public void publishEvent(ApplicationEvent event)

Description copied from interface: ApplicationEventPublisher

Notify all matching listeners registered with this application of an application event. Events may be framework events (such as RequestHandledEvent) or application-specific events.

Specified by:

publishEvent in interface ApplicationEventPublisher

Parameters:

event - the event to publish

See Also:

RequestHandledEvent

publishEvent

public void publishEvent(java.lang.Object event)

Description copied from interface: ApplicationEventPublisher

Notify all matching listeners registered with this application of an event.

If the specified event is not an ApplicationEvent, it is wrapped in a PayloadApplicationEvent.

Specified by:

publishEvent in interface ApplicationEventPublisher

Parameters:

event - the event to publish

See Also:

PayloadApplicationEvent

getResources

public Resource[] getResources(java.lang.String locationPattern)
                        throws java.io.IOException

Description copied from interface: ResourcePatternResolver

Resolve the given location pattern into Resource objects.

Overlapping resource entries that point to the same physical resource should be avoided, as far as possible. The result should have set semantics.

Specified by:

getResources in interface ResourcePatternResolver

Parameters:

locationPattern - the location pattern to resolve

Returns:

the corresponding Resource objects

Throws:

java.io.IOException - in case of I/O errors