com.orientechnologies.orient.server.distributed

Class ODistributedConfiguration

java.lang.Object

com.orientechnologies.orient.server.distributed.ODistributedConfiguration

Direct Known Subclasses:

OModifiableDistributedConfiguration

public class ODistributedConfiguration
extends java.lang.Object

Immutable Distributed configuration. It uses an ODocument object to store the configuration. Every changes must be done by obtaining a modifiable verson of the object through the method `modify()`.

Author:

Luca Garulli (l.garulli--(at)--orientdb.com)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ODistributedConfiguration.NEW_NODE_STRATEGIES
static class	ODistributedConfiguration.ROLES

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALL_WILDCARD
protected static java.lang.String	AUTO_DEPLOY
protected static java.lang.String	CLUSTERS
protected com.orientechnologies.orient.core.record.impl.ODocument	configuration
protected static java.lang.String	DCS
protected static java.util.List<java.lang.String>	DEFAULT_CLUSTER_NAME
static java.lang.Integer	DEFAULT_READ_QUORUM
static java.lang.String	DEFAULT_WRITE_QUORUM
protected static java.lang.String	EXECUTION_MODE
protected static java.lang.String	EXECUTION_MODE_SYNCHRONOUS
protected static java.lang.String	NEW_NODE_STRATEGY
static java.lang.String	NEW_NODE_TAG
protected static java.lang.String	OWNER
static java.lang.String	QUORUM_ALL
static java.lang.String	QUORUM_LOCAL_DC
static java.lang.String	QUORUM_MAJORITY
protected static java.lang.String	READ_QUORUM
protected static java.lang.String	READ_YOUR_WRITES
protected static java.lang.String	SERVERS
protected static java.lang.String	VERSION
protected static java.lang.String	WRITE_QUORUM

Constructor Summary

Constructors

Constructor and Description
ODistributedConfiguration(com.orientechnologies.orient.core.record.impl.ODocument iConfiguration)

Method Summary

