Tomcat 10.1.19 · org.apache.naming.NamingContext · APIdia, the JavaDoc alternative

Modifier and Type	Field and Description
protected final HashMap<String, NamingEntry>	bindings Bindings in this Context.
protected final Hashtable<String, Object>	env Environment.
private boolean	exceptionOnFailedWrite Determines if an attempt to write to a read-only context results in an exception or if the request is ignored.
private static final boolean	GRAAL
private static final Log	log
protected final String	name Name of the associated Catalina Context.
protected static final NameParser	nameParser Name parser for this context.
protected static final StringManager	sm The string manager for this package.

Access	Constructor and Description
public	NamingContext(Hashtable<String, Object> The environment to use to construct the naming context env, String The name of the associated Catalina Context name) Builds a naming context.
public	NamingContext(Hashtable<String, Object> The environment to use to construct the naming context env, String The name of the associated Catalina Context name, HashMap<String, NamingEntry> The initial bindings for the naming context bindings) Builds a naming context.

Method Summary

Modifier and Type	Method and Description
public Object	addToEnvironment(String the name of the environment property to add; may not be null propName, Object the value of the property to add; may not be null propVal) Implements javax.naming.Context.addToEnvironment. Adds a new environment property to the environment of this context.
public void	bind(Name the name to bind; may not be empty name, Object the object to bind; possibly null obj) Implements javax.naming.Context.bind. Binds a name to an object.
public void	bind(String the name to bind; may not be empty name, Object the object to bind; possibly null obj) Implements javax.naming.Context.bind. Binds a name to an object.
protected void	bind(Name the name to bind; may not be empty name, Object the object to bind; possibly null obj, boolean if true, then perform a rebind (ie, overwrite) rebind) Binds a name to an object.
protected boolean	Returns: `true` if the Context is writable checkWritable() Throws a naming exception is Context is not writable.
public void	close() Implements javax.naming.Context.close. Closes this context.
public Name	Returns: the composition of prefix and name composeName(Name a name relative to this context name, Name the name of this context relative to one of its ancestors prefix) Implements javax.naming.Context.composeName. Composes the name of this context with a name relative to this context.
public String	Returns: the composition of prefix and name composeName(String a name relative to this context name, String the name of this context relative to one of its ancestors prefix) Implements javax.naming.Context.composeName. Composes the name of this context with a name relative to this context.
public Context	Returns: the newly created context createSubcontext(Name the name of the context to create; may not be empty name) Implements javax.naming.Context.createSubcontext. Creates and binds a new context.
public Context	Returns: the newly created context createSubcontext(String the name of the context to create; may not be empty name) Implements javax.naming.Context.createSubcontext. Creates and binds a new context.
public void	destroySubcontext(Name the name of the context to be destroyed; may not be empty name) Implements javax.naming.Context.destroySubcontext. Destroys the named context and removes it from the namespace.
public void	destroySubcontext(String the name of the context to be destroyed; may not be empty name) Implements javax.naming.Context.destroySubcontext. Destroys the named context and removes it from the namespace.
public Hashtable<?, ?>	Returns: the environment of this context; never null getEnvironment() Implements javax.naming.Context.getEnvironment. Retrieves the environment in effect for this context.
public boolean	getExceptionOnFailedWrite()
public String	Returns: this context's name in its own namespace; never null getNameInNamespace() Implements javax.naming.Context.getNameInNamespace. Retrieves the full name of this context within its own namespace.
public NameParser	Returns: a name parser that can parse compound names into their atomic components getNameParser(Name the name of the context from which to get the parser name) Implements javax.naming.Context.getNameParser. Retrieves the parser associated with the named context.
public NameParser	Returns: a name parser that can parse compound names into their atomic components getNameParser(String the name of the context from which to get the parser name) Implements javax.naming.Context.getNameParser. Retrieves the parser associated with the named context.
protected boolean	Returns: `true` if writing is allowed on this context. isWritable()
public NamingEnumeration<NameClassPair>	Returns: an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair. list(Name the name of the context to list name) Implements javax.naming.Context.list. Enumerates the names bound in the named context, along with the class names of objects bound to them.
public NamingEnumeration<NameClassPair>	Returns: an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair. list(String the name of the context to list name) Implements javax.naming.Context.list. Enumerates the names bound in the named context, along with the class names of objects bound to them.
public NamingEnumeration<Binding>	Returns: an enumeration of the bindings in this context. Each element of the enumeration is of type Binding. listBindings(Name the name of the context to list name) Implements javax.naming.Context.listBindings. Enumerates the names bound in the named context, along with the objects bound to them.
public NamingEnumeration<Binding>	Returns: an enumeration of the bindings in this context. Each element of the enumeration is of type Binding. listBindings(String the name of the context to list name) Implements javax.naming.Context.listBindings. Enumerates the names bound in the named context, along with the objects bound to them.
public Object	Returns: the object bound to name lookup(Name the name of the object to look up name) Implements javax.naming.Context.lookup. Retrieves the named object.
public Object	Returns: the object bound to name lookup(String the name of the object to look up name) Implements javax.naming.Context.lookup. Retrieves the named object.
protected Object	Returns: the object bound to name lookup(Name the name of the object to look up name, boolean If true, the links will be resolved resolveLinks) Retrieves the named object.
public Object	Returns: the object bound to name, not following the terminal link (if any). lookupLink(Name the name of the object to look up name) Implements javax.naming.Context.lookupLink. Retrieves the named object, following links except for the terminal atomic component of the name.
public Object	Returns: the object bound to name, not following the terminal link (if any). lookupLink(String the name of the object to look up name) Implements javax.naming.Context.lookupLink. Retrieves the named object, following links except for the terminal atomic component of the name.
public void	rebind(Name the name to bind; may not be empty name, Object the object to bind; possibly null obj) Implements javax.naming.Context.rebind. Binds a name to an object, overwriting any existing binding.
public void	rebind(String the name to bind; may not be empty name, Object the object to bind; possibly null obj) Implements javax.naming.Context.rebind. Binds a name to an object, overwriting any existing binding.
public Object	removeFromEnvironment(String the name of the environment property to remove; may not be null propName) Implements javax.naming.Context.removeFromEnvironment. Removes an environment property from the environment of this context.
public void	rename(Name the name of the existing binding; may not be empty oldName, Name the name of the new binding; may not be empty newName) Implements javax.naming.Context.rename. Binds a new name to the object bound to an old name, and unbinds the old name.
public void	rename(String the name of the existing binding; may not be empty oldName, String the name of the new binding; may not be empty newName) Implements javax.naming.Context.rename. Binds a new name to the object bound to an old name, and unbinds the old name.
public void	setExceptionOnFailedWrite(boolean exceptionOnFailedWrite)
public void	unbind(Name the name to bind; may not be empty name) Implements javax.naming.Context.unbind. Unbinds the named object.
public void	unbind(String the name to bind; may not be empty name) Implements javax.naming.Context.unbind. Unbinds the named object.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

