Package org.springframework.jndi

Class JndiLocatorSupport

java.lang.Object
org.springframework.jndi.JndiAccessor
org.springframework.jndi.JndiLocatorSupport
Direct Known Subclasses:
JndiDataSourceLookup, JndiDestinationResolver, JndiLocatorDelegate, JndiObjectLocator, SimpleJndiBeanFactory
public abstract class JndiLocatorSupport extends JndiAccessor
Convenient superclass for classes that can locate any number of JNDI objects. Derives from JndiAccessor to inherit the "jndiTemplate" and "jndiEnvironment" bean properties.

JNDI names may or may not include the "java:comp/env/" prefix expected by Jakarta EE applications when accessing a locally mapped (ENC - 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.

Since:
1.1
Author:
Juergen Hoeller
See Also:

  • Field Details

    • CONTAINER_PREFIX

      public static final String CONTAINER_PREFIX
      JNDI prefix used in a Jakarta EE container.
      See Also:

  • Constructor Details

    • JndiLocatorSupport

      public JndiLocatorSupport()

  • Method Details

    • setResourceRef

      public void setResourceRef(boolean resourceRef)
      Set whether the lookup occurs in a Jakarta EE container, i.e. if the prefix "java:comp/env/" needs to be added if the JNDI name doesn't already contain it. Default is "false".

      Note: Will only get applied if no other scheme (e.g. "java:") is given.

    • isResourceRef

      public boolean isResourceRef()
      Return whether the lookup occurs in a Jakarta EE container.

    • lookup

      protected Object lookup(String jndiName) throws NamingException
      Perform an actual JNDI lookup for the given name via the JndiTemplate.

      If the name doesn't begin with "java:comp/env/", this prefix is added if "resourceRef" is set to "true".

      Parameters:
      jndiName - the JNDI name to look up
      Returns:
      the obtained object
      Throws:
      NamingException - if the JNDI lookup failed
      See Also:

    • lookup

      protected <T> T lookup(String jndiName, @Nullable Class<T> requiredType) throws NamingException
      Perform an actual JNDI lookup for the given name via the JndiTemplate.

      If the name doesn't begin with "java:comp/env/", this prefix is added if "resourceRef" is set to "true".

      Parameters:
      jndiName - the JNDI name to look up
      requiredType - the required type of the object
      Returns:
      the obtained object
      Throws:
      NamingException - if the JNDI lookup failed
      See Also:

    • convertJndiName

      protected String convertJndiName(String jndiName)
      Convert the given JNDI name into the actual JNDI name to use.

      The default implementation applies the "java:comp/env/" prefix if "resourceRef" is "true" and no other scheme (e.g. "java:") is given.

      Parameters:
      jndiName - the original JNDI name
      Returns:
      the JNDI name to use
      See Also: