public class

SimpleJndiBeanFactory

extends JndiLocatorSupport
implements BeanFactory
java.lang.Object
   ↳ org.springframework.jndi.JndiAccessor
     ↳ org.springframework.jndi.JndiLocatorSupport
       ↳ org.springframework.jndi.support.SimpleJndiBeanFactory

Class Overview

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 J2EE 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.

See Also

Summary

[Expand]
Inherited Constants
From class org.springframework.jndi.JndiLocatorSupport
From interface org.springframework.beans.factory.BeanFactory
[Expand]
Inherited Fields
From class org.springframework.jndi.JndiAccessor
Public Constructors
SimpleJndiBeanFactory()
Public Methods
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 with the given name? More specifically, is getBean(Class) able to obtain a bean instance for the given name?

Translates aliases back to the corresponding canonical bean name.

String[] getAliases(String name)
Return the aliases for the given bean name, if any.
Object getBean(String name)
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> T getBean(Class<T> requiredType)
Return the bean instance that uniquely matches the given object type, if any.
<T> T getBean(String name, Class<T> requiredType)
Return an instance, which may be shared or independent, of the specified bean.
Class<?> getType(String name)
Determine the type of the bean with the given name.
boolean isPrototype(String name)
Is this bean a prototype? That is, will getBean(Class) always return independent instances?

Note: This method returning false does not clearly indicate a singleton object.

boolean isSingleton(String name)
Is this bean a shared singleton? That is, will getBean(Class) always return the same instance?

Note: This method returning false does not clearly indicate independent instances.

boolean isTypeMatch(String name, Class targetType)
void setShareableResources(String[] shareableResources)
Set a list of names of shareable JNDI resources, which this factory is allowed to cache once obtained.
[Expand]
Inherited Methods
From class org.springframework.jndi.JndiLocatorSupport
From class org.springframework.jndi.JndiAccessor
From class java.lang.Object
From interface org.springframework.beans.factory.BeanFactory

Public Constructors

public SimpleJndiBeanFactory ()

Public Methods

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)

public boolean containsBean (String name)

Does this bean factory contain a bean with the given name? More specifically, is getBean(Class) able to obtain a bean instance for the given name?

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

Parameters
name the name of the bean to query
Returns
  • whether a bean with the given name is defined

public String[] getAliases (String name)

Return the aliases for the given bean name, if any. All of those aliases point to the same bean when used in a getBean(Class) 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.

Parameters
name the bean name to check for aliases
Returns
  • the aliases, or an empty array if none

public Object getBean (String name)

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.

Parameters
name the name of the bean to retrieve
Returns
  • an instance of the bean
Throws
BeansException

public Object getBean (String name, Object... args)

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.

Parameters
name the name of the bean to retrieve
args arguments to use if creating a prototype using explicit arguments to a static factory method. It is invalid to use a non-null args value in any other case.
Returns
  • an instance of the bean
Throws
BeansException

public T getBean (Class<T> requiredType)

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

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
BeansException

public T getBean (String name, Class<T> requiredType)

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

Behaves the same as 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 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.

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
BeansException

public Class<?> getType (String name)

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

For a FactoryBean, return the type of object that the FactoryBean creates, as exposed by 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.

Parameters
name the name of the bean to query
Returns
  • the type of the bean, or null if not determinable
Throws
NoSuchBeanDefinitionException

public boolean isPrototype (String name)

Is this bean a prototype? That is, will getBean(Class) 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 isSingleton(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.

Parameters
name the name of the bean to query
Returns
  • whether this bean will always deliver independent instances
Throws
NoSuchBeanDefinitionException

public boolean isSingleton (String name)

Is this bean a shared singleton? That is, will getBean(Class) 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 isPrototype(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.

Parameters
name the name of the bean to query
Returns
  • whether this bean corresponds to a singleton instance
Throws
NoSuchBeanDefinitionException

public boolean isTypeMatch (String name, Class targetType)

Throws
NoSuchBeanDefinitionException

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)