|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjava.rmi.server.RemoteObject
java.rmi.server.RemoteServer
java.rmi.server.UnicastRemoteObject
nl.tudelft.simulation.naming.RemoteContext
public class RemoteContext
(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.
Field Summary |
---|
Fields inherited from class java.rmi.server.RemoteObject |
---|
ref |
Fields inherited from interface nl.tudelft.simulation.naming.RemoteContextInterface |
---|
WRAPPED_PREFIX |
Constructor Summary | |
---|---|
RemoteContext(EventContext eventContext)
constructs a new RemoteContext |
Method Summary | |
---|---|
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. |
Methods inherited from class java.rmi.server.UnicastRemoteObject |
---|
clone, exportObject, exportObject, exportObject, unexportObject |
Methods inherited from class java.rmi.server.RemoteServer |
---|
getClientHost, getLog, setLog |
Methods inherited from class java.rmi.server.RemoteObject |
---|
equals, getRef, hashCode, toString, toStub |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public RemoteContext(EventContext eventContext) throws RemoteException
eventContext
- the underlying context
RemoteException
- on network failureMethod Detail |
---|
public void addNamingListener(Name target, int scope, RemoteContextListenerInterface l) throws NamingException
RemoteContextInterface
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.
addNamingListener
in interface RemoteContextInterface
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.RemoteContextInterface.addNamingListener(javax.naming.Name,
int,
nl.tudelft.simulation.naming.listener.RemoteContextListenerInterface)
public void addNamingListener(String target, int scope, RemoteContextListenerInterface l) throws NamingException
RemoteContextInterface
addNamingListener
in interface RemoteContextInterface
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.RemoteContextInterface.addNamingListener(java.lang.String,
int,
nl.tudelft.simulation.naming.listener.RemoteContextListenerInterface)
public void removeNamingListener(RemoteContextListenerInterface l) throws NamingException
RemoteContextInterface
removeNamingListener
in interface RemoteContextInterface
l
- The nonnull listener.
NamingException
- If a problem was encountered while removing
the listener.RemoteContextInterface.removeNamingListener(nl.tudelft.simulation.naming.listener.RemoteContextListenerInterface)
public boolean targetMustExist() throws NamingException
RemoteContextInterface
targetMustExist
in interface RemoteContextInterface
NamingException
- If the context's behavior in this regard
cannot be determined.RemoteContextInterface.targetMustExist()
public Object lookup(Name name) throws NamingException
RemoteContextInterface
lookup
in interface RemoteContextInterface
name
- the name of the object to look up
NamingException
- if a naming exception is encounteredRemoteContextInterface.lookup(javax.naming.Name)
public Object lookup(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.lookup(Name)
for details.
lookup
in interface RemoteContextInterface
name
- the name of the object to look up
NamingException
- if a naming exception is encounteredRemoteContextInterface.lookup(java.lang.String)
public void bind(Name name, Object obj) throws NamingException
RemoteContextInterface
bind
in interface RemoteContextInterface
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
InvalidAttributesException
- if object did
not supply all mandatory attributes
NamingException
- if a naming exception is encounteredRemoteContextInterface.bind(javax.naming.Name,
java.lang.Object)
public void bind(String name, Object obj) throws NamingException
RemoteContextInterface
RemoteContextInterface.bind(Name, Object)
for details.
bind
in interface RemoteContextInterface
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
InvalidAttributesException
- if object did
not supply all mandatory attributes
NamingException
- if a naming exception is encounteredRemoteContextInterface.bind(java.lang.String,
java.lang.Object)
public void rebind(Name name, Object obj) throws NamingException
RemoteContextInterface
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.
rebind
in interface RemoteContextInterface
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
InvalidAttributesException
- if object did
not supply all mandatory attributes
NamingException
- if a naming exception is encounteredRemoteContextInterface.rebind(javax.naming.Name,
java.lang.Object)
public void rebind(String name, Object obj) throws NamingException
RemoteContextInterface
RemoteContextInterface.rebind(Name, Object)
for details.
rebind
in interface RemoteContextInterface
name
- the name to bind; may not be emptyobj
- the object to bind; possibly null
InvalidAttributesException
- if object did
not supply all mandatory attributes
NamingException
- if a naming exception is encounteredRemoteContextInterface.rebind(java.lang.String,
java.lang.Object)
public void unbind(Name name) throws NamingException
RemoteContextInterface
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.
unbind
in interface RemoteContextInterface
name
- the name to unbind; may not be empty
NamingException
- if a naming exception is encounteredRemoteContextInterface.unbind(javax.naming.Name)
public void unbind(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.unbind(Name)
for details.
unbind
in interface RemoteContextInterface
name
- the name to unbind; may not be empty
NamingException
- if a naming exception is encounteredRemoteContextInterface.unbind(java.lang.String)
public void rename(Name oldName, Name newName) throws NamingException
RemoteContextInterface
rename
in interface RemoteContextInterface
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty
NamingException
- if a naming exception is encounteredRemoteContextInterface.rename(javax.naming.Name,
javax.naming.Name)
public void rename(String oldName, String newName) throws NamingException
RemoteContextInterface
RemoteContextInterface.rename(Name, Name)
for details.
rename
in interface RemoteContextInterface
oldName
- the name of the existing binding; may not be emptynewName
- the name of the new binding; may not be empty
NamingException
- if a naming exception is encounteredRemoteContextInterface.rename(java.lang.String,
java.lang.String)
public NamingEnumeration list(Name name) throws NamingException
RemoteContextInterface
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
list
in interface RemoteContextInterface
name
- the name of the context to list
NamingException
- if a naming exception is encounteredRemoteContextInterface.list(javax.naming.Name)
public NamingEnumeration list(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.list(Name)
for details.
list
in interface RemoteContextInterface
name
- the name of the context to list
NamingException
- if a naming exception is encounteredRemoteContextInterface.list(java.lang.String)
public NamingEnumeration listBindings(Name name) throws NamingException
RemoteContextInterface
If a binding is added to or removed from this context, its effect on an enumeration previously returned is undefined.
listBindings
in interface RemoteContextInterface
name
- the name of the context to list
NamingException
- if a naming exception is encounteredRemoteContextInterface.listBindings(javax.naming.Name)
public NamingEnumeration listBindings(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.listBindings(Name)
for details.
listBindings
in interface RemoteContextInterface
name
- the name of the context to list
NamingException
- if a naming exception is encounteredRemoteContextInterface.listBindings(java.lang.String)
public void destroySubcontext(Name name) throws NamingException
RemoteContextInterface
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.
destroySubcontext
in interface RemoteContextInterface
name
- the name of the context to be destroyed; may not be empty
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
ContextNotEmptyException
- if the named context is not empty
NamingException
- if a naming exception is encounteredRemoteContextInterface.destroySubcontext(javax.naming.Name)
public void destroySubcontext(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.destroySubcontext(Name)
for details.
destroySubcontext
in interface RemoteContextInterface
name
- the name of the context to be destroyed; may not be empty
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
ContextNotEmptyException
- if the named context is not empty
NamingException
- if a naming exception is encounteredRemoteContextInterface.destroySubcontext(java.lang.String)
public RemoteContextInterface createSubcontext(Name name) throws NamingException, RemoteException
RemoteContextInterface
createSubcontext
in interface RemoteContextInterface
name
- the name of the context to create; may not be empty
NameAlreadyBoundException
- if name is already bound
InvalidAttributesException
- if creation of
the subcontext requires specification of mandatory attributes
NamingException
- if a naming exception is encountered
RemoteException
- on network exceptionRemoteContextInterface.createSubcontext(javax.naming.Name)
public RemoteContextInterface createSubcontext(String name) throws NamingException, RemoteException
RemoteContextInterface
RemoteContextInterface.createSubcontext(Name)
for
details.
createSubcontext
in interface RemoteContextInterface
name
- the name of the context to create; may not be empty
NameAlreadyBoundException
- if name is already bound
InvalidAttributesException
- if creation of
the subcontext requires specification of mandatory attributes
NamingException
- if a naming exception is encountered
RemoteException
- on network exceptionRemoteContextInterface.createSubcontext(java.lang.String)
public Object lookupLink(Name name) throws NamingException
RemoteContextInterface
lookupLink
in interface RemoteContextInterface
name
- the name of the object to look up
NamingException
- if a naming exception is encounteredRemoteContextInterface.lookupLink(javax.naming.Name)
public Object lookupLink(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.lookupLink(Name)
for details.
lookupLink
in interface RemoteContextInterface
name
- the name of the object to look up
NamingException
- if a naming exception is encounteredRemoteContextInterface.lookupLink(java.lang.String)
public NameParser getNameParser(Name name) throws NamingException
RemoteContextInterface
getNameParser
in interface RemoteContextInterface
name
- the name of the context from which to get the parser
NamingException
- if a naming exception is encounteredRemoteContextInterface.getNameParser(javax.naming.Name)
public NameParser getNameParser(String name) throws NamingException
RemoteContextInterface
RemoteContextInterface.getNameParser(Name)
for details.
getNameParser
in interface RemoteContextInterface
name
- the name of the context from which to get the parser
NamingException
- if a naming exception is encounteredRemoteContextInterface.getNameParser(java.lang.String)
public Name composeName(Name name, Name prefix) throws NamingException
RemoteContextInterface
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"
.
composeName
in interface RemoteContextInterface
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors
prefix
and name
NamingException
- if a naming exception is encounteredRemoteContextInterface.composeName(javax.naming.Name,
javax.naming.Name)
public String composeName(String name, String prefix) throws NamingException
RemoteContextInterface
RemoteContextInterface.composeName(Name, Name)
for details.
composeName
in interface RemoteContextInterface
name
- a name relative to this contextprefix
- the name of this context relative to one of its ancestors
prefix
and name
NamingException
- if a naming exception is encounteredRemoteContextInterface.composeName(java.lang.String,
java.lang.String)
public Object addToEnvironment(String propName, Object propVal) throws NamingException
RemoteContextInterface
addToEnvironment
in interface RemoteContextInterface
propName
- the name of the environment property to add; may not be
nullpropVal
- the value of the property to add; may not be null
NamingException
- if a naming exception is encounteredRemoteContextInterface.addToEnvironment(java.lang.String,
java.lang.Object)
public Object removeFromEnvironment(String propName) throws NamingException
RemoteContextInterface
removeFromEnvironment
in interface RemoteContextInterface
propName
- the name of the environment property to remove; may not
be null
NamingException
- if a naming exception is encounteredRemoteContextInterface.removeFromEnvironment(java.lang.String)
public Hashtable getEnvironment() throws NamingException
RemoteContextInterface
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().
getEnvironment
in interface RemoteContextInterface
NamingException
- if a naming exception is encounteredRemoteContextInterface.getEnvironment()
public void close() throws NamingException
RemoteContextInterface
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.
close
in interface RemoteContextInterface
NamingException
- if a naming exception is encounteredRemoteContextInterface.close()
public String getNameInNamespace() throws NamingException
RemoteContextInterface
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.
getNameInNamespace
in interface RemoteContextInterface
OperationNotSupportedException
- if the naming system does not have
the notion of a full name
NamingException
- if a naming exception is encounteredRemoteContextInterface.getNameInNamespace()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |