org.apache.river.mercury

Class MailboxAdminProxy

java.lang.Object

org.apache.river.mercury.MailboxAdminProxy

All Implemented Interfaces:

Serializable, JoinAdmin, ReferentUuid, DestroyAdmin, MailboxAdmin

Direct Known Subclasses:

MailboxAdminProxy.ConstrainableMailboxAdminProxy

class MailboxAdminProxy
extends Object
implements MailboxAdmin, Serializable, ReferentUuid

A MailboxAdminProxy is a client-side proxy for a mailbox service. This interface provides access to the administrative functions of the mailbox service as defined by the MailboxAdmin interface.

Since:

1.1

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	MailboxAdminProxy.ConstrainableMailboxAdminProxy

Field Summary

Fields

Modifier and Type	Field and Description
(package private) Uuid	proxyID The registrar's service ID
private static long	serialVersionUID
(package private) MailboxBackEnd	server The registrar

Constructor Summary

Constructors

Modifier	Constructor and Description
private	MailboxAdminProxy(MailboxBackEnd server, Uuid serviceProxyID) Simple constructor.

Method Summary

Modifier and Type	Method and Description
void	addLookupAttributes(Entry[] attrSets) Add attribute sets for the service.
void	addLookupGroups(String[] groups) Add new groups to the set to join.
void	addLookupLocators(LookupLocator[] locators) Add locators for specific new lookup services to join.
(package private) static MailboxAdminProxy	create(MailboxBackEnd mailbox, Uuid id) Creates a mailbox proxy, returning an instance that implements RemoteMethodControl if the server does too.
void	destroy() Destroy the service, if possible, including its persistent storage.
boolean	equals(Object o) Proxies for servers with the same serviceProxyID are considered equal.
Entry[]	getLookupAttributes() Get the current attribute sets for the service.
String[]	getLookupGroups() Get the list of groups to join.
LookupLocator[]	getLookupLocators() Get the list of locators of specific lookup services to join.
Uuid	getReferentUuid() Returns the universally unique identifier that has been assigned to the resource this proxy represents.
int	hashCode()
void	modifyLookupAttributes(Entry[] attrSetTemplates, Entry[] attrSets) Modify the current attribute sets, using the same semantics as ServiceRegistration.modifyAttributes.
private void	readObject(ObjectInputStream s) When an instance of this class is deserialized, this method is automatically invoked.
private void	readObjectNoData() During deserialization of an instance of this class, if it is found that the stream contains no data, this method is automatically invoked.
void	removeLookupGroups(String[] groups) Remove groups from the set to join.
void	removeLookupLocators(LookupLocator[] locators) Remove locators for specific lookup services from the set to join.
void	setLookupGroups(String[] groups) Replace the list of groups to join with a new list.
void	setLookupLocators(LookupLocator[] locators) Replace the list of locators of specific lookup services to join with a new list.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

server

final MailboxBackEnd server

The registrar

proxyID

final Uuid proxyID

The registrar's service ID

Constructor Detail

MailboxAdminProxy

private MailboxAdminProxy(MailboxBackEnd server,
                          Uuid serviceProxyID)

Simple constructor.

Method Detail

create

static MailboxAdminProxy create(MailboxBackEnd mailbox,
                                Uuid id)

Creates a mailbox proxy, returning an instance that implements RemoteMethodControl if the server does too.

Parameters:

mailbox - the server proxy

id - the ID of the server

getLookupAttributes

public Entry[] getLookupAttributes()
                            throws RemoteException

Description copied from interface: JoinAdmin

Get the current attribute sets for the service.

Specified by:

getLookupAttributes in interface JoinAdmin

Returns:

the current attribute sets for the service

Throws:

RemoteException

addLookupAttributes

public void addLookupAttributes(Entry[] attrSets)
                         throws RemoteException

Description copied from interface: JoinAdmin

Add attribute sets for the service. The resulting set will be used for all future joins. The attribute sets are also added to all currently-joined lookup services.

Specified by:

addLookupAttributes in interface JoinAdmin

Parameters:

attrSets - the attribute sets to add

Throws:

RemoteException

modifyLookupAttributes

public void modifyLookupAttributes(Entry[] attrSetTemplates,
                                   Entry[] attrSets)
                            throws RemoteException

Description copied from interface: JoinAdmin

Modify the current attribute sets, using the same semantics as ServiceRegistration.modifyAttributes. The resulting set will be used for all future joins. The same modifications are also made to all currently-joined lookup services.

Specified by:

modifyLookupAttributes in interface JoinAdmin

Parameters:

attrSetTemplates - the templates for matching attribute sets

attrSets - the modifications to make to matching sets

Throws:

RemoteException

See Also:

ServiceRegistration.modifyAttributes(net.jini.core.entry.Entry[], net.jini.core.entry.Entry[])

getLookupGroups

public String[] getLookupGroups()
                         throws RemoteException

Description copied from interface: JoinAdmin

Get the list of groups to join. An empty array means the service joins no groups (as opposed to "all" groups).

Specified by:

getLookupGroups in interface JoinAdmin

Returns:

an array of groups to join. An empty array means the service joins no groups (as opposed to "all" groups).

