com.orientechnologies.orient.client.remote

Class OStorageRemote

java.lang.Object

com.orientechnologies.common.concur.resource.OSharedContainerImpl

com.orientechnologies.orient.core.storage.OStorageAbstract

com.orientechnologies.orient.client.remote.OStorageRemote

All Implemented Interfaces:

com.orientechnologies.common.concur.resource.OSharedContainer, com.orientechnologies.orient.core.storage.OStorage, com.orientechnologies.orient.core.storage.OStorageProxy

public class OStorageRemote
extends com.orientechnologies.orient.core.storage.OStorageAbstract
implements com.orientechnologies.orient.core.storage.OStorageProxy

This object is bound to each remote ODatabase instances.

Nested Class Summary

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

com.orientechnologies.orient.core.storage.OStorage.CLUSTER_TYPE, com.orientechnologies.orient.core.storage.OStorage.SIZE, com.orientechnologies.orient.core.storage.OStorage.STATUS

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,com.orientechnologies.orient.core.storage.OCluster>	clusterMap
static String	PARAM_DB_TYPE
static String	PARAM_MAX_POOL
static String	PARAM_MIN_POOL
protected List<String>	serverURLs

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

configuration, level2Cache, lock, mode, name, status, url, version

Fields inherited from class com.orientechnologies.common.concur.resource.OSharedContainerImpl

sharedResources

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

CLUSTER_DEFAULT_NAME, DATA_DEFAULT_NAME

Constructor Summary

Constructors

Constructor and Description
OStorageRemote(String iClientId, String iURL, String iMode)

Method Summary

Methods

