Package com.orientechnologies.orient.client.remote

Class ORemoteClient

java.lang.Object

com.orientechnologies.orient.client.remote.ORemoteClient

All Implemented Interfaces:

OStorageInfo

public class ORemoteClient
extends Object
implements OStorageInfo

This object is bound to each remote ODatabase instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ORemoteClient.CONNECTION_STRATEGY

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADDRESS_SEPARATOR
protected OCurrentStorageComponentsFactory	componentsFactory
protected OStorageConfiguration	configuration
final ORemoteConnectionManager	connectionManager
protected final OrientDBRemote	context
static final String	DRIVER_NAME
protected final String	name
protected final ReentrantReadWriteLock	stateLock
protected OStorage.STATUS	status
static final String	TYPE
protected final String	url

Constructor Summary

Constructors

Constructor	Description
ORemoteClient(ORemoteURLs hosts, String name, OrientDBRemote context, ORemoteConnectionManager connectionManager, OContextConfiguration config)
ORemoteClient(ORemoteURLs hosts, String name, OrientDBRemote context, ORemoteConnectionManager connectionManager, OStorage.STATUS status, OContextConfiguration config)

Method Summary

Modifier and Type	Method	Description
int	addCluster(ORemoteClientSession session, String iClusterName, int iRequestedId)
int	addCluster(ORemoteClientSession session, String iClusterName, Object... iArguments)
void	addNewClusterToConfiguration(int clusterId, String iClusterName)
int	addUser()
<T> T	baseNetworkOperation(ORemoteClientSession session, ORemoteClientOperation<T> operation, String errorMessage, int retry)
OChannelBinaryAsynchClient	beginRequest(OChannelBinaryAsynchClient network, byte iCommand, ORemoteClientSession session)	Acquire a network channel from the pool.
static void	beginResponse(OChannelBinaryAsynchClient iNetwork, ORemoteClientSession session)
void	beginTransaction(ORemoteClientSession session, OTransactionOptimistic transaction)
OPhysicalPosition[]	ceilingPhysicalPositions(ORemoteClientSession session, int clusterId, OPhysicalPosition physicalPosition)
boolean	checkForRecordValidity(OPhysicalPosition ppos)
void	close(ORemoteClientSession session)
void	close(ORemoteClientSession session, boolean iForce)
void	closeQuery(ODatabaseDocumentRemote db, String queryId)
ORemoteQueryResult	command(ODatabaseDocumentRemote db, String query, Object[] args)
ORemoteQueryResult	command(ODatabaseDocumentRemote db, String query, Map args)
List<ORecordOperation>	commit(ODatabaseDocumentRemote db, OTransactionInternal iTx)
ORemoteClient	copy(ODatabaseDocumentRemote source, ODatabaseDocumentRemote dest)
long	count(ORemoteClientSession session, int iClusterId)
long	count(ORemoteClientSession session, int[] iClusterIds)
long	countRecords(ORemoteClientSession session)
OBinaryPushRequest	createPush(byte type)
boolean	dropCluster(ORemoteClientSession session, int iClusterId)
boolean	dropCluster(ORemoteClientSession session, String iClusterName)
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, Object[] args)
ORemoteQueryResult	execute(ODatabaseDocumentRemote db, String language, String query, Map args)
void	fetchNextPage(ODatabaseDocumentRemote db, ORemoteResultSet rs)
void	fetchTransaction(ODatabaseDocumentRemote db)
OPhysicalPosition[]	floorPhysicalPositions(ORemoteClientSession session, int clusterId, OPhysicalPosition physicalPosition)
OContextConfiguration	getClientConfiguration()
ODocument	getClusterConfiguration()
long[]	getClusterDataRange(ORemoteClientSession session, int iClusterId)
int	getClusterIdByName(String iClusterName)
Collection<OCluster>	getClusterInstances()
int	getClusterMap()
String	getClusterName(ORemoteClientSession session, int clusterId)
String	getClusterNameById(int clusterId)
Set<String>	getClusterNames()
long	getClusterRecordsSizeById(int clusterId)
long	getClusterRecordsSizeByName(String clusterName)
int	getClusters()
OCurrentStorageComponentsFactory	getComponentsFactory()
OStorageConfiguration	getConfiguration()
OrientDBInternal	getContext()
protected String	getCurrentServerURL(ORemoteClientSession session)
int	getDefaultClusterId()
Map<Integer,OLiveQueryClientListener>	getLiveQueryListener()
String	getName()
OChannelBinaryAsynchClient	getNetwork(String iCurrentURL)
static OChannelBinaryAsynchClient	getNetwork(String iCurrentURL, ORemoteConnectionManager connectionManager, OContextConfiguration config)
protected String	getNextAvailableServerURL(boolean iIsConnectOperation, ORemoteClientSession session)
String	getPhysicalClusterNameById(int iClusterId)
ORecordConflictStrategy	getRecordConflictStrategy()
ORecordMetadata	getRecordMetadata(ORemoteClientSession session, ORID rid)
ORemoteURLs	getRemoteURLs()
OSBTreeCollectionManager	getSBtreeCollectionManager()
String	getServerURL(ORemoteClientSession session)
List<String>	getServerURLs()
int	getSessionId(ORemoteClientSession session)
long	getSize(ORemoteClientSession session)
OStorage.STATUS	getStatus()
String	getType()
String	getURL()
String	getUserName(ORemoteClientSession session)
int	getUsers()
OPhysicalPosition[]	higherPhysicalPositions(ORemoteClientSession session, int iClusterId, OPhysicalPosition iClusterPosition)
void	importDatabase(ORemoteClientSession session, String options, InputStream inputStream, String name, OCommandOutputListener listener)
String	incrementalBackup(ORemoteClientSession session, String backupDirectory, OCallable<Void,Void> started)
void	initPush(ORemoteClientSession session, OMetadataPushListener handler)
boolean	isAssigningClusterIds()
boolean	isClosed(ORemoteClientSession session)
boolean	isDistributed()
boolean	isRemote()
OLiveQueryMonitor	liveQuery(ODatabaseDocumentRemote db, String query, OLiveQueryClientListener listener, Object[] params)
OLiveQueryMonitor	liveQuery(ODatabaseDocumentRemote db, String query, OLiveQueryClientListener listener, Map<String,?> params)
OLockRecordResponse	lockRecord(ORemoteClientSession session, OIdentifiable iRecord, OStorage.LOCKING_STRATEGY lockingStrategy, long timeout)
OPhysicalPosition[]	lowerPhysicalPositions(ORemoteClientSession session, int iClusterId, OPhysicalPosition physicalPosition)
<T extends OBinaryResponse> T	networkOperation(ORemoteClientSession session, OBinaryRequest<T> request, String errorMessage)
<T extends OBinaryResponse> T	networkOperationNoRetry(ORemoteClientSession session, OBinaryRequest<T> request, String errorMessage)
<T extends OBinaryResponse> T	networkOperationRetryTimeout(ORemoteClientSession baseSession, OBinaryRequest<T> request, String errorMessage, int retry, int timeout)
ORemoteClientSession	newInitialSession()
int	nextInitialSessionId()
void	onPushDisconnect(OChannelBinary network, Exception e)
void	onPushReconnect(String host)
void	open(ORemoteClientSession session, String iUserName, String iUserPassword, OContextConfiguration conf)
protected void	openRemoteDatabase(ORemoteClientSession session)
void	openRemoteDatabase(ORemoteClientSession session, OChannelBinaryAsynchClient network)
protected void	openRemoteDatabase(ORemoteClientSession session, String currentURL)
static HashMap<String,Object>	paramsArrayToParamsMap(Object[] positionalParams)
ORemoteQueryResult	query(ODatabaseDocumentRemote db, String query, Object[] args)
ORemoteQueryResult	query(ODatabaseDocumentRemote db, String query, Map args)
ORawBuffer	readRecord(ORemoteClientSession session, ORecordId iRid, String iFetchPlan, boolean iIgnoreCache, boolean prefetchRecords)
ORawBuffer	readRecordIfVersionIsNotLatest(ORemoteClientSession session, ORecordId rid, String fetchPlan, boolean ignoreCache, int recordVersion)
void	reBeginTransaction(ORemoteClientSession session, OTransactionOptimistic transaction)
void	registerLiveListener(int monitorId, OLiveQueryClientListener listener)
void	reload(ORemoteClientSession session)
void	removeClusterFromConfiguration(int iClusterId)
int	removeUser()
protected String	reopenRemoteDatabase(ORemoteClientSession session)
void	returnSocket(OChannelBinary network)
void	rollback(ORemoteClientSession session, OTransactionInternal iTx)
void	setConflictStrategy(ORecordConflictStrategy strategy)
void	setDefaultClusterId(int defaultClusterId)
void	shutdown()
void	stickToSession(ORemoteClientSession session)
void	unlockRecord(ORemoteClientSession session, OIdentifiable iRecord)
void	unstickToSession(ORemoteClientSession session)
void	unsubscribeLive(ORemoteClientSession session, int monitorId)
void	updateStorageConfiguration(OStorageConfigurationPayload updatedConfiguration)
void	updateStorageConfiguration(OStorageConfiguration storageConfiguration)
protected String	useNewServerURL(ORemoteClientSession session, String iUrl)

