A C D E F G H I K L M N P R S T U V W

A

AbstractCommand - Class in mirrormap.commands

Base class for ICommand implementations

AbstractCommand() - Constructor for class mirrormap.commands.AbstractCommand

AbstractLifeCycle - Class in mirrormap.lifecycle

Base-class for all ILifeCycle instances.

AbstractLifeCycle() - Constructor for class mirrormap.lifecycle.AbstractLifeCycle

AddCommand - Class in mirrormap.commands

Encapsulates a command to put a key-value entry into a MirrorMap.

AddCommand() - Constructor for class mirrormap.commands.AddCommand

AddCommand(String, Serializable, Serializable) - Constructor for class mirrormap.commands.AddCommand

addListener(IMapListener<K, V>) - Method in class mirrormap.collections.NotifyingMap

Add a listener that will be notified when entries in the underlying Map are added, updated or removed.

C

checkActive() - Method in class mirrormap.lifecycle.AbstractLifeCycle

Check if this instance is active.

clear() - Method in class mirrormap.collections.NotifyingMap

Clear the underlying map.

connect(MirrorMap<? extends Serializable, ? extends Serializable>, String, int) - Static method in class mirrormap.MirrorMap

Connects the passed in MirrorMap to the mirror map server identified by the host and port.

containsKey(Object) - Method in class mirrormap.collections.NotifyingMap

containsValue(Object) - Method in class mirrormap.collections.NotifyingMap

CONTEXT_RCV_BUFFER - Static variable in class mirrormap.nio.TcpServer

The system property for overriding the default receive buffer size for the server port.

create(String, Map<Key, Value>) - Static method in class mirrormap.MirrorMap

Create a MirrorMap identified by a unique name that wraps the passed in Map.

createEndPointRecevier() - Method in interface mirrormap.nio.IConnectionEndPointReceiver.IFactory

Create the IConnectionEndPointReceiver

D

DEFAULT_TCP_PORT - Static variable in class mirrormap.nio.TcpServer

The default TCP port

destroy() - Method in class mirrormap.lifecycle.AbstractLifeCycle

destroy() - Method in interface mirrormap.lifecycle.IDestroyable

This is called when the object is being removed from application use.

didAdd(K, V) - Method in interface mirrormap.collections.IMapListener

Called after a new entry has been added to the underlying Map of a NotifyingMap.

didAdd(K, V) - Method in class mirrormap.collections.MapListenerAdapter

didRemove(K, V) - Method in interface mirrormap.collections.IMapListener

Called after an entry in the underlying Map of a NotifyingMap is removed

didRemove(K, V) - Method in class mirrormap.collections.MapListenerAdapter

didUpdate(K, V, V) - Method in interface mirrormap.collections.IMapListener

Called after an entry in the underlying Map of a NotifyingMap has been updated.

didUpdate(K, V, V) - Method in class mirrormap.collections.MapListenerAdapter

disconnect(MirrorMap<? extends Serializable, ? extends Serializable>) - Static method in class mirrormap.MirrorMap

Disconnects the passed in MirrorMap from the mirror map server.

doDestroy() - Method in class mirrormap.lifecycle.AbstractLifeCycle

Overridden in subclasses to perform custom logic on destruction.

doDestroy() - Method in class mirrormap.nio.SelectorTasks

doDestroy() - Method in class mirrormap.nio.TcpConnectionEndPoint

Destroy the internal TCP I/O components.

doDestroy() - Method in class mirrormap.nio.TcpServer

doStart() - Method in class mirrormap.lifecycle.AbstractLifeCycle

Overridden in subclasses to perform custom logic on activation.

doStart() - Method in class mirrormap.nio.SelectorTasks

doStart() - Method in class mirrormap.nio.TcpConnectionEndPoint

doStart() - Method in class mirrormap.nio.TcpServer

E

entrySet() - Method in class mirrormap.collections.NotifyingMap

equals(Object) - Method in class mirrormap.collections.NotifyingMap

execute() - Method in class mirrormap.commands.AddCommand

execute() - Method in interface mirrormap.commands.ICommand

Execute the command

execute() - Method in class mirrormap.commands.PeerConnectedCommand

execute() - Method in class mirrormap.commands.PeerDisconnectedCommand