Modifier and Type	Method and Description
int	addCluster(String iClusterType, String iClusterName, int iRequestedId, String iLocation, String iDataSegmentName, boolean forceListBased, Object... iParameters)
int	addCluster(String iClusterType, String iClusterName, String iLocation, String iDataSegmentName, boolean forceListBased, Object... iArguments)
int	addDataSegment(String iDataSegmentName)
int	addDataSegment(String iSegmentName, String iLocation)
protected String	addHost(String host) Registers the remote server with port.
protected OChannelBinaryClient	beginRequest(byte iCommand) Acquire a network channel from the pool.
protected void	beginResponse(OChannelBinaryClient iNetwork) Starts listening the response.
<V> V	callInRecordLock(Callable<V> iCallable, com.orientechnologies.orient.core.id.ORID rid, boolean iExclusiveLock)
com.orientechnologies.orient.core.storage.OPhysicalPosition[]	ceilingPhysicalPositions(int clusterId, com.orientechnologies.orient.core.storage.OPhysicalPosition physicalPosition)
protected void	checkConnection()
boolean	cleanOutRecord(com.orientechnologies.orient.core.id.ORecordId recordId, com.orientechnologies.orient.core.version.ORecordVersion recordVersion, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<Boolean> callback)
void	close(boolean iForce)
protected void	closeChannel(OChannelBinaryClient iNetwork) Closes the channel and remove it from the pool.
Object	command(com.orientechnologies.orient.core.command.OCommandRequestText iCommand) Execute the command remotely and get the results back.
void	commit(com.orientechnologies.orient.core.tx.OTransaction iTx)
long	count(int iClusterId)
long	count(int[] iClusterIds)
long	count(int[] iClusterIds, boolean countTombstones)
long	count(int iClusterId, boolean countTombstones)
long	countRecords()
void	create(Map<String,Object> iOptions)
protected void	createConnectionPool()
protected OChannelBinaryClient	createNetworkConnection()
com.orientechnologies.orient.core.storage.OStorageOperationResult<com.orientechnologies.orient.core.storage.OPhysicalPosition>	createRecord(int iDataSegmentId, com.orientechnologies.orient.core.id.ORecordId iRid, byte[] iContent, com.orientechnologies.orient.core.version.ORecordVersion iRecordVersion, byte iRecordType, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<com.orientechnologies.orient.core.id.OClusterPosition> iCallback)
void	delete()
com.orientechnologies.orient.core.storage.OStorageOperationResult<Boolean>	deleteRecord(com.orientechnologies.orient.core.id.ORecordId iRid, com.orientechnologies.orient.core.version.ORecordVersion iVersion, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<Boolean> iCallback)
boolean	dropCluster(int iClusterId, boolean iTruncate)
boolean	dropDataSegment(String iSegmentName)
void	endRequest(OChannelBinaryClient iNetwork) Ends the request and unlock the write lock
void	endResponse(OChannelBinaryClient iNetwork) End response reached: release the channel in the pool to being reused
boolean	exists()
com.orientechnologies.orient.core.storage.OPhysicalPosition[]	floorPhysicalPositions(int clusterId, com.orientechnologies.orient.core.storage.OPhysicalPosition physicalPosition)
ORemoteServerEventListener	getAsynchEventListener()
String	getClientId()
com.orientechnologies.orient.core.storage.OCluster	getClusterById(int iClusterId)
com.orientechnologies.orient.core.record.impl.ODocument	getClusterConfiguration()
com.orientechnologies.orient.core.id.OClusterPosition[]	getClusterDataRange(int iClusterId)
int	getClusterIdByName(String iClusterName)
Collection<com.orientechnologies.orient.core.storage.OCluster>	getClusterInstances()
int	getClusterMap()
Set<String>	getClusterNames()
int	getClusters()
String	getClusterTypeByName(String iClusterName)
com.orientechnologies.orient.core.storage.ODataSegment	getDataSegmentById(int iDataSegmentId)
int	getDataSegmentIdByName(String iName)
int	getDefaultClusterId()
protected String	getDefaultHost()
protected int	getDefaultPort()
String	getPhysicalClusterNameById(int iClusterId)
com.orientechnologies.orient.core.storage.ORecordMetadata	getRecordMetadata(com.orientechnologies.orient.core.id.ORID rid)
protected void	getResponse(OChannelBinaryClient iNetwork)
int	getSessionId()
long	getSize()
String	getType()
String	getURL()
long	getVersion()
protected void	handleException(String message, Exception exception) Handles exceptions.
com.orientechnologies.orient.core.storage.OPhysicalPosition[]	higherPhysicalPositions(int iClusterId, com.orientechnologies.orient.core.storage.OPhysicalPosition iClusterPosition)
boolean	isHashClustersAreUsed()
boolean	isPermanentRequester()
com.orientechnologies.orient.core.storage.OPhysicalPosition[]	lowerPhysicalPositions(int iClusterId, com.orientechnologies.orient.core.storage.OPhysicalPosition physicalPosition)
void	open(String iUserName, String iUserPassword, Map<String,Object> iOptions)
protected void	openRemoteDatabase()
protected void	parseServerURLs() Parse the URL in the following formats:
com.orientechnologies.orient.core.storage.OStorageOperationResult<com.orientechnologies.orient.core.storage.ORawBuffer>	readRecord(com.orientechnologies.orient.core.id.ORecordId iRid, String iFetchPlan, boolean iIgnoreCache, com.orientechnologies.orient.core.storage.ORecordCallback<com.orientechnologies.orient.core.storage.ORawBuffer> iCallback, boolean loadTombstones)
void	reload()
void	removeRemoteServerEventListener()
void	rollback(com.orientechnologies.orient.core.tx.OTransaction iTx)
protected void	sendClientInfo(OChannelBinaryClient network)
void	setAsynchEventListener(ORemoteServerEventListener iListener)
void	setDefaultClusterId(int defaultClusterId)
void	setSessionId(int iSessionId)
void	synch()
void	updateClusterConfiguration(byte[] obj)
com.orientechnologies.orient.core.storage.OStorageOperationResult<com.orientechnologies.orient.core.version.ORecordVersion>	updateRecord(com.orientechnologies.orient.core.id.ORecordId iRid, byte[] iContent, com.orientechnologies.orient.core.version.ORecordVersion iVersion, byte iRecordType, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<com.orientechnologies.orient.core.version.ORecordVersion> iCallback)
boolean	updateReplica(int dataSegmentId, com.orientechnologies.orient.core.id.ORecordId rid, byte[] content, com.orientechnologies.orient.core.version.ORecordVersion recordVersion, byte recordType)

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

