Package org.springframework.jndi
Class JndiObjectLocator
java.lang.Object
org.springframework.jndi.JndiAccessor
org.springframework.jndi.JndiLocatorSupport
org.springframework.jndi.JndiObjectLocator
- All Implemented Interfaces:
org.springframework.beans.factory.InitializingBean
- Direct Known Subclasses:
JndiObjectFactoryBean
,JndiObjectTargetSource
public abstract class JndiObjectLocator
extends JndiLocatorSupport
implements org.springframework.beans.factory.InitializingBean
Convenient superclass for JNDI-based service locators,
providing configurable lookup of a specific JNDI resource.
Exposes a "jndiName"
property. This may or may not
include the "java:comp/env/" prefix expected by Jakarta EE applications when
accessing a locally mapped (Environmental Naming Context) resource. If it
doesn't, the "java:comp/env/" prefix will be prepended if the "resourceRef"
property is true (the default is false) and no other scheme
(e.g. "java:") is given.
Subclasses may invoke the lookup()
method whenever it is appropriate.
Some classes might do this on initialization, while others might do it
on demand. The latter strategy is more flexible in that it allows for
initialization of the locator before the JNDI object is available.
-
Field Summary
Fields inherited from class org.springframework.jndi.JndiLocatorSupport
CONTAINER_PREFIX
Fields inherited from class org.springframework.jndi.JndiAccessor
logger
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Class<?>
Return the type that the located JNDI object is supposed to be assignable to, if any.Return the JNDI name to look up.protected Object
lookup()
Perform the actual JNDI lookup for this locator's target resource.void
setExpectedType
(Class<?> expectedType) Specify the type that the located JNDI object is supposed to be assignable to, if any.void
setJndiName
(String jndiName) Specify the JNDI name to look up.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
-
JndiObjectLocator
public JndiObjectLocator()
-
-
Method Details
-
setJndiName
Specify the JNDI name to look up. If it doesn't begin with "java:comp/env/" this prefix is added automatically if "resourceRef" is set to "true".- Parameters:
jndiName
- the JNDI name to look up- See Also:
-
getJndiName
Return the JNDI name to look up. -
setExpectedType
Specify the type that the located JNDI object is supposed to be assignable to, if any. -
getExpectedType
Return the type that the located JNDI object is supposed to be assignable to, if any. -
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
IllegalArgumentException
NamingException
-
lookup
Perform the actual JNDI lookup for this locator's target resource.- Returns:
- the located target object
- Throws:
NamingException
- if the JNDI lookup failed or if the located JNDI object is not assignable to the expected type- See Also:
-