Throws:

RemoteException

See Also:

JoinAdmin.setLookupGroups(java.lang.String[])

addLookupGroups

public void addLookupGroups(String[] groups)
                     throws RemoteException

Description copied from interface: JoinAdmin

Add new groups to the set to join. Lookup services in the new groups will be discovered and joined.

Specified by:

addLookupGroups in interface JoinAdmin

Parameters:

groups - groups to join

Throws:

RemoteException

See Also:

JoinAdmin.removeLookupGroups(java.lang.String[])

removeLookupGroups

public void removeLookupGroups(String[] groups)
                        throws RemoteException

Description copied from interface: JoinAdmin

Remove groups from the set to join. Leases are cancelled at lookup services that are not members of any of the remaining groups.

Specified by:

removeLookupGroups in interface JoinAdmin

Parameters:

groups - groups to leave

Throws:

RemoteException

See Also:

JoinAdmin.addLookupGroups(java.lang.String[])

setLookupGroups

public void setLookupGroups(String[] groups)
                     throws RemoteException

Description copied from interface: JoinAdmin

Replace the list of groups to join with a new list. Leases are cancelled at lookup services that are not members of any of the new groups. Lookup services in the new groups will be discovered and joined.

Specified by:

setLookupGroups in interface JoinAdmin

Parameters:

groups - groups to join

Throws:

RemoteException

See Also:

JoinAdmin.getLookupGroups()

getLookupLocators

public LookupLocator[] getLookupLocators()
                                  throws RemoteException

Description copied from interface: JoinAdmin

Get the list of locators of specific lookup services to join.

Specified by:

getLookupLocators in interface JoinAdmin

Returns:

the list of locators of specific lookup services to join

Throws:

RemoteException

See Also:

JoinAdmin.setLookupLocators(net.jini.core.discovery.LookupLocator[])

addLookupLocators

public void addLookupLocators(LookupLocator[] locators)
                       throws RemoteException

Description copied from interface: JoinAdmin

Add locators for specific new lookup services to join. The new lookup services will be discovered and joined.

Specified by:

addLookupLocators in interface JoinAdmin

Parameters:

locators - locators of specific lookup services to join

Throws:

RemoteException

See Also:

JoinAdmin.removeLookupLocators(net.jini.core.discovery.LookupLocator[])

removeLookupLocators

public void removeLookupLocators(LookupLocator[] locators)
                          throws RemoteException

Description copied from interface: JoinAdmin

Remove locators for specific lookup services from the set to join. Any leases held at the lookup services are cancelled.

Specified by:

removeLookupLocators in interface JoinAdmin

Parameters:

locators - locators of specific lookup services to leave

Throws:

RemoteException

See Also:

JoinAdmin.addLookupLocators(net.jini.core.discovery.LookupLocator[])

setLookupLocators

public void setLookupLocators(LookupLocator[] locators)
                       throws RemoteException

Description copied from interface: JoinAdmin

Replace the list of locators of specific lookup services to join with a new list. Leases are cancelled at lookup services that were in the old list but are not in the new list. Any new lookup services will be discovered and joined.

Specified by:

setLookupLocators in interface JoinAdmin

Parameters:

locators - locators of specific lookup services to join

Throws:

RemoteException

See Also:

JoinAdmin.getLookupLocators()

destroy

public void destroy()
             throws RemoteException

Description copied from interface: DestroyAdmin

Destroy the service, if possible, including its persistent storage. This method should (in effect) spawn a separate thread to do the actual work asynchronously, and make a reasonable attempt to let this remote call return successfully. As such, a successful return from this method does not mean that the service has been destroyed. Although the service should make a reasonable attempt to let this remote call return successfully, the service must not wait indefinitely for other (in-progress and subsequent) remote calls to finish before proceeding to destroy itself. Once this method has been called, the service can, but need not, reject all other (in-progress and subsequent) remote calls to the service.

Specified by:

destroy in interface DestroyAdmin

Throws:

RemoteException

getReferentUuid

public Uuid getReferentUuid()

Returns the universally unique identifier that has been assigned to the resource this proxy represents.

Specified by:

getReferentUuid in interface ReferentUuid

Returns:

the instance of Uuid that is associated with the resource this proxy represents. This method will not return null.

See Also:

ReferentUuid

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Proxies for servers with the same serviceProxyID are considered equal.

Overrides:

equals in class Object

readObject

private void readObject(ObjectInputStream s)
                 throws IOException,
                        ClassNotFoundException

When an instance of this class is deserialized, this method is automatically invoked. This implementation of this method validates the state of the deserialized instance.

Throws:

InvalidObjectException - if the state of the deserialized instance of this class is found to be invalid.

IOException

ClassNotFoundException

readObjectNoData

private void readObjectNoData()
                       throws ObjectStreamException

During deserialization of an instance of this class, if it is found that the stream contains no data, this method is automatically invoked. Because it is expected that the stream should always contain data, this implementation of this method simply declares that something must be wrong.

Throws:

InvalidObjectException - to indicate that there was no data in the stream during deserialization of an instance of this class; declaring that something is wrong.

ObjectStreamException