addUser, callInLock, checkForClose, checkForClusterPermissions, checkForRecordValidity, close, dropCluster, getConfiguration, getLevel2Cache, getLock, getName, getStatus, getUsers, isClosed, removeUser, toString

Methods inherited from class com.orientechnologies.common.concur.resource.OSharedContainerImpl

existsResource, getResource, removeResource

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

addUser, callInLock, checkForClusterPermissions, checkForRecordValidity, close, dropCluster, getConfiguration, getLevel2Cache, getLock, getName, getStatus, getUsers, isClosed, removeUser

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

existsResource, getResource, removeResource

Field Detail

PARAM_MIN_POOL

public static final String PARAM_MIN_POOL

See Also:

Constant Field Values

PARAM_MAX_POOL

public static final String PARAM_MAX_POOL

See Also:

Constant Field Values

PARAM_DB_TYPE

public static final String PARAM_DB_TYPE

See Also:

Constant Field Values

serverURLs

protected final List<String> serverURLs

clusterMap

protected final Map<String,com.orientechnologies.orient.core.storage.OCluster> clusterMap

Constructor Detail

OStorageRemote

public OStorageRemote(String iClientId,
              String iURL,
              String iMode)
               throws IOException

Throws:

IOException

Method Detail

getSessionId

public int getSessionId()

setSessionId

public void setSessionId(int iSessionId)

getAsynchEventListener

public ORemoteServerEventListener getAsynchEventListener()

setAsynchEventListener

public void setAsynchEventListener(ORemoteServerEventListener iListener)

removeRemoteServerEventListener

public void removeRemoteServerEventListener()

open

public void open(String iUserName,
        String iUserPassword,
        Map<String,Object> iOptions)

Specified by:

open in interface com.orientechnologies.orient.core.storage.OStorage

reload

public void reload()

Specified by:

reload in interface com.orientechnologies.orient.core.storage.OStorage

create

public void create(Map<String,Object> iOptions)

Specified by:

create in interface com.orientechnologies.orient.core.storage.OStorage

exists

public boolean exists()

Specified by:

exists in interface com.orientechnologies.orient.core.storage.OStorage

close

public void close(boolean iForce)

Specified by:

close in interface com.orientechnologies.orient.core.storage.OStorage

Overrides:

close in class com.orientechnologies.orient.core.storage.OStorageAbstract

delete

public void delete()

Specified by:

delete in interface com.orientechnologies.orient.core.storage.OStorage

getClusterNames

public Set<String> getClusterNames()

Specified by:

getClusterNames in interface com.orientechnologies.orient.core.storage.OStorage

createRecord

public com.orientechnologies.orient.core.storage.OStorageOperationResult<com.orientechnologies.orient.core.storage.OPhysicalPosition> createRecord(int iDataSegmentId,
                                                                                                                                          com.orientechnologies.orient.core.id.ORecordId iRid,
                                                                                                                                          byte[] iContent,
                                                                                                                                          com.orientechnologies.orient.core.version.ORecordVersion iRecordVersion,
                                                                                                                                          byte iRecordType,
                                                                                                                                          int iMode,
                                                                                                                                          com.orientechnologies.orient.core.storage.ORecordCallback<com.orientechnologies.orient.core.id.OClusterPosition> iCallback)

Specified by:

createRecord in interface com.orientechnologies.orient.core.storage.OStorage

updateReplica

public boolean updateReplica(int dataSegmentId,
                    com.orientechnologies.orient.core.id.ORecordId rid,
                    byte[] content,
                    com.orientechnologies.orient.core.version.ORecordVersion recordVersion,
                    byte recordType)
                      throws IOException