Methods inherited from class java.lang.Object

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

Field Details

DRIVER_NAME

public static final String DRIVER_NAME

See Also:

• Constant Field Values

connectionManager

public final ORemoteConnectionManager connectionManager

context

protected final OrientDBRemote context

url

protected final String url

stateLock

protected final ReentrantReadWriteLock stateLock

configuration

protected volatile OStorageConfiguration configuration

componentsFactory

protected volatile OCurrentStorageComponentsFactory componentsFactory

name

protected final String name

status

protected volatile OStorage.STATUS status

TYPE

public static final String TYPE

See Also:

• Constant Field Values

ADDRESS_SEPARATOR

public static final String ADDRESS_SEPARATOR

See Also:

• Constant Field Values

Constructor Details

ORemoteClient

public ORemoteClient(ORemoteURLs hosts,
 String name,
 OrientDBRemote context,
 ORemoteConnectionManager connectionManager,
 OContextConfiguration config)

ORemoteClient

public ORemoteClient(ORemoteURLs hosts,
 String name,
 OrientDBRemote context,
 ORemoteConnectionManager connectionManager,
 OStorage.STATUS status,
 OContextConfiguration config)

Method Details

getConfiguration

public OStorageConfiguration getConfiguration()

Specified by:

getConfiguration in interface OStorageInfo

