| java.lang.Object
 uk.org.primrose.jndi.PrimroseContext
All known Subclasses: uk.org.primrose.jndi.PrimroseInitialContext,
| PrimroseContext | | public class PrimroseContext implements Context(Code) | | |
| 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.
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. | | public Name | composeName(Name name, Name prefix)
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. | | 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.
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). | | 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.
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. | | public void | destroySubcontext(String name)
Destroys the named context and removes it from the namespace. | | 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.
Many naming services have a notion of a "full name" for objects
in their respective namespaces. | | public NameParser | getNameParser(Name name)
Retrieves the parser associated with the named context.
In a federation of namespaces, different naming systems will
parse names differently. | | public NameParser | getNameParser(String name)
Retrieves the parser associated with the named context. | | public NamingEnumeration | list(Name name)
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 thebindings in this context. | | public NamingEnumeration | list(String name)
Enumerates the names bound in the named context, along with the
class names of objects bound to them.
See
PrimroseContext.list(Name) for details.
Parameters:
name - the name of the context to list an enumeration of the names and class names of thebindings in this context. | | public NamingEnumeration | listBindings(Name name)
Enumerates the names bound in the named context, along with the
objects bound to them. | | public NamingEnumeration | 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 be null
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
See Also: PrimroseContext.getEnvironment()
See Also: PrimroseContext.removeFromEnvironment(String) |
| 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.
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.
For example, if this context is named "wiz.com" relative
to the initial context, then
composeName("east", "wiz.com")
might return "east.wiz.com".
If instead this context is named "org/research", then
composeName("user/jane", "org/research")
might return "org/research/user/jane" while
composeName("user/jane", "research")
returns "research/user/jane".
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
See Also: PrimroseContext.composeName(String,String) |
| 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:
NameNotFoundException - if an intermediate context does not exist
throws:
NotContextException - if the name is bound but does not name acontext, or does not name a context of the appropriate type
throws:
ContextNotEmptyException - if the named context is not empty
throws:
NamingException - if a naming exception is encountered
See Also: PrimroseContext.destroySubcontext(String) |
| getNameInNamespace | | public String getNameInNamespace() throws NamingException(Code) | | 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.
this context's name in its own namespace {} never null
throws:
OperationNotSupportedException - if the naming system doesnot have the notion of a full name
throws:
NamingException - if a naming exception is encountered
since:
1.3 |
| 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
See Also: PrimroseContext.getNameParser(String)
See Also: CompoundName |
| list | | public NamingEnumeration 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 thebindings in this context. Each element of theenumeration is of type NameClassPair.
throws:
NamingException - if a naming exception is encountered
See Also: PrimroseContext.list(String)
See Also: PrimroseContext.listBindings(Name)
See Also: NameClassPair |
| list | | public NamingEnumeration list(String name) throws NamingException(Code) | | Enumerates the names bound in the named context, along with the
class names of objects bound to them.
See
PrimroseContext.list(Name) for details.
Parameters:
name - the name of the context to list an enumeration of the names and class names of thebindings in this context. Each element of theenumeration is of type NameClassPair.
throws:
NamingException - if a naming exception is encountered |
| listBindings | | public NamingEnumeration 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 of the enumeration is of typeBinding.
throws:
NamingException - if a naming exception is encountered
See Also: PrimroseContext.listBindings(String)
See Also: PrimroseContext.list(Name)
See Also: Binding |
| 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 theterminal link (if any).
throws:
NamingException - if a naming exception is encountered
See Also: PrimroseContext.lookupLink(String) |
| 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
PrimroseContext.lookupLink(Name) for details.
Parameters:
name - the name of the object to look up the object bound to name, not following theterminal link (if any)
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:
NameNotFoundException - if an intermediate context does not exist
throws:
NamingException - if a naming exception is encountered
See Also: PrimroseContext.unbind(String) |
|
|