com.ibm.websphere.objectgrid.plugins
Class DistributionMode

java.lang.Object
  com.ibm.websphere.objectgrid.plugins.DistributionMode

public final class DistributionMode
extends Object

This class is used to define the "distribution" mode when the serialize() method on the LogSequenceTransformer interface is used. The caller is expected to pass one of the static constant variables defined in this class to the serialize() method. The DistributionMode works with the LogSequenceFilter to limit the amount of data distributed via the LogSequences.

Since:

WAS XD 6.0

See Also:

LogSequenceFilter

Field Summary

static DistributionMode	INVALIDATE The INVALIDATE distribution mode is used to communicate invalidates to the receivers of the LogSequence.
static DistributionMode	INVALIDATE_CONDITIONAL The INVALIDATE_CONDITIONAL is very much like the INVALIDATE distribution mode except that it also takes into account the versioned value data associated with each entry.
static DistributionMode	PUSH The PUSH distribution mode is used to communicate changes to the receivers of the LogSequence.
static DistributionMode	PUSH_CONDITIONAL The PUSH_CONDITIONAL is very much like the PUSH distribution mode except that it also takes into account the versioned value data associated with each entry.

Method Summary

boolean	isConditional() Checks whether the mode is conditional mode or not.
boolean	isInvalidate() Checks whether the mode is a invalidate mode or not.
boolean	isPush() Checks whether the mode is a push mode or not.
int	toInt() Return the int representation of mode
String	toString() Returns a string representation of the DistributionMode.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

INVALIDATE

public static final DistributionMode INVALIDATE

The INVALIDATE distribution mode is used to communicate invalidates to the receivers of the LogSequence. This means that any updates (Updates, Deletes, Evicts) in the current LogSequence will be communicated as invalidates on the receiving side. This allows the receivers of the LogSequence to properly invalidate entries that are now out of date due to the LogSequence that was just processed. The INVALIDATE mode will only send the Keys in the distributed LogSequence since that is all that is required for an unqualified invalidate.

INVALIDATE_CONDITIONAL

public static final DistributionMode INVALIDATE_CONDITIONAL

The INVALIDATE_CONDITIONAL is very much like the INVALIDATE distribution mode except that it also takes into account the versioned value data associated with each entry. Thus, before the invalidates are performed on the receiving side, a comparison is done between the versioned value and the value currently in the receiving side ObjectMap. If the versioned value is older than the current value, then the invalidate is not performed.

See Also:

INVALIDATE

PUSH

public static final DistributionMode PUSH

The PUSH distribution mode is used to communicate changes to the receivers of the LogSequence. This means that any LogElements in the current LogSequence will be communicated as corresponding LogElements on the receiving side. This allows the receivers of the LogSequence to properly update their instance of the ObjectMap. The PUSH mode will process the LogSequence unconditionally, without any concern of optimistic collisions. This means that an Update done via PUSH mode could overwrite the value in the receiving ObjectMap that was performed via another transaction.

PUSH_CONDITIONAL

public static final DistributionMode PUSH_CONDITIONAL

The PUSH_CONDITIONAL is very much like the PUSH distribution mode except that it also takes into account the versioned value data associated with each entry. Thus, before the updates are applied on the receiving side, a comparison is done between the versioned value and the value currently in the receiving side ObjectMap. If the versioned value is older than the current value, then the operation is not performed.

See Also:

PUSH

Method Detail

isConditional

public boolean isConditional()

Checks whether the mode is conditional mode or not. A mode is conditional if it is either PUSH_CONDITIONAL or INVALIDATE_CONDITIONAL.

Returns:

true if the mode is conditional; false otherwise

See Also:

PUSH_CONDITIONAL, INVALIDATE_CONDITIONAL

isInvalidate

public boolean isInvalidate()

Checks whether the mode is a invalidate mode or not. A mode is a invalidate mode if it is either INVALIDATE or INVALIDATE_CONDITIONAL.

Returns:

true if the mode is a invalidate mode; false otherwise

See Also:

INVALIDATE, INVALIDATE_CONDITIONAL

isPush

public boolean isPush()

Checks whether the mode is a push mode or not. A mode is a push mode if it is either PUSH or PUSH_CONDITIONAL.

Returns:

true if the mode is a push mode; false otherwise

See Also:

PUSH, PUSH_CONDITIONAL

toInt

public int toInt()

Return the int representation of mode

Returns:

the int representation of mode

toString

public String toString()

Returns a string representation of the DistributionMode.

Overrides:

toString in class Object

Returns:

a string representation of the DistributionMode.