Package com.orientechnologies.orient.server.distributed

Interface ODistributedServerManager

All Known Implementing Classes:

ODistributedPlugin, OHazelcastPlugin

public interface ODistributedServerManager

Server cluster interface to abstract cluster behavior.

Author:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ODistributedServerManager.DB_STATUS	Database status.
static enum	ODistributedServerManager.NODE_STATUS	Server status.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILE_DISTRIBUTED_DB_CONFIG

Method Summary

Modifier and Type	Method	Description
boolean	checkNodeStatus(ODistributedServerManager.NODE_STATUS status)
Throwable	convertException(Throwable original)
<T> T	executeInDistributedDatabaseLock(String databaseName, long timeoutLocking, OModifiableDistributedConfiguration lastCfg, OCallable<T,OModifiableDistributedConfiguration> iCallback)	Executes an operation protected by a distributed lock (one per database).
Object	executeOnLocalNode(ODistributedRequestId reqId, ORemoteTask task, ODatabaseDocumentInternal database)
void	executeOnLocalNodeFromRemote(ODistributedRequest request)
Set<String>	getActiveServers()
Set<String>	getAvailableNodeNames(String databaseName)
int	getAvailableNodes(String iDatabaseName)
int	getAvailableNodes(Collection<String> iNodes, String databaseName)
ODocument	getClusterConfiguration()
long	getClusterTime()	Returns the cluster-wide time in milliseconds.
String	getCoordinatorServer()	Deprecated.
ODistributedDatabase	getDatabase(String name)
ODistributedConfiguration	getDatabaseConfiguration(String iDatabaseName)
Set<String>	getDatabases()
ODistributedServerManager.DB_STATUS	getDatabaseStatus(String iNode, String iDatabaseName)
File	getDefaultDatabaseConfigFile()
ODistributedStrategy	getDistributedStrategy()
long	getLastClusterChangeOn()
ODocument	getLocalNodeConfiguration()
int	getLocalNodeId()
String	getLocalNodeName()
ODistributedLockManager	getLockManagerExecutor()
ODistributedLockManager	getLockManagerRequester()
ODistributedMessageService	getMessageService()
long	getNextMessageIdCounter()
ODocument	getNodeConfigurationByUuid(String iNode, boolean useCache)
int	getNodeIdByName(String node)
String	getNodeNameById(int id)
ODistributedServerManager.NODE_STATUS	getNodeStatus()
int	getNodesWithStatus(Collection<String> iNodes, String databaseName, ODistributedServerManager.DB_STATUS... statuses)
String	getNodeUuidByName(String name)
ODocument	getOnlineDatabaseConfiguration(String databaseName)
List<String>	getOnlineNodes(String iDatabaseName)
ORemoteServerController	getRemoteServer(String nodeName)
OServer	getServerInstance()
ODocument	getStats()
ORemoteTaskFactoryManager	getTaskFactoryManager()	Returns the task factory manager.
int	getTotalNodes(String iDatabaseName)
boolean	installDatabase(boolean iStartup, String databaseName, boolean forceDeployment, boolean tryWithDeltaFirst)
boolean	isEnabled()
boolean	isNodeAvailable(String iNodeName)
boolean	isNodeAvailable(String iNodeName, String databaseName)	Available means not OFFLINE, so ONLINE or SYNCHRONIZING.
boolean	isNodeOnline(String iNodeName, String databaseName)	Returns true if the node status is ONLINE.
boolean	isNodeStatusEqualsTo(String iNodeName, String iDatabaseName, ODistributedServerManager.DB_STATUS... statuses)	Checks the node status if it's one of the statuses received as argument.
boolean	isOffline()
boolean	isSyncronizing(String databaseName)
boolean	isWriteQuorumPresent(String databaseName)	Returns true if the quorum is present in terms of number of available nodes for full replication only.
default void	messageAfterOp(String op, ODistributedRequestId requestId)
default void	messageBeforeOp(String op, ODistributedRequestId requestId)
default void	messageCurrentPayload(ODistributedRequestId requestId, Object responsePayload)
default void	messagePartitionCalculate(ODistributedRequest request, Set<Integer> involvedWorkerQueues)
default void	messageProcessEnd(ODistributedRequest iRequest, Object responsePayload)
default void	messageProcessStart(ODistributedRequest message)
default void	messageReceived(ODistributedRequest request)
void	notifyClients(String databaseName)
void	publishDistributedConfiguration(String iDatabaseName, ODistributedConfiguration cfg)
void	reassignClustersOwnership(String iNode, String databaseName, OModifiableDistributedConfiguration cfg, boolean canCreateNewClusters)
ODistributedServerManager	registerLifecycleListener(ODistributedLifecycleListener iListener)
void	removeServer(String nodeLeftName, boolean removeOnlyDynamicServers)
ODistributedResponse	sendRequest(String iDatabaseName, Collection<String> iClusterNames, Collection<String> iTargetNodeNames, ORemoteTask iTask, long messageId, ODistributedRequest.EXECUTION_MODE iExecutionMode, Object localResult)	Sends a distributed request against multiple servers.
ODistributedResponse	sendRequest(String iDatabaseName, Collection<String> iClusterNames, Collection<String> iTargetNodeNames, ORemoteTask iTask, long messageId, ODistributedRequest.EXECUTION_MODE iExecutionMode, Object localResult, ODistributedResponseManagerFactory responseManagerFactory)
void	setDatabaseStatus(String iNode, String iDatabaseName, ODistributedServerManager.DB_STATUS iStatus)
void	setDistributedStrategy(ODistributedStrategy streatgy)
void	setNodeStatus(ODistributedServerManager.NODE_STATUS iStatus)
ODistributedServerManager	unregisterLifecycleListener(ODistributedLifecycleListener iListener)
boolean	updateCachedDatabaseConfiguration(String iDatabaseName, OModifiableDistributedConfiguration cfg)
void	updateLastClusterChange()
void	waitUntilNodeOnline()
void	waitUntilNodeOnline(String nodeName, String databaseName)