Specified by:

updateReplica in interface com.orientechnologies.orient.core.storage.OStorage

Throws:

IOException

callInRecordLock

public <V> V callInRecordLock(Callable<V> iCallable,
                     com.orientechnologies.orient.core.id.ORID rid,
                     boolean iExclusiveLock)

Specified by:

callInRecordLock in interface com.orientechnologies.orient.core.storage.OStorage

getRecordMetadata

public com.orientechnologies.orient.core.storage.ORecordMetadata getRecordMetadata(com.orientechnologies.orient.core.id.ORID rid)

Specified by:

getRecordMetadata in interface com.orientechnologies.orient.core.storage.OStorage

readRecord

public com.orientechnologies.orient.core.storage.OStorageOperationResult<com.orientechnologies.orient.core.storage.ORawBuffer> readRecord(com.orientechnologies.orient.core.id.ORecordId iRid,
                                                                                                                                 String iFetchPlan,
                                                                                                                                 boolean iIgnoreCache,
                                                                                                                                 com.orientechnologies.orient.core.storage.ORecordCallback<com.orientechnologies.orient.core.storage.ORawBuffer> iCallback,
                                                                                                                                 boolean loadTombstones)

Specified by:

readRecord in interface com.orientechnologies.orient.core.storage.OStorage

updateRecord

public com.orientechnologies.orient.core.storage.OStorageOperationResult<com.orientechnologies.orient.core.version.ORecordVersion> updateRecord(com.orientechnologies.orient.core.id.ORecordId iRid,
                                                                                                                                       byte[] iContent,
                                                                                                                                       com.orientechnologies.orient.core.version.ORecordVersion iVersion,
                                                                                                                                       byte iRecordType,
                                                                                                                                       int iMode,
                                                                                                                                       com.orientechnologies.orient.core.storage.ORecordCallback<com.orientechnologies.orient.core.version.ORecordVersion> iCallback)

Specified by:

updateRecord in interface com.orientechnologies.orient.core.storage.OStorage

deleteRecord

public com.orientechnologies.orient.core.storage.OStorageOperationResult<Boolean> deleteRecord(com.orientechnologies.orient.core.id.ORecordId iRid,
                                                                                      com.orientechnologies.orient.core.version.ORecordVersion iVersion,
                                                                                      int iMode,
                                                                                      com.orientechnologies.orient.core.storage.ORecordCallback<Boolean> iCallback)

Specified by:

deleteRecord in interface com.orientechnologies.orient.core.storage.OStorage

cleanOutRecord

public boolean cleanOutRecord(com.orientechnologies.orient.core.id.ORecordId recordId,
                     com.orientechnologies.orient.core.version.ORecordVersion recordVersion,
                     int iMode,
                     com.orientechnologies.orient.core.storage.ORecordCallback<Boolean> callback)

Specified by:

cleanOutRecord in interface com.orientechnologies.orient.core.storage.OStorage

count

public long count(int iClusterId)

Specified by:

count in interface com.orientechnologies.orient.core.storage.OStorage

count

public long count(int iClusterId,
         boolean countTombstones)

Specified by:

count in interface com.orientechnologies.orient.core.storage.OStorage

getClusterDataRange

public com.orientechnologies.orient.core.id.OClusterPosition[] getClusterDataRange(int iClusterId)

Specified by:

getClusterDataRange in interface com.orientechnologies.orient.core.storage.OStorage

higherPhysicalPositions

public com.orientechnologies.orient.core.storage.OPhysicalPosition[] higherPhysicalPositions(int iClusterId,
                                                                                    com.orientechnologies.orient.core.storage.OPhysicalPosition iClusterPosition)

Specified by:

higherPhysicalPositions in interface com.orientechnologies.orient.core.storage.OStorage

ceilingPhysicalPositions

public com.orientechnologies.orient.core.storage.OPhysicalPosition[] ceilingPhysicalPositions(int clusterId,
                                                                                     com.orientechnologies.orient.core.storage.OPhysicalPosition physicalPosition)