Modifier and Type	Method and Description
void	clearForceWriteQuorum()
void	forceWriteQuorum(int quorum)
java.util.Set<java.lang.String>	getAllConfiguredServers() Returns the complete list of servers found in configuration.
protected com.orientechnologies.orient.core.record.impl.ODocument	getClusterConfiguration(java.lang.String iClusterName) Gets the document representing the cluster configuration.
java.lang.String[]	getClusterNames() Returns the array of configured clusters
java.lang.String	getClusterOwner(java.lang.String iClusterName) Returns the owner server for the given cluster excluding the passed node.
java.util.Set<java.lang.String>	getClustersOnServer(java.lang.String iNodeName) Returns the set of clusters managed by a server.
java.util.Set<java.lang.String>	getClustersOwnedByServer(java.lang.String iNodeName) Returns the set of clusters where server is the owner.
java.lang.String	getConfiguredClusterOwner(java.lang.String iClusterName) Returns the static owner server for the given cluster.
java.util.List<java.lang.String>	getConfiguredServers(java.lang.String iClusterName) Returns the configured server list for the requested cluster.
java.lang.String	getDataCenterOfServer(java.lang.String server) Returns the data center where the server belongs.
java.util.Set<java.lang.String>	getDataCenters() Returns all the configured data centers' names, if any.
java.util.List<java.lang.String>	getDataCenterServers(java.lang.String dataCenter) Returns the list of servers in a data center.
int	getDataCenterWriteQuorum(java.lang.String dataCenter) Returns the data center write quorum.
ODistributedConfiguration.ROLES	getDefaultServerRole() Returns the default server role between MASTER (default) and REPLICA.
com.orientechnologies.orient.core.record.impl.ODocument	getDocument()
java.lang.Object	getGlobalReadQuorum(java.lang.String iClusterName) Returns the global read quorum.
java.util.List<java.lang.String>	getMasterServers() Returns an ordered list of master server.
ODistributedConfiguration.NEW_NODE_STRATEGIES	getNewNodeStrategy() Returns the new node strategy between "dynamic" and "static".
java.util.List<java.lang.String>	getOwnedClustersByServer(java.util.Collection<java.lang.String> iClusterNames, java.lang.String iNode) Returns the clusters where a server is owner.
int	getReadQuorum(java.lang.String clusterName, int totalConfiguredServers, java.lang.String server) Returns the read quorum.
java.util.Set<java.lang.String>	getRegisteredServers() Returns the registered servers.
java.util.Map<java.lang.String,java.util.Collection<java.lang.String>>	getServerClusterMap(java.util.Collection<java.lang.String> iClusterNames, java.lang.String iLocalNode, boolean optimizeForLocalOnly) Returns the list of servers that can manage a list of clusters.
ODistributedConfiguration.ROLES	getServerRole(java.lang.String iServerName) Returns the server role between MASTER (default) and REPLICA.
java.util.Set<java.lang.String>	getServers(java.util.Collection<java.lang.String> iClusterNames) Returns the set of server names involved on the passed cluster collection.
java.util.List<java.lang.String>	getServers(java.lang.String iClusterName, java.lang.String iExclude) Returns the server list for the requested cluster cluster excluding any tags like and iExclude if any.
int	getVersion()
int	getWriteQuorum(java.lang.String clusterName, int totalConfiguredMasterServers, java.lang.String server) Returns the write quorum.
boolean	hasDataCenterConfiguration() Returns true if the configuration per data centers is specified.
boolean	isAutoDeploy()
java.lang.Boolean	isExecutionModeSynchronous(java.lang.String iClusterName) Returns the execution mode if synchronous.
boolean	isLocalDataCenterWriteQuorum() Returns true if the global write quorum is "localDataCenter".
java.lang.Boolean	isReadYourWrites(java.lang.String iClusterName) Reads your writes.
boolean	isReplicationActive(java.lang.String iClusterName, java.lang.String iLocalNode) Returns true if the replication is active, otherwise false.
boolean	isServerContainingAllClusters(java.lang.String server, java.util.Collection<java.lang.String> clusters) Returns true if the local server has all the requested clusters.
boolean	isServerContainingCluster(java.lang.String server, java.lang.String cluster) Returns true if the local server has the requested cluster.
boolean	isSharded() Returns true if the database is sharded across servers.
OModifiableDistributedConfiguration	modify()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

NEW_NODE_TAG

public static final java.lang.String NEW_NODE_TAG

See Also:

Constant Field Values

ALL_WILDCARD

public static final java.lang.String ALL_WILDCARD

See Also:

Constant Field Values

SERVERS

protected static final java.lang.String SERVERS

See Also:

Constant Field Values

DCS

protected static final java.lang.String DCS

See Also:

Constant Field Values

OWNER

protected static final java.lang.String OWNER

See Also:

Constant Field Values

CLUSTERS

protected static final java.lang.String CLUSTERS

See Also:

Constant Field Values

VERSION

protected static final java.lang.String VERSION

See Also:

Constant Field Values

AUTO_DEPLOY

protected static final java.lang.String AUTO_DEPLOY

See Also:

Constant Field Values

READ_QUORUM

protected static final java.lang.String READ_QUORUM

See Also:

Constant Field Values

WRITE_QUORUM

protected static final java.lang.String WRITE_QUORUM

See Also:

Constant Field Values

QUORUM_MAJORITY

public static final java.lang.String QUORUM_MAJORITY

See Also:

Constant Field Values

QUORUM_ALL

public static final java.lang.String QUORUM_ALL

See Also:

Constant Field Values

QUORUM_LOCAL_DC

public static final java.lang.String QUORUM_LOCAL_DC

See Also:

Constant Field Values

DEFAULT_READ_QUORUM

public static final java.lang.Integer DEFAULT_READ_QUORUM

DEFAULT_WRITE_QUORUM

public static final java.lang.String DEFAULT_WRITE_QUORUM

See Also:

Constant Field Values

NEW_NODE_STRATEGY

protected static final java.lang.String NEW_NODE_STRATEGY

See Also:

Constant Field Values

READ_YOUR_WRITES

