Class JndiObjectLocator

java.lang.Object

org.springframework.jndi.JndiAccessor

org.springframework.jndi.JndiLocatorSupport

org.springframework.jndi.JndiObjectLocator

All Implemented Interfaces:

InitializingBean

Direct Known Subclasses:

JndiObjectFactoryBean, JndiObjectTargetSource

public abstract class JndiObjectLocator
extends JndiLocatorSupport
implements 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 (for example, "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.

Since:

1.1

Author:

Juergen Hoeller

See Also:

• setJndiName(String)
• JndiAccessor.setJndiTemplate(JndiTemplate)
• JndiAccessor.setJndiEnvironment(Properties)
• JndiLocatorSupport.setResourceRef(boolean)
• lookup()

Field Summary

Fields inherited from class JndiLocatorSupport

CONTAINER_PREFIX

Fields inherited from class JndiAccessor

logger

Constructor Summary

Constructors

Constructor	Description
JndiObjectLocator()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()	Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.
@Nullable Class<?>	getExpectedType()	Return the type that the located JNDI object is supposed to be assignable to, if any.
@Nullable String	getJndiName()	Return the JNDI name to look up.
protected Object	lookup()	Perform the actual JNDI lookup for this locator's target resource.
void	setExpectedType(@Nullable Class<?> expectedType)	Specify the type that the located JNDI object is supposed to be assignable to, if any.
void	setJndiName(@Nullable String jndiName)	Specify the JNDI name to look up.

Methods inherited from class JndiLocatorSupport

convertJndiName, isResourceRef, lookup, lookup, setResourceRef

Methods inherited from class JndiAccessor

getJndiEnvironment, getJndiTemplate, setJndiEnvironment, setJndiTemplate

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

JndiObjectLocator

public JndiObjectLocator()

Method Details

setJndiName

public void setJndiName(@Nullable String jndiName)

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:

• JndiLocatorSupport.setResourceRef(boolean)

getJndiName

public @Nullable String getJndiName()

Return the JNDI name to look up.

setExpectedType

public void setExpectedType(@Nullable Class<?> expectedType)

Specify the type that the located JNDI object is supposed to be assignable to, if any.

getExpectedType

public @Nullable Class<?> getExpectedType()

Return the type that the located JNDI object is supposed to be assignable to, if any.

afterPropertiesSet

public void afterPropertiesSet()
                        throws IllegalArgumentException,
NamingException

Description copied from interface: InitializingBean

Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

Specified by:

afterPropertiesSet in interface InitializingBean

Throws:

IllegalArgumentException

NamingException

lookup

protected Object lookup()
                 throws NamingException

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:

• setJndiName(String)
• setExpectedType(Class)
• JndiLocatorSupport.lookup(String, Class)