private class CNSService.UserObject extends java.lang.Object implements ServiceUserObject, CNSUser
Modifier | Constructor and Description |
---|---|
private |
UserObject() |
Modifier and Type | Method and Description |
---|---|
boolean |
deregisterChannelName(java.lang.String name,
NameAccessLevel accessLevel,
ChannelNameKey channelKey)
This deregisters a registered or leased Channel name from the
Naming Service implementation.
|
ChannelNameKey |
leaseChannelName(java.lang.String name,
NameAccessLevel accessLevel,
ChannelNameKey channelKey)
Leases the channel name within the specified name space
from the Naming Service Implemenation.
|
ChannelNameKey |
register(NetChannelLocation ownerLocation,
java.lang.String name,
NameAccessLevel accessLevel,
ChannelNameKey key)
This method allows a channel's location to be registered against a
name in the Naming Service implementation.
|
ChannelNameKey |
register(Networked owner,
java.lang.String name)
This method allows a channel (or any instance of a class implementing
) to be registered with a Naming
Service Implementation. |
ChannelNameKey |
register(Networked owner,
java.lang.String name,
ChannelNameKey key)
This method allows a channel (or any instance of a class implementing
) that has previously been registered
with the to be reregistered with a Naming Service implementation. |
ChannelNameKey |
register(Networked owner,
java.lang.String name,
NameAccessLevel accessLevel)
This method allows a channel (or any instance of a class implementing
) to be registered with a Naming Service
Implementation. |
ChannelNameKey |
register(Networked owner,
java.lang.String name,
NameAccessLevel accessLevel,
ChannelNameKey key)
This method allows a channel (or any instance of a class implementing
) that has previously been registered
to be reregistered with the Naming Service implementation. |
NetChannelLocation |
resolve(java.lang.String name)
This method resolves a channel name into a
NetChannelLocation object. |
NetChannelLocation |
resolve(java.lang.String name,
NameAccessLevel accessLevel)
This method resolves a channel name into a
NetChannelLocation object. |
public NetChannelLocation resolve(java.lang.String name)
CNSUser
This method resolves a channel name into a
NetChannelLocation
object. The name should be
assumed to be in the global name space (see
NameAccessLevel.GLOBAL_ACCESS_LEVEL
).
public NetChannelLocation resolve(java.lang.String name, NameAccessLevel accessLevel)
CNSUser
This method resolves a channel name into a
NetChannelLocation
object. The name must
exist in the specified name space.
The name space is specified by passing in a
object. A name space
includes itself and any name space higher up in the
hierarchy. The global name space is the highest level of
name space.
NameAccessLevel
public ChannelNameKey register(Networked owner, java.lang.String name)
CNSUser
This method allows a channel (or any instance of a class implementing
) to be registered with a Naming
Service Implementation. The name will be registered in the
global name space.
Networked
public ChannelNameKey register(Networked owner, java.lang.String name, NameAccessLevel accessLevel)
CNSUser
This method allows a channel (or any instance of a class implementing
) to be registered with a Naming Service
Implementation.
Networked
The name will be registered in the specified name space. This is
specified by passing in a
object.
NameAccessLevel
register
in interface CNSUser
owner
- the Networked
object whose location
should be registered.name
- the name against which to register the channel.accessLevel
- the name space in which to register the channel name.ChannelNameKey
needed for managing
the name registration or null
if registration
failed.NameAccessLevel
public ChannelNameKey register(Networked owner, java.lang.String name, ChannelNameKey key)
CNSUser
This method allows a channel (or any instance of a class implementing
) that has previously been registered
with the to be reregistered with a Naming Service implementation.
The name should have been leased (see Networked
). It is necessaray to supply the key that was obtained when
the name was leased. If the channel name has not previously been
registered, then the key can be specified as CNSUser.leaseChannelName(String, NameAccessLevel, ChannelNameKey)
null
.
The name will be registered in the in the global name space.
public ChannelNameKey register(Networked owner, java.lang.String name, NameAccessLevel accessLevel, ChannelNameKey key)
CNSUser
This method allows a channel (or any instance of a class implementing
) that has previously been registered
to be reregistered with the Naming Service implementation. The name
should have been leased (see Networked
). It is necessaray to supply the key that was obtained when
the name was leased. If the channel name has not previously been
registered, then the key can be specified as CNSUser.leaseChannelName(String, NameAccessLevel, ChannelNameKey)
null
.
The name will be registered in the specified name space. This is
specified by passing in a
object.
NameAccessLevel
register
in interface CNSUser
owner
- the Networked
object whose location
should be registered.name
- the name against which to register the channel.accessLevel
- the name space in which to register the channel name.key
- the ChannelNameKey
returned when the
name was leased.ChannelNameKey
needed for managing
the name registration or null
if registration
failed.NameAccessLevel
public ChannelNameKey register(NetChannelLocation ownerLocation, java.lang.String name, NameAccessLevel accessLevel, ChannelNameKey key)
CNSUser
This method allows a channel's location to be registered against a
name in the Naming Service implementation. It differs from the other
register methods in that it takes a NetChannelLocation
object instead of a Networked
object. This can be obtained
from a Networked
object by invoking its
getChannelLocation()
method (see
).
Networked.getChannelLocation()
The name will be registered in the specified name space. This is
specified by passing in a
object.
NameAccessLevel
CNSUser.register(Networked, String, NameAccessLevel, ChannelNameKey)
).
register
in interface CNSUser
ownerLocation
- the location of a channel to be registered
against the name.name
- the name against which to register the channel.accessLevel
- the name space in which to register the channel name.key
- the ChannelNameKey
returned when the
name was leased.ChannelNameKey
needed for managing
the name registration or null
if registration
failed.CNSUser.register(Networked, String, NameAccessLevel, ChannelNameKey)
,
NameAccessLevel
public ChannelNameKey leaseChannelName(java.lang.String name, NameAccessLevel accessLevel, ChannelNameKey channelKey) throws ChannelNameException, NameAccessLevelException
CNSUser
Leases the channel name within the specified name space from the Naming Service Implemenation. Once a name has been leased, a channel cannot be registered with that name without supplying the key returned by the call to this method.
Depending on the implementation, leases may expire, however, they may be renew by recalling this mehtod. Leases can be given up by deregistering the name. Leases should remain even after the obtaining Node has shut down. This allows a channel to move its registered location to another channel on a different Node. There should be no danger of another party managing to obtain the name as transfering a registered name into a lease should be an atomic action.
leaseChannelName
in interface CNSUser
name
- the name to lease.accessLevel
- the name space in which to lease the name.channelKey
- the key to use if the name is currently
registered or leased.ChannelNameKey
needed for managing the
lease or null
if leasing failed.ChannelNameException
- if the channel name is invalid.NameAccessLevelException
- if the specifed name space is
invalid.public boolean deregisterChannelName(java.lang.String name, NameAccessLevel accessLevel, ChannelNameKey channelKey)
CNSUser
This deregisters a registered or leased Channel name from the Naming Service implementation. A boolean is returned to indicate whether deregistration was successful.
deregisterChannelName
in interface CNSUser
name
- the name of the channel as a String.channelKey
- the ChannelNameKey to use to deregister the
Channel name.