protected static final java.lang.String READ_YOUR_WRITES

See Also:

Constant Field Values

EXECUTION_MODE

protected static final java.lang.String EXECUTION_MODE

See Also:

Constant Field Values

EXECUTION_MODE_SYNCHRONOUS

protected static final java.lang.String EXECUTION_MODE_SYNCHRONOUS

See Also:

Constant Field Values

configuration

protected final com.orientechnologies.orient.core.record.impl.ODocument configuration

DEFAULT_CLUSTER_NAME

protected static final java.util.List<java.lang.String> DEFAULT_CLUSTER_NAME

Constructor Detail

ODistributedConfiguration

public ODistributedConfiguration(com.orientechnologies.orient.core.record.impl.ODocument iConfiguration)

Method Detail

modify

public OModifiableDistributedConfiguration modify()

isReplicationActive

public boolean isReplicationActive(java.lang.String iClusterName,
                                   java.lang.String iLocalNode)

Returns true if the replication is active, otherwise false.

Parameters:

iClusterName - Cluster name, or null for *

hasDataCenterConfiguration

public boolean hasDataCenterConfiguration()

Returns true if the configuration per data centers is specified.

isAutoDeploy

public boolean isAutoDeploy()

getNewNodeStrategy

public ODistributedConfiguration.NEW_NODE_STRATEGIES getNewNodeStrategy()

Returns the new node strategy between "dynamic" and "static". If static, the node is registered under the "server" tag.

Returns:

NEW_NODE_STRATEGIES enum

isExecutionModeSynchronous

public java.lang.Boolean isExecutionModeSynchronous(java.lang.String iClusterName)

Returns the execution mode if synchronous.

Parameters:

iClusterName - Cluster name, or null for *

Returns:

true = synchronous, false = asynchronous, null = undefined

isReadYourWrites

public java.lang.Boolean isReadYourWrites(java.lang.String iClusterName)

Reads your writes.

Parameters:

iClusterName - Cluster name, or null for *

getServerClusterMap

public java.util.Map<java.lang.String,java.util.Collection<java.lang.String>> getServerClusterMap(java.util.Collection<java.lang.String> iClusterNames,
                                                                                                  java.lang.String iLocalNode,
                                                                                                  boolean optimizeForLocalOnly)

Returns the list of servers that can manage a list of clusters. The algorithm makes its best to involve the less servers as it can.

Parameters:

iClusterNames - Set of cluster names to find

iLocalNode - Local node name

getOwnedClustersByServer

public java.util.List<java.lang.String> getOwnedClustersByServer(java.util.Collection<java.lang.String> iClusterNames,
                                                                 java.lang.String iNode)

Returns the clusters where a server is owner. This is used when a cluster must be selected: locality is always the best choice.

Parameters:

iClusterNames - Set of cluster names

iNode - Node

getServers

public java.util.Set<java.lang.String> getServers(java.util.Collection<java.lang.String> iClusterNames)

Returns the set of server names involved on the passed cluster collection.

Parameters:

iClusterNames - Collection of cluster names to find

isServerContainingAllClusters

public boolean isServerContainingAllClusters(java.lang.String server,
                                             java.util.Collection<java.lang.String> clusters)

Returns true if the local server has all the requested clusters.

Parameters:

server - Server name

clusters - Collection of cluster names to find

isServerContainingCluster

public boolean isServerContainingCluster(java.lang.String server,
                                         java.lang.String cluster)

Returns true if the local server has the requested cluster.

Parameters:

server - Server name

cluster - cluster names to find

getServers

public java.util.List<java.lang.String> getServers(java.lang.String iClusterName,
                                                   java.lang.String iExclude)

Returns the server list for the requested cluster cluster excluding any tags like and iExclude if any.

Parameters:

iClusterName - Cluster name, or null for *

iExclude - Node to exclude

getMasterServers

public java.util.List<java.lang.String> getMasterServers()

Returns an ordered list of master server. The first in the list is the first found in configuration. This is used to determine the cluster leader.

getAllConfiguredServers

public java.util.Set<java.lang.String> getAllConfiguredServers()

