OpenJDK 27 · javax.naming · APIdia, the JavaDoc alternative

Provides the classes and interfaces for accessing naming services.

This package defines the naming operations of the Java Naming and Directory Interface (JNDI). JNDI provides naming and directory functionality to applications written in the Java programming language. It is designed to be independent of any specific naming or directory service implementation. Thus a variety of services--new, emerging, and already deployed ones--can be accessed in a common way.

Context

This package defines the notion of a context, represented by the Context interface. A context consists of a set of name-to-object bindings. Context is the core interface for looking up, binding, unbinding, and renaming objects, and for creating and destroying subcontexts.

lookup() is the most commonly used operation. You supply lookup() the name of the object you want to look up, and it returns the object bound to that name. For example, the following code fragment looks up a printer and sends a document to the printer object to be printed:

Printer printer = (Printer)ctx.lookup("treekiller");
printer.print(report);

Names

Every naming method in the Context interface has two overloads: one that accepts a Name argument and one that accepts a string name. Name is an interface that represents a generic name--an ordered sequence of zero of more components. For these methods, Name can be used to represent a composite name (CompositeName) so that you can name an object using a name which spans multiple namespaces.

The overloads that accept Name are useful for applications that need to manipulate names: composing them, comparing components, and so on. The overloads that accept string names are likely to be more useful for simple applications, such as those that simply read in a name and look up the corresponding object.

Bindings

The Binding class represents a name-to-object binding. It is a tuple containing the name of the bound object, the name of the object's class, and the object itself.

The Binding class is actually a subclass of NameClassPair, which consists simply of the object's name and the object's class name. The NameClassPair is useful when you only want information about the object's class and do not want to pay the extra cost of getting the object.

References

Objects are stored in naming and directory services in different ways. If an object store supports storing Java objects, it might support storing an object in its serialized form. However, some naming and directory services do not support the storing of Java objects. Furthermore, for some objects in the directory, Java programs are but one group of applications that access them. In this case, a serialized Java object might not be the most appropriate representation. JNDI defines a reference, represented by the Reference class, which contains information on how to construct a copy of the object. JNDI will attempt to turn references looked up from the directory into the Java objects they represent, so that JNDI clients have the illusion that what is stored in the directory are Java objects.

The Initial Context

In JNDI, all naming and directory operations are performed relative to a context. There are no absolute roots. Therefore JNDI defines an initial context, InitialContext, which provides a starting point for naming and directory operations. Once you have an initial context, you can use it to look up other contexts and objects.

Exceptions

JNDI defines a class hierarchy for exceptions that can be thrown in the course of performing naming and directory operations. The root of this class hierarchy is NamingException. Programs interested in dealing with a particular exception can catch the corresponding subclass of the exception. Otherwise, programs should catch NamingException.

Package Specification

The JNDI API Specification and related documents can be found in the JNDI documentation.

Modifier and Type	Interface and Description
public interface	Context This interface represents a naming context, which consists of a set of name-to-object bindings.
public interface	Name The `Name` interface represents a generic name -- an ordered sequence of components.
public interface	NameParser This interface is used for parsing names from a hierarchical namespace.
public interface	NamingEnumeration< the type of elements returned by this enumeration T> This interface is for enumerating lists returned by methods in the javax.naming and javax.naming.directory packages.
public interface	Referenceable This interface is implemented by an object that can provide a Reference to itself.

Class Summary

Modifier and Type	Class and Description
public class	AuthenticationException This exception is thrown when an authentication error occurs while accessing the naming or directory service.
public class	AuthenticationNotSupportedException This exception is thrown when the particular flavor of authentication requested is not supported.
public class	BinaryRefAddr This class represents the binary form of the address of a communications end-point.
public class	Binding This class represents a name-to-object binding found in a context.
public class	CannotProceedException This exception is thrown to indicate that the operation reached a point in the name where the operation cannot proceed any further.
public class	CommunicationException This exception is thrown when the client is unable to communicate with the directory or naming service.
public class	CompositeName This class represents a composite name -- a sequence of component names spanning multiple namespaces.
public class	CompoundName This class represents a compound name -- a name from a hierarchical name space.
public class	ConfigurationException This exception is thrown when there is a configuration problem.
public class	ContextNotEmptyException This exception is thrown when attempting to destroy a context that is not empty.
public class	InitialContext This class is the starting context for performing naming operations.
public class	InsufficientResourcesException This exception is thrown when resources are not available to complete the requested operation.
public class	InterruptedNamingException This exception is thrown when the naming operation being invoked has been interrupted.
public class	InvalidNameException This exception indicates that the name being specified does not conform to the naming syntax of a naming system.
public class	LimitExceededException This exception is thrown when a method terminates abnormally due to a user or system specified limit.
public class	LinkException This exception is used to describe problems encountered while resolving links.
public class	LinkLoopException This exception is thrown when a loop was detected while attempting to resolve a link, or an implementation specific limit on link counts has been reached.
public class	LinkRef This class represents a Reference whose contents is a name, called the link name, that is bound to an atomic name in a context.
public class	MalformedLinkException This exception is thrown when a malformed link was encountered while resolving or constructing a link.
public class	NameAlreadyBoundException This exception is thrown by methods to indicate that a binding cannot be added because the name is already bound to another object.
public class	NameClassPair This class represents the object name and class name pair of a binding found in a context.
pack-priv class	NameImpl The implementation class for CompoundName and CompositeName.
pack-priv class	NameImplEnumerator
public class	NameNotFoundException This exception is thrown when a component of the name cannot be resolved because it is not bound.
public class	NamingException This is the superclass of all exceptions thrown by operations in the Context and DirContext interfaces.
public abstract class	NamingSecurityException This is the superclass of security-related exceptions thrown by operations in the Context and DirContext interfaces.
public class	NoInitialContextException This exception is thrown when no initial context implementation can be created.
public class	NoPermissionException This exception is thrown when attempting to perform an operation for which the client has no permission.
public class	NotContextException This exception is thrown when a naming operation proceeds to a point where a context is required to continue the operation, but the resolved object is not a context.
public class	OperationNotSupportedException This exception is thrown when a context implementation does not support the operation being invoked.
public class	PartialResultException This exception is thrown to indicate that the result being returned or returned so far is partial, and that the operation cannot be completed.
public abstract class	RefAddr This class represents the address of a communications end-point.
public class	Reference This class represents a reference to an object that is found outside of the naming/directory system.
public abstract class	ReferralException This abstract class is used to represent a referral exception, which is generated in response to a referral such as that returned by LDAP v3 servers.
public class	ServiceUnavailableException This exception is thrown when attempting to communicate with a directory or naming service and that service is not available.
public class	SizeLimitExceededException This exception is thrown when a method produces a result that exceeds a size-related limit.
public class	StringRefAddr This class represents the string form of the address of a communications end-point.
public class	TimeLimitExceededException This exception is thrown when a method does not terminate within the specified time limit.

Package javax.naming