spring-framework / org.springframework.jndi / JndiPropertySource

JndiPropertySource

open class JndiPropertySource : PropertySource<JndiLocatorDelegate>

PropertySource implementation that reads properties from an underlying Spring JndiLocatorDelegate.

By default, the underlying JndiLocatorDelegate will be configured with its "resourceRef" property set to true, meaning that names looked up will automatically be prefixed with "java:comp/env/" in alignment with published JNDI naming conventions. To override this setting or to change the prefix, manually configure a JndiLocatorDelegate and provide it to one of the constructors here that accepts it. The same applies when providing custom JNDI properties. These should be specified using JndiLocatorDelegate#setJndiEnvironment(java.util.Properties) prior to construction of the JndiPropertySource.

Note that org.springframework.web.context.support.StandardServletEnvironment includes a JndiPropertySource by default, and any customization of the underlying JndiLocatorDelegate may be performed within an org.springframework.context.ApplicationContextInitializer or org.springframework.web.WebApplicationInitializer.

Author
Chris Beams

Author
Juergen Hoeller

Since
3.1

See Also
JndiLocatorDelegateorg.springframework.context.ApplicationContextInitializerorg.springframework.web.WebApplicationInitializerorg.springframework.web.context.support.StandardServletEnvironment

Constructors

<init>

JndiPropertySource(name: String)

Create a new JndiPropertySource with the given name and a JndiLocatorDelegate configured to prefix any names with "java:comp/env/".

JndiPropertySource(name: String, jndiLocator: JndiLocatorDelegate)

Create a new JndiPropertySource with the given name and the given JndiLocatorDelegate.

Functions

getProperty

open fun getProperty(name: String): Any

This implementation looks up and returns the value associated with the given name from the underlying JndiLocatorDelegate. If a NamingException is thrown during the call to JndiLocatorDelegate#lookup(String), returns null and issues a DEBUG-level log statement with the exception message.