org.springframework.jndi.support

Class SimpleJndiBeanFactory

java.lang.Object

org.springframework.jndi.JndiAccessor

org.springframework.jndi.JndiLocatorSupport

org.springframework.jndi.support.SimpleJndiBeanFactory

All Implemented Interfaces:

BeanFactory

public class SimpleJndiBeanFactory
extends JndiLocatorSupport
implements BeanFactory

Simple JNDI-based implementation of Spring's BeanFactory interface. Does not support enumerating bean definitions, hence doesn't implement the ListableBeanFactory interface.

This factory resolves given bean names as JNDI names within the Java EE application's "java:comp/env/" namespace. It caches the resolved types for all obtained objects, and optionally also caches shareable objects (if they are explicitly marked as shareable resource).

The main intent of this factory is usage in combination with Spring's CommonAnnotationBeanPostProcessor, configured as "resourceFactory" for resolving @Resource annotations as JNDI objects without intermediate bean definitions. It may be used for similar lookup scenarios as well, of course, in particular if BeanFactory-style type checking is required.

Since:

2.5

Author:

Juergen Hoeller

See Also:

DefaultListableBeanFactory, CommonAnnotationBeanPostProcessor

Field Summary

Fields inherited from class org.springframework.jndi.JndiLocatorSupport

CONTAINER_PREFIX

Fields inherited from class org.springframework.jndi.JndiAccessor

logger

Fields inherited from interface org.springframework.beans.factory.BeanFactory

FACTORY_BEAN_PREFIX

Constructor Summary

Constructors

Constructor and Description
SimpleJndiBeanFactory()

Method Summary

Modifier and Type	Method and Description
void	addShareableResource(String shareableResource) Add the name of a shareable JNDI resource, which this factory is allowed to cache once obtained.
boolean	containsBean(String name) Does this bean factory contain a bean definition or externally registered singleton instance with the given name?
String[]	getAliases(String name) Return the aliases for the given bean name, if any.
<T> T	getBean(Class<T> requiredType) Return the bean instance that uniquely matches the given object type, if any.
<T> T	getBean(Class<T> requiredType, Object... args) Return an instance, which may be shared or independent, of the specified bean.
Object	getBean(String name) Return an instance, which may be shared or independent, of the specified bean.
<T> T	getBean(String name, Class<T> requiredType) Return an instance, which may be shared or independent, of the specified bean.
Object	getBean(String name, Object... args) Return an instance, which may be shared or independent, of the specified bean.
<T> ObjectProvider<T>	getBeanProvider(Class<T> requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
<T> ObjectProvider<T>	getBeanProvider(ResolvableType requiredType) Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.
Class<?>	getType(String name) Determine the type of the bean with the given name.
Class<?>	getType(String name, boolean allowFactoryBeanInit) Determine the type of the bean with the given name.
boolean	isPrototype(String name) Is this bean a prototype? That is, will BeanFactory.getBean(java.lang.String) always return independent instances?
boolean	isSingleton(String name) Is this bean a shared singleton? That is, will BeanFactory.getBean(java.lang.String) always return the same instance?
boolean	isTypeMatch(String name, Class<?> typeToMatch) Check whether the bean with the given name matches the specified type.
boolean	isTypeMatch(String name, ResolvableType typeToMatch) Check whether the bean with the given name matches the specified type.
void	setShareableResources(String... shareableResources) Set a list of names of shareable JNDI resources, which this factory is allowed to cache once obtained.

Methods inherited from class org.springframework.jndi.JndiLocatorSupport

convertJndiName, isResourceRef, lookup, lookup, setResourceRef

Methods inherited from class org.springframework.jndi.JndiAccessor

getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleJndiBeanFactory

public SimpleJndiBeanFactory()

Method Detail

addShareableResource

public void addShareableResource(String shareableResource)

Add the name of a shareable JNDI resource, which this factory is allowed to cache once obtained.

Parameters:

shareableResource - the JNDI name (typically within the "java:comp/env/" namespace)

setShareableResources

public void setShareableResources(String... shareableResources)

Set a list of names of shareable JNDI resources, which this factory is allowed to cache once obtained.

Parameters:

shareableResources - the JNDI names (typically within the "java:comp/env/" namespace)

getBean

public Object getBean(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. Note that the return value will never be null but possibly a stub for null returned from a factory method, to be checked via equals(null). Consider using BeanFactory.getBeanProvider(Class) for resolving optional dependencies.

Throws:

NoSuchBeanDefinitionException - if there is no bean with the specified name

BeansException - if the bean could not be obtained

getBean

public <T> T getBean(String name,
                     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

Returns:

an instance of the bean. Note that the return value will never be null. In case of a stub for null from a factory method having been resolved for the requested bean, a BeanNotOfRequiredTypeException against the NullBean stub will be raised. Consider using BeanFactory.getBeanProvider(Class) for resolving optional dependencies.

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 Object getBean(String name,
                      @Nullable
                      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(Class<T> requiredType)
              throws BeansException

Description copied from interface: BeanFactory

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

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.

Specified by:

getBean in interface BeanFactory

Parameters:

requiredType - type the bean must match; can be an interface or superclass

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 <T> T getBean(Class<T> requiredType,
                     @Nullable
                     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.

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.

Specified by:

getBean in interface BeanFactory

Parameters:

requiredType - type the bean must match; can be an interface or superclass

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

getBeanProvider

public <T> ObjectProvider<T> getBeanProvider(Class<T> requiredType)

Description copied from interface: BeanFactory

Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options.

For matching a generic type, consider BeanFactory.getBeanProvider(ResolvableType).

Specified by:

getBeanProvider in interface BeanFactory

Parameters:

requiredType - type the bean must match; can be an interface or superclass

Returns:

a corresponding provider handle

See Also:

BeanFactory.getBeanProvider(ResolvableType)

getBeanProvider

public <T> ObjectProvider<T> getBeanProvider(ResolvableType requiredType)

Description copied from interface: BeanFactory

Return a provider for the specified bean, allowing for lazy on-demand retrieval of instances, including availability and uniqueness options. This variant allows for specifying a generic type to match, similar to reflective injection points with generic type declarations in method/constructor parameters.

Note that collections of beans are not supported here, in contrast to reflective injection points. For programmatically retrieving a list of beans matching a specific type, specify the actual bean type as an argument here and subsequently use ObjectProvider.orderedStream() or its lazy streaming/iteration options.

Also, generics matching is strict here, as per the Java assignment rules. For lenient fallback matching with unchecked semantics (similar to the 'unchecked' Java compiler warning), consider calling BeanFactory.getBeanProvider(Class) with the raw type as a second step if no full generic match is available with this variant.

Specified by:

getBeanProvider in interface BeanFactory

Parameters:

requiredType - type the bean must match; can be a generic type declaration

Returns:

a corresponding provider handle

See Also:

ObjectProvider.iterator(), ObjectProvider.stream(), ObjectProvider.orderedStream()

containsBean

public boolean containsBean(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(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(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(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(String name,
                           @Nullable
                           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

@Nullable
public Class<?> getType(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(). This may lead to the initialization of a previously uninitialized FactoryBean (see BeanFactory.getType(String, boolean)).

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)

getType

@Nullable
public Class<?> getType(String name,
                                  boolean allowFactoryBeanInit)
                           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(). Depending on the allowFactoryBeanInit flag, this may lead to the initialization of a previously uninitialized FactoryBean if no early type information is available.

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

allowFactoryBeanInit - whether a FactoryBean may get initialized just for the purpose of determining its object type

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 String[] getAliases(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)