| java.lang.Object org.ow2.easybeans.naming.pkg.java.JavaURLContext
JavaURLContext | public class JavaURLContext implements Context(Code) | | Context implementation for the "java:" namespace.
author: Florent Benoit |
Method Summary | |
public Object | addToEnvironment(String propName, Object propVal) Adds a new environment property to the environment of this context. | public void | bind(Name name, Object obj) Binds a name to an object. | public void | bind(String name, Object obj) Binds a name to an object. | public void | close() Closes this context. | public Name | composeName(Name name, Name prefix) Composes the name of this context with a name relative to this context. | public String | composeName(String name, String prefix) Composes the name of this context with a name relative to this context. | public Context | createSubcontext(Name name) Creates and binds a new context. | public Context | createSubcontext(String name) Creates and binds a new context. | public void | destroySubcontext(Name name) Destroys the named context and removes it from the namespace. | public void | destroySubcontext(String name) Destroys the named context and removes it from the namespace. | public Context | findContext() | public Hashtable, ?> | getEnvironment() Retrieves the environment in effect for this context. | public String | getNameInNamespace() Retrieves the full name of this context within its own namespace. | public NameParser | getNameParser(Name name) Retrieves the parser associated with the named context. | public NameParser | getNameParser(String name) Retrieves the parser associated with the named context. | public NamingEnumeration<NameClassPair> | list(Name name) Enumerates the names bound in the named context, along with the class
names of objects bound to them. | public NamingEnumeration<NameClassPair> | list(String name) Enumerates the names bound in the named context, along with the class
names of objects bound to them. | public NamingEnumeration<Binding> | listBindings(Name name) Enumerates the names bound in the named context, along with the objects
bound to them. | public NamingEnumeration<Binding> | listBindings(String name) Enumerates the names bound in the named context, along with the objects
bound to them. | public Object | lookup(Name name) Retrieves the named object. | public Object | lookup(String name) Retrieves the named object. | public Object | lookupLink(Name name) Retrieves the named object, following links except for the terminal
atomic component of the name. | public Object | lookupLink(String name) Retrieves the named object, following links except for the terminal
atomic component of the name. | public void | rebind(Name name, Object obj) Binds a name to an object, overwriting any existing binding. | public void | rebind(String name, Object obj) Binds a name to an object, overwriting any existing binding. | public Object | removeFromEnvironment(String propName) Removes an environment property from the environment of this context. | public void | rename(Name oldName, Name newName) Binds a new name to the object bound to an old name, and unbinds the old
name. | public void | rename(String oldName, String newName) Binds a new name to the object bound to an old name, and unbinds the old
name. | public void | unbind(Name name) Unbinds the named object. | public void | unbind(String name) Unbinds the named object. |
addToEnvironment | public Object addToEnvironment(String propName, Object propVal) throws NamingException(Code) | | 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.
Parameters: propName - the name of the environment property to add; may not benull Parameters: propVal - the value of the property to add; may not be null the previous value of the property, or null if the property wasnot in the environment before throws: NamingException - if a naming exception is encountered |
bind | public void bind(Name name, Object obj) throws NamingException(Code) | | Binds a name to an object.
Parameters: name - the name to bind; may not be empty Parameters: obj - the object to bind; possibly null throws: NamingException - if a naming exception is encountered |
bind | public void bind(String name, Object obj) throws NamingException(Code) | | 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 - the name to bind; may not be empty Parameters: obj - the object to bind; possibly null throws: NamingException - if a naming exception is encountered |
close | public void close() throws NamingException(Code) | | 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.
throws: NamingException - if a naming exception is encountered |
composeName | public Name composeName(Name name, Name prefix) throws NamingException(Code) | | Composes the name of this context with a name relative to this context.
Parameters: name - a name relative to this context Parameters: prefix - the name of this context relative to one of its ancestors the composition of prefix and name throws: NamingException - if a naming exception is encountered |
composeName | public String composeName(String name, String prefix) throws NamingException(Code) | | Composes the name of this context with a name relative to this context.
Parameters: name - a name relative to this context Parameters: prefix - the name of this context relative to one of its ancestors the composition of prefix and name throws: NamingException - if a naming exception is encountered |
createSubcontext | public Context createSubcontext(Name name) throws NamingException(Code) | | 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 - the name of the context to create; may not be empty the newly created context throws: NamingException - if a naming exception is encountered |
destroySubcontext | public void destroySubcontext(Name name) throws NamingException(Code) | | 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 - the name of the context to be destroyed; may not be empty throws: NamingException - if a naming exception is encountered |
getEnvironment | public Hashtable, ?> getEnvironment() throws NamingException(Code) | | 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().
the environment of this context; never null throws: NamingException - if a naming exception is encountered |
getNameInNamespace | public String getNameInNamespace() throws NamingException(Code) | | Retrieves the full name of this context within its own namespace.
this context's name in its own namespace; never null throws: NamingException - if a naming exception is encountered |
getNameParser | public NameParser getNameParser(Name name) throws NamingException(Code) | | 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 - the name of the context from which to get the parser a name parser that can parse compound names into their atomiccomponents throws: NamingException - if a naming exception is encountered |
list | public NamingEnumeration<NameClassPair> list(Name name) throws NamingException(Code) | | 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 - the name of the context to list an enumeration of the names and class names of the bindings inthis context. Each element of the enumeration is of typeNameClassPair. throws: NamingException - if a naming exception is encountered |
listBindings | public NamingEnumeration<Binding> listBindings(Name name) throws NamingException(Code) | | 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 - the name of the context to list an enumeration of the bindings in this context. Each element ofthe enumeration is of type Binding. throws: NamingException - if a naming exception is encountered |
lookup | public Object lookup(Name name) throws NamingException(Code) | | Retrieves the named object.
Parameters: name - the name of the object to look up the object bound to name throws: NamingException - if a naming exception is encountered |
lookupLink | public Object lookupLink(Name name) throws NamingException(Code) | | 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 - the name of the object to look up the object bound to name, not following the terminal link (ifany). throws: NamingException - if a naming exception is encountered |
lookupLink | public Object lookupLink(String name) throws NamingException(Code) | | Retrieves the named object, following links except for the terminal
atomic component of the name. See
JavaURLContext.lookupLink(Name) for details.
Parameters: name - the name of the object to look up the object bound to name, not following the terminal link (ifany) throws: NamingException - if a naming exception is encountered |
rebind | public void rebind(Name name, Object obj) throws NamingException(Code) | | 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 - the name to bind; may not be empty Parameters: obj - the object to bind; possibly null throws: NamingException - if a naming exception is encountered |
removeFromEnvironment | public Object removeFromEnvironment(String propName) throws NamingException(Code) | | Removes an environment property from the environment of this context. See
class description for more details on environment properties.
Parameters: propName - the name of the environment property to remove; may notbe null the previous value of the property, or null if the property wasnot in the environment throws: NamingException - if a naming exception is encountered |
rename | public void rename(Name oldName, Name newName) throws NamingException(Code) | | Binds a new name to the object bound to an old name, and unbinds the old
name. This operation is not supported (read only env.)
Parameters: oldName - the name of the existing binding; may not be empty Parameters: newName - the name of the new binding; may not be empty throws: NamingException - if a naming exception is encountered |
rename | public void rename(String oldName, String newName) throws NamingException(Code) | | Binds a new name to the object bound to an old name, and unbinds the old
name. Not supported.
Parameters: oldName - the name of the existing binding; may not be empty Parameters: newName - the name of the new binding; may not be empty throws: NamingException - if a naming exception is encountered |
unbind | public void unbind(Name name) throws NamingException(Code) | | 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.
Parameters: name - the name to unbind; may not be empty throws: NamingException - if a naming exception is encountered See Also: JavaURLContext.unbind(String) |
|
|