com.ibm.websphere.objectgrid
Interface ClientReplicableMap

All Known Subinterfaces:

BackingMap

Deprecated. The client replicated map function is deprecated in version 8.6. Use the ContinuousQueryManager function.

public interface ClientReplicableMap

This interface represents a replicable client map. A replicable client map can be a continuous replica or a snapshot replica of the server map.

If the client is a continuous replica of the server map, the data in the server will be replicated to the client continuously in an asynchronous manner.

If the client is a snapshot replica of the server map, a snapshot on the data in the server will be taken and the snapshot will be replicated to the client in an asynchronous manner. A snapshot replication is a one-time replication.

A ReplicationMapListener can be used to listen for the data changes as well as the replication lifecycle events.

Since:

WAS XD 6.1, XC10

See Also:

ReplicationMapListener

Nested Class Summary

static class

ClientReplicableMap.Mode Deprecated. Client Replication mode

Field Summary

static ClientReplicableMap.Mode	CONTINUOUS_REPLICATION Deprecated. Full replication mode.
static ClientReplicableMap.Mode	NONE Deprecated. No replication mode, aka normal mode.
static ClientReplicableMap.Mode	SNAPSHOT_REPLICATION Deprecated. Snapshot replication mode.

Method Summary

void	disableClientReplication() Deprecated. Disables the replication for this client.
void	enableClientReplication(ClientReplicableMap.Mode mode, int[] partitions, ReplicationMapListener listener) Deprecated. Make the client map a replica of the server side map.
ClientReplicableMap.Mode	getReplicationMode() Deprecated. Returns the current replication mode

Field Detail

NONE

static final ClientReplicableMap.Mode NONE

Deprecated.

No replication mode, aka normal mode.

CONTINUOUS_REPLICATION

static final ClientReplicableMap.Mode CONTINUOUS_REPLICATION

Deprecated.

Full replication mode. Data in the server map will be replicated to the client continuously.

SNAPSHOT_REPLICATION

static final ClientReplicableMap.Mode SNAPSHOT_REPLICATION

Deprecated.

Snapshot replication mode. A snapshot on the data in the server will be taken and the snapshot will be replicated to the client. A snapshot replication is a one-time replication.

Method Detail

enableClientReplication

void enableClientReplication(ClientReplicableMap.Mode mode,
                             int[] partitions,
                             ReplicationMapListener listener)
                             throws ObjectGridException

Deprecated.

Make the client map a replica of the server side map.

When security is enabled, this method requires a ServerMapPermission with action "replicate". Refer to ServerMapPermission for more permission details.

Required Client Permission: ServerMapPermission.REPLICATE

Parameters:

mode - The replication mode.

partitions - The array of partition IDs represent which partitions the data should be replicated from. If the value is null or an empty array, it indicates the data should be replicated from all partitions.

listener - a listener to receive client replication events

Throws:

IllegalArgumentException - if mode is not CONTINUOUS_REPLICATION or SNAPSHOT_REPLICATION or the map isn't currently in the mode specified or is not in NONE mode

IllegalStateException - if this method is invoked on a map other than a client map

ObjectGridException - if an error occurs during processing this request

See Also:

ReplicationMapListener, CONTINUOUS_REPLICATION, SNAPSHOT_REPLICATION, getReplicationMode(), BackingMap.CLIENT

getReplicationMode

ClientReplicableMap.Mode getReplicationMode()

Deprecated.

Returns the current replication mode

Returns:

the replication mode

See Also:

NONE, CONTINUOUS_REPLICATION, SNAPSHOT_REPLICATION

disableClientReplication

void disableClientReplication()
                              throws ObjectGridException

Deprecated.

Disables the replication for this client. If it is not in a replication mode, this method will be a no-op.

When security is enabled, this method requires a ServerMapPermission with action "replicate". Refer to ServerMapPermission for more permission details.

Throws:

IllegalStateException - if this method is invoked on a map other than a client map

ObjectGridException - if an error occurs during processing this request

See Also:

BackingMap.CLIENT