execute() - Method in class mirrormap.commands.RegisterCommand

execute() - Method in class mirrormap.commands.RemoveCommand

execute() - Method in class mirrormap.commands.UnregisterCommand

F

finalize() - Method in class mirrormap.lifecycle.AbstractLifeCycle

G

get(Object) - Method in class mirrormap.collections.NotifyingMap

get(String) - Static method in class mirrormap.MirrorMap

Get the MirrorMap identified by the name.

getBytes() - Method in class mirrormap.commands.AbstractCommand

getBytes() - Method in interface mirrormap.commands.ICommand

Get the serialised byte[] of this

getConnectionListener() - Method in class mirrormap.MirrorMap

Get the connection listener attached to this mirror map

getMirrorMapName() - Method in class mirrormap.commands.AbstractCommand

getMirrorMapName() - Method in interface mirrormap.commands.ICommand

The MirrorMap the command is for

getName() - Method in class mirrormap.MirrorMap

The name of this instance

getReceiver() - Method in interface mirrormap.nio.IConnectionEndPoint

The object handling the inbound data for the connection

getReceiver() - Method in class mirrormap.nio.TcpConnectionEndPoint

getRunnable() - Method in class mirrormap.nio.SelectorTasks

Get a Runnable to continually execute the SelectorTasks.process() method.

getSocketChannel() - Method in class mirrormap.nio.TcpConnectionEndPoint

H

hashCode() - Method in class mirrormap.collections.NotifyingMap

HOST_NAME - Static variable in class mirrormap.nio.TcpServer

The host name

I

ICommand - Interface in mirrormap.commands

Represents an command to perform on a MirrorMap

IConnectionEndPoint - Interface in mirrormap.nio

Encapsulates the end point of an I/O connection.

IConnectionEndPointReceiver - Interface in mirrormap.nio

Handles data received from a remote IConnectionEndPoint.

IConnectionEndPointReceiver.IFactory - Interface in mirrormap.nio

Factory that creates IConnectionEndPointReceiver instances

IDestroyable - Interface in mirrormap.lifecycle

An object that can be destroyed.

ILifeCycle - Interface in mirrormap.lifecycle

An object that has a life-cycle:

IMapListener<K,V> - Interface in mirrormap.collections

Receives notifications of changes to the underlying Map wrapped by a NotifyingMap.

IMirrorMapConnectionListener - Interface in mirrormap

Receives notifications about the connection status of a local and remote MirrorMap instances.

isActive() - Method in class mirrormap.lifecycle.AbstractLifeCycle

isActive() - Method in interface mirrormap.lifecycle.ILifeCycle

Determine if this life-cycle object is active.

isConnected() - Method in class mirrormap.nio.TcpConnectionEndPoint

ISelectionKeyTask - Interface in mirrormap.nio

A task that is associated with a SelectionKey.

ISelectorTasksStateListener - Interface in mirrormap.nio

Receives notifications regarding the state of a SelectorTasks object.

isEmpty() - Method in class mirrormap.collections.NotifyingMap

isOutbound() - Method in interface mirrormap.nio.IConnectionEndPoint

Indicates if this connection was initiated from this end point.

isOutbound() - Method in class mirrormap.nio.TcpConnectionEndPoint

Indicates the connecting direction.

K

key - Variable in class mirrormap.commands.AbstractCommand

The key in the MirrorMap the command applies to

keySet() - Method in class mirrormap.collections.NotifyingMap

L

localConnected(String) - Method in interface mirrormap.IMirrorMapConnectionListener

Received when a local MirrorMap is connected to its server.

localDisconnected(String) - Method in interface mirrormap.IMirrorMapConnectionListener

Received when a MirrorMap is disconnected from its server.

logException(Logger, Object, Exception) - Static method in class mirrormap.Utils

Log an exception to WARN or System.err if the log level is not enabled.

M

MapListenerAdapter<K,V> - Class in mirrormap.collections

Implements no-op methods for the IMapListener

MapListenerAdapter() - Constructor for class mirrormap.collections.MapListenerAdapter

mirrormap - package mirrormap

MirrorMap<K extends Serializable,V extends Serializable> - Class in mirrormap

MirrorMap is a replicating Java map implementation.

mirrormap.collections - package mirrormap.collections

