com.orientechnologies.orient.client.remote

Class OServerAdmin

java.lang.Object

com.orientechnologies.orient.client.remote.OServerAdmin

public class OServerAdmin
extends Object

Remote administration class of OrientDB Server instances.

Constructor Summary

Constructors

Constructor and Description
OServerAdmin(OStorageRemote iStorage) Creates the object starting from an existent remote storage.
OServerAdmin(String iURL) Creates the object passing a remote URL to connect.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close the connection if open.
void	close(boolean iForce)
com.orientechnologies.orient.core.record.impl.ODocument	clusterAddNode(String iRemoteNode) Adds a node in the cluster.
com.orientechnologies.orient.core.record.impl.ODocument	clusterRemoveNode(String iRemoteNode) Removes a node from the cluster.
com.orientechnologies.orient.core.record.impl.ODocument	clusterStatus() Gets the cluster status.
OServerAdmin	connect(String iUserName, String iUserPassword) Connects to a remote server.
OServerAdmin	copyDatabase(String iDatabaseName, String iDatabaseUserName, String iDatabaseUserPassword, String iRemoteName, String iRemoteEngine) Copies a database to a remote server instance.
OServerAdmin	createDatabase(String iStorageMode) Deprecated.
OServerAdmin	createDatabase(String iDatabaseType, String iStorageMode) Creates a database in a remote server.
OServerAdmin	deleteDatabase() Deprecated.
OServerAdmin	dropDatabase() Drops a database from a remote server instance.
boolean	existsDatabase() Checks if a database exists in the remote server.
String	getGlobalConfiguration(com.orientechnologies.orient.core.config.OGlobalConfiguration iConfig)
Map<String,String>	getGlobalConfigurations()
com.orientechnologies.orient.core.record.impl.ODocument	getReplicationConflicts(String iDatabaseName) Gets the replication conflicts for a database.
com.orientechnologies.orient.core.record.impl.ODocument	getReplicationJournal(String iDatabaseName, String iRemoteServer) Gets the replication journal for a database.
int	getSessionId()
String	getURL()
Map<String,String>	listDatabases() List the databases on a remote server.
OServerAdmin	replicationAlign(String iDatabaseName, String iRemoteServer, String iOptions) Aligns a database between two servers
OServerAdmin	replicationStart(String iDatabaseName, String iRemoteServer) Starts the replication between two servers.
OServerAdmin	replicationStop(String iDatabaseName, String iRemoteServer) Stops the replication between two servers.
com.orientechnologies.orient.core.record.impl.ODocument	resetReplicationJournal(String iDatabaseName, String iRemoteServer) Resets the replication Journal for a database.
protected com.orientechnologies.orient.core.record.impl.ODocument	sendRequest(byte iRequest, com.orientechnologies.orient.core.record.impl.ODocument iPayLoad, String iActivity)
OServerAdmin	setGlobalConfiguration(com.orientechnologies.orient.core.config.OGlobalConfiguration iConfig, Object iValue)

Methods inherited from class java.lang.Object

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

Constructor Detail

OServerAdmin

public OServerAdmin(String iURL)
             throws IOException

Creates the object passing a remote URL to connect.

Parameters:

iURL - URL to connect. It supports only the "remote" storage type.

Throws:

IOException

OServerAdmin

public OServerAdmin(OStorageRemote iStorage)

Creates the object starting from an existent remote storage.

Parameters:

iStorage -

Method Detail

connect

public OServerAdmin connect(String iUserName,
                   String iUserPassword)
                     throws IOException

Connects to a remote server.

Parameters:

iUserName - Server's user name

iUserPassword - Server's password for the user name used

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

listDatabases

public Map<String,String> listDatabases()
                                 throws IOException

List the databases on a remote server.

Parameters:

iUserName - Server's user name

iUserPassword - Server's password for the user name used

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

getSessionId

public int getSessionId()

createDatabase

@Deprecated
public OServerAdmin createDatabase(String iStorageMode)
                            throws IOException

Deprecated.

Deprecated. Use the createDatabase(String, String) instead.

Throws:

IOException

createDatabase

public OServerAdmin createDatabase(String iDatabaseType,
                          String iStorageMode)
                            throws IOException

Creates a database in a remote server.

Parameters:

iDatabaseType - 'document' or 'graph'

iStorageMode - local or memory

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

existsDatabase

public boolean existsDatabase()
                       throws IOException

