public interface RemoteContextInterface extends Remote
(c) copyright 2002-2005 Delft
University of Technology , the Netherlands.
See for project information www.simulation.tudelft.nl
License of use: Lesser
General Public License (LGPL) , no warranty.
Modifier and Type | Field and Description |
---|---|
static String |
WRAPPED_PREFIX
Constant defining the first part of properties wrapped by our remote
construction.
|
Modifier and Type | Method and Description |
---|---|
void |
addNamingListener(Name target,
int scope,
RemoteContextListenerInterface l)
Adds a listener for receiving naming events fired when the object(s)
identified by a target and scope changes.
|
void |
addNamingListener(String target,
int scope,
RemoteContextListenerInterface l)
Adds a listener for receiving naming events fired when the object named
by the string target name and scope changes.
|
Object |
addToEnvironment(String propName,
Object propVal)
Adds a new environment property to the environment of this context.
|
void |
bind(Name name,
Object obj)
Binds a name to an object.
|
void |
bind(String name,
Object obj)
Binds a name to an object.
|
void |
close()
Closes this context.
|
Name |
composeName(Name name,
Name prefix)
Composes the name of this context with a name relative to this context.
|
String |
composeName(String name,
String prefix)
Composes the name of this context with a name relative to this context.
|
RemoteContextInterface |
createSubcontext(Name name)
Creates and binds a new context.
|
RemoteContextInterface |
createSubcontext(String name)
Creates and binds a new context.
|
void |
destroySubcontext(Name name)
Destroys the named context and removes it from the namespace.
|
void |
destroySubcontext(String name)
Destroys the named context and removes it from the namespace.
|
Hashtable |
getEnvironment()
Retrieves the environment in effect for this context.
|
String |
getNameInNamespace()
Retrieves the full name of this context within its own namespace.
|
NameParser |
getNameParser(Name name)
Retrieves the parser associated with the named context.
|
NameParser |
getNameParser(String name)
Retrieves the parser associated with the named context.
|
NamingEnumeration |
list(Name name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them.
|
NamingEnumeration |
list(String name)
Enumerates the names bound in the named context, along with the class
names of objects bound to them.
|
NamingEnumeration |
listBindings(Name name)
Enumerates the names bound in the named context, along with the objects
bound to them.
|
NamingEnumeration |
listBindings(String name)
Enumerates the names bound in the named context, along with the objects
bound to them.
|
Object |
lookup(Name name)
Retrieves the named object.
|
Object |
lookup(String name)
Retrieves the named object.
|
Object |
lookupLink(Name name)
Retrieves the named object, following links except for the terminal
atomic component of the name.
|
Object |
lookupLink(String name)
Retrieves the named object, following links except for the terminal
atomic component of the name.
|
void |
rebind(Name name,
Object obj)
Binds a name to an object, overwriting any existing binding.
|
void |
rebind(String name,
Object obj)
Binds a name to an object, overwriting any existing binding.
|
Object |
removeFromEnvironment(String propName)
Removes an environment property from the environment of this context.
|
void |
removeNamingListener(RemoteContextListenerInterface l)
Removes a listener from receiving naming events fired by this
EventContext.
|
void |
rename(Name oldName,
Name newName)
Binds a new name to the object bound to an old name, and unbinds the old
name.
|
void |
rename(String oldName,
String newName)
Binds a new name to the object bound to an old name, and unbinds the old
name.
|
boolean |
targetMustExist()
Determines whether a listener can register interest in a target that does
not exist.
|
void |
unbind(Name name)
Unbinds the named object.
|
void |
unbind(String name)
Unbinds the named object.
|
static final String WRAPPED_PREFIX
void addNamingListener(Name target, int scope, RemoteContextListenerInterface l) throws RemoteException, NamingException
target needs to name a context only when scope is ONELEVEL_SCOPE.target may name a non-context if scope is either OBJECT_SCOPE or SUBTREE_SCOPE. Using SUBTREE_SCOPE for a non-context might be useful, for example, if the caller does not know in advance whether target is a context and just wants to register interest in the (possibly degenerate subtree) rooted at target.
When the listener is notified of an event, the listener may in invoked in a thread other than the one in which addNamingListener() is executed. Care must be taken when multiple threads are accessing the same EventContext concurrently. See the package description for more information on threading issues.
target
- A nonnull name to be resolved relative to this context.scope
- One of OBJECT_SCOPE,ONELEVEL_SCOPE,
or SUBTREE_SCOPE.l
- The nonnull listener.NamingException
- If a problem was encountered while adding the
listener.RemoteException
- on network exceptionvoid addNamingListener(String target, int scope, RemoteContextListenerInterface l) throws NamingException, RemoteException
target
- The nonnull string name of the object resolved relative to
this context.scope
- One of OBJECT_SCOPE,ONELEVEL_SCOPE,
or SUBTREE_SCOPE.l
- The nonnull listener.NamingException
- If a problem was encountered while adding the
listener.RemoteException
- on network exceptionvoid removeNamingListener(RemoteContextListenerInterface l) throws NamingException, RemoteException
l
- The nonnull listener.NamingException
- If a problem was encountered while removing
the listener.RemoteException
- on network exceptionboolean targetMustExist() throws NamingException, RemoteException
NamingException
- If the context's behavior in this regard
cannot be determined.RemoteException
- on network exceptionObject lookup(Name name) throws NamingException, RemoteException
name
- the name of the object to look upNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionlookup(String)
,
lookupLink(Name)
Object lookup(String name) throws NamingException, RemoteException
lookup(Name)
for details.name
- the name of the object to look upNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionvoid bind(Name name, Object obj) throws NamingException, RemoteException
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullInvalidAttributesException
- if object did
not supply all mandatory attributesNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionbind(String, Object)
,
rebind(Name, Object)
,
DirContext.bind(Name, Object,
javax.naming.directory.Attributes)
void bind(String name, Object obj) throws NamingException, RemoteException
bind(Name, Object)
for details.name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullInvalidAttributesException
- if object did
not supply all mandatory attributesNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionvoid rebind(Name name, Object obj) throws NamingException, RemoteException
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.
name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullInvalidAttributesException
- if object did
not supply all mandatory attributesNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionrebind(String, Object)
,
bind(Name, Object)
,
DirContext.rebind(Name, Object,
javax.naming.directory.Attributes)
,
DirContext
void rebind(String name, Object obj) throws NamingException, RemoteException
rebind(Name, Object)
for details.name
- the name to bind; may not be emptyobj
- the object to bind; possibly nullInvalidAttributesException
- if object did
not supply all mandatory attributesNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionvoid unbind(Name name) throws NamingException, RemoteException
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.
name
- the name to unbind; may not be emptyNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionunbind(String)
void unbind(String name) throws NamingException, RemoteException
unbind(Name)
for details.name
- the name to unbind; may not be emptyRemoteException
- on network exceptionNamingException
- if a naming exception is encounteredvoid rename(Name oldName, Name newName) throws NamingException, RemoteException
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionrename(String, String)
,
bind(Name, Object)
,
rebind(Name, Object)
void rename(String oldName, String newName) throws NamingException, RemoteException
rename(Name, Name)
for details.oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be emptyNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionNamingEnumeration list(Name name) throws NamingException, RemoteException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
name
- the name of the context to listNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionlist(String)
,
listBindings(Name)
,
NameClassPair
NamingEnumeration list(String name) throws NamingException, RemoteException
list(Name)
for details.name
- the name of the context to listNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionNamingEnumeration listBindings(Name name) throws NamingException, RemoteException
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
name
- the name of the context to listNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionlistBindings(String)
,
list(Name)
,
Binding
NamingEnumeration listBindings(String name) throws NamingException, RemoteException
listBindings(Name)
for details.name
- the name of the context to listNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionvoid destroySubcontext(Name name) throws NamingException, RemoteException
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.
name
- the name of the context to be destroyed; may not be emptyNameNotFoundException
- if an intermediate context does not existNotContextException
- if the name is bound but does not name a
context, or does not name a context of the appropriate typeContextNotEmptyException
- if the named context is not emptyNamingException
- if a naming exception is encounteredRemoteException
- on network exceptiondestroySubcontext(String)
void destroySubcontext(String name) throws NamingException, RemoteException
destroySubcontext(Name)
for details.name
- the name of the context to be destroyed; may not be emptyNameNotFoundException
- if an intermediate context does not existNotContextException
- if the name is bound but does not name a
context, or does not name a context of the appropriate typeContextNotEmptyException
- if the named context is not emptyNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionRemoteContextInterface createSubcontext(Name name) throws NamingException, RemoteException
name
- the name of the context to create; may not be emptyNameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of
the subcontext requires specification of mandatory attributesNamingException
- if a naming exception is encounteredRemoteException
- on network exceptioncreateSubcontext(String)
RemoteContextInterface createSubcontext(String name) throws NamingException, RemoteException
createSubcontext(Name)
for
details.name
- the name of the context to create; may not be emptyNameAlreadyBoundException
- if name is already boundInvalidAttributesException
- if creation of
the subcontext requires specification of mandatory attributesNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionObject lookupLink(Name name) throws NamingException, RemoteException
name
- the name of the object to look upNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionlookupLink(String)
Object lookupLink(String name) throws NamingException, RemoteException
lookupLink(Name)
for details.name
- the name of the object to look upNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionNameParser getNameParser(Name name) throws NamingException, RemoteException
name
- the name of the context from which to get the parserNamingException
- if a naming exception is encounteredRemoteException
- on network exceptiongetNameParser(String)
,
CompoundName
NameParser getNameParser(String name) throws NamingException, RemoteException
getNameParser(Name)
for details.name
- the name of the context from which to get the parserNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionName composeName(Name name, Name prefix) throws NamingException, RemoteException
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"
.name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestorsprefix
and name
NamingException
- if a naming exception is encounteredRemoteException
- on network exceptioncomposeName(String, String)
String composeName(String name, String prefix) throws NamingException, RemoteException
composeName(Name, Name)
for details.name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestorsprefix
and name
NamingException
- if a naming exception is encounteredRemoteException
- on network exceptionObject addToEnvironment(String propName, Object propVal) throws NamingException, RemoteException
propName
- the name of the environment property to add; may not be
nullpropVal
- the value of the property to add; may not be nullNamingException
- if a naming exception is encounteredRemoteException
- on network exceptiongetEnvironment()
,
removeFromEnvironment(String)
Object removeFromEnvironment(String propName) throws NamingException, RemoteException
propName
- the name of the environment property to remove; may not
be nullNamingException
- if a naming exception is encounteredRemoteException
- on network exceptiongetEnvironment()
,
addToEnvironment(String, Object)
Hashtable getEnvironment() throws NamingException, RemoteException
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().
NamingException
- if a naming exception is encounteredRemoteException
- on network exceptionaddToEnvironment(String, Object)
,
removeFromEnvironment(String)
void close() throws NamingException, RemoteException
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.
NamingException
- if a naming exception is encounteredRemoteException
- on network exceptionString getNameInNamespace() throws NamingException, RemoteException
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.
OperationNotSupportedException
- if the naming system does not have
the notion of a full nameNamingException
- if a naming exception is encounteredRemoteException
- on network exceptionCopyright © 2002-2012 Delft University of Technology, the Netherlands. All Rights Reserved.