checkForRecordValidity

public boolean checkForRecordValidity(OPhysicalPosition ppos)

getName

public String getName()

Specified by:

getName in interface OStorageInfo

networkOperationRetryTimeout

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

networkOperationNoRetry

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

networkOperation

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

baseNetworkOperation

public <T> T baseNetworkOperation(ORemoteClientSession session,
 ORemoteClientOperation<T> operation,
 String errorMessage,
 int retry)

isAssigningClusterIds

public boolean isAssigningClusterIds()

Specified by:

isAssigningClusterIds in interface OStorageInfo

getSessionId

public int getSessionId(ORemoteClientSession session)

getServerURL

public String getServerURL(ORemoteClientSession session)

open

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

getSBtreeCollectionManager

public OSBTreeCollectionManager getSBtreeCollectionManager()

reload

public void reload(ORemoteClientSession session)

close

public void close(ORemoteClientSession session,
 boolean iForce)

shutdown

public void shutdown()

getUsers

public int getUsers()

addUser

public int addUser()

removeUser

public int removeUser()

getClusterNames

public Set<String> getClusterNames()

Specified by:

getClusterNames in interface OStorageInfo

getRecordMetadata

public ORecordMetadata getRecordMetadata(ORemoteClientSession session,
 ORID rid)

readRecordIfVersionIsNotLatest

public ORawBuffer readRecordIfVersionIsNotLatest(ORemoteClientSession session,
 ORecordId rid,
 String fetchPlan,
 boolean ignoreCache,
 int recordVersion)
                                          throws ORecordNotFoundException

Throws:

ORecordNotFoundException

readRecord

public ORawBuffer readRecord(ORemoteClientSession session,
 ORecordId iRid,
 String iFetchPlan,
 boolean iIgnoreCache,
 boolean prefetchRecords)

incrementalBackup

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

getClientConfiguration

public OContextConfiguration getClientConfiguration()

count

public long count(ORemoteClientSession session,
 int iClusterId)

getClusterDataRange

public long[] getClusterDataRange(ORemoteClientSession session,
 int iClusterId)

higherPhysicalPositions

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

ceilingPhysicalPositions

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

lowerPhysicalPositions

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

floorPhysicalPositions

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

getSize

public long getSize(ORemoteClientSession session)

countRecords

public long countRecords(ORemoteClientSession session)

count

public long count(ORemoteClientSession session,
 int[] iClusterIds)

stickToSession

public void stickToSession(ORemoteClientSession session)

unstickToSession

public void unstickToSession(ORemoteClientSession session)

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 db,
 String queryId)

fetchNextPage

public void fetchNextPage(ODatabaseDocumentRemote db,
 ORemoteResultSet rs)

commit

public List<ORecordOperation> commit(ODatabaseDocumentRemote db,
 OTransactionInternal iTx)

rollback

public void rollback(ORemoteClientSession session,
 OTransactionInternal iTx)

getClusterIdByName

public int getClusterIdByName(String iClusterName)

Specified by:

getClusterIdByName in interface OStorageInfo

getDefaultClusterId

public int getDefaultClusterId()

Specified by:

getDefaultClusterId in interface OStorageInfo

setDefaultClusterId

public void setDefaultClusterId(int defaultClusterId)

addCluster

public int addCluster(ORemoteClientSession session,
 String iClusterName,
 Object... iArguments)

addCluster

public int addCluster(ORemoteClientSession session,
 String iClusterName,
 int iRequestedId)

getClusterNameById

public String getClusterNameById(int clusterId)

getClusterRecordsSizeById

public long getClusterRecordsSizeById(int clusterId)

getClusterRecordsSizeByName

public long getClusterRecordsSizeByName(String clusterName)