bindings	back to summary
protected final HashMap<String, NamingEntry> bindings Bindings in this Context.

env	back to summary
protected final Hashtable<String, Object> env Environment.

exceptionOnFailedWrite	back to summary
private boolean exceptionOnFailedWrite Determines if an attempt to write to a read-only context results in an exception or if the request is ignored.

GRAAL	back to summary
private static final boolean GRAAL

log	back to summary
private static final Log log

name	back to summary
protected final String name Name of the associated Catalina Context.

nameParser	back to summary
protected static final NameParser nameParser Name parser for this context.

sm	back to summary
protected static final StringManager sm The string manager for this package.

NamingContext	back to summary
public NamingContext(Hashtable<String, Object> env, String name) Builds a naming context. Parameters env:Hashtable<String, Object> The environment to use to construct the naming context name:String The name of the associated Catalina Context

NamingContext	back to summary
public NamingContext(Hashtable<String, Object> env, String name, HashMap<String, NamingEntry> bindings) Builds a naming context. Parameters env:Hashtable<String, Object> The environment to use to construct the naming context name:String The name of the associated Catalina Context bindings:HashMap<String, NamingEntry> The initial bindings for the naming context

Method Detail

addToEnvironment	back to summary
public Object addToEnvironment(String propName, Object propVal) Implements javax.naming.Context.addToEnvironment. Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten. Parameters propName:String the name of the environment property to add; may not be null propVal:Object the value of the property to add; may not be null Returns:Object Doc from javax.naming.Context.addToEnvironment. the previous value of the property, or null if the property was not in the environment before Annotations @Override

