com.sun.jini.mercury
Interface MailboxBackEnd

All Superinterfaces:
Administrable, DestroyAdmin, EventMailbox, JoinAdmin, Landlord, MailboxAdmin, PullEventMailbox, Remote, ServiceProxyAccessor
All Known Implementing Classes:
ActivatableMercuryImpl, MailboxImpl, NonActivatableMercuryImpl, TransientMercuryImpl

interface MailboxBackEnd
extends Landlord, Administrable, MailboxAdmin, PullEventMailbox, ServiceProxyAccessor

MailboxBackEnd defines the private protocol between the various client-side proxies and the event mailbox server.

The declared methods are pretty straightforward mappings of the PullEventMailbox and MailboxPullRegistration interfaces.

Note: The Landlord interface extends Remote, which implicitly makes this interface Remote as well.

Since:
1.1
Author:
Sun Microsystems, Inc.

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.sun.jini.landlord.Landlord
Landlord.RenewResults
 
Method Summary
 void addUnknownEvents(Uuid uuid, Collection unknownEvents)
          Get events for the given registration
 void disableDelivery(Uuid registrationID)
          Disable delivery of events for the given registration
 void enableDelivery(Uuid registrationID, RemoteEventListener target)
          Enable delivery of events for the given registration to the specified target
 Collection getNextBatch(Uuid regId, Uuid iterId, long timeout, Object lastEventCookie)
          Get next batch of events for the given registration.
 RemoteEventIteratorData getRemoteEvents(Uuid uuid)
          Get events for the given registration via the returned iterator.
 void notify(Uuid registrationID, RemoteEvent theEvent)
          Collect remote events for the associated registration.
 
Methods inherited from interface com.sun.jini.landlord.Landlord
cancel, cancelAll, renew, renewAll
 
Methods inherited from interface net.jini.admin.Administrable
getAdmin
 
Methods inherited from interface com.sun.jini.admin.DestroyAdmin
destroy
 
Methods inherited from interface net.jini.admin.JoinAdmin
addLookupAttributes, addLookupGroups, addLookupLocators, getLookupAttributes, getLookupGroups, getLookupLocators, modifyLookupAttributes, removeLookupGroups, removeLookupLocators, setLookupGroups, setLookupLocators
 
Methods inherited from interface net.jini.event.PullEventMailbox
pullRegister
 
Methods inherited from interface net.jini.event.EventMailbox
register
 
Methods inherited from interface com.sun.jini.start.ServiceProxyAccessor
getServiceProxy
 

Method Detail

enableDelivery

void enableDelivery(Uuid registrationID,
                    RemoteEventListener target)
                    throws RemoteException,
                           ThrowThis
Enable delivery of events for the given registration to the specified target

Parameters:
registrationID - The unique registration identifier
target - The designated delivery target for event notifications
Throws:
RemoteException
ThrowThis
See Also:
MailboxRegistration.enableDelivery(net.jini.core.event.RemoteEventListener)

disableDelivery

void disableDelivery(Uuid registrationID)
                     throws RemoteException,
                            ThrowThis
Disable delivery of events for the given registration

Parameters:
registrationID - The unique registration identifier
Throws:
RemoteException
ThrowThis
See Also:
MailboxRegistration.disableDelivery()

getRemoteEvents

RemoteEventIteratorData getRemoteEvents(Uuid uuid)
                                        throws RemoteException,
                                               ThrowThis
Get events for the given registration via the returned iterator.

Parameters:
uuid - The unique registration identifier
Throws:
RemoteException
ThrowThis
See Also:
MailboxPullRegistration.getRemoteEvents()

getNextBatch

Collection getNextBatch(Uuid regId,
                        Uuid iterId,
                        long timeout,
                        Object lastEventCookie)
                        throws RemoteException,
                               InvalidIteratorException,
                               ThrowThis
Get next batch of events for the given registration.

Parameters:
regId - The unique registration identifier
Throws:
RemoteException
InvalidIteratorException
ThrowThis

addUnknownEvents

void addUnknownEvents(Uuid uuid,
                      Collection unknownEvents)
                      throws RemoteException,
                             ThrowThis
Get events for the given registration

Parameters:
uuid - The unique registration identifier
unknownEvents - collection of unknown events to be added to the associated registration's unknown event list.
Throws:
RemoteException
ThrowThis
See Also:
MailboxPullRegistration.getRemoteEvents()

notify

void notify(Uuid registrationID,
            RemoteEvent theEvent)
            throws UnknownEventException,
                   RemoteException,
                   ThrowThis
Collect remote events for the associated registration.

Parameters:
registrationID - The unique registration identifier
theEvent - The event to store and/or forward
Throws:
UnknownEventException
RemoteException
ThrowThis
See Also:
RemoteEventListener.notify(net.jini.core.event.RemoteEvent)


Copyright 2007-2010, multiple authors.
Licensed under the Apache License, Version 2.0, see the NOTICE file for attributions.