mirrormap.commands - package mirrormap.commands

mirrormap.lifecycle - package mirrormap.lifecycle

mirrormap.nio - package mirrormap.nio

mirrorMapName - Variable in class mirrormap.commands.AbstractCommand

The name of the MirrorMap instance this command applies to

N

NotifyingMap<K,V> - Class in mirrormap.collections

A NotifyingMap wraps a Map and notifies IMapListener instances when entries in the underlying map are added, updated or removed.

NotifyingMap(Map<K, V>) - Constructor for class mirrormap.collections.NotifyingMap

Construct the NotifyingMap with the underlying data map.

P

peerConnected(String) - Method in interface mirrormap.IMirrorMapConnectionListener

Received when any MirrorMap connects to the server.

PeerConnectedCommand - Class in mirrormap.commands

Encapsulates the command to run when a peer mirror map is connected

PeerConnectedCommand(String) - Constructor for class mirrormap.commands.PeerConnectedCommand

peerDisconnected(String) - Method in interface mirrormap.IMirrorMapConnectionListener

Received when any MirrorMap disconnects from the server.

PeerDisconnectedCommand - Class in mirrormap.commands

Encapsulates the command to run when a peer mirror map is disconnected

PeerDisconnectedCommand(String) - Constructor for class mirrormap.commands.PeerDisconnectedCommand

process() - Method in class mirrormap.nio.SelectorTasks

Call Selector.select() and wait for a one of the operations in any of the registered channels to occur.

put(K, V) - Method in class mirrormap.collections.NotifyingMap

If the mapping is new, this will: call IMapListener.willAdd(Object, Object) on all listeners put the mapping call IMapListener.didAdd(Object, Object) on all listeners Otherwise this will: call IMapListener.willUpdate(Object, Object, Object) on all listeners put the mapping (overwriting) call IMapListener.didUpdate(Object, Object, Object) on all listeners

putAll(Map<? extends K, ? extends V>) - Method in class mirrormap.collections.NotifyingMap

Calls NotifyingMap.put(Object, Object) for each entry added from the argument map.

R

receive(byte[]) - Method in interface mirrormap.nio.IConnectionEndPointReceiver

Handle data received from the remote end point.

register(int, SelectableChannel, ISelectionKeyTask) - Method in class mirrormap.nio.SelectorTasks

Register the internal Selector with the channel and map the supplied task to the SelectionKey that is returned from the SelectableChannel.register(Selector, int) method.

RegisterCommand - Class in mirrormap.commands

Represents the registration for changes to be received from a named MirrorMap

RegisterCommand(String) - Constructor for class mirrormap.commands.RegisterCommand

remove(Object) - Method in class mirrormap.collections.NotifyingMap

If the mapping exists, this will: call IMapListener.willRemove(Object) on all listeners remove the mapping call IMapListener.didRemove(Object, Object) on all listeners

RemoveCommand - Class in mirrormap.commands

Encapsulates a command to remove a key-value entry into a MirrorMap.

RemoveCommand() - Constructor for class mirrormap.commands.RemoveCommand

RemoveCommand(String, Serializable) - Constructor for class mirrormap.commands.RemoveCommand

removeListener(IMapListener<?, ?>) - Method in class mirrormap.collections.NotifyingMap

Remove the listener from this NotifyingMap instance.

run() - Method in interface mirrormap.nio.ISelectionKeyTask

Run the task associated with the operation and selection key

run() - Method in class mirrormap.nio.TcpConnectionEndPoint

S

safeToString(Object) - Static method in class mirrormap.Utils

Invoke the toString() method on the target.

selectorOpened(SelectorTasks) - Method in interface mirrormap.nio.ISelectorTasksStateListener

The Selector of the SelectorTasks has been opened.

SelectorTasks - Class in mirrormap.nio

A collection of ISelectionKeyTask objects that handle the logic for the ready operations raised from registered NIO Channel objects.

SelectorTasks() - Constructor for class mirrormap.nio.SelectorTasks

Standard constructor

send(byte[]) - Method in interface mirrormap.nio.IConnectionEndPoint

Send the data to the other end point.

send(byte[]) - Method in class mirrormap.nio.TcpConnectionEndPoint

Add the data to the pending messages list

server(String, int) - Static method in class mirrormap.MirrorMap