addToEnvironment

back to summary

public Object addToEnvironment(String propName, Object propVal)

Implements javax.naming.Context.addToEnvironment.

Adds a new environment property to the environment of this context. If the property already exists, its value is overwritten.

Parameters

propName:String: the name of the environment property to add; may not be null
propVal:Object: the value of the property to add; may not be null

Returns:Object

Doc from javax.naming.Context.addToEnvironment.

the previous value of the property, or null if the property was not in the environment before

Annotations

@Override

bind	back to summary
public void bind(Name name, Object obj) throws NamingException Implements javax.naming.Context.bind. 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. Parameters name:Name the name to bind; may not be empty obj:Object the object to bind; possibly null Annotations @Override Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if name is already bound InvalidAttributesException: if object did not supply all mandatory attributes

bind

back to summary

public void bind(Name name, Object obj) throws NamingException

Implements javax.naming.Context.bind.

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.

Parameters

name:Name: the name to bind; may not be empty
obj:Object: the object to bind; possibly null

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if name is already bound
InvalidAttributesException:: if object did not supply all mandatory attributes

bind	back to summary
public void bind(String name, Object obj) throws NamingException Implements javax.naming.Context.bind. Binds a name to an object. Parameters name:String the name to bind; may not be empty obj:Object the object to bind; possibly null Annotations @Override Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if name is already bound InvalidAttributesException: if object did not supply all mandatory attributes

bind

back to summary

public void bind(String name, Object obj) throws NamingException

Implements javax.naming.Context.bind.

Binds a name to an object.

Parameters

name:String: the name to bind; may not be empty
obj:Object: the object to bind; possibly null

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if name is already bound
InvalidAttributesException:: if object did not supply all mandatory attributes

bind	back to summary
protected void bind(Name name, Object obj, boolean rebind) throws NamingException 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. Parameters name:Name the name to bind; may not be empty obj:Object the object to bind; possibly null rebind:boolean if true, then perform a rebind (ie, overwrite) Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if name is already bound InvalidAttributesException: if object did not supply all mandatory attributes

bind

back to summary

protected void bind(Name name, Object obj, boolean rebind) throws NamingException

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.

Parameters

name:Name: the name to bind; may not be empty
obj:Object: the object to bind; possibly null
rebind:boolean: if true, then perform a rebind (ie, overwrite)

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if name is already bound
InvalidAttributesException:: if object did not supply all mandatory attributes

checkWritable back to summary

checkWritable	back to summary
protected boolean checkWritable() throws NamingException Throws a naming exception is Context is not writable. Returns:boolean `true` if the Context is writable Exceptions NamingException: if the Context is not writable and `exceptionOnFailedWrite` is `true`

protected boolean checkWritable() throws NamingException

Throws a naming exception is Context is not writable.

Returns:boolean

true if the Context is writable

Exceptions

NamingException:: if the Context is not writable and exceptionOnFailedWrite is true

close	back to summary
public void close() throws NamingException Implements javax.naming.Context.close. 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. Annotations @Override Exceptions NamingException: if a naming exception is encountered

back to summary

public void close() throws NamingException

Implements javax.naming.Context.close.

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.

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

composeName	back to summary
public Name composeName(Name name, Name prefix) throws NamingException Implements javax.naming.Context.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. Parameters name:Name a name relative to this context prefix:Name the name of this context relative to one of its ancestors Returns:Name the composition of prefix and name Annotations @Override Exceptions NamingException: if a naming exception is encountered