dropCluster

public boolean dropCluster(ORemoteClientSession session,
 int iClusterId)

getClusterName

public String getClusterName(ORemoteClientSession session,
 int clusterId)

removeClusterFromConfiguration

public void removeClusterFromConfiguration(int iClusterId)

getPhysicalClusterNameById

public String getPhysicalClusterNameById(int iClusterId)

Specified by:

getPhysicalClusterNameById in interface OStorageInfo

getClusterMap

public int getClusterMap()

getClusterInstances

public Collection<OCluster> getClusterInstances()

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

getURL

public String getURL()

Specified by:

getURL in interface OStorageInfo

getClusters

public int getClusters()

Specified by:

getClusters in interface OStorageInfo

getType

public String getType()

Specified by:

getType in interface OStorageInfo

getUserName

public String getUserName(ORemoteClientSession session)

reopenRemoteDatabase

protected String reopenRemoteDatabase(ORemoteClientSession session)
                               throws IOException

Throws:

IOException

openRemoteDatabase

protected void openRemoteDatabase(ORemoteClientSession session)
                           throws IOException

Throws:

IOException

openRemoteDatabase

public void openRemoteDatabase(ORemoteClientSession session,
 OChannelBinaryAsynchClient network)
                        throws IOException

Throws:

IOException

initPush

public void initPush(ORemoteClientSession session,
 OMetadataPushListener handler)

openRemoteDatabase

protected void openRemoteDatabase(ORemoteClientSession session,
 String currentURL)

useNewServerURL

protected String useNewServerURL(ORemoteClientSession session,
 String iUrl)

beginRequest

public OChannelBinaryAsynchClient beginRequest(OChannelBinaryAsynchClient network,
 byte iCommand,
 ORemoteClientSession 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,
 ORemoteClientSession session)

getCurrentServerURL

protected String getCurrentServerURL(ORemoteClientSession session)

getNetwork

public OChannelBinaryAsynchClient getNetwork(String iCurrentURL)

getNetwork

public static OChannelBinaryAsynchClient getNetwork(String iCurrentURL,
 ORemoteConnectionManager connectionManager,
 OContextConfiguration config)

beginResponse

public static void beginResponse(OChannelBinaryAsynchClient iNetwork,
 ORemoteClientSession session)
                          throws IOException

Throws:

IOException

updateStorageConfiguration

public void updateStorageConfiguration(OStorageConfigurationPayload updatedConfiguration)

updateStorageConfiguration

public void updateStorageConfiguration(OStorageConfiguration storageConfiguration)

nextInitialSessionId

public int nextInitialSessionId()

newInitialSession

public ORemoteClientSession newInitialSession()

isClosed

public boolean isClosed(ORemoteClientSession session)

copy

public ORemoteClient copy(ODatabaseDocumentRemote source,
 ODatabaseDocumentRemote dest)

importDatabase

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

addNewClusterToConfiguration

public void addNewClusterToConfiguration(int clusterId,
 String iClusterName)

beginTransaction

public void beginTransaction(ORemoteClientSession session,
 OTransactionOptimistic transaction)

reBeginTransaction

public void reBeginTransaction(ORemoteClientSession session,
 OTransactionOptimistic transaction)

fetchTransaction

public void fetchTransaction(ODatabaseDocumentRemote db)

createPush

public OBinaryPushRequest createPush(byte type)

liveQuery

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

liveQuery

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

unsubscribeLive

public void unsubscribeLive(ORemoteClientSession session,
 int monitorId)

registerLiveListener

public void registerLiveListener(int monitorId,
 OLiveQueryClientListener listener)

paramsArrayToParamsMap

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

onPushReconnect

public void onPushReconnect(String host)

onPushDisconnect

public void onPushDisconnect(OChannelBinary network,
 Exception e)

lockRecord

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

unlockRecord

public void unlockRecord(ORemoteClientSession session,
 OIdentifiable iRecord)

returnSocket

public void returnSocket(OChannelBinary network)

getServerURLs

public List<String> getServerURLs()

getRemoteURLs

public ORemoteURLs getRemoteURLs()

isDistributed

public boolean isDistributed()

getStatus

public OStorage.STATUS getStatus()

close

public void close(ORemoteClientSession session)

dropCluster

public boolean dropCluster(ORemoteClientSession session,
 String iClusterName)

getComponentsFactory

public OCurrentStorageComponentsFactory getComponentsFactory()

getContext

public OrientDBInternal getContext()

getRecordConflictStrategy

public ORecordConflictStrategy getRecordConflictStrategy()

Specified by:

getRecordConflictStrategy in interface OStorageInfo

setConflictStrategy

public void setConflictStrategy(ORecordConflictStrategy strategy)

getLiveQueryListener

public Map<Integer,OLiveQueryClientListener> getLiveQueryListener()