public class JndiObjectFactoryBean extends JndiObjectLocator implements org.springframework.beans.factory.FactoryBean<java.lang.Object>, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.BeanClassLoaderAware
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
javax.sql.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 lookup 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!
setProxyInterface(java.lang.Class<?>)
,
setLookupOnStartup(boolean)
,
setCache(boolean)
,
JndiObjectTargetSource
CONTAINER_PREFIX
logger
Constructor and Description |
---|
JndiObjectFactoryBean() |
Modifier and Type | Method and Description |
---|---|
void |
afterPropertiesSet()
Look up the JNDI object and store it.
|
protected java.lang.Class<?> |
createCompositeInterface(java.lang.Class<?>[] interfaces)
Create a composite interface Class for the given interfaces,
implementing the given interfaces in one single Class.
|
java.lang.Object |
getObject()
Return the singleton JNDI object.
|
java.lang.Class<?> |
getObjectType() |
boolean |
isSingleton() |
protected java.lang.Object |
lookupWithFallback()
Lookup variant that returns the specified "defaultObject"
(if any) in case of lookup failure.
|
void |
setBeanClassLoader(java.lang.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(java.lang.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(java.lang.Class<?> proxyInterface)
Specify the proxy interface to use for the JNDI object.
|
void |
setProxyInterfaces(java.lang.Class<?>... proxyInterfaces)
Specify multiple proxy interfaces to use for the JNDI object.
|
getExpectedType, getJndiName, lookup, setExpectedType, setJndiName
convertJndiName, isResourceRef, lookup, lookup, setResourceRef
getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate
public void setProxyInterface(java.lang.Class<?> proxyInterface)
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.
public void setProxyInterfaces(java.lang.Class<?>... proxyInterfaces)
Typically used in conjunction with "lookupOnStartup"=false and/or "cache"=false. Note that proxy interfaces will be autodetected from a specified "expectedType", if necessary.
public void setLookupOnStartup(boolean lookupOnStartup)
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.
public void setCache(boolean cache)
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.
public void setExposeAccessContext(boolean exposeAccessContext)
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.
public void setDefaultObject(java.lang.Object defaultObject)
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.
setLookupOnStartup(boolean)
,
ConfigurableBeanFactory.getTypeConverter()
,
SimpleTypeConverter
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory)
setBeanFactory
in interface org.springframework.beans.factory.BeanFactoryAware
public void setBeanClassLoader(java.lang.ClassLoader classLoader)
setBeanClassLoader
in interface org.springframework.beans.factory.BeanClassLoaderAware
public void afterPropertiesSet() throws java.lang.IllegalArgumentException, javax.naming.NamingException
afterPropertiesSet
in interface org.springframework.beans.factory.InitializingBean
afterPropertiesSet
in class JndiObjectLocator
java.lang.IllegalArgumentException
javax.naming.NamingException
protected java.lang.Object lookupWithFallback() throws javax.naming.NamingException
javax.naming.NamingException
- in case of lookup failure without fallbacksetDefaultObject(java.lang.Object)
@Nullable public java.lang.Object getObject()
getObject
in interface org.springframework.beans.factory.FactoryBean<java.lang.Object>
public java.lang.Class<?> getObjectType()
getObjectType
in interface org.springframework.beans.factory.FactoryBean<java.lang.Object>
public boolean isSingleton()
isSingleton
in interface org.springframework.beans.factory.FactoryBean<java.lang.Object>
protected java.lang.Class<?> createCompositeInterface(java.lang.Class<?>[] interfaces)
The default implementation builds a JDK proxy class for the given interfaces.
interfaces
- the interfaces to mergeProxy.getProxyClass(java.lang.ClassLoader, java.lang.Class<?>...)