OStorageRemote (OrientDB 3.1.2-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.orient.core.storage.OStorageAbstract
- - com.orientechnologies.orient.client.remote.OStorageRemote

All Implemented Interfaces:

OSharedContainer, ORemotePushHandler, OStorage, OStorageInfo, OStorageProxy, OBackupable
```
public class OStorageRemote
extends OStorageAbstract
implements OStorageProxy, ORemotePushHandler
```
This object is bound to each remote ODatabase instances.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class OStorageRemote.CONNECTION_STRATEGY
- Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.storage.OStorage
  OStorage.LOCKING_STRATEGY, OStorage.STATUS

Nested Classes
Modifier and Type	Class and Description
`static class`	`OStorageRemote.CONNECTION_STRATEGY`

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ADDRESS_SEPARATOR`
`ORemoteConnectionManager`	`connectionManager`
`static String`	`DRIVER_NAME`
`static String`	`PARAM_CONNECTION_STRATEGY` Deprecated.

Fields inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract
componentsFactory, configuration, mode, name, sharedContainer, stateLock, status, storageThreadGroup, url

Fields inherited from interface com.orientechnologies.orient.core.storage.OStorage
CLUSTER_DEFAULT_NAME

Constructor Summary

Constructors
Constructor and Description
`OStorageRemote(String iURL, OrientDBRemote context, String iMode, ORemoteConnectionManager connectionManager, OrientDBConfig config)`
`OStorageRemote(String iURL, OrientDBRemote context, String iMode, ORemoteConnectionManager connectionManager, OStorage.STATUS status, OrientDBConfig config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`addCluster(String iClusterName, int iRequestedId)` Add a new cluster into the storage.
`int`	`addCluster(String iClusterName, Object... iArguments)` Add a new cluster into the storage.
`protected String`	`addHost(String host)` Registers the remote server with port.
`void`	`addNewClusterToConfiguration(int clusterId, String iClusterName)`
`int`	`addUser()`
`<T extends OBinaryResponse> T`	`asyncNetworkOperationNoRetry(OBinaryAsyncRequest<T> request, int mode, ORecordId recordId, ORecordCallback<T> callback, String errorMessage)`
`<T extends OBinaryResponse> T`	`asyncNetworkOperationRetry(OBinaryAsyncRequest<T> request, int mode, ORecordId recordId, ORecordCallback<T> callback, String errorMessage, int retry)`
`List<String>`	`backup(OutputStream out, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener, int compressionLevel, int bufferSize)` Executes a backup of the database.
`<T> T`	`baseNetworkOperation(OStorageRemoteOperation<T> operation, String errorMessage, int retry)`
`OChannelBinaryAsynchClient`	`beginRequest(OChannelBinaryAsynchClient network, byte iCommand, OStorageRemoteSession session)` Acquire a network channel from the pool.
`void`	`beginResponse(OChannelBinaryAsynchClient iNetwork, OStorageRemoteSession session)`
`void`	`beginTransaction(ODatabaseDocumentRemote database, OTransactionOptimistic transaction)`
`OPhysicalPosition[]`	`ceilingPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)`
`boolean`	`cleanOutRecord(ORecordId recordId, int recordVersion, int iMode, ORecordCallback<Boolean> callback)`
`void`	`clearProperties()`
`void`	`close(boolean iForce, boolean onDelete)`
`void`	`closeQuery(ODatabaseDocumentRemote database, String queryId)`
`Object`	`command(OCommandRequestText iCommand)` Execute the command remotely and get the results back.
`ORemoteQueryResult`	`command(ODatabaseDocumentRemote db, String query, Map args)`
`ORemoteQueryResult`	`command(ODatabaseDocumentRemote db, String query, Object[] args)`
`List<ORecordOperation>`	`commit(OTransactionInternal iTx)`
`OStorageRemote`	`copy(ODatabaseDocumentRemote source, ODatabaseDocumentRemote dest)`
`long`	`count(int iClusterId)`
`long`	`count(int[] iClusterIds)`
`long`	`count(int[] iClusterIds, boolean countTombstones)`
`long`	`count(int iClusterId, boolean countTombstones)`
`long`	`countRecords()` Returns the total number of records.
`void`	`create(OContextConfiguration contextConfiguration)`
`OBinaryPushRequest`	`createPush(byte type)`
`OStorageOperationResult<OPhysicalPosition>`	`createRecord(ORecordId iRid, byte[] iContent, int iRecordVersion, byte iRecordType, int iMode, ORecordCallback<Long> iCallback)`
`void`	`delete()`
`OStorageOperationResult<Boolean>`	`deleteRecord(ORecordId iRid, int iVersion, int iMode, ORecordCallback<Boolean> iCallback)`
`boolean`	`dropCluster(int iClusterId)` Drops a cluster.
`void`	`endRequest(OChannelBinaryAsynchClient iNetwork)` Ends the request and unlock the write lock
`void`	`endResponse(OChannelBinaryAsynchClient iNetwork)` End response reached: release the channel in the pool to being reused
`ORemoteQueryResult`	`execute(ODatabaseDocumentRemote db, String language, String query, Map args)`
`ORemoteQueryResult`	`execute(ODatabaseDocumentRemote db, String language, String query, Object[] args)`
`void`	`executeLiveQueryPush(OLiveQueryPushRequest pushRequest)`
`OBinaryPushResponse`	`executeUpdateDistributedConfig(OPushDistributedConfigurationRequest request)`
`OBinaryPushResponse`	`executeUpdateFunction(OPushFunctionsRequest request)`
`OBinaryPushResponse`	`executeUpdateIndexManager(OPushIndexManagerRequest request)`
`OBinaryPushResponse`	`executeUpdateSchema(OPushSchemaRequest request)`
`OBinaryPushResponse`	`executeUpdateSequences(OPushSequencesRequest request)`
`OBinaryPushResponse`	`executeUpdateStorageConfig(OPushStorageConfigurationRequest payload)`
`boolean`	`exists()`
`void`	`fetchNextPage(ODatabaseDocumentRemote database, ORemoteResultSet rs)`
`void`	`fetchTransaction(ODatabaseDocumentRemote remote)`
`OPhysicalPosition[]`	`floorPhysicalPositions(int clusterId, OPhysicalPosition physicalPosition)`
`void`	`fullIncrementalBackup(OutputStream stream)`
`OContextConfiguration`	`getClientConfiguration()`
`ODocument`	`getClusterConfiguration()`
`long[]`	`getClusterDataRange(int iClusterId)` Returns a pair of long values telling the begin and end positions of data in the requested cluster.
`String`	`getClusterEncryption(int clusterId)`
`int`	`getClusterIdByName(String iClusterName)`
`Collection<OCluster>`	`getClusterInstances()`
`int`	`getClusterMap()`
`String`	`getClusterName(int clusterId)`
`String`	`getClusterNameById(int clusterId)`
`Set<String>`	`getClusterNames()`
`long`	`getClusterNextPosition(int clusterId)`
`String`	`getClusterRecordConflictStrategy(int clusterId)`
`long`	`getClusterRecordsSizeById(int clusterId)`
`long`	`getClusterRecordsSizeByName(String clusterName)`
`int`	`getClusters()`
`String`	`getCreatedAtVersion()` Supported only in embedded storage.
`protected String`	`getCurrentServerURL()`
`protected OStorageRemoteSession`	`getCurrentSession()`
`int`	`getDefaultClusterId()`
`protected int`	`getDefaultPort()`
`protected int`	`getDefaultSSLPort()`
`long`	`getLastClusterPosition(int clusterId)`
`OChannelBinaryAsynchClient`	`getNetwork(String iCurrentURL)`
`protected String`	`getNextAvailableServerURL(boolean iIsConnectOperation, OStorageRemoteSession session)`
`String`	`getNextConnectUrl(OStorageRemoteSession session)`
`String`	`getPhysicalClusterNameById(int iClusterId)`
`ORecordConflictStrategy`	`getRecordConflictStrategy()`
`ORecordMetadata`	`getRecordMetadata(ORID rid)`
`OPaginatedCluster.RECORD_STATUS`	`getRecordStatus(ORID rid)`
`OSBTreeCollectionManager`	`getSBtreeCollectionManager()`
`protected String`	`getServerURFromList(boolean iNextAvailable, OStorageRemoteSession session)`
`String`	`getServerURL()`
`List<String>`	`getServerURLs()`
`int`	`getSessionId()`
`long`	`getSize()` Returns the size of the database.
`String`	`getType()` Returns the storage's type.
`String`	`getURL()`
`String`	`getUserName()`
`int`	`getUsers()`
`long`	`getVersion()` Returns current storage's version as serial.
`OPhysicalPosition[]`	`higherPhysicalPositions(int iClusterId, OPhysicalPosition iClusterPosition)`
`void`	`importDatabase(String options, InputStream inputStream, String name, OCommandOutputListener listener)`
`String`	`incrementalBackup(String backupDirectory, OCallable<Void,Void> started)`
`boolean`	`isAssigningClusterIds()`
`boolean`	`isClosed()`
`boolean`	`isPermanentRequester()`
`boolean`	`isRemote()`
`boolean`	`isSystemCluster(int clusterId)`
`OLiveQueryMonitor`	`liveQuery(ODatabaseDocumentRemote database, String query, OLiveQueryClientListener listener, Map<String,?> params)`
`OLiveQueryMonitor`	`liveQuery(ODatabaseDocumentRemote database, String query, OLiveQueryClientListener listener, Object[] params)`
`OLockRecordResponse`	`lockRecord(OIdentifiable iRecord, OStorage.LOCKING_STRATEGY lockingStrategy, long timeout)`
`OPhysicalPosition[]`	`lowerPhysicalPositions(int iClusterId, OPhysicalPosition physicalPosition)`
`<T extends OBinaryResponse> T`	`networkOperation(OBinaryRequest<T> request, String errorMessage)`
`<T extends OBinaryResponse> T`	`networkOperationNoRetry(OBinaryRequest<T> request, String errorMessage)`
`<T extends OBinaryResponse> T`	`networkOperationRetryTimeout(OBinaryRequest<T> request, String errorMessage, int retry, int timeout)`
`void`	`onPushDisconnect(OChannelBinary network, Exception e)`
`void`	`onPushReconnect(String host)`
`void`	`open(String iUserName, String iUserPassword, OContextConfiguration conf)`
`protected void`	`openRemoteDatabase()`
`void`	`openRemoteDatabase(OChannelBinaryAsynchClient network)`
`protected void`	`openRemoteDatabase(String currentURL)`
`static HashMap<String,Object>`	`paramsArrayToParamsMap(Object[] positionalParams)`
`List<String>`	`parseAddressesFromUrl(String url)`
`protected void`	`parseServerURLs()` Parse the URLs.
`ORemoteQueryResult`	`query(ODatabaseDocumentRemote db, String query, Map args)`
`ORemoteQueryResult`	`query(ODatabaseDocumentRemote db, String query, Object[] args)`
`OStorageOperationResult<ORawBuffer>`	`readRecord(ORecordId iRid, String iFetchPlan, boolean iIgnoreCache, boolean prefetchRecords, ORecordCallback<ORawBuffer> iCallback)`
`OStorageOperationResult<ORawBuffer>`	`readRecordIfVersionIsNotLatest(ORecordId rid, String fetchPlan, boolean ignoreCache, int recordVersion)`
`void`	`reBeginTransaction(ODatabaseDocumentRemote database, OTransactionOptimistic transaction)`
`void`	`registerLiveListener(int monitorId, OLiveQueryClientListener listener)`
`void`	`reload()`
`void`	`removeClusterFromConfiguration(int iClusterId)`
`void`	`removeProperty(String property)`
`void`	`removeSessions(String url)`
`int`	`removeUser()`
`protected String`	`reopenRemoteDatabase()`
`void`	`restore(InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener)` Executes a restore of a database backup.
`void`	`restoreFromIncrementalBackup(String filePath)`
`void`	`restoreFullIncrementalBackup(InputStream stream)`
`void`	`returnSocket(OChannelBinary network)`
`void`	`rollback(OTransactionInternal iTx)`
`void`	`setCharset(String charset)`
`boolean`	`setClusterAttribute(int id, OCluster.ATTRIBUTES attribute, Object value)`
`boolean`	`setClusterAttribute(String clusterName, OCluster.ATTRIBUTES attribute, Object value)`
`void`	`setClusterSelection(String clusterSelection)`
`void`	`setConflictStrategy(ORecordConflictStrategy iResolver)`
`void`	`setDateFormat(String dateFormat)`
`void`	`setDateTimeFormat(String dateTimeFormat)`
`void`	`setDefaultClusterId(int defaultClusterId)`
`void`	`setIndexMgrRecordId(String indexMgrRecordId)`
`void`	`setLocaleCountry(String localeCountry)`
`void`	`setLocaleLanguage(String locale)`
`void`	`setMinimumClusters(int minimumClusters)`
`void`	`setProperty(String property, String value)`
`void`	`setRecordSerializer(String recordSerializer, int version)`
`void`	`setSchemaRecordId(String schemaRecordId)`
`void`	`setTimeZone(TimeZone timeZoneValue)`
`void`	`setValidation(boolean validation)`
`void`	`shutdown()` This method is called in `Orient.shutdown()` method.
`void`	`stickToSession()`
`boolean`	`supportIncremental()`
`void`	`synch()`
`void`	`unlockRecord(OIdentifiable iRecord)`
`void`	`unstickToSession()`
`void`	`unsubscribeLive(ODatabaseDocumentRemote database, int monitorId)`
`void`	`updateDistributedNodes(List<String> hosts)`
`OStorageOperationResult<Integer>`	`updateRecord(ORecordId iRid, boolean updateContent, byte[] iContent, int iVersion, byte iRecordType, int iMode, ORecordCallback<Integer> iCallback)`
`void`	`updateStorageConfiguration(OStorageConfiguration storageConfiguration)`
`protected String`	`useNewServerURL(String iUrl)`

Methods inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract
checkForRecordValidity, close, dropCluster, existsResource, getComponentsFactory, getConfiguration, getName, getResource, getStatus, getUnderlying, isDistributed, normalizeName, removeResource, toString

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

Methods inherited from interface com.orientechnologies.orient.core.storage.OStorage
checkForRecordValidity, close, dropCluster, getComponentsFactory, getName, getStatus, getUnderlying, isDistributed

Methods inherited from interface com.orientechnologies.common.concur.resource.OSharedContainer
existsResource, getResource, removeResource

Methods inherited from interface com.orientechnologies.orient.core.storage.OStorageInfo
getConfiguration

Field Detail

PARAM_CONNECTION_STRATEGY

@Deprecated
public static final String PARAM_CONNECTION_STRATEGY

Deprecated.

See Also:: Constant Field Values

ADDRESS_SEPARATOR

public static final String ADDRESS_SEPARATOR

See Also:: Constant Field Values

DRIVER_NAME
```
public static final String DRIVER_NAME
```
See Also:

Constant Field Values

connectionManager

public ORemoteConnectionManager connectionManager

Constructor Detail

OStorageRemote

public OStorageRemote(String iURL,
                      OrientDBRemote context,
                      String iMode,
                      ORemoteConnectionManager connectionManager,
                      OrientDBConfig config)
               throws IOException

Throws:: IOException

OStorageRemote

public OStorageRemote(String iURL,
                      OrientDBRemote context,
                      String iMode,
                      ORemoteConnectionManager connectionManager,
                      OStorage.STATUS status,
                      OrientDBConfig config)
               throws IOException

Throws:: IOException

Method Detail

asyncNetworkOperationNoRetry

public <T extends OBinaryResponse> T asyncNetworkOperationNoRetry(OBinaryAsyncRequest<T> request,
                                                                  int mode,
                                                                  ORecordId recordId,
                                                                  ORecordCallback<T> callback,
                                                                  String errorMessage)

asyncNetworkOperationRetry

public <T extends OBinaryResponse> T asyncNetworkOperationRetry(OBinaryAsyncRequest<T> request,
                                                                int mode,
                                                                ORecordId recordId,
                                                                ORecordCallback<T> callback,
                                                                String errorMessage,
                                                                int retry)

networkOperationRetryTimeout

public <T extends OBinaryResponse> T networkOperationRetryTimeout(OBinaryRequest<T> request,
                                                                  String errorMessage,
                                                                  int retry,
                                                                  int timeout)

networkOperationNoRetry

public <T extends OBinaryResponse> T networkOperationNoRetry(OBinaryRequest<T> request,
                                                             String errorMessage)

networkOperation

public <T extends OBinaryResponse> T networkOperation(OBinaryRequest<T> request,
                                                      String errorMessage)

baseNetworkOperation

public <T> T baseNetworkOperation(OStorageRemoteOperation<T> operation,
                                  String errorMessage,
                                  int retry)

isAssigningClusterIds
```
public boolean isAssigningClusterIds()
```
Specified by:

isAssigningClusterIds in interface OStorage

Specified by:

isAssigningClusterIds in interface OStorageInfo

Overrides:

isAssigningClusterIds in class OStorageAbstract

getCreatedAtVersion
```
public String getCreatedAtVersion()
```
Supported only in embedded storage. Use SELECT FROM metadata:storage instead.

Specified by:

getCreatedAtVersion in interface OStorage

Returns:

Version of product release under which storage was created.

getSessionId
```
public int getSessionId()
```

getServerURL
```
public String getServerURL()
```

open

public void open(String iUserName,
                 String iUserPassword,
                 OContextConfiguration conf)

Specified by:: open in interface OStorage

getSBtreeCollectionManager
```
public OSBTreeCollectionManager getSBtreeCollectionManager()
```
Specified by:

getSBtreeCollectionManager in interface OStorage

reload
```
public void reload()
```
Specified by:

reload in interface OStorage

create

public void create(OContextConfiguration contextConfiguration)

Specified by:: create in interface OStorage

exists
```
public boolean exists()
```
Specified by:

exists in interface OStorage

close
```
public void close(boolean iForce,
                  boolean onDelete)
```
Specified by:

close in interface OStorage

Overrides:

close in class OStorageAbstract

shutdown
```
public void shutdown()
```
Description copied from interface: OStorage

This method is called in Orient.shutdown() method. For most of the storages it means that storage will be merely closed, but sometimes additional operations are need to be taken in account.

Specified by:

shutdown in interface OStorage

Overrides:

shutdown in class OStorageAbstract

getUsers
```
public int getUsers()
```
Specified by:

getUsers in interface OStorageProxy

addUser
```
public int addUser()
```
Specified by:

addUser in interface OStorageProxy

removeUser
```
public int removeUser()
```
Specified by:

removeUser in interface OStorageProxy

delete
```
public void delete()
```
Specified by:

delete in interface OStorage

getClusterNames
```
public Set<String> getClusterNames()
```
Specified by:

getClusterNames in interface OStorage

Specified by:

getClusterNames in interface OStorageInfo

createRecord

public OStorageOperationResult<OPhysicalPosition> createRecord(ORecordId iRid,
                                                               byte[] iContent,
                                                               int iRecordVersion,
                                                               byte iRecordType,
                                                               int iMode,
                                                               ORecordCallback<Long> iCallback)

getRecordMetadata
```
public ORecordMetadata getRecordMetadata(ORID rid)
```
Specified by:

getRecordMetadata in interface OStorage

readRecordIfVersionIsNotLatest

public OStorageOperationResult<ORawBuffer> readRecordIfVersionIsNotLatest(ORecordId rid,
                                                                          String fetchPlan,
                                                                          boolean ignoreCache,
                                                                          int recordVersion)
                                                                   throws ORecordNotFoundException

Specified by:: readRecordIfVersionIsNotLatest in interface OStorage
Throws:: ORecordNotFoundException

readRecord

public OStorageOperationResult<ORawBuffer> readRecord(ORecordId iRid,
                                                      String iFetchPlan,
                                                      boolean iIgnoreCache,
                                                      boolean prefetchRecords,
                                                      ORecordCallback<ORawBuffer> iCallback)

Specified by:: readRecord in interface OStorage

incrementalBackup

public String incrementalBackup(String backupDirectory,
                                OCallable<Void,Void> started)

Specified by:: incrementalBackup in interface OStorage
Returns:: Backup file name

supportIncremental
```
public boolean supportIncremental()
```
Specified by:

supportIncremental in interface OStorage

fullIncrementalBackup

public void fullIncrementalBackup(OutputStream stream)
                           throws UnsupportedOperationException

Specified by:: fullIncrementalBackup in interface OStorage
Throws:: UnsupportedOperationException

restoreFromIncrementalBackup
```
public void restoreFromIncrementalBackup(String filePath)
```
Specified by:

restoreFromIncrementalBackup in interface OStorage

restoreFullIncrementalBackup

public void restoreFullIncrementalBackup(InputStream stream)
                                  throws UnsupportedOperationException

Specified by:: restoreFullIncrementalBackup in interface OStorage
Throws:: UnsupportedOperationException

updateRecord

public OStorageOperationResult<Integer> updateRecord(ORecordId iRid,
                                                     boolean updateContent,
                                                     byte[] iContent,
                                                     int iVersion,
                                                     byte iRecordType,
                                                     int iMode,
                                                     ORecordCallback<Integer> iCallback)

deleteRecord

public OStorageOperationResult<Boolean> deleteRecord(ORecordId iRid,
                                                     int iVersion,
                                                     int iMode,
                                                     ORecordCallback<Boolean> iCallback)

Specified by:: deleteRecord in interface OStorage

cleanOutRecord

public boolean cleanOutRecord(ORecordId recordId,
                              int recordVersion,
                              int iMode,
                              ORecordCallback<Boolean> callback)

Specified by:: cleanOutRecord in interface OStorage

backup
```
public List<String> backup(OutputStream out,
                           Map<String,Object> options,
                           Callable<Object> callable,
                           OCommandOutputListener iListener,
                           int compressionLevel,
                           int bufferSize)
                    throws IOException
```
Description copied from interface: OBackupable

Executes a backup of the database. During the backup the database will be frozen in read-only mode.

Specified by:

backup in interface OBackupable

Parameters:

out - OutputStream used to write the backup content. Use a FileOutputStream to make the backup persistent on disk

options - Backup options as Map object

callable - Callback to execute when the database is locked

iListener - Listener called for backup messages

compressionLevel - ZIP Compression level between 1 (the minimum) and 9 (maximum). The bigger is the compression, the smaller will be the final backup content, but will consume more CPU and time to execute

bufferSize - Buffer size in bytes, the bigger is the buffer, the more efficient will be the compression

Throws:

IOException

See Also:

ODatabaseExport

restore
```
public void restore(InputStream in,
                    Map<String,Object> options,
                    Callable<Object> callable,
                    OCommandOutputListener iListener)
             throws IOException
```
Description copied from interface: OBackupable

Executes a restore of a database backup. During the restore the database will be frozen in read-only mode.

Specified by:

restore in interface OBackupable

Parameters:

in - InputStream used to read the backup content. Use a FileInputStream to read a backup on a disk

options - Backup options as Map object

callable - Callback to execute when the database is locked

iListener - Listener called for backup messages

Throws:

IOException

See Also:

ODatabaseImport

getClientConfiguration

public OContextConfiguration getClientConfiguration()

count
```
public long count(int iClusterId)
```
Specified by:

count in interface OStorage

count

public long count(int iClusterId,
                  boolean countTombstones)

Specified by:: count in interface OStorage

getClusterDataRange
```
public long[] getClusterDataRange(int iClusterId)
```
Description copied from interface: OStorage

Returns a pair of long values telling the begin and end positions of data in the requested cluster. Useful to know the range of the records.

Specified by:

getClusterDataRange in interface OStorage

Parameters:

iClusterId - Cluster id

higherPhysicalPositions

public OPhysicalPosition[] higherPhysicalPositions(int iClusterId,
                                                   OPhysicalPosition iClusterPosition)

Specified by:: higherPhysicalPositions in interface OStorage

ceilingPhysicalPositions

public OPhysicalPosition[] ceilingPhysicalPositions(int clusterId,
                                                    OPhysicalPosition physicalPosition)

Specified by:: ceilingPhysicalPositions in interface OStorage

lowerPhysicalPositions

public OPhysicalPosition[] lowerPhysicalPositions(int iClusterId,
                                                  OPhysicalPosition physicalPosition)

Specified by:: lowerPhysicalPositions in interface OStorage

floorPhysicalPositions

public OPhysicalPosition[] floorPhysicalPositions(int clusterId,
                                                  OPhysicalPosition physicalPosition)

Specified by:: floorPhysicalPositions in interface OStorage

getSize
```
public long getSize()
```
Description copied from interface: OStorage

Returns the size of the database.

Specified by:

getSize in interface OStorage

countRecords
```
public long countRecords()
```
Description copied from interface: OStorage

Returns the total number of records.

Specified by:

countRecords in interface OStorage

Overrides:

countRecords in class OStorageAbstract

count
```
public long count(int[] iClusterIds)
```
Specified by:

count in interface OStorage

count

public long count(int[] iClusterIds,
                  boolean countTombstones)

Specified by:: count in interface OStorage

command
```
public Object command(OCommandRequestText iCommand)
```
Execute the command remotely and get the results back.

Specified by:

command in interface OStorage

stickToSession
```
public void stickToSession()
```

unstickToSession
```
public void unstickToSession()
```

query

public ORemoteQueryResult query(ODatabaseDocumentRemote db,
                                String query,
                                Object[] args)

query

public ORemoteQueryResult query(ODatabaseDocumentRemote db,
                                String query,
                                Map args)

command

public ORemoteQueryResult command(ODatabaseDocumentRemote db,
                                  String query,
                                  Object[] args)

command

public ORemoteQueryResult command(ODatabaseDocumentRemote db,
                                  String query,
                                  Map args)

execute

public ORemoteQueryResult execute(ODatabaseDocumentRemote db,
                                  String language,
                                  String query,
                                  Object[] args)

execute

public ORemoteQueryResult execute(ODatabaseDocumentRemote db,
                                  String language,
                                  String query,
                                  Map args)

closeQuery

public void closeQuery(ODatabaseDocumentRemote database,
                       String queryId)

fetchNextPage

public void fetchNextPage(ODatabaseDocumentRemote database,
                          ORemoteResultSet rs)

commit

public List<ORecordOperation> commit(OTransactionInternal iTx)

Specified by:: commit in interface OStorage

rollback

public void rollback(OTransactionInternal iTx)

Specified by:: rollback in interface OStorage

getClusterIdByName
```
public int getClusterIdByName(String iClusterName)
```
Specified by:

getClusterIdByName in interface OStorage

getDefaultClusterId
```
public int getDefaultClusterId()
```
Specified by:

getDefaultClusterId in interface OStorageInfo

setDefaultClusterId
```
public void setDefaultClusterId(int defaultClusterId)
```
Specified by:

setDefaultClusterId in interface OStorage

addCluster
```
public int addCluster(String iClusterName,
                      Object... iArguments)
```
Description copied from interface: OStorage

Add a new cluster into the storage.

Specified by:

addCluster in interface OStorage

Parameters:

iClusterName - name of the cluster

addCluster
```
public int addCluster(String iClusterName,
                      int iRequestedId)
```
Description copied from interface: OStorage

Add a new cluster into the storage.

Specified by:

addCluster in interface OStorage

Parameters:

iClusterName - name of the cluster

iRequestedId - requested id of the cluster

getClusterNameById
```
public String getClusterNameById(int clusterId)
```
Specified by:

getClusterNameById in interface OStorage

getClusterRecordsSizeById
```
public long getClusterRecordsSizeById(int clusterId)
```
Specified by:

getClusterRecordsSizeById in interface OStorage

getClusterRecordsSizeByName
```
public long getClusterRecordsSizeByName(String clusterName)
```
Specified by:

getClusterRecordsSizeByName in interface OStorage

setClusterAttribute

public boolean setClusterAttribute(String clusterName,
                                   OCluster.ATTRIBUTES attribute,
                                   Object value)

Specified by:: setClusterAttribute in interface OStorage

getClusterRecordConflictStrategy
```
public String getClusterRecordConflictStrategy(int clusterId)
```
Specified by:

getClusterRecordConflictStrategy in interface OStorage

getClusterEncryption
```
public String getClusterEncryption(int clusterId)
```
Specified by:

getClusterEncryption in interface OStorage

isSystemCluster
```
public boolean isSystemCluster(int clusterId)
```
Specified by:

isSystemCluster in interface OStorage

getLastClusterPosition
```
public long getLastClusterPosition(int clusterId)
```
Specified by:

getLastClusterPosition in interface OStorage

getClusterNextPosition
```
public long getClusterNextPosition(int clusterId)
```
Specified by:

getClusterNextPosition in interface OStorage

getRecordStatus

public OPaginatedCluster.RECORD_STATUS getRecordStatus(ORID rid)

Specified by:: getRecordStatus in interface OStorage

dropCluster
```
public boolean dropCluster(int iClusterId)
```
Description copied from interface: OStorage

Drops a cluster.

Specified by:

dropCluster in interface OStorage

Parameters:

iClusterId - id of the cluster to delete

Returns:

true if has been removed, otherwise false

getClusterName
```
public String getClusterName(int clusterId)
```
Specified by:

getClusterName in interface OStorage

setClusterAttribute

public boolean setClusterAttribute(int id,
                                   OCluster.ATTRIBUTES attribute,
                                   Object value)

Specified by:: setClusterAttribute in interface OStorage

removeClusterFromConfiguration

public void removeClusterFromConfiguration(int iClusterId)

synch
```
public void synch()
```
Specified by:

synch in interface OStorage

getPhysicalClusterNameById
```
public String getPhysicalClusterNameById(int iClusterId)
```
Specified by:

getPhysicalClusterNameById in interface OStorage

getClusterMap
```
public int getClusterMap()
```

getClusterInstances
```
public Collection<OCluster> getClusterInstances()
```
Specified by:

getClusterInstances in interface OStorage

getVersion
```
public long getVersion()
```
Description copied from class: OStorageAbstract

Returns current storage's version as serial.

Specified by:

getVersion in interface OStorage

Overrides:

getVersion in class OStorageAbstract

getClusterConfiguration

public ODocument getClusterConfiguration()

endRequest

public void endRequest(OChannelBinaryAsynchClient iNetwork)
                throws IOException

Ends the request and unlock the write lock

Throws:: IOException

endResponse

public void endResponse(OChannelBinaryAsynchClient iNetwork)
                 throws IOException

End response reached: release the channel in the pool to being reused

Throws:: IOException

isRemote
```
public boolean isRemote()
```
Specified by:

isRemote in interface OStorage

isPermanentRequester
```
public boolean isPermanentRequester()
```

updateDistributedNodes

public void updateDistributedNodes(List<String> hosts)

removeSessions

public void removeSessions(String url)

getRecordConflictStrategy
```
public ORecordConflictStrategy getRecordConflictStrategy()
```
Specified by:

getRecordConflictStrategy in interface OStorage

setConflictStrategy

public void setConflictStrategy(ORecordConflictStrategy iResolver)

Specified by:: setConflictStrategy in interface OStorage

getURL
```
public String getURL()
```
Specified by:

getURL in interface OStorageInfo

Overrides:

getURL in class OStorageAbstract

getClusters
```
public int getClusters()
```
Specified by:

getClusters in interface OStorageInfo

getType
```
public String getType()
```
Description copied from interface: OStorage

Returns the storage's type.

Specified by:

getType in interface OStorage

getUserName
```
public String getUserName()
```
Specified by:

getUserName in interface OStorageProxy

reopenRemoteDatabase

protected String reopenRemoteDatabase()
                               throws IOException

Throws:: IOException

openRemoteDatabase

protected void openRemoteDatabase()
                           throws IOException

Throws:: IOException

openRemoteDatabase

public void openRemoteDatabase(OChannelBinaryAsynchClient network)
                        throws IOException

Throws:: IOException

openRemoteDatabase

protected void openRemoteDatabase(String currentURL)

useNewServerURL

protected String useNewServerURL(String iUrl)

parseAddressesFromUrl

public List<String> parseAddressesFromUrl(String url)

parseServerURLs
```
protected void parseServerURLs()
```
Parse the URLs. Multiple URLs must be separated by semicolon (;)

addHost

protected String addHost(String host)

Registers the remote server with port.

getDefaultPort
```
protected int getDefaultPort()
```

getDefaultSSLPort
```
protected int getDefaultSSLPort()
```

beginRequest

public OChannelBinaryAsynchClient beginRequest(OChannelBinaryAsynchClient network,
                                               byte iCommand,
                                               OStorageRemoteSession session)
                                        throws IOException

Acquire a network channel from the pool. Don't lock the write stream since the connection usage is exclusive.

Parameters:: iCommand - id. Ids described at OChannelBinaryProtocol
Returns:: connection to server
Throws:: IOException

getNextAvailableServerURL

protected String getNextAvailableServerURL(boolean iIsConnectOperation,
                                           OStorageRemoteSession session)

getNextConnectUrl

public String getNextConnectUrl(OStorageRemoteSession session)

getCurrentServerURL

protected String getCurrentServerURL()

getServerURFromList

protected String getServerURFromList(boolean iNextAvailable,
                                     OStorageRemoteSession session)

getNetwork

public OChannelBinaryAsynchClient getNetwork(String iCurrentURL)

Specified by:: getNetwork in interface ORemotePushHandler

beginResponse

public void beginResponse(OChannelBinaryAsynchClient iNetwork,
                          OStorageRemoteSession session)
                   throws IOException

Throws:: IOException

updateStorageConfiguration

public void updateStorageConfiguration(OStorageConfiguration storageConfiguration)

getCurrentSession

protected OStorageRemoteSession getCurrentSession()

isClosed
```
public boolean isClosed()
```
Specified by:

isClosed in interface OStorage

Overrides:

isClosed in class OStorageAbstract

copy

public OStorageRemote copy(ODatabaseDocumentRemote source,
                           ODatabaseDocumentRemote dest)

importDatabase

public void importDatabase(String options,
                           InputStream inputStream,
                           String name,
                           OCommandOutputListener listener)

addNewClusterToConfiguration

public void addNewClusterToConfiguration(int clusterId,
                                         String iClusterName)

beginTransaction

public void beginTransaction(ODatabaseDocumentRemote database,
                             OTransactionOptimistic transaction)

reBeginTransaction

public void reBeginTransaction(ODatabaseDocumentRemote database,
                               OTransactionOptimistic transaction)

fetchTransaction

public void fetchTransaction(ODatabaseDocumentRemote remote)

createPush
```
public OBinaryPushRequest createPush(byte type)
```
Specified by:

createPush in interface ORemotePushHandler

executeUpdateDistributedConfig

public OBinaryPushResponse executeUpdateDistributedConfig(OPushDistributedConfigurationRequest request)

Specified by:: executeUpdateDistributedConfig in interface ORemotePushHandler

executeUpdateFunction

public OBinaryPushResponse executeUpdateFunction(OPushFunctionsRequest request)

Specified by:: executeUpdateFunction in interface ORemotePushHandler

executeUpdateSequences

public OBinaryPushResponse executeUpdateSequences(OPushSequencesRequest request)

Specified by:: executeUpdateSequences in interface ORemotePushHandler

executeUpdateStorageConfig

public OBinaryPushResponse executeUpdateStorageConfig(OPushStorageConfigurationRequest payload)

Specified by:: executeUpdateStorageConfig in interface ORemotePushHandler

executeUpdateSchema

public OBinaryPushResponse executeUpdateSchema(OPushSchemaRequest request)

Specified by:: executeUpdateSchema in interface ORemotePushHandler

executeUpdateIndexManager

public OBinaryPushResponse executeUpdateIndexManager(OPushIndexManagerRequest request)

Specified by:: executeUpdateIndexManager in interface ORemotePushHandler

liveQuery

public OLiveQueryMonitor liveQuery(ODatabaseDocumentRemote database,
                                   String query,
                                   OLiveQueryClientListener listener,
                                   Object[] params)

liveQuery

public OLiveQueryMonitor liveQuery(ODatabaseDocumentRemote database,
                                   String query,
                                   OLiveQueryClientListener listener,
                                   Map<String,?> params)

unsubscribeLive

public void unsubscribeLive(ODatabaseDocumentRemote database,
                            int monitorId)

registerLiveListener

public void registerLiveListener(int monitorId,
                                 OLiveQueryClientListener listener)

paramsArrayToParamsMap

public static HashMap<String,Object> paramsArrayToParamsMap(Object[] positionalParams)

executeLiveQueryPush
```
public void executeLiveQueryPush(OLiveQueryPushRequest pushRequest)
```
Specified by:

executeLiveQueryPush in interface ORemotePushHandler

onPushReconnect
```
public void onPushReconnect(String host)
```
Specified by:

onPushReconnect in interface ORemotePushHandler

onPushDisconnect

public void onPushDisconnect(OChannelBinary network,
                             Exception e)

Specified by:: onPushDisconnect in interface ORemotePushHandler

lockRecord

public OLockRecordResponse lockRecord(OIdentifiable iRecord,
                                      OStorage.LOCKING_STRATEGY lockingStrategy,
                                      long timeout)

unlockRecord

public void unlockRecord(OIdentifiable iRecord)

returnSocket
```
public void returnSocket(OChannelBinary network)
```
Specified by:

returnSocket in interface ORemotePushHandler

setSchemaRecordId
```
public void setSchemaRecordId(String schemaRecordId)
```
Specified by:

setSchemaRecordId in interface OStorage

setDateFormat
```
public void setDateFormat(String dateFormat)
```
Specified by:

setDateFormat in interface OStorage

setTimeZone
```
public void setTimeZone(TimeZone timeZoneValue)
```
Specified by:

setTimeZone in interface OStorage

setLocaleLanguage
```
public void setLocaleLanguage(String locale)
```
Specified by:

setLocaleLanguage in interface OStorage

setCharset
```
public void setCharset(String charset)
```
Specified by:

setCharset in interface OStorage

setIndexMgrRecordId
```
public void setIndexMgrRecordId(String indexMgrRecordId)
```
Specified by:

setIndexMgrRecordId in interface OStorage

setDateTimeFormat
```
public void setDateTimeFormat(String dateTimeFormat)
```
Specified by:

setDateTimeFormat in interface OStorage

setLocaleCountry
```
public void setLocaleCountry(String localeCountry)
```
Specified by:

setLocaleCountry in interface OStorage

setClusterSelection
```
public void setClusterSelection(String clusterSelection)
```
Specified by:

setClusterSelection in interface OStorage

setMinimumClusters
```
public void setMinimumClusters(int minimumClusters)
```
Specified by:

setMinimumClusters in interface OStorage

setValidation
```
public void setValidation(boolean validation)
```
Specified by:

setValidation in interface OStorage

removeProperty
```
public void removeProperty(String property)
```
Specified by:

removeProperty in interface OStorage

setProperty

public void setProperty(String property,
                        String value)

Specified by:: setProperty in interface OStorage

setRecordSerializer

public void setRecordSerializer(String recordSerializer,
                                int version)

Specified by:: setRecordSerializer in interface OStorage

clearProperties
```
public void clearProperties()
```
Specified by:

clearProperties in interface OStorage

getServerURLs
```
public List<String> getServerURLs()
```

Class OStorageRemote

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.storage.OStorage

Field Summary

Fields inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

Fields inherited from interface com.orientechnologies.orient.core.storage.OStorage

Constructor Summary

Method Summary

Methods inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

Methods inherited from class java.lang.Object

Methods inherited from interface com.orientechnologies.orient.core.storage.OStorage

Methods inherited from interface com.orientechnologies.common.concur.resource.OSharedContainer

Methods inherited from interface com.orientechnologies.orient.core.storage.OStorageInfo

Field Detail

PARAM_CONNECTION_STRATEGY

ADDRESS_SEPARATOR

DRIVER_NAME

connectionManager

Constructor Detail

OStorageRemote

OStorageRemote

Method Detail

asyncNetworkOperationNoRetry

asyncNetworkOperationRetry

networkOperationRetryTimeout

networkOperationNoRetry

networkOperation

baseNetworkOperation

isAssigningClusterIds

getCreatedAtVersion

getSessionId

getServerURL

open

getSBtreeCollectionManager

reload

create

exists

close

shutdown

getUsers

addUser

removeUser

delete

getClusterNames

createRecord

getRecordMetadata

readRecordIfVersionIsNotLatest

readRecord

incrementalBackup

supportIncremental

fullIncrementalBackup

restoreFromIncrementalBackup

restoreFullIncrementalBackup

updateRecord

deleteRecord

cleanOutRecord

backup

restore

getClientConfiguration

count

count

getClusterDataRange

higherPhysicalPositions

ceilingPhysicalPositions

lowerPhysicalPositions

floorPhysicalPositions

getSize

countRecords

count

count

command

stickToSession

unstickToSession

query

query

command

command

execute

execute

closeQuery