Specified by:

ceilingPhysicalPositions in interface com.orientechnologies.orient.core.storage.OStorage

lowerPhysicalPositions

public com.orientechnologies.orient.core.storage.OPhysicalPosition[] lowerPhysicalPositions(int iClusterId,
                                                                                   com.orientechnologies.orient.core.storage.OPhysicalPosition physicalPosition)

Specified by:

lowerPhysicalPositions in interface com.orientechnologies.orient.core.storage.OStorage

floorPhysicalPositions

public com.orientechnologies.orient.core.storage.OPhysicalPosition[] floorPhysicalPositions(int clusterId,
                                                                                   com.orientechnologies.orient.core.storage.OPhysicalPosition physicalPosition)

Specified by:

floorPhysicalPositions in interface com.orientechnologies.orient.core.storage.OStorage

getSize

public long getSize()

Specified by:

getSize in interface com.orientechnologies.orient.core.storage.OStorage

countRecords

public long countRecords()

Specified by:

countRecords in interface com.orientechnologies.orient.core.storage.OStorage

Overrides:

countRecords in class com.orientechnologies.orient.core.storage.OStorageAbstract

count

public long count(int[] iClusterIds)

Specified by:

count in interface com.orientechnologies.orient.core.storage.OStorage

count

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

Specified by:

count in interface com.orientechnologies.orient.core.storage.OStorage

isHashClustersAreUsed

public boolean isHashClustersAreUsed()

Specified by:

isHashClustersAreUsed in interface com.orientechnologies.orient.core.storage.OStorage

command

public Object command(com.orientechnologies.orient.core.command.OCommandRequestText iCommand)

Execute the command remotely and get the results back.

Specified by:

command in interface com.orientechnologies.orient.core.storage.OStorage

commit

public void commit(com.orientechnologies.orient.core.tx.OTransaction iTx)

Specified by:

commit in interface com.orientechnologies.orient.core.storage.OStorage

rollback

public void rollback(com.orientechnologies.orient.core.tx.OTransaction iTx)

Specified by:

rollback in interface com.orientechnologies.orient.core.storage.OStorage

getClusterIdByName

public int getClusterIdByName(String iClusterName)

Specified by:

getClusterIdByName in interface com.orientechnologies.orient.core.storage.OStorage

getClusterTypeByName

public String getClusterTypeByName(String iClusterName)

Specified by:

getClusterTypeByName in interface com.orientechnologies.orient.core.storage.OStorage

getDefaultClusterId

public int getDefaultClusterId()

Specified by:

getDefaultClusterId in interface com.orientechnologies.orient.core.storage.OStorage

addCluster

public int addCluster(String iClusterType,
             String iClusterName,
             String iLocation,
             String iDataSegmentName,
             boolean forceListBased,
             Object... iArguments)

Specified by:

addCluster in interface com.orientechnologies.orient.core.storage.OStorage

addCluster

public int addCluster(String iClusterType,
             String iClusterName,
             int iRequestedId,
             String iLocation,
             String iDataSegmentName,
             boolean forceListBased,
             Object... iParameters)

Specified by:

addCluster in interface com.orientechnologies.orient.core.storage.OStorage

dropCluster

public boolean dropCluster(int iClusterId,
                  boolean iTruncate)

Specified by:

dropCluster in interface com.orientechnologies.orient.core.storage.OStorage

addDataSegment

public int addDataSegment(String iDataSegmentName)

Specified by:

addDataSegment in interface com.orientechnologies.orient.core.storage.OStorage

addDataSegment

public int addDataSegment(String iSegmentName,
                 String iLocation)

Specified by:

addDataSegment in interface com.orientechnologies.orient.core.storage.OStorage

dropDataSegment

public boolean dropDataSegment(String iSegmentName)

Specified by:

dropDataSegment in interface com.orientechnologies.orient.core.storage.OStorage

synch

public void synch()

Specified by:

synch in interface com.orientechnologies.orient.core.storage.OStorage

