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

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

This object is bound to each remote ODatabase instances.

Nested Class Summary

Nested classes/interfaces inherited from class com.orientechnologies.orient.core.storage.OStorageAbstract

com.orientechnologies.orient.core.storage.OStorageAbstract.STATUS

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

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, CLUSTER_INDEX_NAME, CLUSTER_INTERNAL_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, String iLocation, String iDataSegmentName, 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.
protected void	checkConnection()
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	countRecords()
void	create(Map<String,Object> iOptions)
protected void	createConnectionPool()
protected OChannelBinaryClient	createNetworkConnection()
com.orientechnologies.orient.core.storage.OPhysicalPosition	createRecord(int iDataSegmentId, com.orientechnologies.orient.core.id.ORecordId iRid, byte[] iContent, int iRecordVersion, byte iRecordType, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<Long> iCallback)
void	delete()
boolean	deleteRecord(com.orientechnologies.orient.core.id.ORecordId iRid, int iVersion, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<Boolean> iCallback)
boolean	dropCluster(int iClusterId)
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()
ORemoteServerEventListener	getAsynchEventListener()
String	getClientId()
com.orientechnologies.orient.core.storage.OCluster	getClusterById(int iClusterId)
com.orientechnologies.orient.core.record.impl.ODocument	getClusterConfiguration()
long[]	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)
protected void	getResponse(OChannelBinaryClient iNetwork)
int	getSessionId()
long	getSize()
String	getURL()
long	getVersion()
protected void	handleException(String iMessage, Exception iException) Handles exceptions.
boolean	isPermanentRequester()
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.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)
void	reload()
void	removeRemoteServerEventListener()
void	rollback(com.orientechnologies.orient.core.tx.OTransaction iTx)
protected void	sendClientInfo(OChannelBinaryClient network)
void	setAsynchEventListener(ORemoteServerEventListener iListener)
void	setSessionId(int iSessionId)
void	synch()
void	updateClusterConfiguration(com.orientechnologies.orient.core.record.impl.ODocument obj)
int	updateRecord(com.orientechnologies.orient.core.id.ORecordId iRid, byte[] iContent, int iVersion, byte iRecordType, int iMode, com.orientechnologies.orient.core.storage.ORecordCallback<Integer> iCallback)

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

addUser, callInLock, checkForClose, checkForRecordValidity, close, dropCluster, getConfiguration, getLevel2Cache, getLock, getName, 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.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 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)

reload

public void reload()

create

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

exists

public boolean exists()

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()

getClusterNames

public Set<String> getClusterNames()

createRecord

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

readRecord

public 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)

updateRecord

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

deleteRecord

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

count

public long count(int iClusterId)

getClusterDataRange

public long[] getClusterDataRange(int iClusterId)

getSize

public long getSize()

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)

command

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

Execute the command remotely and get the results back.

commit

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

rollback

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

getClusterIdByName

public int getClusterIdByName(String iClusterName)

getClusterTypeByName

public String getClusterTypeByName(String iClusterName)

getDefaultClusterId

public int getDefaultClusterId()

addCluster

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

dropCluster

public boolean dropCluster(int iClusterId)

addDataSegment

public int addDataSegment(String iDataSegmentName)

addDataSegment

public int addDataSegment(String iSegmentName,
                 String iLocation)

dropDataSegment

public boolean dropDataSegment(String iSegmentName)

synch

public void synch()

getPhysicalClusterNameById

public String getPhysicalClusterNameById(int iClusterId)

getClusterMap

public int getClusterMap()

getClusterInstances

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

getClusterById

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

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 iMessage,
                   Exception iException)

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

Parameters:

iMessage -

iException -

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(com.orientechnologies.orient.core.record.impl.ODocument 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)

getDataSegmentById

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

getClusters

public int getClusters()