composeName

back to summary

public Name composeName(Name name, Name prefix) throws NamingException

Implements javax.naming.Context.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.

Parameters

name:Name: a name relative to this context
prefix:Name: the name of this context relative to one of its ancestors

Returns:Name

the composition of prefix and name

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

composeName	back to summary
public String composeName(String name, String prefix) Implements javax.naming.Context.composeName. Composes the name of this context with a name relative to this context. Parameters name:String a name relative to this context prefix:String the name of this context relative to one of its ancestors Returns:String the composition of prefix and name Annotations @Override

composeName

back to summary

public String composeName(String name, String prefix)

Implements javax.naming.Context.composeName.

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

Parameters

name:String: a name relative to this context
prefix:String: the name of this context relative to one of its ancestors

Returns:String

the composition of prefix and name

Annotations

@Override

createSubcontext	back to summary
public Context createSubcontext(Name name) throws NamingException Implements javax.naming.Context.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. Parameters name:Name the name of the context to create; may not be empty Returns:Context the newly created context Annotations @Override Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if name is already bound InvalidAttributesException: if creation of the sub-context requires specification of mandatory attributes

createSubcontext

back to summary

public Context createSubcontext(Name name) throws NamingException

Implements javax.naming.Context.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.

Parameters

name:Name: the name of the context to create; may not be empty

Returns:Context

the newly created context

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if name is already bound
InvalidAttributesException:: if creation of the sub-context requires specification of mandatory attributes

createSubcontext	back to summary
public Context createSubcontext(String name) throws NamingException Implements javax.naming.Context.createSubcontext. Creates and binds a new context. Parameters name:String the name of the context to create; may not be empty Returns:Context the newly created context Annotations @Override Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if name is already bound InvalidAttributesException: if creation of the sub-context requires specification of mandatory attributes

createSubcontext

back to summary

public Context createSubcontext(String name) throws NamingException

Implements javax.naming.Context.createSubcontext.

Creates and binds a new context.

Parameters

name:String: the name of the context to create; may not be empty

Returns:Context

the newly created context

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if name is already bound
InvalidAttributesException:: if creation of the sub-context requires specification of mandatory attributes

destroySubcontext	back to summary
public void destroySubcontext(Name name) throws NamingException Implements javax.naming.Context.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. Parameters name:Name the name of the context to be destroyed; may not be empty Annotations @Override Exceptions NamingException: Doc from javax.naming.Context.destroySubcontext. if a naming exception is encountered 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

destroySubcontext

back to summary

public void destroySubcontext(Name name) throws NamingException

Implements javax.naming.Context.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.

Parameters

name:Name: the name of the context to be destroyed; may not be empty

Annotations

@Override

Exceptions

NamingException:

Doc from javax.naming.Context.destroySubcontext.

if a naming exception is encountered

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

destroySubcontext	back to summary
public void destroySubcontext(String name) throws NamingException Implements javax.naming.Context.destroySubcontext. Destroys the named context and removes it from the namespace. Parameters name:String the name of the context to be destroyed; may not be empty Annotations @Override Exceptions NamingException: Doc from javax.naming.Context.destroySubcontext. if a naming exception is encountered 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

destroySubcontext

back to summary

public void destroySubcontext(String name) throws NamingException

Implements javax.naming.Context.destroySubcontext.

Destroys the named context and removes it from the namespace.

Parameters

name:String: the name of the context to be destroyed; may not be empty

Annotations

@Override

Exceptions

NamingException:

Doc from javax.naming.Context.destroySubcontext.

if a naming exception is encountered

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

getEnvironment	back to summary
public Hashtable<?, ?> getEnvironment() Implements javax.naming.Context.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(). Returns:Hashtable<?, ?> the environment of this context; never null Annotations @Override

getEnvironment

back to summary

public Hashtable<?, ?> getEnvironment()

