com.kabira.platform.highavailability

Class Partition.Properties

java.lang.Object

com.kabira.platform.highavailability.Partition.Properties

Enclosing class:

Partition

public static final class Partition.Properties
extends java.lang.Object

The Partition properties used when defining a partition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Partition.Properties.RemoteEnableAction An enumeration of the possible actions to be taken when a remote node enables a Partition.
static class	Partition.Properties.ReplicaAudit An enumeration of the possible audits done for each replica when enabling a Partition.
static class	Partition.Properties.SparseAudit An enumeration of the possible audits that can be taken when enabling a sparse Partition.

Constructor Summary

Constructors

Constructor and Description
Properties() Default constructor.

Method Summary

Modifier and Type	Method and Description
void	broadcastUpdates(boolean enabled) Set the broadcastUpdates property value.
void	forceReplication(boolean enabled) Determine how objects are replicated during a migrate of an object partition.
boolean	getBroadcastUpdates() Get the current broadcastUpdates property value.
boolean	getForceReplication() Get the current forceReplication property value.
long	getNumberOfThreads() Get the current numberOfThreads property value.
long	getObjectsLockedPerTransaction() Get the current objectsLockedPerTransaction property value.
Partition.Properties.RemoteEnableAction	getRemoteEnableAction() Get the current remoteEnableAction property value.
Partition.Properties.ReplicaAudit	getReplicaAudit() Get the current replicaAudit property value.
java.lang.String	getRestoreFromNode() Get the current restoreFromNode property value.
Partition.Properties.SparseAudit	getSparseAudit() Get the current sparseAudit property value.
void	restoreFromNode(java.lang.String nodeName) Define the node that the partition should be restored from.
void	setNumberOfThreads(long numberOfThreads) Define the number of threads used when performing a migrate().
void	setObjectsLockedPerTransaction(long objectsLockedPerTransaction) Define the number of objects locked in a transaction when performing a migrate() or update().
void	setRemoteEnableAction(Partition.Properties.RemoteEnableAction remoteEnableAction) Set the remoteEnableAction property value.
void	setReplicaAudit(Partition.Properties.ReplicaAudit replicaAudit) Set the replicaAudit property value.
void	setSparseAudit(Partition.Properties.SparseAudit sparseAudit) Set the sparseAudit property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

Properties

public Properties()

Default constructor.

Method Detail

restoreFromNode

public void restoreFromNode(java.lang.String nodeName)
                     throws java.lang.IllegalArgumentException

Define the node that the partition should be restored from.

When this property is set, the partition defined on the given remote node is loaded to the local node. This should be done when restoring a node from a split-brain situation, where nodeName is the node in the cluster where all objects should be preserved, and the local node is the node being restored. Any conflicts during restore will preserve the objects on nodeName, and remove the conflicting objects on the local node.

A restore is needed when multiple nodes are currently the active node for a partition in a cluster due to a split-brain scenario. In this case, the application needs to decide which active node will be the node where the objects are preserved during a restore. Note that the nodeName does not necessarily have to be the node which becomes the partition's active node after the restore completes.

The actual restore of the partition is done in the enable() or enablePartitions() method when the JOIN_CLUSTER_RESTORE EnableAction is used. If any other EnableAction is used, object data isn't preserved, and no restoration of partition objects is done.

If restoreFromNode isn't set after a split-brain scenario, the runtime will perform a cluster wide broadcast to find the current active node, and use that node to restore instances in the partition. If multiple active nodes are found, the first responder is chosen.

Parameters:

nodeName - The remote node to use when restoring the partition's objects.

Throws:

java.lang.IllegalArgumentException - The nodeName was empty.

See Also:

PartitionManager.definePartition(String, Partition.Properties, String, ReplicaNode []), PartitionManager.EnableAction

getRestoreFromNode

public final java.lang.String getRestoreFromNode()

Get the current restoreFromNode property value.

Returns:

String containing value.

forceReplication

public void forceReplication(boolean enabled)

Determine how objects are replicated during a migrate of an object partition.

When set to true, a migrate() or definePartition()/enablePartitions() will force the copy of partitioned objects to all pre-existing replica nodes. The default value for this property is false, objects are only copied to new replicas as they are added since the objects should already exist on the pre-existing replica nodes.

Normally, a migrate will skip the replication of objects to pre-existing nodes in the partition's replica node list. This allows applications to incrementally add replica nodes without having to copy the objects to replicas that already exist in the partition. However, if one or more replicas have gone offline, or were not discovered when the partition was first enabled, this property can be set to insure that objects are pushed to all replicas in the cluster.