Checks if a database exists in the remote server.

Returns:

true if exists, otherwise false

Throws:

IOException

deleteDatabase

@Deprecated
public OServerAdmin deleteDatabase()
                            throws IOException

Deprecated.

Deprecated. Use dropDatabase() instead.

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

See Also:

dropDatabase()

dropDatabase

public OServerAdmin dropDatabase()
                          throws IOException

Drops a database from a remote server instance.

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

clusterStatus

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

Gets the cluster status.

Returns:

the JSON containing the current cluster structure

clusterAddNode

public com.orientechnologies.orient.core.record.impl.ODocument clusterAddNode(String iRemoteNode)

Adds a node in the cluster.

Returns:

The current cluster status.

clusterRemoveNode

public com.orientechnologies.orient.core.record.impl.ODocument clusterRemoveNode(String iRemoteNode)

Removes a node from the cluster.

Returns:

The current cluster status.

replicationStart

public OServerAdmin replicationStart(String iDatabaseName,
                            String iRemoteServer)
                              throws IOException

Starts the replication between two servers.

Parameters:

iDatabaseName - database name to replicate

iRemoteServer - remote server alias as IP+address

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

replicationStop

public OServerAdmin replicationStop(String iDatabaseName,
                           String iRemoteServer)
                             throws IOException

Stops the replication between two servers.

Parameters:

iDatabaseName - database name to replicate

iRemoteServer - remote server alias as IP+address

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

getReplicationJournal

public com.orientechnologies.orient.core.record.impl.ODocument getReplicationJournal(String iDatabaseName,
                                                                            String iRemoteServer)
                                                                              throws IOException

Gets the replication journal for a database.

Parameters:

iDatabaseName - database name to replicate

iRemoteName -

Returns:

The journal composed as a JSON with key the serial number of the entry and as key the operation type id and the RID involved. Example {"10022":"1#10:3"}

Throws:

IOException

resetReplicationJournal

public com.orientechnologies.orient.core.record.impl.ODocument resetReplicationJournal(String iDatabaseName,
                                                                              String iRemoteServer)
                                                                                throws IOException

Resets the replication Journal for a database.

Parameters:

iDatabaseName - database name to replicate

iRemoteName -

Returns:

A JSON containing in the field "removedEntries" the removed log entries. Example {"removedEntries":342}

Throws:

IOException

getReplicationConflicts

public com.orientechnologies.orient.core.record.impl.ODocument getReplicationConflicts(String iDatabaseName)
                                                                                throws IOException

Gets the replication conflicts for a database.

Parameters:

iDatabaseName - database name to replicate

iRemoteName -

Returns:

The records in conflict as a JSON with key the serial number of the entry and as key the operation type id and the RID involved. Example {"10022":"1#10:3"}

Throws:

IOException

replicationAlign

public OServerAdmin replicationAlign(String iDatabaseName,
                            String iRemoteServer,
                            String iOptions)

Aligns a database between two servers

Parameters:

iDatabaseName - database name to align

iRemoteServer - remote server alias as IP+address

iOptions - options

Returns:

Throws:

IOException

copyDatabase

public OServerAdmin copyDatabase(String iDatabaseName,
                        String iDatabaseUserName,
                        String iDatabaseUserPassword,
                        String iRemoteName,
                        String iRemoteEngine)
                          throws IOException

Copies a database to a remote server instance.

Parameters:

iDatabaseName -

iDatabaseUserName -

iDatabaseUserPassword -

iRemoteName -

iRemoteEngine -

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

getGlobalConfigurations

public Map<String,String> getGlobalConfigurations()
                                           throws IOException

Throws:

IOException

getGlobalConfiguration

public String getGlobalConfiguration(com.orientechnologies.orient.core.config.OGlobalConfiguration iConfig)
                              throws IOException

Throws:

IOException

setGlobalConfiguration

public OServerAdmin setGlobalConfiguration(com.orientechnologies.orient.core.config.OGlobalConfiguration iConfig,
                                  Object iValue)
                                    throws IOException

Throws:

IOException

close

public void close()

Close the connection if open.

close

public void close(boolean iForce)

getURL

public String getURL()

sendRequest

protected com.orientechnologies.orient.core.record.impl.ODocument sendRequest(byte iRequest,
                                                                  com.orientechnologies.orient.core.record.impl.ODocument iPayLoad,
                                                                  String iActivity)