Implements javax.naming.Context.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().

Returns:Hashtable<?, ?>

the environment of this context; never null

Annotations

@Override

getExceptionOnFailedWrite	back to summary
public boolean getExceptionOnFailedWrite()

getNameInNamespace	back to summary
public String getNameInNamespace() throws NamingException Implements javax.naming.Context.getNameInNamespace. 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:String this context's name in its own namespace; never null Annotations @Override Exceptions NamingException: if a naming exception is encountered OperationNotSupportedException: if the naming system does not have the notion of a full name

getNameInNamespace

back to summary

public String getNameInNamespace() throws NamingException

Implements javax.naming.Context.getNameInNamespace.

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:String

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

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
OperationNotSupportedException:: if the naming system does not have the notion of a full name

getNameParser	back to summary
public NameParser getNameParser(Name name) throws NamingException Implements javax.naming.Context.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). Parameters name:Name the name of the context from which to get the parser Returns:NameParser a name parser that can parse compound names into their atomic components Annotations @Override Exceptions NamingException: if a naming exception is encountered

getNameParser

back to summary

public NameParser getNameParser(Name name) throws NamingException

Implements javax.naming.Context.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).

Parameters

name:Name: the name of the context from which to get the parser

Returns:NameParser

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

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

getNameParser	back to summary
public NameParser getNameParser(String name) throws NamingException Implements javax.naming.Context.getNameParser. Retrieves the parser associated with the named context. Parameters name:String the name of the context from which to get the parser Returns:NameParser a name parser that can parse compound names into their atomic components Annotations @Override Exceptions NamingException: if a naming exception is encountered

getNameParser

back to summary

public NameParser getNameParser(String name) throws NamingException

Implements javax.naming.Context.getNameParser.

Retrieves the parser associated with the named context.

Parameters

name:String: the name of the context from which to get the parser

Returns:NameParser

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

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

isWritable	back to summary
protected boolean isWritable() Returns:boolean `true` if writing is allowed on this context.

list	back to summary
public NamingEnumeration<NameClassPair> list(Name name) throws NamingException Implements javax.naming.Context.list. 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. Parameters name:Name the name of the context to list Returns:NamingEnumeration<NameClassPair> an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair. Annotations @Override Exceptions NamingException: if a naming exception is encountered

list

back to summary

public NamingEnumeration<NameClassPair> list(Name name) throws NamingException

Implements javax.naming.Context.list.

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.

Parameters

name:Name: the name of the context to list

Returns:NamingEnumeration<NameClassPair>

an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

list	back to summary
public NamingEnumeration<NameClassPair> list(String name) throws NamingException Implements javax.naming.Context.list. Enumerates the names bound in the named context, along with the class names of objects bound to them. Parameters name:String the name of the context to list Returns:NamingEnumeration<NameClassPair> an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair. Annotations @Override Exceptions NamingException: if a naming exception is encountered

list

back to summary

public NamingEnumeration<NameClassPair> list(String name) throws NamingException

Implements javax.naming.Context.list.

Enumerates the names bound in the named context, along with the class names of objects bound to them.

Parameters

name:String: the name of the context to list

Returns:NamingEnumeration<NameClassPair>

an enumeration of the names and class names of the bindings in this context. Each element of the enumeration is of type NameClassPair.

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

listBindings	back to summary
public NamingEnumeration<Binding> listBindings(Name name) throws NamingException Implements javax.naming.Context.listBindings. 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. Parameters name:Name the name of the context to list Returns:NamingEnumeration<Binding> an enumeration of the bindings in this context. Each element of the enumeration is of type Binding. Annotations @Override Exceptions NamingException: if a naming exception is encountered

listBindings

back to summary

public NamingEnumeration<Binding> listBindings(Name name) throws NamingException

Implements javax.naming.Context.listBindings.

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.

Parameters

name:Name: the name of the context to list

Returns:NamingEnumeration<Binding>

an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

