public class SimpleJndiBeanFactory extends JndiLocatorSupport implements BeanFactory
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.
DefaultListableBeanFactory
,
CommonAnnotationBeanPostProcessor
Modifier and Type | Field and Description |
---|---|
private java.util.Map<java.lang.String,java.lang.Class<?>> |
resourceTypes
Cache of the types of nonshareable resources: bean name --> bean type
|
private java.util.Set<java.lang.String> |
shareableResources
JNDI names of resources that are known to be shareable, i.e.
|
private java.util.Map<java.lang.String,java.lang.Object> |
singletonObjects
Cache of shareable singleton objects: bean name --> bean instance
|
CONTAINER_PREFIX
logger
FACTORY_BEAN_PREFIX
Constructor and Description |
---|
SimpleJndiBeanFactory() |
Modifier and Type | Method and Description |
---|---|
void |
addShareableResource(java.lang.String shareableResource)
Add the name of a shareable JNDI resource,
which this factory is allowed to cache once obtained.
|
boolean |
containsBean(java.lang.String name)
Does this bean factory contain a bean definition or externally registered singleton
instance with the given name?
|
private <T> T |
doGetSingleton(java.lang.String name,
java.lang.Class<T> requiredType) |
private java.lang.Class<?> |
doGetType(java.lang.String name) |
java.lang.String[] |
getAliases(java.lang.String name)
Return the aliases for the given bean name, if any.
|
<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.
|
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 |
setShareableResources(java.lang.String... shareableResources)
Set a list of names of shareable JNDI resources,
which this factory is allowed to cache once obtained.
|
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
private final java.util.Set<java.lang.String> shareableResources
private final java.util.Map<java.lang.String,java.lang.Object> singletonObjects
private final java.util.Map<java.lang.String,java.lang.Class<?>> resourceTypes
public void addShareableResource(java.lang.String shareableResource)
shareableResource
- the JNDI name
(typically within the "java:comp/env/" namespace)public void setShareableResources(java.lang.String... shareableResources)
shareableResources
- the JNDI names
(typically within the "java:comp/env/" namespace)public java.lang.Object getBean(java.lang.String name) throws BeansException
BeanFactory
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.
getBean
in interface BeanFactory
name
- the name of the bean to retrieveNoSuchBeanDefinitionException
- if there is no bean definition
with the specified nameBeansException
- if the bean could not be obtainedpublic <T> T getBean(java.lang.String name, java.lang.Class<T> requiredType) throws BeansException
BeanFactory
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.
getBean
in interface BeanFactory
name
- the name of the bean to retrieverequiredType
- 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.NoSuchBeanDefinitionException
- if there is no such bean definitionBeanNotOfRequiredTypeException
- if the bean is not of the required typeBeansException
- if the bean could not be createdpublic <T> T getBean(java.lang.Class<T> requiredType) throws BeansException
BeanFactory
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
.
getBean
in interface BeanFactory
requiredType
- type the bean must match; can be an interface or superclass.
null
is disallowed.NoSuchBeanDefinitionException
- if no bean of the given type was foundNoUniqueBeanDefinitionException
- if more than one bean of the given type was foundBeansException
- if the bean could not be createdListableBeanFactory
public java.lang.Object getBean(java.lang.String name, java.lang.Object... args) throws BeansException
BeanFactory
Allows for specifying explicit constructor arguments / factory method arguments, overriding the specified default arguments (if any) in the bean definition.
getBean
in interface BeanFactory
name
- the name of the bean to retrieveargs
- 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)NoSuchBeanDefinitionException
- if there is no such bean definitionBeanDefinitionStoreException
- if arguments have been given but
the affected bean isn't a prototypeBeansException
- if the bean could not be createdpublic <T> T getBean(java.lang.Class<T> requiredType, java.lang.Object... args) throws BeansException
BeanFactory
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
.
getBean
in interface BeanFactory
requiredType
- type the bean must match; can be an interface or superclass.
null
is disallowed.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)NoSuchBeanDefinitionException
- if there is no such bean definitionBeanDefinitionStoreException
- if arguments have been given but
the affected bean isn't a prototypeBeansException
- if the bean could not be createdpublic boolean containsBean(java.lang.String name)
BeanFactory
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.
containsBean
in interface BeanFactory
name
- the name of the bean to querypublic boolean isSingleton(java.lang.String name) throws NoSuchBeanDefinitionException
BeanFactory
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.
isSingleton
in interface BeanFactory
name
- the name of the bean to queryNoSuchBeanDefinitionException
- if there is no bean with the given nameBeanFactory.getBean(java.lang.String)
,
BeanFactory.isPrototype(java.lang.String)
public boolean isPrototype(java.lang.String name) throws NoSuchBeanDefinitionException
BeanFactory
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.
isPrototype
in interface BeanFactory
name
- the name of the bean to queryNoSuchBeanDefinitionException
- if there is no bean with the given nameBeanFactory.getBean(java.lang.String)
,
BeanFactory.isSingleton(java.lang.String)
public boolean isTypeMatch(java.lang.String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException
BeanFactory
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.
isTypeMatch
in interface BeanFactory
name
- the name of the bean to querytypeToMatch
- the type to match against (as a ResolvableType
)true
if the bean type matches,
false
if it doesn't match or cannot be determined yetNoSuchBeanDefinitionException
- if there is no bean with the given nameBeanFactory.getBean(java.lang.String)
,
BeanFactory.getType(java.lang.String)
public boolean isTypeMatch(java.lang.String name, java.lang.Class<?> typeToMatch) throws NoSuchBeanDefinitionException
BeanFactory
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.
isTypeMatch
in interface BeanFactory
name
- the name of the bean to querytypeToMatch
- the type to match against (as a Class
)true
if the bean type matches,
false
if it doesn't match or cannot be determined yetNoSuchBeanDefinitionException
- if there is no bean with the given nameBeanFactory.getBean(java.lang.String)
,
BeanFactory.getType(java.lang.String)
public java.lang.Class<?> getType(java.lang.String name) throws NoSuchBeanDefinitionException
BeanFactory
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.
getType
in interface BeanFactory
name
- the name of the bean to querynull
if not determinableNoSuchBeanDefinitionException
- if there is no bean with the given nameBeanFactory.getBean(java.lang.String)
,
BeanFactory.isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)
public java.lang.String[] getAliases(java.lang.String name)
BeanFactory
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.
getAliases
in interface BeanFactory
name
- the bean name to check for aliasesBeanFactory.getBean(java.lang.String)
private <T> T doGetSingleton(java.lang.String name, java.lang.Class<T> requiredType) throws javax.naming.NamingException
javax.naming.NamingException
private java.lang.Class<?> doGetType(java.lang.String name) throws javax.naming.NamingException
javax.naming.NamingException