Create a TcpServer with the corresponding server socket details.

setConnectionListener(IMirrorMapConnectionListener) - Method in class mirrormap.MirrorMap

Set the IMirrorMapConnectionListener on this mirror map

setEndPointConnection(IConnectionEndPoint) - Method in interface mirrormap.nio.IConnectionEndPointReceiver

The end point this receiver is associated with.

setSelectionKey(SelectionKey) - Method in interface mirrormap.nio.ISelectionKeyTask

Receives the selection key returned from the SelectableChannel.register(java.nio.channels.Selector, int) method called during the SelectorTasks.register(int, SelectableChannel, ISelectionKeyTask) method.

setSelectionKey(SelectionKey) - Method in class mirrormap.nio.TcpConnectionEndPoint

setStateListener(ISelectorTasksStateListener) - Method in class mirrormap.nio.SelectorTasks

Set the state listener

shouldExecute(MirrorMap<Serializable, Serializable>) - Method in class mirrormap.commands.AddCommand

Determines whether the command should be executed.

shouldExecute(MirrorMap<Serializable, Serializable>) - Method in class mirrormap.commands.UpdateCommand

size() - Method in class mirrormap.collections.NotifyingMap

start() - Method in class mirrormap.lifecycle.AbstractLifeCycle

start() - Method in interface mirrormap.lifecycle.ILifeCycle

Activate (start) this object.

string(Object, String) - Static method in class mirrormap.Utils

Produces a string representation of a source object class with a message.

T

TcpConnectionEndPoint - Class in mirrormap.nio

Handles the socket processing for a TCP end point.

TcpConnectionEndPoint(IConnectionEndPointReceiver, SelectorTasks, Executor, String, int) - Constructor for class mirrormap.nio.TcpConnectionEndPoint

Standard constructor for a TCP end point.

TcpServer - Class in mirrormap.nio

A server that opens a TCP server socket and spawns TcpConnectionEndPoint instances to handle each of the client connections.

TcpServer(IConnectionEndPointReceiver.IFactory, String, int) - Constructor for class mirrormap.nio.TcpServer

Construct the server with the factory that will create the IConnectionEndPointReceiver per client socket connection and the server socket address and port

toString() - Method in class mirrormap.collections.NotifyingMap

toString() - Method in class mirrormap.commands.AbstractCommand

toString() - Method in class mirrormap.lifecycle.AbstractLifeCycle

toString() - Method in class mirrormap.MirrorMap

toString() - Method in class mirrormap.nio.TcpConnectionEndPoint

toString() - Method in class mirrormap.nio.TcpServer

U

unregister(SelectionKey) - Method in class mirrormap.nio.SelectorTasks

Unregister the selection key and remove the associated ISelectionKeyTask.

UnregisterCommand - Class in mirrormap.commands

Represents an unregister operation of changes from a named MirrorMap

UnregisterCommand(String) - Constructor for class mirrormap.commands.UnregisterCommand

UpdateCommand - Class in mirrormap.commands

Encapsulates a command to put a key-value entry into a MirrorMap.

UpdateCommand() - Constructor for class mirrormap.commands.UpdateCommand

UpdateCommand(String, Serializable, Serializable) - Constructor for class mirrormap.commands.UpdateCommand

Utils - Class in mirrormap

Utility methods and constants.

Utils() - Constructor for class mirrormap.Utils

V

value - Variable in class mirrormap.commands.AddCommand

The value the command applies to

values() - Method in class mirrormap.collections.NotifyingMap

W

willAdd(K, V) - Method in interface mirrormap.collections.IMapListener

Called before a new entry is added to the underlying Map of a NotifyingMap.

willAdd(K, V) - Method in class mirrormap.collections.MapListenerAdapter

willRemove(K) - Method in interface mirrormap.collections.IMapListener

Called before an entry in the underlying Map of a NotifyingMap is removed

willRemove(K) - Method in class mirrormap.collections.MapListenerAdapter

willUpdate(K, V, V) - Method in interface mirrormap.collections.IMapListener

Called before an entry in the underlying Map of a NotifyingMap is updated.

willUpdate(K, V, V) - Method in class mirrormap.collections.MapListenerAdapter

A C D E F G H I K L M N P R S T U V W