Class JndiObjectFactoryBean
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanClassLoaderAware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.FactoryBean<Object>
,org.springframework.beans.factory.InitializingBean
FactoryBean
that looks up a
JNDI object. Exposes the object found in JNDI for bean references,
e.g. for data access object's "dataSource" property in case of a
DataSource
.
The typical usage will be to register this as singleton factory (e.g. for a certain JNDI-bound DataSource) in an application context, and give bean references to application services that need it.
The default behavior is to look up the JNDI object on startup and cache it.
This can be customized through the "lookupOnStartup" and "cache" properties,
using a JndiObjectTargetSource
underneath. Note that you need to specify
a "proxyInterface" in such a scenario, since the actual JNDI object type is not
known in advance.
Of course, bean classes in a Spring environment may look up e.g. a DataSource from JNDI themselves. This class simply enables central configuration of the JNDI name, and easy switching to non-JNDI alternatives. The latter is particularly convenient for test setups, reuse in standalone clients, etc.
Note that switching to e.g. DriverManagerDataSource is just a matter of
configuration: Simply replace the definition of this FactoryBean with a
org.springframework.jdbc.datasource.DriverManagerDataSource
definition!
- Since:
- 22.05.2003
- Author:
- Juergen Hoeller
- See Also:
-
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.FactoryBean
OBJECT_TYPE_ATTRIBUTE
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Look up the JNDI object and store it.protected Class<?>
createCompositeInterface
(Class<?>[] interfaces) Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.Return the singleton JNDI object.Class<?>
boolean
protected Object
Lookup variant that returns the specified "defaultObject" (if any) in case of lookup failure.void
setBeanClassLoader
(ClassLoader classLoader) void
setBeanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) void
setCache
(boolean cache) Set whether to cache the JNDI object once it has been located.void
setDefaultObject
(Object defaultObject) Specify a default object to fall back to if the JNDI lookup fails.void
setExposeAccessContext
(boolean exposeAccessContext) Set whether to expose the JNDI environment context for all access to the target object, i.e.void
setLookupOnStartup
(boolean lookupOnStartup) Set whether to look up the JNDI object on startup.void
setProxyInterface
(Class<?> proxyInterface) Specify the proxy interface to use for the JNDI object.void
setProxyInterfaces
(Class<?>... proxyInterfaces) Specify multiple proxy interfaces to use for the JNDI object.Methods inherited from class org.springframework.jndi.JndiObjectLocator
getExpectedType, getJndiName, lookup, setExpectedType, setJndiName
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
-
Constructor Details
-
JndiObjectFactoryBean
public JndiObjectFactoryBean()
-
-
Method Details
-
setProxyInterface
Specify the proxy interface to use for the JNDI object.Typically used in conjunction with "lookupOnStartup"=false and/or "cache"=false. Needs to be specified because the actual JNDI object type is not known in advance in case of a lazy lookup.
-
setProxyInterfaces
Specify multiple proxy interfaces to use for the JNDI object.Typically used in conjunction with "lookupOnStartup"=false and/or "cache"=false. Note that proxy interfaces will be autodetected from a specified "expectedType", if necessary.
-
setLookupOnStartup
public void setLookupOnStartup(boolean lookupOnStartup) Set whether to look up the JNDI object on startup. Default is "true".Can be turned off to allow for late availability of the JNDI object. In this case, the JNDI object will be fetched on first access.
For a lazy lookup, a proxy interface needs to be specified.
-
setCache
public void setCache(boolean cache) Set whether to cache the JNDI object once it has been located. Default is "true".Can be turned off to allow for hot redeployment of JNDI objects. In this case, the JNDI object will be fetched for each invocation.
For hot redeployment, a proxy interface needs to be specified.
-
setExposeAccessContext
public void setExposeAccessContext(boolean exposeAccessContext) Set whether to expose the JNDI environment context for all access to the target object, i.e. for all method invocations on the exposed object reference.Default is "false", i.e. to only expose the JNDI context for object lookup. Switch this flag to "true" in order to expose the JNDI environment (including the authorization context) for each method invocation, as needed by WebLogic for JNDI-obtained factories (e.g. JDBC DataSource, JMS ConnectionFactory) with authorization requirements.
-
setDefaultObject
Specify a default object to fall back to if the JNDI lookup fails. Default is none.This can be an arbitrary bean reference or literal value. It is typically used for literal values in scenarios where the JNDI environment might define specific config settings but those are not required to be present.
Note: This is only supported for lookup on startup. If specified together with
JndiObjectLocator.setExpectedType(java.lang.Class<?>)
, the specified value needs to be either of that type or convertible to it.- See Also:
-
setLookupOnStartup(boolean)
ConfigurableBeanFactory.getTypeConverter()
SimpleTypeConverter
-
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) - Specified by:
setBeanFactory
in interfaceorg.springframework.beans.factory.BeanFactoryAware
-
setBeanClassLoader
- Specified by:
setBeanClassLoader
in interfaceorg.springframework.beans.factory.BeanClassLoaderAware
-
afterPropertiesSet
Look up the JNDI object and store it.- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Overrides:
afterPropertiesSet
in classJndiObjectLocator
- Throws:
IllegalArgumentException
NamingException
-
lookupWithFallback
Lookup variant that returns the specified "defaultObject" (if any) in case of lookup failure.- Returns:
- the located object, or the "defaultObject" as fallback
- Throws:
NamingException
- in case of lookup failure without fallback- See Also:
-
getObject
Return the singleton JNDI object.- Specified by:
getObject
in interfaceorg.springframework.beans.factory.FactoryBean<Object>
-
getObjectType
- Specified by:
getObjectType
in interfaceorg.springframework.beans.factory.FactoryBean<Object>
-
isSingleton
public boolean isSingleton()- Specified by:
isSingleton
in interfaceorg.springframework.beans.factory.FactoryBean<Object>
-
createCompositeInterface
Create a composite interface Class for the given interfaces, implementing the given interfaces in one single Class.The default implementation builds a JDK proxy class for the given interfaces.
- Parameters:
interfaces
- the interfaces to merge- Returns:
- the merged interface as Class
- See Also:
-