org.springframework.jndi
Class JndiTemplate

java.lang.Object
  org.springframework.jndi.JndiTemplate

Direct Known Subclasses:

ExpectedLookupTemplate

public class JndiTemplate

extends java.lang.Object

Helper class that simplifies JNDI operations. It provides methods to lookup and bind objects, and allows implementations of the JndiCallback interface to perform any operation they like with a JNDI naming context provided.

This is the central class in this package. It is analogous to the JdbcTemplate class. This class performs all JNDI context handling.

Version:

$Id: JndiTemplate.java,v 1.6 2004/03/18 02:46:17 trisberg Exp $

Author:

Rod Johnson, Juergen Hoeller

See Also:

JndiCallback, JdbcTemplate

Field Summary

protected org.apache.commons.logging.Log

logger

Constructor Summary

JndiTemplate()
Create a new JndiTemplate instance.

JndiTemplate(java.util.Properties environment)
Create a new JndiTemplate instance, using the given environment.

Method Summary

void	bind(java.lang.String name, java.lang.Object object) Bind the given object to the current JNDI context, using the given name.
protected javax.naming.Context	createInitialContext() Create a new JNDI initial context.
java.lang.Object	execute(JndiCallback contextCallback) Execute the given JNDI context callback implementation.
java.util.Properties	getEnvironment() Return the environment for the JNDI InitialContext.
java.lang.Object	lookup(java.lang.String name) Look up the object with the given name in the current JNDI context.
void	setEnvironment(java.util.Properties environment) Set the environment for the JNDI InitialContext.
void	unbind(java.lang.String name) Remove the binding for the given name from the current JNDI context.

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected final org.apache.commons.logging.Log logger

Constructor Detail

JndiTemplate

public JndiTemplate()

Create a new JndiTemplate instance.

JndiTemplate

public JndiTemplate(java.util.Properties environment)

Create a new JndiTemplate instance, using the given environment.

Method Detail

setEnvironment

public void setEnvironment(java.util.Properties environment)

Set the environment for the JNDI InitialContext.

getEnvironment

public java.util.Properties getEnvironment()

Return the environment for the JNDI InitialContext.

execute

public java.lang.Object execute(JndiCallback contextCallback)
                         throws javax.naming.NamingException

Execute the given JNDI context callback implementation.

Parameters:

contextCallback - JndiCallback implementation

Returns:

a result object returned by the callback, or null

Throws:

javax.naming.NamingException - thrown by the callback implementation

See Also:

createInitialContext()

createInitialContext

protected javax.naming.Context createInitialContext()
                                             throws javax.naming.NamingException

Create a new JNDI initial context. Invoked by execute. The default implementation use this template's environment settings. Can be subclassed for custom contexts, e.g. for testing.

Returns:

the initial Context instance

Throws:

javax.naming.NamingException - in case of initialization errors

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws javax.naming.NamingException

Look up the object with the given name in the current JNDI context.

Parameters:

name - the JNDI name of the object

Returns:

object found (cannot be null; if a not so well-behaved JNDI implementations returns null, a NamingException gets thrown)

Throws:

javax.naming.NamingException - if there is no object with the given name bound to JNDI

bind

public void bind(java.lang.String name,
                 java.lang.Object object)
          throws javax.naming.NamingException

Bind the given object to the current JNDI context, using the given name.

Parameters:

name - the JNDI name of the object

object - the object to bind

Throws:

javax.naming.NamingException - thrown by JNDI, mostly name already bound

unbind

public void unbind(java.lang.String name)
            throws javax.naming.NamingException

Remove the binding for the given name from the current JNDI context.

Parameters:

name - the JNDI name of the object

Throws:

javax.naming.NamingException - thrown by JNDI, mostly name not found