类 SimpleJndiBeanFactory
- java.lang.Object
- org.springframework.jndi.JndiAccessor
- org.springframework.jndi.JndiLocatorSupport
- org.springframework.jndi.support.SimpleJndiBeanFactory
- 所有已实现的接口:
BeanFactory
public class SimpleJndiBeanFactory extends JndiLocatorSupport implements BeanFactory
Simple JNDI-based implementation of Spring'sBeanFactory
interface. Does not support enumerating bean definitions, hence doesn't implement theListableBeanFactory
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.- 从以下版本开始:
- 2.5
- 作者:
- Juergen Hoeller
- 另请参阅:
DefaultListableBeanFactory
,CommonAnnotationBeanPostProcessor
字段概要
从类继承的字段 org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX
从类继承的字段 org.springframework.jndi.JndiAccessor
logger
从接口继承的字段 org.springframework.beans.factory.BeanFactory
FACTORY_BEAN_PREFIX
构造器概要
构造器 构造器 说明 SimpleJndiBeanFactory()
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 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.Class<?>
getType(String name)
Determine the type of the bean with the given name.boolean
isPrototype(String name)
Is this bean a prototype?boolean
isSingleton(String name)
Is this bean a shared singleton?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.从类继承的方法 org.springframework.jndi.JndiLocatorSupport
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
从类继承的方法 org.springframework.jndi.JndiAccessor
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
构造器详细资料
SimpleJndiBeanFactory
public SimpleJndiBeanFactory()
方法详细资料
addShareableResource
public void addShareableResource(String shareableResource)
Add the name of a shareable JNDI resource, which this factory is allowed to cache once obtained.- 参数:
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.- 参数:
shareableResources
- the JNDI names (typically within the "java:comp/env/" namespace)
getBean
public Object getBean(String name) throws BeansException
从接口复制的说明: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.
- 指定者:
getBean
在接口中BeanFactory
- 参数:
name
- the name of the bean to retrieve- 返回:
- an instance of the bean
- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the specified nameBeansException
- if the bean could not be obtained
getBean
public <T> T getBean(String name, Class<T> requiredType) throws BeansException
从接口复制的说明: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 withBeanFactory.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
在接口中BeanFactory
- 参数:
name
- the name of the bean to retrieverequiredType
- type the bean must match. Can be an interface or superclass of the actual class, ornull
for any match. For example, if the value isObject.class
, this method will succeed whatever the class of the returned instance.- 返回:
- an instance of the bean
- 抛出:
NoSuchBeanDefinitionException
- if there is no such bean definitionBeanNotOfRequiredTypeException
- if the bean is not of the required typeBeansException
- if the bean could not be created
getBean
public <T> T getBean(Class<T> requiredType) throws BeansException
从接口复制的说明: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, useListableBeanFactory
and/orBeanFactoryUtils
.- 指定者:
getBean
在接口中BeanFactory
- 参数:
requiredType
- type the bean must match; can be an interface or superclass- 返回:
- an instance of the single bean matching the required type
- 抛出:
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 created- 另请参阅:
ListableBeanFactory
getBean
public Object getBean(String name, Object... args) throws BeansException
从接口复制的说明: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.
- 指定者:
getBean
在接口中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)- 返回:
- an instance of the bean
- 抛出:
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 created
getBean
public <T> T getBean(Class<T> requiredType, Object... args) throws BeansException
从接口复制的说明: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, useListableBeanFactory
and/orBeanFactoryUtils
.- 指定者:
getBean
在接口中BeanFactory
- 参数:
requiredType
- type the bean must match; can be an interface or superclassargs
- 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)- 返回:
- an instance of the bean
- 抛出:
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 created
containsBean
public boolean containsBean(String name)
从接口复制的说明: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 atrue
return value from this method does not necessarily indicate thatBeanFactory.getBean(java.lang.String)
will be able to obtain an instance for the same name.- 指定者:
containsBean
在接口中BeanFactory
- 参数:
name
- the name of the bean to query- 返回:
- whether a bean with the given name is present
isSingleton
public boolean isSingleton(String name) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Is this bean a shared singleton? That is, willBeanFactory.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 theBeanFactory.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
在接口中BeanFactory
- 参数:
name
- the name of the bean to query- 返回:
- whether this bean corresponds to a singleton instance
- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isPrototype(java.lang.String)
isPrototype
public boolean isPrototype(String name) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Is this bean a prototype? That is, willBeanFactory.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 theBeanFactory.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
在接口中BeanFactory
- 参数:
name
- the name of the bean to query- 返回:
- whether this bean will always deliver independent instances
- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isSingleton(java.lang.String)
isTypeMatch
public boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Check whether the bean with the given name matches the specified type. More specifically, check whether aBeanFactory.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
在接口中BeanFactory
- 参数:
name
- the name of the bean to querytypeToMatch
- the type to match against (as aResolvableType
)- 返回:
true
if the bean type matches,false
if it doesn't match or cannot be determined yet- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.getType(java.lang.String)
isTypeMatch
public boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Check whether the bean with the given name matches the specified type. More specifically, check whether aBeanFactory.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
在接口中BeanFactory
- 参数:
name
- the name of the bean to querytypeToMatch
- the type to match against (as aClass
)- 返回:
true
if the bean type matches,false
if it doesn't match or cannot be determined yet- 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.getType(java.lang.String)
getType
public Class<?> getType(String name) throws NoSuchBeanDefinitionException
从接口复制的说明:BeanFactory
Determine the type of the bean with the given name. More specifically, determine the type of object thatBeanFactory.getBean(java.lang.String)
would return for the given name.For a
FactoryBean
, return the type of object that the FactoryBean creates, as exposed byFactoryBean.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
在接口中BeanFactory
- 参数:
name
- the name of the bean to query- 返回:
- the type of the bean, or
null
if not determinable - 抛出:
NoSuchBeanDefinitionException
- if there is no bean with the given name- 另请参阅:
BeanFactory.getBean(java.lang.String)
,BeanFactory.isTypeMatch(java.lang.String, org.springframework.core.ResolvableType)
getAliases
public String[] getAliases(String name)
从接口复制的说明:BeanFactory
Return the aliases for the given bean name, if any. All of those aliases point to the same bean when used in aBeanFactory.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
在接口中BeanFactory
- 参数:
name
- the bean name to check for aliases- 返回:
- the aliases, or an empty array if none
- 另请参阅:
BeanFactory.getBean(java.lang.String)