Warning: This is performance hostile, and should only be done if the replica can't be manually taken offline and restored.

The value passed into definePartition() is stored and used in failover. The value passed to migrate() overrides the value passed to definePartition().

Parameters:

enabled - If true, force the copy of objects to all replicas when a migrate() or enablePartition() is executed.

getForceReplication

public final boolean getForceReplication()

Get the current forceReplication property value.

Returns:

boolean containing value.

setObjectsLockedPerTransaction

public void setObjectsLockedPerTransaction(long objectsLockedPerTransaction)

Define the number of objects locked in a transaction when performing a migrate() or update().

When distribution performs a migrate() or update(), or when it performs a migrate() as part of failover, the work is done in units of work defined by objectsLockedPerTransaction. This allows applications to concurrently run while the work is in progress, otherwise all partitioned instances would be locked in the calling transaction, preventing application code from establishing a write lock on instances on the active node, or establishing a read lock on instances on replica nodes.

The default is defined by Partition.DefaultObjectsLockedPerTransaction

If objectsLockedPerTransaction is set to zero, all instances will be processed in the caller's transaction.

If the calling transaction has one or more partitioned instances locked in the transaction, objectsLockedPerTransaction is ignored, and all work is done in the caller's transaction. To insure that migrate() or update() minimizes the number of locks taken, they should be run in separate transactions that have no partitioned instances locked.

The value passed into definePartition() is stored and used in failover. The value passed to migrate() and update() override the value passed to definePartition().

Parameters:

objectsLockedPerTransaction - Number of objects locked per transaction when sending data to remote nodes.

Throws:

java.lang.IllegalArgumentException - The objectsLockedPerTransaction value was negative.

getObjectsLockedPerTransaction

public final long getObjectsLockedPerTransaction()

Get the current objectsLockedPerTransaction property value.

Returns:

long containing value.

setNumberOfThreads

public void setNumberOfThreads(long numberOfThreads)

Define the number of threads used when performing a migrate().

When distribution performs a migrate(), either explicitly or as part of the enablePartitions() call, the work is done in multiple threads in order to scale to the number of CPUs available in the system.

The default is defined by Partition.DefaultNumberOfThreads

If the number of partitioned instances is less that objectsLockedPerTransaction, only one thread will be used.

If objectsLockedPerTransaction is zero, or the calling transaction has one or more partitioned instances locked in the transaction, numberOfThreads is ignored, and all work is done in the caller's transaction.

Parameters:

numberOfThreads - Number of threads to use when sending data to remote nodes.

Throws:

java.lang.IllegalArgumentException - The numberOfThreads value was less than one.

getNumberOfThreads

public final long getNumberOfThreads()

Get the current numberOfThreads property value.

Returns:

long containing value.

setSparseAudit

public void setSparseAudit(Partition.Properties.SparseAudit sparseAudit)

Set the sparseAudit property value.

The default is defined by Partition.DefaultSparseAudit

Parameters:

sparseAudit - What auditing should be done.

getSparseAudit

public final Partition.Properties.SparseAudit getSparseAudit()

Get the current sparseAudit property value.

Returns:

SparseAudit enum.

setReplicaAudit

public void setReplicaAudit(Partition.Properties.ReplicaAudit replicaAudit)

Set the replicaAudit property value.

The default is defined by Partition.DefaultReplicaAudit

Parameters:

replicaAudit - What auditing should be done.

getReplicaAudit

public final Partition.Properties.ReplicaAudit getReplicaAudit()

Get the current replicaAudit property value.

Returns:

ReplicaAudit enum.

setRemoteEnableAction

public void setRemoteEnableAction(Partition.Properties.RemoteEnableAction remoteEnableAction)

Set the remoteEnableAction property value.

The default is defined by Partition.DefaultRemoteEnableAction

Parameters:

remoteEnableAction - The action to take when remote nodes enable a partition.

getRemoteEnableAction

public final Partition.Properties.RemoteEnableAction getRemoteEnableAction()

Get the current remoteEnableAction property value.

Returns:

RemoteEnableAction enum.

broadcastUpdates

public void broadcastUpdates(boolean enabled)

Set the broadcastUpdates property value.

By default, this property is enabled. Updates to the partition's definition are broadcast to all nodes in the cluster so that the partition definition is consistent across the cluster.

Warning: The ability to disable this property is only provided to support the testing of multi-master scenarios. Disabling this property for any other reason is not recommended.

Parameters:

enabled - If true, broadcast partition definition updates to all nodes in the cluster.

getBroadcastUpdates

public final boolean getBroadcastUpdates()

Get the current broadcastUpdates property value.

Returns:

boolean containing value.