getPhysicalClusterNameById

public String getPhysicalClusterNameById(int iClusterId)

Specified by:

getPhysicalClusterNameById in interface com.orientechnologies.orient.core.storage.OStorage

getClusterMap

public int getClusterMap()

getClusterInstances

public Collection<com.orientechnologies.orient.core.storage.OCluster> getClusterInstances()

Specified by:

getClusterInstances in interface com.orientechnologies.orient.core.storage.OStorage

getClusterById

public com.orientechnologies.orient.core.storage.OCluster getClusterById(int iClusterId)

Specified by:

getClusterById in interface com.orientechnologies.orient.core.storage.OStorage

getVersion

public long getVersion()

Specified by:

getVersion in interface com.orientechnologies.orient.core.storage.OStorage

Overrides:

getVersion in class com.orientechnologies.orient.core.storage.OStorageAbstract

getClusterConfiguration

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

handleException

protected void handleException(String message,
                   Exception exception)

Handles exceptions. In case of IO errors retries to reconnect until the configured retry times has reached.

Parameters:

message -

exception -

openRemoteDatabase

protected void openRemoteDatabase()
                           throws IOException

Throws:

IOException

sendClientInfo

protected void sendClientInfo(OChannelBinaryClient network)
                       throws IOException

Throws:

IOException

parseServerURLs

protected void parseServerURLs()

Parse the URL in the following formats:

addHost

protected String addHost(String host)

Registers the remote server with port.

getDefaultHost

protected String getDefaultHost()

getDefaultPort

protected int getDefaultPort()

createNetworkConnection

protected OChannelBinaryClient createNetworkConnection()
                                                throws IOException,
                                                       UnknownHostException

Throws:

IOException

UnknownHostException

checkConnection

protected void checkConnection()

beginRequest

protected OChannelBinaryClient beginRequest(byte iCommand)
                                     throws IOException

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

Parameters:

iCommand -

Returns:

Throws:

IOException

endRequest

public void endRequest(OChannelBinaryClient iNetwork)
                throws IOException

Ends the request and unlock the write lock

Throws:

IOException

closeChannel

protected void closeChannel(OChannelBinaryClient iNetwork)

Closes the channel and remove it from the pool.

Parameters:

iNetwork - Channel to close and remove

beginResponse

protected void beginResponse(OChannelBinaryClient iNetwork)
                      throws IOException

Starts listening the response.

Throws:

IOException

endResponse

public void endResponse(OChannelBinaryClient iNetwork)

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

isPermanentRequester

public boolean isPermanentRequester()

getResponse

protected void getResponse(OChannelBinaryClient iNetwork)
                    throws IOException

Throws:

IOException

updateClusterConfiguration

public void updateClusterConfiguration(byte[] obj)

createConnectionPool

protected void createConnectionPool()
                             throws IOException,
                                    UnknownHostException

Throws:

IOException

UnknownHostException

getURL

public String getURL()

Specified by:

getURL in interface com.orientechnologies.orient.core.storage.OStorage

Overrides:

getURL in class com.orientechnologies.orient.core.storage.OStorageAbstract

getClientId

public String getClientId()

getDataSegmentIdByName

public int getDataSegmentIdByName(String iName)

Specified by:

getDataSegmentIdByName in interface com.orientechnologies.orient.core.storage.OStorage

getDataSegmentById

public com.orientechnologies.orient.core.storage.ODataSegment getDataSegmentById(int iDataSegmentId)

Specified by:

getDataSegmentById in interface com.orientechnologies.orient.core.storage.OStorage

getClusters

public int getClusters()

Specified by:

getClusters in interface com.orientechnologies.orient.core.storage.OStorage

setDefaultClusterId

public void setDefaultClusterId(int defaultClusterId)

Specified by:

setDefaultClusterId in interface com.orientechnologies.orient.core.storage.OStorage

getType

public String getType()

Specified by:

getType in interface com.orientechnologies.orient.core.storage.OStorage