listBindings	back to summary
public NamingEnumeration<Binding> listBindings(String name) throws NamingException Implements javax.naming.Context.listBindings. Enumerates the names bound in the named context, along with the objects bound to them. Parameters name:String the name of the context to list Returns:NamingEnumeration<Binding> an enumeration of the bindings in this context. Each element of the enumeration is of type Binding. Annotations @Override Exceptions NamingException: if a naming exception is encountered

listBindings

back to summary

public NamingEnumeration<Binding> listBindings(String name) throws NamingException

Implements javax.naming.Context.listBindings.

Enumerates the names bound in the named context, along with the objects bound to them.

Parameters

name:String: the name of the context to list

Returns:NamingEnumeration<Binding>

an enumeration of the bindings in this context. Each element of the enumeration is of type Binding.

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

lookup	back to summary
public Object lookup(Name name) throws NamingException Implements javax.naming.Context.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). Parameters name:Name the name of the object to look up Returns:Object the object bound to name Annotations @Override Exceptions NamingException: if a naming exception is encountered

lookup

back to summary

public Object lookup(Name name) throws NamingException

Implements javax.naming.Context.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).

Parameters

name:Name: the name of the object to look up

Returns:Object

the object bound to name

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

lookup	back to summary
public Object lookup(String name) throws NamingException Implements javax.naming.Context.lookup. Retrieves the named object. Parameters name:String the name of the object to look up Returns:Object the object bound to name Annotations @Override Exceptions NamingException: if a naming exception is encountered

lookup

back to summary

public Object lookup(String name) throws NamingException

Implements javax.naming.Context.lookup.

Retrieves the named object.

Parameters

name:String: the name of the object to look up

Returns:Object

the object bound to name

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

lookup	back to summary
protected Object lookup(Name name, boolean resolveLinks) throws NamingException Retrieves the named object. Parameters name:Name the name of the object to look up resolveLinks:boolean If true, the links will be resolved Returns:Object the object bound to name Exceptions NamingException: if a naming exception is encountered

lookup

back to summary

protected Object lookup(Name name, boolean resolveLinks) throws NamingException

Retrieves the named object.

Parameters

name:Name: the name of the object to look up
resolveLinks:boolean: If true, the links will be resolved

Returns:Object

the object bound to name

Exceptions

NamingException:: if a naming exception is encountered

lookupLink	back to summary
public Object lookupLink(Name name) throws NamingException Implements javax.naming.Context.lookupLink. 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. Parameters name:Name the name of the object to look up Returns:Object the object bound to name, not following the terminal link (if any). Annotations @Override Exceptions NamingException: if a naming exception is encountered

lookupLink

back to summary

public Object lookupLink(Name name) throws NamingException

Implements javax.naming.Context.lookupLink.

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.

Parameters

name:Name: the name of the object to look up

Returns:Object

the object bound to name, not following the terminal link (if any).

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

lookupLink	back to summary
public Object lookupLink(String name) throws NamingException Implements javax.naming.Context.lookupLink. Retrieves the named object, following links except for the terminal atomic component of the name. Parameters name:String the name of the object to look up Returns:Object the object bound to name, not following the terminal link (if any). Annotations @Override Exceptions NamingException: if a naming exception is encountered

lookupLink

back to summary

public Object lookupLink(String name) throws NamingException

Implements javax.naming.Context.lookupLink.

Retrieves the named object, following links except for the terminal atomic component of the name.

Parameters

name:String: the name of the object to look up

Returns:Object

the object bound to name, not following the terminal link (if any).

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered

rebind	back to summary
public void rebind(Name name, Object obj) throws NamingException Implements javax.naming.Context.rebind. 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. Parameters name:Name the name to bind; may not be empty obj:Object the object to bind; possibly null Annotations @Override Exceptions NamingException: if a naming exception is encountered InvalidAttributesException: if object did not supply all mandatory attributes

rebind

back to summary

public void rebind(Name name, Object obj) throws NamingException

Implements javax.naming.Context.rebind.

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.

Parameters

