org.apache.geronimo.messaging.replication
Interface ReplicationMember

All Superinterfaces:
EndPoint, MsgConsProd, MsgConsumer, MsgProducer, UpdateListener
All Known Implementing Classes:
ReplicationMemberImpl

public interface ReplicationMember
extends UpdateListener, EndPoint

A replication group member.
This is an EndPoint in charge of replicating the state of registered ReplicantCapables across N-nodes, which constitute a replication group.

Version:
$Revision: 1.1 $ $Date: 2004/05/11 12:06:40 $

Method Summary
 Object getReplicationGroupID()
          Gets the replication group identifier.
 void mergeWithUpdate(UpdateEvent anEvent)
          Merges an UpdateEvent with a registered ReplicationCapable.
 void registerLocalReplicantCapable(ReplicationCapable aReplicant)
          This method is for internal use only.
 void registerReplicantCapable(ReplicationCapable aReplicant)
          Registers a ReplicantCapable.
 ReplicationCapable retrieveReplicantCapable(Object anID)
          Retrieves the ReplicationCapable having the specified id.
 void unregisterReplicantCapable(ReplicationCapable aReplicant)
          Unregisters a ReplicantCapable.
 
Methods inherited from interface org.apache.geronimo.messaging.replication.UpdateListener
fireUpdateEvent
 
Methods inherited from interface org.apache.geronimo.messaging.EndPoint
getID
 
Methods inherited from interface org.apache.geronimo.messaging.MsgProducer
setMsgProducerOut
 
Methods inherited from interface org.apache.geronimo.messaging.MsgConsumer
getMsgConsumerOut
 

Method Detail

getReplicationGroupID

public Object getReplicationGroupID()
Gets the replication group identifier.

Returns:
Identifier.

mergeWithUpdate

public void mergeWithUpdate(UpdateEvent anEvent)
                     throws ReplicationException
Merges an UpdateEvent with a registered ReplicationCapable.

Parameters:
anEvent - Update event to be merged.
Throws:
ReplicationException - Indicates that the merge can not be performed.

registerReplicantCapable

public void registerReplicantCapable(ReplicationCapable aReplicant)
Registers a ReplicantCapable. From now, UpdateEvents multicasted by the provided ReplicantCapable are also pushed to the replication group.

Parameters:
aReplicant - ReplicantCapable to be controlled by this group.

unregisterReplicantCapable

public void unregisterReplicantCapable(ReplicationCapable aReplicant)
Unregisters a ReplicantCapable.

Parameters:
aReplicant - ReplicantCapable to be removed from the replication group.

registerLocalReplicantCapable

public void registerLocalReplicantCapable(ReplicationCapable aReplicant)
This method is for internal use only.
It registers with this member a ReplicationCapable, which has been registered by a remote member.

Parameters:
aReplicant - ReplicantCapable to be locally registered.

retrieveReplicantCapable

public ReplicationCapable retrieveReplicantCapable(Object anID)
Retrieves the ReplicationCapable having the specified id.

Parameters:
anID - Replicant identifier.
Returns:
ReplicantCapable having the specified id or null if such an identifier is not known.


Copyright © 2003-2005 Apache Software Foundation. All Rights Reserved.