public abstract class

JndiObjectLocator

extends JndiLocatorSupport
implements InitializingBean
java.lang.Object
   ↳ org.springframework.jndi.JndiAccessor
     ↳ org.springframework.jndi.JndiLocatorSupport
       ↳ org.springframework.jndi.JndiObjectLocator
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

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 J2EE 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.

Summary

[Expand]
Inherited Constants
From class org.springframework.jndi.JndiLocatorSupport
[Expand]
Inherited Fields
From class org.springframework.jndi.JndiAccessor
Public Constructors
JndiObjectLocator()
Public Methods
void afterPropertiesSet()
Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).
Class<?> getExpectedType()
Return the type that the located JNDI object is supposed to be assignable to, if any.
String getJndiName()
Return the JNDI name to look up.
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.
Protected Methods
Object lookup()
Perform the actual JNDI lookup for this locator's target resource.
[Expand]
Inherited Methods
From class org.springframework.jndi.JndiLocatorSupport
From class org.springframework.jndi.JndiAccessor
From class java.lang.Object
From interface org.springframework.beans.factory.InitializingBean

Public Constructors

public JndiObjectLocator ()

Public Methods

public void afterPropertiesSet ()

Invoked by a BeanFactory after it has set all bean properties supplied (and satisfied BeanFactoryAware and ApplicationContextAware).

This method allows the bean instance to perform initialization only possible when all bean properties have been set and to throw an exception in the event of misconfiguration.

public Class<?> getExpectedType ()

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

public String getJndiName ()

Return the JNDI name to look up.

public void setExpectedType (Class<?> expectedType)

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

public void setJndiName (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

Protected Methods

protected Object 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 assigable to the expected type