name:Name: the name to bind; may not be empty
obj:Object: the object to bind; possibly null

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
InvalidAttributesException:: if object did not supply all mandatory attributes

rebind	back to summary
public void rebind(String name, Object obj) throws NamingException Implements javax.naming.Context.rebind. Binds a name to an object, overwriting any existing binding. Parameters name:String the name to bind; may not be empty obj:Object the object to bind; possibly null Annotations @Override Exceptions NamingException: if a naming exception is encountered InvalidAttributesException: if object did not supply all mandatory attributes

rebind

back to summary

public void rebind(String name, Object obj) throws NamingException

Implements javax.naming.Context.rebind.

Binds a name to an object, overwriting any existing binding.

Parameters

name:String: the name to bind; may not be empty
obj:Object: the object to bind; possibly null

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
InvalidAttributesException:: if object did not supply all mandatory attributes

removeFromEnvironment	back to summary
public Object removeFromEnvironment(String propName) Implements javax.naming.Context.removeFromEnvironment. Removes an environment property from the environment of this context. Parameters propName:String the name of the environment property to remove; may not be null Returns:Object Doc from javax.naming.Context.removeFromEnvironment. the previous value of the property, or null if the property was not in the environment Annotations @Override

removeFromEnvironment

back to summary

public Object removeFromEnvironment(String propName)

Implements javax.naming.Context.removeFromEnvironment.

Removes an environment property from the environment of this context.

Parameters

propName:String: the name of the environment property to remove; may not be null

Returns:Object

Doc from javax.naming.Context.removeFromEnvironment.

the previous value of the property, or null if the property was not in the environment

Annotations

@Override

rename	back to summary
public void rename(Name oldName, Name newName) throws NamingException Implements javax.naming.Context.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. Parameters oldName:Name the name of the existing binding; may not be empty newName:Name the name of the new binding; may not be empty Annotations @Override Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if newName is already bound

rename

back to summary

public void rename(Name oldName, Name newName) throws NamingException

Implements javax.naming.Context.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.

Parameters

oldName:Name: the name of the existing binding; may not be empty
newName:Name: the name of the new binding; may not be empty

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if newName is already bound

rename	back to summary
public void rename(String oldName, String newName) throws NamingException Implements javax.naming.Context.rename. Binds a new name to the object bound to an old name, and unbinds the old name. Parameters oldName:String the name of the existing binding; may not be empty newName:String the name of the new binding; may not be empty Annotations @Override Exceptions NamingException: if a naming exception is encountered NameAlreadyBoundException: if newName is already bound

rename

back to summary

public void rename(String oldName, String newName) throws NamingException

Implements javax.naming.Context.rename.

Binds a new name to the object bound to an old name, and unbinds the old name.

Parameters

oldName:String: the name of the existing binding; may not be empty
newName:String: the name of the new binding; may not be empty

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameAlreadyBoundException:: if newName is already bound

setExceptionOnFailedWrite	back to summary
public void setExceptionOnFailedWrite(boolean exceptionOnFailedWrite)

unbind	back to summary
public void unbind(Name name) throws NamingException Implements javax.naming.Context.unbind. 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. Parameters name:Name the name to bind; may not be empty Annotations @Override Exceptions NamingException: if a naming exception is encountered NameNotFoundException: if an intermediate context does not exist

unbind

back to summary

public void unbind(Name name) throws NamingException

Implements javax.naming.Context.unbind.

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.

Parameters

name:Name: the name to bind; may not be empty

Annotations

@Override

Exceptions

NamingException:: if a naming exception is encountered
NameNotFoundException:: if an intermediate context does not exist

unbind	back to summary
public void unbind(String name) throws NamingException Implements javax.naming.Context.unbind. Unbinds the named object. Parameters name:String the name to bind; may not be empty Annotations @Override Exceptions NamingException: if a naming exception is encountered NameNotFoundException: if an intermediate context does not exist

unbind

back to summary

public void unbind(String name) throws NamingException

Implements javax.naming.Context.unbind.

Unbinds the named object.

Parameters