Field Details

FILE_DISTRIBUTED_DB_CONFIG

static final String FILE_DISTRIBUTED_DB_CONFIG

See Also:

• Constant Field Values

Method Details

isNodeStatusEqualsTo

boolean isNodeStatusEqualsTo(String iNodeName,
 String iDatabaseName,
 ODistributedServerManager.DB_STATUS... statuses)

Checks the node status if it's one of the statuses received as argument.

Parameters:

iNodeName - Node name

iDatabaseName - Database name

statuses - vararg of statuses

Returns:

true if the node's status is equals to one of the passed statuses, otherwise false

isNodeAvailable

boolean isNodeAvailable(String iNodeName)

getAvailableNodeNames

Set<String> getAvailableNodeNames(String databaseName)

getCoordinatorServer

@Deprecated
String getCoordinatorServer()

Deprecated.

waitUntilNodeOnline

void waitUntilNodeOnline()
                  throws InterruptedException

Throws:

InterruptedException

waitUntilNodeOnline

void waitUntilNodeOnline(String nodeName,
 String databaseName)
                  throws InterruptedException

Throws:

InterruptedException

getServerInstance

OServer getServerInstance()

isEnabled

boolean isEnabled()

registerLifecycleListener

ODistributedServerManager registerLifecycleListener(ODistributedLifecycleListener iListener)

unregisterLifecycleListener

ODistributedServerManager unregisterLifecycleListener(ODistributedLifecycleListener iListener)

executeOnLocalNode

Object executeOnLocalNode(ODistributedRequestId reqId,
 ORemoteTask task,
 ODatabaseDocumentInternal database)

executeOnLocalNodeFromRemote

void executeOnLocalNodeFromRemote(ODistributedRequest request)

getRemoteServer

ORemoteServerController getRemoteServer(String nodeName)
                                 throws IOException

Throws:

IOException

getLastClusterChangeOn

long getLastClusterChangeOn()

getNodeStatus

ODistributedServerManager.NODE_STATUS getNodeStatus()

setNodeStatus

void setNodeStatus(ODistributedServerManager.NODE_STATUS iStatus)

checkNodeStatus

boolean checkNodeStatus(ODistributedServerManager.NODE_STATUS status)

removeServer

void removeServer(String nodeLeftName,
 boolean removeOnlyDynamicServers)

getDatabaseStatus

ODistributedServerManager.DB_STATUS getDatabaseStatus(String iNode,
 String iDatabaseName)

setDatabaseStatus

void setDatabaseStatus(String iNode,
 String iDatabaseName,
 ODistributedServerManager.DB_STATUS iStatus)

getNodesWithStatus

int getNodesWithStatus(Collection<String> iNodes,
 String databaseName,
 ODistributedServerManager.DB_STATUS... statuses)

getMessageService

ODistributedMessageService getMessageService()

getDatabase

ODistributedDatabase getDatabase(String name)

getDistributedStrategy

ODistributedStrategy getDistributedStrategy()

setDistributedStrategy

void setDistributedStrategy(ODistributedStrategy streatgy)

updateCachedDatabaseConfiguration

boolean updateCachedDatabaseConfiguration(String iDatabaseName,
 OModifiableDistributedConfiguration cfg)

publishDistributedConfiguration

void publishDistributedConfiguration(String iDatabaseName,
 ODistributedConfiguration cfg)

getNextMessageIdCounter

long getNextMessageIdCounter()

getNodeUuidByName

String getNodeUuidByName(String name)

updateLastClusterChange

void updateLastClusterChange()

reassignClustersOwnership

