public class JndiObjectFactoryBean extends JndiObjectLocator implements FactoryBean<Object>, BeanFactoryAware, 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
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
DriverManagerDataSource definition!
setProxyInterface(java.lang.Class<?>),
setLookupOnStartup(boolean),
setCache(boolean),
JndiObjectTargetSourceCONTAINER_PREFIXlogger| Constructor and Description |
|---|
JndiObjectFactoryBean() |
| Modifier and Type | Method and Description |
|---|---|
void |
afterPropertiesSet()
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.
|
Object |
getObject()
Return the singleton JNDI object.
|
Class<?> |
getObjectType()
Return the type of object that this FactoryBean creates,
or
null if not known in advance. |
boolean |
isSingleton()
Is the object managed by this factory a singleton? That is,
will
FactoryBean.getObject() always return the same object
(a reference that can be cached)? |
protected Object |
lookupWithFallback()
Lookup variant that returns the specified "defaultObject"
(if any) in case of lookup failure.
|
void |
setBeanClassLoader(ClassLoader classLoader)
Callback that supplies the bean
class loader to
a bean instance. |
void |
setBeanFactory(BeanFactory beanFactory)
Callback that supplies the owning factory to a bean instance.
|
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.
|
getExpectedType, getJndiName, lookup, setExpectedType, setJndiNameconvertJndiName, isResourceRef, lookup, lookup, setResourceRefgetJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplatepublic void setProxyInterface(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(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(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.
public void setBeanFactory(BeanFactory beanFactory)
BeanFactoryAwareInvoked after the population of normal bean properties
but before an initialization callback such as
InitializingBean.afterPropertiesSet() or a custom init-method.
setBeanFactory in interface BeanFactoryAwarebeanFactory - owning BeanFactory (never null).
The bean can immediately call methods on the factory.BeanInitializationExceptionpublic void setBeanClassLoader(ClassLoader classLoader)
BeanClassLoaderAwareclass loader to
a bean instance.
Invoked after the population of normal bean properties but
before an initialization callback such as
InitializingBean's
InitializingBean.afterPropertiesSet()
method or a custom init-method.
setBeanClassLoader in interface BeanClassLoaderAwareclassLoader - the owning class loaderpublic void afterPropertiesSet()
throws IllegalArgumentException,
NamingException
afterPropertiesSet in interface InitializingBeanafterPropertiesSet in class JndiObjectLocatorIllegalArgumentExceptionNamingExceptionprotected Object lookupWithFallback() throws NamingException
NamingException - in case of lookup failure without fallbacksetDefaultObject(java.lang.Object)@Nullable public Object getObject()
getObject in interface FactoryBean<Object>null)FactoryBeanNotInitializedExceptionpublic Class<?> getObjectType()
FactoryBeannull if not known in advance.
This allows one to check for specific types of beans without instantiating objects, for example on autowiring.
In the case of implementations that are creating a singleton object, this method should try to avoid singleton creation as far as possible; it should rather estimate the type in advance. For prototypes, returning a meaningful type here is advisable too.
This method can be called before this FactoryBean has been fully initialized. It must not rely on state created during initialization; of course, it can still use such state if available.
NOTE: Autowiring will simply ignore FactoryBeans that return
null here. Therefore it is highly recommended to implement
this method properly, using the current state of the FactoryBean.
getObjectType in interface FactoryBean<Object>null if not known at the time of the callListableBeanFactory.getBeansOfType(java.lang.Class<T>)public boolean isSingleton()
FactoryBeanFactoryBean.getObject() always return the same object
(a reference that can be cached)?
NOTE: If a FactoryBean indicates to hold a singleton object,
the object returned from getObject() might get cached
by the owning BeanFactory. Hence, do not return true
unless the FactoryBean always exposes the same reference.
The singleton status of the FactoryBean itself will generally be provided by the owning BeanFactory; usually, it has to be defined as singleton there.
NOTE: This method returning false does not
necessarily indicate that returned objects are independent instances.
An implementation of the extended SmartFactoryBean interface
may explicitly indicate independent instances through its
SmartFactoryBean.isPrototype() method. Plain FactoryBean
implementations which do not implement this extended interface are
simply assumed to always return independent instances if the
isSingleton() implementation returns false.
The default implementation returns true, since a
FactoryBean typically manages a singleton instance.
isSingleton in interface FactoryBean<Object>FactoryBean.getObject(),
SmartFactoryBean.isPrototype()protected Class<?> createCompositeInterface(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<?>...)