removeFromEnvironment(java.lang.String propName)
Removes an environment property from the environment of this context.

void

rename(javax.naming.Name oldName,
javax.naming.Name newName)
Binds a new name to the object bound to an old name, and unbinds the
old name.

abstract void

rename(java.lang.String oldName,
java.lang.String newName)
Binds a new name to the object bound to an old name, and unbinds the
old name.

javax.naming.NamingEnumeration

search(javax.naming.Name name,
javax.naming.directory.Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes.

javax.naming.NamingEnumeration

search(javax.naming.Name name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes.

javax.naming.NamingEnumeration

search(javax.naming.Name name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter.

javax.naming.NamingEnumeration

search(javax.naming.Name name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter.

abstract javax.naming.NamingEnumeration

search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes)
Searches in a single context for objects that contain a specified set
of attributes.

abstract javax.naming.NamingEnumeration

search(java.lang.String name,
javax.naming.directory.Attributes matchingAttributes,
java.lang.String[] attributesToReturn)
Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes.

abstract javax.naming.NamingEnumeration

search(java.lang.String name,
java.lang.String filterExpr,
java.lang.Object[] filterArgs,
javax.naming.directory.SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter.

abstract javax.naming.NamingEnumeration

search(java.lang.String name,
java.lang.String filter,
javax.naming.directory.SearchControls cons)
Searches in the named context or object for entries that satisfy the
given search filter.

release

lookup

Retrieves the named object. If name is empty, returns a new instance
of this context (which represents the same naming context as this
context, but its environment may be modified independently and it may
be accessed concurrently).

rename

Binds a new name to the object bound to an old name, and unbinds the
old name. Both names are relative to this context. Any attributes
associated with the old name become associated with the new name.
Intermediate contexts of the old name are not changed.

destroySubcontext

Destroys the named context and removes it from the namespace. Any
attributes associated with the name are also removed. Intermediate
contexts are not destroyed.

This method is idempotent. It succeeds even if the terminal atomic
name is not bound in the target context, but throws
NameNotFoundException if any of the intermediate contexts do not exist.
In a federated naming system, a context from one naming system may be
bound to a name in another. One can subsequently look up and perform
operations on the foreign context using a composite name. However, an
attempt destroy the context using this composite name will fail with
NotContextException, because the foreign context is not a "subcontext"
of the context in which it is bound. Instead, use unbind() to remove
the binding of the foreign context. Destroying the foreign context
requires that the destroySubcontext() be performed on a context from
the foreign context's "native" naming system.

Specified by:

destroySubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to be destroyed; may not be empty

Throws:

NameNotFoundException - if an intermediate context does not
exist

NotContextException - if the name is bound but does not name
a context, or does not name a context of the appropriate type

createSubcontext

Creates and binds a new context. Creates a new context with the given
name and binds it in the target context (that named by all but
terminal atomic component of the name). All intermediate contexts and
the target context must already exist.

Specified by:

createSubcontext in interface javax.naming.Context

Parameters:

name - the name of the context to create; may not be empty

Returns:

the newly created context

Throws:

NameAlreadyBoundException - if name is already bound

InvalidAttributesException - if creation of the subcontext
requires specification of mandatory attributes

getNameParser

Retrieves the parser associated with the named context. In a
federation of namespaces, different naming systems will parse names
differently. This method allows an application to get a parser for
parsing names into their atomic components using the naming convention
of a particular naming system. Within any single naming system,
NameParser objects returned by this method must be equal (using the
equals() test).

Specified by:

getNameParser in interface javax.naming.Context

Parameters:

name - the name of the context from which to get the parser

Returns:

a name parser that can parse compound names into their atomic
components

composeName

Composes the name of this context with a name relative to this context.

Given a name (name) relative to this context, and the name (prefix)
of this context relative to one of its ancestors, this method returns
the composition of the two names using the syntax appropriate for the
naming system(s) involved. That is, if name names an object relative
to this context, the result is the name of the same object, but
relative to the ancestor context. None of the names may be null.

getEnvironment

Retrieves the environment in effect for this context. See class
description for more details on environment properties.
The caller should not make any changes to the object returned: their
effect on the context is undefined. The environment of this context
may be changed using addToEnvironment() and removeFromEnvironment().

Specified by:

getEnvironment in interface javax.naming.Context

Returns:

the environment of this context; never null

Throws:

javax.naming.NamingException - if a naming exception is encountered

close

public void close()
throws javax.naming.NamingException

Closes this context. This method releases this context's resources
immediately, instead of waiting for them to be released automatically
by the garbage collector.
This method is idempotent: invoking it on a context that has already
been closed has no effect. Invoking any other method on a closed
context is not allowed, and results in undefined behaviour.

Specified by:

close in interface javax.naming.Context

Throws:

javax.naming.NamingException - if a naming exception is encountered

getNameInNamespace

Many naming services have a notion of a "full name" for objects in
their respective namespaces. For example, an LDAP entry has a
distinguished name, and a DNS record has a fully qualified name. This
method allows the client application to retrieve this name. The string
returned by this method is not a JNDI composite name and should not be
passed directly to context methods. In naming systems for which the
notion of full name does not make sense,
OperationNotSupportedException is thrown.

Specified by:

getNameInNamespace in interface javax.naming.Context

Returns:

this context's name in its own namespace; never null

Throws:

OperationNotSupportedException - if the naming system does
not have the notion of a full name

modifyAttributes

Modifies the attributes associated with a named object using an an
ordered list of modifications. The modifications are performed in the
order specified. Each modification specifies a modification operation
code and an attribute on which to operate. Where possible, the
modifications are performed atomically.

Specified by:

modifyAttributes in interface javax.naming.directory.DirContext

Parameters:

name - the name of the object whose attributes will be updated

mods - an ordered sequence of modifications to be performed; may
not be null

Throws:

AttributeModificationException - if the modification cannot be
completed successfully

bind

Binds a name to an object, along with associated attributes. If attrs
is null, the resulting binding will have the attributes associated
with obj if obj is a DirContext, and no attributes otherwise. If attrs
is non-null, the resulting binding will have attrs as its attributes;
any attributes associated with obj are ignored.

Specified by:

bind in interface javax.naming.directory.DirContext

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

attrs - the attributes to associate with the binding

Throws:

NameAlreadyBoundException - if name is already bound

InvalidAttributesException - if some "mandatory" attributes
of the binding are not supplied

rebind

Binds a name to an object, along with associated attributes,
overwriting any existing binding. If attrs is null and obj is a
DirContext, the attributes from obj are used. If attrs is null and obj
is not a DirContext, any existing attributes associated with the object
already bound in the directory remain unchanged. If attrs is non-null,
any existing attributes associated with the object already bound in
the directory are removed and attrs is associated with the named
object. If obj is a DirContext and attrs is non-null, the attributes
of obj are ignored.

Specified by:

rebind in interface javax.naming.directory.DirContext

Parameters:

name - the name to bind; may not be empty

obj - the object to bind; possibly null

attrs - the attributes to associate with the binding

Throws:

InvalidAttributesException - if some "mandatory" attributes
of the binding are not supplied

createSubcontext

Creates and binds a new context, along with associated attributes.
This method creates a new subcontext with the given name, binds it in
the target context (that named by all but terminal atomic component of
the name), and associates the supplied attributes with the newly
created object. All intermediate and target contexts must already
exist. If attrs is null, this method is equivalent to
Context.createSubcontext().

Specified by:

createSubcontext in interface javax.naming.directory.DirContext

Parameters:

name - the name of the context to create; may not be empty

attrs - the attributes to associate with the newly created context

Returns:

the newly created context

Throws:

NameAlreadyBoundException - if the name is already bound

InvalidAttributesException - if attrs does not contain all
the mandatory attributes required for creation

getSchema

Retrieves the schema associated with the named object. The schema
describes rules regarding the structure of the namespace and the
attributes stored within it. The schema specifies what types of
objects can be added to the directory and where they can be added;
what mandatory and optional attributes an object can have. The range
of support for schemas is directory-specific.

search

Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes. The search is
performed using the default SearchControls settings.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - the name of the context to search

matchingAttributes - the attributes to search for. If empty or
null, all objects in the target context are returned.

attributesToReturn - the attributes to return. null indicates
that all attributes are to be returned; an empty array indicates that
none are to be returned.

Returns:

a non-null enumeration of SearchResult objects. Each
SearchResult contains the attributes identified by attributesToReturn
and the name of the corresponding object, named relative to the
context named by name.

Searches in a single context for objects that contain a specified set
of attributes, and retrieves selected attributes.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - the name of the context to search

matchingAttributes - the attributes to search for. If empty or
null, all objects in the target context are returned.

attributesToReturn - the attributes to return. null indicates
that all attributes are to be returned; an empty array indicates that
none are to be returned.

Returns:

a non-null enumeration of SearchResult objects. Each
SearchResult contains the attributes identified by attributesToReturn
and the name of the corresponding object, named relative to the
context named by name.

Throws:

javax.naming.NamingException - if a naming exception is encountered

search

Searches in a single context for objects that contain a specified set
of attributes. This method returns all the attributes of such objects.
It is equivalent to supplying null as the atributesToReturn parameter
to the method search(Name, Attributes, String[]).

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - the name of the context to search

matchingAttributes - the attributes to search for. If empty or
null, all objects in the target context are returned.

Returns:

a non-null enumeration of SearchResult objects. Each
SearchResult contains the attributes identified by attributesToReturn
and the name of the corresponding object, named relative to the
context named by name.

search

Searches in a single context for objects that contain a specified set
of attributes.

Specified by:

search in interface javax.naming.directory.DirContext

Parameters:

name - the name of the context to search

matchingAttributes - the attributes to search for. If empty or
null, all objects in the target context are returned.

Returns:

a non-null enumeration of SearchResult objects. Each
SearchResult contains the attributes identified by attributesToReturn
and the name of the corresponding object, named relative to the
context named by name.