ODistributedConfiguration (OrientDB Server 2.2.13 API)

java.lang.Object
- com.orientechnologies.orient.server.distributed.ODistributedConfiguration

```
public class ODistributedConfiguration
extends Object
```
Distributed configuration. It uses an ODocument object to store the configuration. Every changes increment the field "version".

Author:

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ODistributedConfiguration.NEW_NODE_STRATEGIES

static class ODistributedConfiguration.ROLES

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 String`	`ALL_WILDCARD`
`static Integer`	`DEFAULT_READ_QUORUM`
`static String`	`DEFAULT_WRITE_QUORUM`
`static String`	`NEW_NODE_TAG`
`static String`	`QUORUM_ALL`
`static String`	`QUORUM_LOCAL_DC`
`static String`	`QUORUM_MAJORITY`

Constructor Summary

Constructors
Constructor and Description

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

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`addNewNodeInServerList(String iNode)` Adds a server in the configuration.
`Set<String>`	`getAllConfiguredServers()` Returns the complete list of servers found in configuration.
`String[]`	`getClusterNames()` Returns the array of configured clusters
`String`	`getClusterOwner(String iClusterName)` Returns the owner server for the given cluster excluding the passed node.
`Set<String>`	`getClustersOnServer(String iNodeName)` Returns the set of clusters managed by a server.
`Set<String>`	`getClustersOwnedByServer(String iNodeName)` Returns the set of clusters where server is the owner.
`String`	`getConfiguredClusterOwner(String iClusterName)` Returns the static owner server for the given cluster.
`String`	`getDataCenterOfServer(String server)` Returns the data center where the server belongs.
`Set<String>`	`getDataCenters()` Returns all the configured data centers' names, if any.
`List<String>`	`getDataCenterServers(String dataCenter)` Returns the list of servers in a data center.
`int`	`getDataCenterWriteQuorum(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()`
`Object`	`getGlobalReadQuorum(String iClusterName)` Returns the global read quorum.
`ODistributedConfiguration.NEW_NODE_STRATEGIES`	`getNewNodeStrategy()` Returns the new node strategy between "dynamic" and "static".
`List<String>`	`getOwnedClustersByServer(Collection<String> iClusterNames, String iNode)` Returns the clusters where a server is owner.
`int`	`getReadQuorum(String clusterName, int availableNodes, String server)` Returns the read quorum.
`Set<String>`	`getRegisteredServers()` Returns the registered servers.
`Map<String,Collection<String>>`	`getServerClusterMap(Collection<String> iClusterNames, String iLocalNode, boolean optimizeForLocalOnly)` Returns the list of servers that can manage a list of clusters.
`ODistributedConfiguration.ROLES`	`getServerRole(String iServerName)` Returns the server role between MASTER (default) and REPLICA.
`Set<String>`	`getServers(Collection<String> iClusterNames)` Returns the set of server names involved on the passed cluster collection.
`List<String>`	`getServers(String iClusterName)` Returns the server list for the requested cluster.
`List<String>`	`getServers(String iClusterName, String iExclude)` Returns the server list for the requested cluster cluster excluding any tags like and iExclude if any.
`int`	`getVersion()`
`int`	`getWriteQuorum(String clusterName, int availableNodes, String server)` Returns the write quorum.
`boolean`	`hasDataCenterConfiguration()` Returns true if the configuration per data centers is specified.
`Boolean`	`isExecutionModeSynchronous(String iClusterName)` Returns the execution mode if synchronous.
`boolean`	`isLocalDataCenterWriteQuorum()` Returns true if the global write quorum is "localDataCenter".
`Boolean`	`isReadYourWrites(String iClusterName)` Reads your writes.
`boolean`	`isReplicationActive(String iClusterName, String iLocalNode)` Returns true if the replication is active, otherwise false.
`boolean`	`isServerContainingAllClusters(String server, Collection<String> clusters)` Returns true if the local server has all the requested clusters.
`boolean`	`isServerContainingCluster(String server, String cluster)` Returns true if the local server has the requested cluster.
`boolean`	`isSharded()` Returns true if the database is sharded across servers.
`List<String>`	`removeServer(String iNode)` Removes a server from the list. NOTE: It must be executed in distributed database lock.
`List<String>`	`setServerOffline(String iNode, String newServerCoordinator)` Set a server offline.
`void`	`setServerOwner(String iClusterName, String iServerName)` Sets the server as owner for the given cluster.
`void`	`setServerRole(String iServerName, ODistributedConfiguration.ROLES role)` Sets the server role between MASTER (default) and REPLICA.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - NEW_NODE_TAG
```
public static final String NEW_NODE_TAG
```
    See Also:
    
    Constant Field Values
  - ALL_WILDCARD
```
public static final String ALL_WILDCARD
```
    See Also:
    
    Constant Field Values
  - QUORUM_MAJORITY
```
public static final String QUORUM_MAJORITY
```
    See Also:
    
    Constant Field Values
  - QUORUM_ALL
```
public static final String QUORUM_ALL
```
    See Also:
    
    Constant Field Values
  - QUORUM_LOCAL_DC
```
public static final String QUORUM_LOCAL_DC
```
    See Also:
    
    Constant Field Values
  - DEFAULT_READ_QUORUM
```
public static final Integer DEFAULT_READ_QUORUM
```
  - DEFAULT_WRITE_QUORUM
```
public static final String DEFAULT_WRITE_QUORUM
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ODistributedConfiguration
```
public ODistributedConfiguration(com.orientechnologies.orient.core.record.impl.ODocument iConfiguration)
```
- Method Detail
  - isReplicationActive
```
public boolean isReplicationActive(String iClusterName,
                                   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.
  - 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 Boolean isExecutionModeSynchronous(String iClusterName)
```
    Returns the execution mode if synchronous.
    
    Parameters:
    
    iClusterName - Cluster name, or null for *
    
    Returns:
    
    true = synchronous, false = asynchronous, null = undefined
  - isReadYourWrites
```
public Boolean isReadYourWrites(String iClusterName)
```
    Reads your writes.
    
    Parameters:
    
    iClusterName - Cluster name, or null for *
  - getServerClusterMap
```
public Map<String,Collection<String>> getServerClusterMap(Collection<String> iClusterNames,
                                                          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 List<String> getOwnedClustersByServer(Collection<String> iClusterNames,
                                             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 Set<String> getServers(Collection<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(String server,
                                             Collection<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(String server,
                                         String cluster)
```
    Returns true if the local server has the requested cluster.
    
    Parameters:
    
    server - Server name
    
    cluster - cluster names to find
  - getServers
```
public List<String> getServers(String iClusterName,
                               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
  - getAllConfiguredServers
```
public Set<String> getAllConfiguredServers()
```
    Returns the complete list of servers found in configuration.
  - getClustersOnServer
```
public Set<String> getClustersOnServer(String iNodeName)
```
    Returns the set of clusters managed by a server.
    
    Parameters:
    
    iNodeName - Server name
  - getClustersOwnedByServer
```
public Set<String> getClustersOwnedByServer(String iNodeName)
```
    Returns the set of clusters where server is the owner.
    
    Parameters:
    
    iNodeName - Server name
  - getClusterOwner
```
public String getClusterOwner(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 String getConfiguredClusterOwner(String iClusterName)
```
    Returns the static owner server for the given cluster.
    
    Parameters:
    
    iClusterName - Cluster name, or null for *
  - getServers
```
public List<String> getServers(String iClusterName)
```
    Returns the server list for the requested cluster.
    
    Parameters:
    
    iClusterName - Cluster name, or null for *
  - getClusterNames
```
public 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(String iServerName)
```
    Returns the server role between MASTER (default) and REPLICA.
  - setServerRole
```
public void setServerRole(String iServerName,
                          ODistributedConfiguration.ROLES role)
```
    Sets the server role between MASTER (default) and REPLICA.
  - getRegisteredServers
```
public Set<String> getRegisteredServers()
```
    Returns the registered servers.
  - getDocument
```
public com.orientechnologies.orient.core.record.impl.ODocument getDocument()
```
  - addNewNodeInServerList
```
public List<String> addNewNodeInServerList(String iNode)
```
    Adds a server in the configuration. It replaces all the tags <NEW_NODE> with the new server name
    NOTE: It must be executed in distributed database lock.
    
    Parameters:
    
    iNode - Server name
    
    Returns:
  - setServerOwner
```
public void setServerOwner(String iClusterName,
                           String iServerName)
```
    Sets the server as owner for the given cluster. The owner server is the first in server list.
    NOTE: It must be executed in distributed database lock.
    
    Parameters:
    
    iClusterName - Cluster name or *. Does not accept null.
  - removeServer
```
public List<String> removeServer(String iNode)
```
    Removes a server from the list.
    NOTE: It must be executed in distributed database lock.
    
    Parameters:
    
    iNode - Server name
    
    Returns:
  - getDataCenters
```
public Set<String> getDataCenters()
```
    Returns all the configured data centers' names, if any.
  - getDataCenterWriteQuorum
```
public int getDataCenterWriteQuorum(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 List<String> getDataCenterServers(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 String getDataCenterOfServer(String server)
```
    Returns the data center where the server belongs.
    
    Parameters:
    
    server - Server name
  - setServerOffline
```
public List<String> setServerOffline(String iNode,
                                     String newServerCoordinator)
```
    Set a server offline. It assures the offline server is never on top of the list.
    NOTE: It must be executed in distributed database lock.
    
    Parameters:
    
    iNode - Server name
    
    newServerCoordinator - New coordinator server name
    
    Returns:
  - getVersion
```
public int getVersion()
```
  - isLocalDataCenterWriteQuorum
```
public boolean isLocalDataCenterWriteQuorum()
```
    Returns true if the global write quorum is "localDataCenter".
  - getGlobalReadQuorum
```
public Object getGlobalReadQuorum(String iClusterName)
```
    Returns the global read quorum.
    
    Parameters:
    
    iClusterName - Cluster name, or null for *
  - getReadQuorum
```
public int getReadQuorum(String clusterName,
                         int availableNodes,
                         String server)
```
    Returns the read quorum.
    
    Parameters:
    
    clusterName - Cluster name, or null for *
    
    availableNodes - Total node available
  - getWriteQuorum
```
public int getWriteQuorum(String clusterName,
                          int availableNodes,
                          String server)
```
    Returns the write quorum.
    
    Parameters:
    
    clusterName - Cluster name, or null for *
    
    availableNodes - Total node available

Class ODistributedConfiguration

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

NEW_NODE_TAG

ALL_WILDCARD

QUORUM_MAJORITY

QUORUM_ALL

QUORUM_LOCAL_DC

DEFAULT_READ_QUORUM

DEFAULT_WRITE_QUORUM

Constructor Detail

ODistributedConfiguration

Method Detail

isReplicationActive

hasDataCenterConfiguration

getNewNodeStrategy

isExecutionModeSynchronous

isReadYourWrites

getServerClusterMap

getOwnedClustersByServer

getServers

isServerContainingAllClusters

isServerContainingCluster

getServers

getAllConfiguredServers

getClustersOnServer

getClustersOwnedByServer

getClusterOwner

getConfiguredClusterOwner

getServers

getClusterNames

getDefaultServerRole

getServerRole

setServerRole

getRegisteredServers

getDocument

addNewNodeInServerList

setServerOwner

removeServer

getDataCenters

getDataCenterWriteQuorum

isSharded

getDataCenterServers

getDataCenterOfServer

setServerOffline

getVersion

isLocalDataCenterWriteQuorum

getGlobalReadQuorum

getReadQuorum

getWriteQuorum