void reassignClustersOwnership(String iNode,
 String databaseName,
 OModifiableDistributedConfiguration cfg,
 boolean canCreateNewClusters)

isNodeAvailable

boolean isNodeAvailable(String iNodeName,
 String databaseName)

Available means not OFFLINE, so ONLINE or SYNCHRONIZING.

isNodeOnline

boolean isNodeOnline(String iNodeName,
 String databaseName)

Returns true if the node status is ONLINE.

getTotalNodes

int getTotalNodes(String iDatabaseName)

getAvailableNodes

int getAvailableNodes(String iDatabaseName)

getAvailableNodes

int getAvailableNodes(Collection<String> iNodes,
 String databaseName)

isOffline

boolean isOffline()

getLocalNodeId

int getLocalNodeId()

getLocalNodeName

String getLocalNodeName()

getClusterConfiguration

ODocument getClusterConfiguration()

getNodeNameById

String getNodeNameById(int id)

getNodeIdByName

int getNodeIdByName(String node)

getNodeConfigurationByUuid

ODocument getNodeConfigurationByUuid(String iNode,
 boolean useCache)

getLocalNodeConfiguration

ODocument getLocalNodeConfiguration()

getDatabaseConfiguration

ODistributedConfiguration getDatabaseConfiguration(String iDatabaseName)

sendRequest

ODistributedResponse sendRequest(String iDatabaseName,
 Collection<String> iClusterNames,
 Collection<String> iTargetNodeNames,
 ORemoteTask iTask,
 long messageId,
 ODistributedRequest.EXECUTION_MODE iExecutionMode,
 Object localResult)

Sends a distributed request against multiple servers.

Parameters:

iDatabaseName -

iClusterNames -

iTargetNodeNames -

iTask -

messageId - Message Id as long

iExecutionMode -

localResult - It's the result of the request executed locally

Returns:

sendRequest

ODistributedResponse sendRequest(String iDatabaseName,
 Collection<String> iClusterNames,
 Collection<String> iTargetNodeNames,
 ORemoteTask iTask,
 long messageId,
 ODistributedRequest.EXECUTION_MODE iExecutionMode,
 Object localResult,
 ODistributedResponseManagerFactory responseManagerFactory)

getStats

ODocument getStats()

convertException

Throwable convertException(Throwable original)

getOnlineNodes

List<String> getOnlineNodes(String iDatabaseName)

installDatabase

boolean installDatabase(boolean iStartup,
 String databaseName,
 boolean forceDeployment,
 boolean tryWithDeltaFirst)

getTaskFactoryManager

ORemoteTaskFactoryManager getTaskFactoryManager()

Returns the task factory manager. During first connect the minor version of the protocol is used.

getActiveServers

Set<String> getActiveServers()

getClusterTime

long getClusterTime()

Returns the cluster-wide time in milliseconds.

Cluster tries to keep a cluster-wide time which might be different than the member's own system time. Cluster-wide time is -almost- the same on all members of the cluster.

getDefaultDatabaseConfigFile

File getDefaultDatabaseConfigFile()

getLockManagerRequester

ODistributedLockManager getLockManagerRequester()

getLockManagerExecutor

ODistributedLockManager getLockManagerExecutor()

executeInDistributedDatabaseLock

<T> T executeInDistributedDatabaseLock(String databaseName,
 long timeoutLocking,
 OModifiableDistributedConfiguration lastCfg,
 OCallable<T,OModifiableDistributedConfiguration> iCallback)

Executes an operation protected by a distributed lock (one per database).

Type Parameters:

T - Return type

Parameters:

databaseName - Database name

timeoutLocking -

iCallback - Operation @return The operation's result of type T

isWriteQuorumPresent

boolean isWriteQuorumPresent(String databaseName)

Returns true if the quorum is present in terms of number of available nodes for full replication only. With sharding, instead, the quorum may depend on the involved clusters.

Returns:

notifyClients

void notifyClients(String databaseName)

messageReceived

default void messageReceived(ODistributedRequest request)

messagePartitionCalculate

default void messagePartitionCalculate(ODistributedRequest request,
 Set<Integer> involvedWorkerQueues)

messageBeforeOp

default void messageBeforeOp(String op,
 ODistributedRequestId requestId)

messageAfterOp

default void messageAfterOp(String op,
 ODistributedRequestId requestId)

messageCurrentPayload

default void messageCurrentPayload(ODistributedRequestId requestId,
 Object responsePayload)

messageProcessStart

default void messageProcessStart(ODistributedRequest message)

messageProcessEnd

default void messageProcessEnd(ODistributedRequest iRequest,
 Object responsePayload)

getOnlineDatabaseConfiguration

ODocument getOnlineDatabaseConfiguration(String databaseName)

getDatabases

Set<String> getDatabases()

isSyncronizing

boolean isSyncronizing(String databaseName)