Returns the complete list of servers found in configuration.

getClustersOnServer

public java.util.Set<java.lang.String> getClustersOnServer(java.lang.String iNodeName)

Returns the set of clusters managed by a server.

Parameters:

iNodeName - Server name

getClustersOwnedByServer

public java.util.Set<java.lang.String> getClustersOwnedByServer(java.lang.String iNodeName)

Returns the set of clusters where server is the owner.

Parameters:

iNodeName - Server name

getClusterOwner

public java.lang.String getClusterOwner(java.lang.String iClusterName)

Returns the owner server for the given cluster excluding the passed node. The Owner server is the first in server list.

Parameters:

iClusterName - Cluster name, or null for *

getConfiguredClusterOwner

public java.lang.String getConfiguredClusterOwner(java.lang.String iClusterName)

Returns the static owner server for the given cluster.

Parameters:

iClusterName - Cluster name, or null for *

getConfiguredServers

public java.util.List<java.lang.String> getConfiguredServers(java.lang.String iClusterName)

Returns the configured server list for the requested cluster.

Parameters:

iClusterName - Cluster name, or null for *

getClusterNames

public java.lang.String[] getClusterNames()

Returns the array of configured clusters

getDefaultServerRole

public ODistributedConfiguration.ROLES getDefaultServerRole()

Returns the default server role between MASTER (default) and REPLICA.

getServerRole

public ODistributedConfiguration.ROLES getServerRole(java.lang.String iServerName)

Returns the server role between MASTER (default) and REPLICA.

getRegisteredServers

public java.util.Set<java.lang.String> getRegisteredServers()

Returns the registered servers.

getDocument

public com.orientechnologies.orient.core.record.impl.ODocument getDocument()

getDataCenters

public java.util.Set<java.lang.String> getDataCenters()

Returns all the configured data centers' names, if any.

getDataCenterWriteQuorum

public int getDataCenterWriteQuorum(java.lang.String dataCenter)

Returns the data center write quorum.

Parameters:

dataCenter - Data center name

isSharded

public boolean isSharded()

Returns true if the database is sharded across servers. False if it's completely replicated.

getDataCenterServers

public java.util.List<java.lang.String> getDataCenterServers(java.lang.String dataCenter)

Returns the list of servers in a data center.

Parameters:

dataCenter - Data center name

Throws:

com.orientechnologies.orient.core.exception.OConfigurationException - if the list of servers is not found in data center configuration

getDataCenterOfServer

public java.lang.String getDataCenterOfServer(java.lang.String server)

Returns the data center where the server belongs.

Parameters:

server - Server name

getVersion

public int getVersion()

isLocalDataCenterWriteQuorum

public boolean isLocalDataCenterWriteQuorum()

Returns true if the global write quorum is "localDataCenter".

getGlobalReadQuorum

public java.lang.Object getGlobalReadQuorum(java.lang.String iClusterName)

Returns the global read quorum.

Parameters:

iClusterName - Cluster name, or null for *

getReadQuorum

public int getReadQuorum(java.lang.String clusterName,
                         int totalConfiguredServers,
                         java.lang.String server)

Returns the read quorum.

Parameters:

clusterName - Cluster name, or null for *

totalConfiguredServers - Total node available

getWriteQuorum

public int getWriteQuorum(java.lang.String clusterName,
                          int totalConfiguredMasterServers,
                          java.lang.String server)

Returns the write quorum.

Parameters:

clusterName - Cluster name, or null for *

totalConfiguredMasterServers - Total node available

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getClusterConfiguration

protected com.orientechnologies.orient.core.record.impl.ODocument getClusterConfiguration(java.lang.String iClusterName)

Gets the document representing the cluster configuration.

Parameters:

iClusterName - Cluster name, or null for *

Returns:

Always a ODocument

Throws:

com.orientechnologies.orient.core.exception.OConfigurationException - in case "clusters" field is not found in configuration

forceWriteQuorum

public void forceWriteQuorum(int quorum)

clearForceWriteQuorum

public void clearForceWriteQuorum()