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.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	clientType
protected boolean	collectStats
protected OStorageRemoteSession	session
protected OStorageRemote	storage

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

Modifier and Type	Method and Description
void	close() Close the connection if open.
void	close(boolean iForce)
ODocument	clusterStatus() Gets the cluster status.
OServerAdmin	connect(String iUserName, String iUserPassword) Connects to a remote server.
OServerAdmin	copyDatabase(String databaseName, String iDatabaseUserName, String iDatabaseUserPassword, String iRemoteName, String iRemoteEngine) Deprecated.
OServerAdmin	createDatabase(String iStorageMode) Deprecated.
OServerAdmin	createDatabase(String iDatabaseType, String iStorageMode) Creates a database in a remote server.
OServerAdmin	createDatabase(String iDatabaseName, String iDatabaseType, String iStorageMode)
OServerAdmin	createDatabase(String iDatabaseName, String iDatabaseType, String iStorageMode, String backupPath) Creates a database in a remote server.
OServerAdmin	deleteDatabase(String storageType) Deprecated.
OServerAdmin	dropDatabase(String storageType) Drops a database from a remote server instance.
OServerAdmin	dropDatabase(String iDatabaseName, String storageType) Drops a database from a remote server instance.
boolean	existsDatabase() Checks if a database exists in the remote server.
boolean	existsDatabase(String storageType) Checks if a database exists in the remote server.
boolean	existsDatabase(String iDatabaseName, String storageType) Checks if a database exists in the remote server.
OServerAdmin	freezeCluster(int clusterId, String storageType) Freezes a cluster by locking it in exclusive mode.
OServerAdmin	freezeDatabase(String storageType) Freezes the database by locking it in exclusive mode.
String	getGlobalConfiguration(OGlobalConfiguration config)
Map<String,String>	getGlobalConfigurations()
ODocument	getServerInfo() Returns the server information in form of document.
int	getSessionId()
String	getStorageName()
String	getURL()
boolean	isConnected()
Map<String,String>	listDatabases() Returns the list of databases on the connected remote server.
protected <T> T	networkAdminOperation(OStorageRemoteOperation<T> operation, String errorMessage)
OServerAdmin	releaseCluster(int clusterId, String storageType) Releases a frozen cluster.
OServerAdmin	releaseDatabase(String storageType) Releases a frozen database.
protected ODocument	sendRequest(byte iRequest, ODocument iPayLoad, String iActivity)
OServerAdmin	setGlobalConfiguration(OGlobalConfiguration config, Object iValue)

Methods inherited from class java.lang.Object

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

Field Detail

storage

protected OStorageRemote storage

session

protected OStorageRemoteSession session

clientType

protected String clientType

collectStats

protected boolean collectStats

Constructor Detail

OServerAdmin

public OServerAdmin(String iURL)
             throws IOException

Creates the object passing a remote URL to connect. sessionToken

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.

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

Returns the list of databases on the connected remote server.

Throws:

IOException

getServerInfo

public ODocument getServerInfo()
                        throws IOException

Returns the server information in form of document.

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

getStorageName

public String getStorageName()

createDatabase

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

Throws:

IOException

createDatabase

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

Creates a database in a remote server.

Parameters:

iDatabaseName - The database name

iDatabaseType - 'document' or 'graph'

iStorageMode - local or memory

backupPath - path to incremental backup which will be used to create database (optional)

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

existsDatabase

public boolean existsDatabase(String iDatabaseName,
                              String storageType)
                       throws IOException

Checks if a database exists in the remote server.

Parameters:

iDatabaseName - The database name

storageType - Storage type between "plocal" or "memory".

Returns:

true if exists, otherwise false

Throws:

IOException

existsDatabase

public boolean existsDatabase(String storageType)
                       throws IOException

Checks if a database exists in the remote server.

Parameters:

storageType - Storage type between "plocal" or "memory".

Returns:

true if exists, otherwise false

Throws:

IOException

deleteDatabase

@Deprecated
public OServerAdmin deleteDatabase(String storageType)
                                        throws IOException

Deprecated.

Deprecated. Use dropDatabase() instead.

Parameters:

storageType - Storage type between "plocal" or "memory".

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

See Also:

dropDatabase(String)

dropDatabase

public OServerAdmin dropDatabase(String iDatabaseName,
                                 String storageType)
                          throws IOException

Drops a database from a remote server instance.

Parameters:

iDatabaseName - The database name

storageType - Storage type between "plocal" or "memory".

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

dropDatabase

public OServerAdmin dropDatabase(String storageType)
                          throws IOException

Drops a database from a remote server instance.

Parameters:

storageType - Storage type between "plocal" or "memory".

Returns:

The instance itself. Useful to execute method in chain

Throws:

IOException

freezeDatabase

public OServerAdmin freezeDatabase(String storageType)
                            throws IOException

Freezes the database by locking it in exclusive mode.

Parameters:

storageType - Storage type between "plocal" or "memory".

Throws:

IOException

See Also:

releaseDatabase(String)

releaseDatabase

public OServerAdmin releaseDatabase(String storageType)
                             throws IOException

Releases a frozen database.

Parameters:

storageType - Storage type between "plocal" or "memory".

Throws:

IOException

See Also:

freezeDatabase(String)

freezeCluster

public OServerAdmin freezeCluster(int clusterId,
                                  String storageType)
                           throws IOException

Freezes a cluster by locking it in exclusive mode.

Parameters:

clusterId - Id of cluster to freeze

storageType - Storage type between "plocal" or "memory".

Throws:

IOException

See Also:

releaseCluster(int, String)

releaseCluster

public OServerAdmin releaseCluster(int clusterId,
                                   String storageType)
                            throws IOException

Releases a frozen cluster.

Parameters:

clusterId - Id of cluster to freeze

storageType - Storage type between "plocal" or "memory".

Throws:

IOException

See Also:

freezeCluster(int, String)

clusterStatus

public ODocument clusterStatus()

Gets the cluster status.

Returns:

the JSON containing the current cluster structure

copyDatabase

@Deprecated
public OServerAdmin copyDatabase(String databaseName,
                                             String iDatabaseUserName,
                                             String iDatabaseUserPassword,
                                             String iRemoteName,
                                             String iRemoteEngine)
                                      throws IOException

Deprecated.

This method is not supported anymore.

Throws:

IOException

getGlobalConfigurations

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

Throws:

IOException

getGlobalConfiguration

public String getGlobalConfiguration(OGlobalConfiguration config)
                              throws IOException

Throws:

IOException

setGlobalConfiguration

public OServerAdmin setGlobalConfiguration(OGlobalConfiguration config,
                                           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()

isConnected

public boolean isConnected()

sendRequest

protected ODocument sendRequest(byte iRequest,
                                ODocument iPayLoad,
                                String iActivity)

networkAdminOperation

protected <T> T networkAdminOperation(OStorageRemoteOperation<T> operation,
                                      String errorMessage)