public Object addToEnvironment (String propName, Object propVal) throws NamingException
Implementing: javax.naming.Context
Adds a new environment property to the environment of this
context. If the property already exists, its value is overwritten.
See class description for more details on environment properties.
Returns: the previous value of the property, or null if the property was
not in the environment before
Exceptions:
NamingException | | if a naming exception is encountered |
public
void bind (
String name,
Object obj) throws
NamingExceptionpublic
void bind (
Name name,
Object obj) throws
NamingExceptionImplementing: javax.naming.Context
Binds a name to an object.
All intermediate contexts and the target context (that named by all
but terminal atomic component of the name) must already exist.
Exceptions:
NamingException | | if a naming exception is encountered |
public
void close () throws
NamingExceptionImplementing: javax.naming.Context
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.
Exceptions:
NamingException | | if a naming exception is encountered |
public String composeName (String name, String prefix) throws NamingException
Implementing: javax.naming.Context
Composes the name of this context with a name relative to
this context.
Since an initial context may never be named relative
to any context other than itself, the value of the
prefix parameter must be an empty name ("").
Returns: the composition of prefix and name
Exceptions:
NamingException | | if a naming exception is encountered |
public Name composeName (Name name, Name prefix) throws NamingException
Implementing: javax.naming.Context
Composes the name of this context with a name relative to
this context.
Since an initial context may never be named relative
to any context other than itself, the value of the
prefix parameter must be an empty name.
Returns: the composition of prefix and name
Exceptions:
NamingException | | if a naming exception is encountered |
public Context createSubcontext (String name) throws NamingException
public Context createSubcontext (Name name) throws NamingException
Implementing: javax.naming.Context
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.
Returns: the newly created context
Exceptions:
NamingException | | if a naming exception is encountered |
public
void destroySubcontext (
String name) throws
NamingExceptionpublic
void destroySubcontext (
Name name) throws
NamingExceptionImplementing: javax.naming.Context
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.
Exceptions:
NamingException | | if a naming exception is encountered |
public Hashtable<?, ?> getEnvironment () throws NamingException
Implementing: javax.naming.Context
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().
Returns: the environment of this context; never null
Exceptions:
NamingException | | if a naming exception is encountered |
public String getNameInNamespace () throws NamingException
Implementing: javax.naming.Context
Retrieves the full name of this context within its own namespace.
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.
Returns: this context's name in its own namespace; never null
Exceptions:
NamingException | | if a naming exception is encountered |
public NameParser getNameParser (String name) throws NamingException
Implementing: javax.naming.Context
Retrieves the parser associated with the named context.
See getNameParser(Name) for details.
Returns: a name parser that can parse compound names into their atomic
components
Exceptions:
NamingException | | if a naming exception is encountered |
public NameParser getNameParser (Name name) throws NamingException
Implementing: javax.naming.Context
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).
Returns: a name parser that can parse compound names into their atomic
components
Exceptions:
NamingException | | if a naming exception is encountered |
public NamingEnumeration<NameClassPair> list (String name) throws NamingException
Implementing: javax.naming.Context
Enumerates the names bound in the named context, along with the
class names of objects bound to them.
See list(Name) for details.
Returns: an enumeration of the names and class names of the
bindings in this context. Each element of the
enumeration is of type NameClassPair.
Exceptions:
NamingException | | if a naming exception is encountered |
public NamingEnumeration<NameClassPair> list (Name name) throws NamingException
Implementing: javax.naming.Context
Enumerates the names bound in the named context, along with the
class names of objects bound to them.
The contents of any subcontexts are not included.
If a binding is added to or removed from this context,
its effect on an enumeration previously returned is undefined.
Returns: an enumeration of the names and class names of the
bindings in this context. Each element of the
enumeration is of type NameClassPair.
Exceptions:
NamingException | | if a naming exception is encountered |
public NamingEnumeration<Binding> listBindings (String name) throws NamingException
Implementing: javax.naming.Context
Enumerates the names bound in the named context, along with the
objects bound to them.
See listBindings(Name) for details.
Returns: an enumeration of the bindings in this context.
Each element of the enumeration is of type
Binding.
Exceptions:
NamingException | | if a naming exception is encountered |
public NamingEnumeration<Binding> listBindings (Name name) throws NamingException
Implementing: javax.naming.Context
Enumerates the names bound in the named context, along with the
objects bound to them.
The contents of any subcontexts are not included.
If a binding is added to or removed from this context,
its effect on an enumeration previously returned is undefined.
Returns: an enumeration of the bindings in this context.
Each element of the enumeration is of type
Binding.
Exceptions:
NamingException | | if a naming exception is encountered |
public Object lookup (String name) throws NamingException
Implementing: javax.naming.Context
Retrieves the named object.
See lookup(Name) for details.
Returns: the object bound to name
Exceptions:
NamingException | | if a naming exception is encountered |
public Object lookup (Name name) throws NamingException
Implementing: javax.naming.Context
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).
Returns: the object bound to name
Exceptions:
NamingException | | if a naming exception is encountered |
public Object lookupLink (String name) throws NamingException
Implementing: javax.naming.Context
Retrieves the named object, following links except
for the terminal atomic component of the name.
See lookupLink(Name) for details.
Returns: the object bound to name, not following the
terminal link (if any)
Exceptions:
NamingException | | if a naming exception is encountered |
public Object lookupLink (Name name) throws NamingException
Implementing: javax.naming.Context
Retrieves the named object, following links except
for the terminal atomic component of the name.
If the object bound to name is not a link,
returns the object itself.
Returns: the object bound to name, not following the
terminal link (if any).
Exceptions:
NamingException | | if a naming exception is encountered |
public
void rebind (
String name,
Object obj) throws
NamingExceptionpublic
void rebind (
Name name,
Object obj) throws
NamingExceptionImplementing: javax.naming.Context
Binds a name to an object, overwriting any existing binding.
All intermediate contexts and the target context (that named by all
but terminal atomic component of the name) must already exist.
If the object is a DirContext, any existing attributes
associated with the name are replaced with those of the object.
Otherwise, any existing attributes associated with the name remain
unchanged.
Exceptions:
NamingException | | if a naming exception is encountered |
public Object removeFromEnvironment (String propName) throws NamingException
Implementing: javax.naming.Context
Removes an environment property from the environment of this
context. See class description for more details on environment
properties.
Returns: the previous value of the property, or null if the property was
not in the environment
Exceptions:
NamingException | | if a naming exception is encountered |
public
void rename (
String oldName,
String newName) throws
NamingExceptionImplementing: javax.naming.Context
Binds a new name to the object bound to an old name, and unbinds
the old name.
See rename(Name, Name) for details.
Exceptions:
NamingException | | if a naming exception is encountered |
public
void rename (
Name oldName,
Name newName) throws
NamingExceptionImplementing: javax.naming.Context
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.
Exceptions:
NamingException | | if a naming exception is encountered |
public
void unbind (
String name) throws
NamingExceptionpublic
void unbind (
Name name) throws
NamingExceptionImplementing: javax.naming.Context
Unbinds the named object.
Removes the terminal atomic name in name
from the target context--that named by all but the terminal
atomic part of name.
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.
Any attributes associated with the name are removed.
Intermediate contexts are not changed.
Exceptions:
NamingException | | if a naming exception is encountered |