com.orientechnologies.orient.server.network.protocol.binary

Class ONetworkProtocolBinary

java.lang.Object

java.lang.Thread

com.orientechnologies.common.thread.OSoftThread

com.orientechnologies.orient.server.network.protocol.ONetworkProtocol

com.orientechnologies.orient.server.network.protocol.binary.ONetworkProtocolBinary

All Implemented Interfaces:

OService, Runnable

public class ONetworkProtocolBinary
extends ONetworkProtocol

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Thread

Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected OChannelBinary	channel
protected int	clientTxId
protected Level	logClientExceptions
protected boolean	logClientFullStackTrace
protected boolean	okSent
protected int	requestType

Fields inherited from class com.orientechnologies.orient.server.network.protocol.ONetworkProtocol

server

Fields inherited from class java.lang.Thread

MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors

Constructor and Description
ONetworkProtocolBinary()
ONetworkProtocolBinary(String iThreadName)

Method Summary

Modifier and Type	Method and Description
protected void	addCluster(OClientConnection connection)
protected void	afterOperationRequest(OClientConnection connection)
protected void	beginResponse()
protected void	checkServerAccess(String iResource, OClientConnection connection)
protected void	checkStorageExistence(String iDatabaseName)
protected void	cleanOutRecord(OClientConnection connection)
protected int	cleanOutRecord(ODatabaseDocument iDatabase, ORID rid, int version)
protected void	closeDatabase(OClientConnection connection)
protected void	command(OClientConnection connection)
protected void	commit(OClientConnection connection)
void	config(OServerNetworkListener iListener, OServer iServer, Socket iSocket, OContextConfiguration iConfig)
protected void	configGet(OClientConnection connection)
protected void	configList(OClientConnection connection)
protected void	configSet(OClientConnection connection)
protected void	connect(OClientConnection connection)
protected void	countClusters(OClientConnection connection)
protected void	countDatabaseRecords(OClientConnection connection)
protected void	createDatabase(OClientConnection connection)
protected ODatabaseDocumentInternal	createDatabase(ODatabaseDocumentInternal iDatabase, String dbUser, String dbPasswd, String backupPath)
protected void	createRecord(OClientConnection connection)
protected ORecord	createRecord(OClientConnection connection, ORecordId rid, byte[] buffer, byte recordType)
protected void	deleteRecord(OClientConnection connection)
protected int	deleteRecord(ODatabaseDocument iDatabase, ORID rid, int version)
protected void	distributedCluster(OClientConnection connection)
protected void	dropDatabase(OClientConnection connection)
protected void	endResponse(OClientConnection connection)
protected void	execute()
protected boolean	executeRequest(OClientConnection connection)
protected void	existsDatabase(OClientConnection connection)
void	fillRecord(OClientConnection connection, ORecordId rid, byte[] buffer, int version, ORecord record)
protected void	freezeDatabase(OClientConnection connection)
OChannelBinary	getChannel()
protected ODatabaseDocumentInternal	getDatabaseInstance(String dbName, String dbType, String storageType) Returns a database instance giving the database name, the database type and storage type.
byte[]	getRecordBytes(OClientConnection connection, ORecord iRecord)
String	getRecordSerializerName(OClientConnection connection)
String	getRemoteAddress()
int	getRequestType()
String	getType()
int	getVersion()
protected void	handleConnectionError(OClientConnection connection, Throwable e)
protected void	hideRecord(OClientConnection connection)
protected int	hideRecord(ODatabaseDocument iDatabase, ORID rid)
void	importDatabase(OClientConnection connection)
void	initVariables(OServer server, OChannelBinaryServer channel) Internal varialbe injection useful for testing.
protected void	openDatabase(OClientConnection connection)
protected void	rangeCluster(OClientConnection connection)
protected void	readConnectionData(OClientConnection connection)
protected void	readRecord(OClientConnection connection)
protected void	readRecordIfVersionIsNotLatest(OClientConnection connection)
protected void	readRecordMetadata(OClientConnection connection)
protected void	releaseDatabase(OClientConnection connection)
protected void	reloadDatabase(OClientConnection connection)
protected void	removeCluster(OClientConnection connection)
protected void	sendError(OClientConnection connection, int iClientTxId, Throwable t)
protected void	sendErrorOrDropConnection(OClientConnection connection, int iClientTxId, Throwable t)
protected void	sendOk(OClientConnection connection, int iClientTxId)
protected void	sendResponse(OClientConnection connection, ODocument iResponse)
void	sendShutdown()
void	serializeValue(OClientConnection connection, OAbstractCommandResultListener listener, Object result, boolean load, boolean isRecordResultSet)
protected void	setDataCommandInfo(OClientConnection connection, String iCommandInfo)
void	shutdown()
protected void	shutdownConnection(OClientConnection connection)
protected void	sizeDatabase(OClientConnection connection)
void	startup()
protected int	trimCsvSerializedContent(OClientConnection connection, byte[] stream)
protected void	updateRecord(OClientConnection connection) VERSION MANAGEMENT: -1 : DOCUMENT UPDATE, NO VERSION CONTROL -2 : DOCUMENT UPDATE, NO VERSION CONTROL, NO VERSION INCREMENT -3 : DOCUMENT ROLLBACK, DECREMENT VERSION >-1 : MVCC CONTROL, RECORD UPDATE AND VERSION INCREMENT <-3 : WRONG VERSION VALUE
protected int	updateRecord(OClientConnection connection, ORecordId rid, byte[] buffer, int version, byte recordType, boolean updateContent)
void	writeIdentifiable(OClientConnection connection, OIdentifiable o) Write a OIdentifiable instance using this format: - 2 bytes: class id [-2=no record, -3=rid, -1=no class id, > -1 = valid] - 1 byte: record type [d,b,f] - 2 bytes: cluster id - 8 bytes: position in cluster - 4 bytes: record version - x bytes: record content

Methods inherited from class com.orientechnologies.orient.server.network.protocol.ONetworkProtocol

getListeningAddress, getServer

Methods inherited from class com.orientechnologies.common.thread.OSoftThread

afterExecution, beforeExecution, isDumpExceptions, isShutdownFlag, pauseCurrentThread, run, setDumpExceptions, softShutdown

Methods inherited from class java.lang.Thread

activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.common.util.OService

getName

Field Detail

logClientExceptions

protected final Level logClientExceptions

logClientFullStackTrace

protected final boolean logClientFullStackTrace

channel

protected OChannelBinary channel

requestType

protected volatile int requestType

clientTxId

protected int clientTxId

okSent

protected boolean okSent

Constructor Detail

ONetworkProtocolBinary

public ONetworkProtocolBinary()

ONetworkProtocolBinary

public ONetworkProtocolBinary(String iThreadName)

Method Detail

initVariables

public void initVariables(OServer server,
                          OChannelBinaryServer channel)

Internal varialbe injection useful for testing.

sendShutdown

public void sendShutdown()

Overrides:

sendShutdown in class OSoftThread

config

public void config(OServerNetworkListener iListener,
                   OServer iServer,
                   Socket iSocket,
                   OContextConfiguration iConfig)
            throws IOException

Specified by:

config in class ONetworkProtocol

Throws:

IOException

startup

public void startup()

Specified by:

startup in interface OService

Overrides:

startup in class OSoftThread

shutdown

public void shutdown()

Specified by:

shutdown in interface OService

Overrides:

shutdown in class OSoftThread

execute

protected void execute()
                throws Exception

Specified by:

execute in class OSoftThread

Throws:

Exception

afterOperationRequest

protected void afterOperationRequest(OClientConnection connection)
                              throws IOException

Throws:

IOException

executeRequest

protected boolean executeRequest(OClientConnection connection)
                          throws IOException

Throws:

IOException

checkServerAccess

protected void checkServerAccess(String iResource,
                                 OClientConnection connection)

removeCluster

protected void removeCluster(OClientConnection connection)
                      throws IOException

Throws:

IOException

addCluster

protected void addCluster(OClientConnection connection)
                   throws IOException

Throws:

IOException

rangeCluster

protected void rangeCluster(OClientConnection connection)
                     throws IOException

Throws:

IOException

countClusters

protected void countClusters(OClientConnection connection)
                      throws IOException

Throws:

IOException

reloadDatabase

protected void reloadDatabase(OClientConnection connection)
                       throws IOException

Throws:

IOException

openDatabase

protected void openDatabase(OClientConnection connection)
                     throws IOException

Throws:

IOException

connect

protected void connect(OClientConnection connection)
                throws IOException

Throws:

IOException

sendError

protected void sendError(OClientConnection connection,
                         int iClientTxId,
                         Throwable t)
                  throws IOException

Throws:

IOException

shutdownConnection

protected void shutdownConnection(OClientConnection connection)
                           throws IOException

Throws:

IOException

distributedCluster

protected void distributedCluster(OClientConnection connection)
                           throws IOException

Throws:

IOException

countDatabaseRecords

protected void countDatabaseRecords(OClientConnection connection)
                             throws IOException

Throws:

IOException

sizeDatabase

protected void sizeDatabase(OClientConnection connection)
                     throws IOException

Throws:

IOException

dropDatabase

protected void dropDatabase(OClientConnection connection)
                     throws IOException

Throws:

IOException

existsDatabase

protected void existsDatabase(OClientConnection connection)
                       throws IOException

Throws:

IOException

createDatabase

protected void createDatabase(OClientConnection connection)
                       throws IOException

Throws:

IOException

closeDatabase

protected void closeDatabase(OClientConnection connection)
                      throws IOException

Throws:

IOException

configList

protected void configList(OClientConnection connection)
                   throws IOException

Throws:

IOException

configSet

protected void configSet(OClientConnection connection)
                  throws IOException

Throws:

IOException

configGet

protected void configGet(OClientConnection connection)
                  throws IOException

Throws:

IOException

commit

protected void commit(OClientConnection connection)
               throws IOException

Throws:

IOException

command

protected void command(OClientConnection connection)
                throws IOException

Throws:

IOException

serializeValue

public void serializeValue(OClientConnection connection,
                           OAbstractCommandResultListener listener,
                           Object result,
                           boolean load,
                           boolean isRecordResultSet)
                    throws IOException

Throws:

IOException

deleteRecord

protected void deleteRecord(OClientConnection connection)
                     throws IOException

Throws:

IOException

hideRecord

protected void hideRecord(OClientConnection connection)
                   throws IOException

Throws:

IOException

cleanOutRecord

protected void cleanOutRecord(OClientConnection connection)
                       throws IOException

Throws:

IOException

updateRecord

protected void updateRecord(OClientConnection connection)
                     throws IOException

VERSION MANAGEMENT:
-1 : DOCUMENT UPDATE, NO VERSION CONTROL
-2 : DOCUMENT UPDATE, NO VERSION CONTROL, NO VERSION INCREMENT
-3 : DOCUMENT ROLLBACK, DECREMENT VERSION
>-1 : MVCC CONTROL, RECORD UPDATE AND VERSION INCREMENT
<-3 : WRONG VERSION VALUE

Throws:

IOException

createRecord

protected void createRecord(OClientConnection connection)
                     throws IOException

Throws:

IOException

readRecordMetadata

protected void readRecordMetadata(OClientConnection connection)
                           throws IOException

Throws:

IOException

readRecord

protected void readRecord(OClientConnection connection)
                   throws IOException

Throws:

IOException

readRecordIfVersionIsNotLatest

protected void readRecordIfVersionIsNotLatest(OClientConnection connection)
                                       throws IOException

Throws:

IOException

beginResponse

protected void beginResponse()

endResponse

protected void endResponse(OClientConnection connection)
                    throws IOException

Throws:

IOException

setDataCommandInfo

protected void setDataCommandInfo(OClientConnection connection,
                                  String iCommandInfo)

readConnectionData

protected void readConnectionData(OClientConnection connection)
                           throws IOException

Throws:

IOException

sendOk

protected void sendOk(OClientConnection connection,
                      int iClientTxId)
               throws IOException

Throws:

IOException

handleConnectionError

protected void handleConnectionError(OClientConnection connection,
                                     Throwable e)

sendResponse

protected void sendResponse(OClientConnection connection,
                            ODocument iResponse)
                     throws IOException

Throws:

IOException

freezeDatabase

protected void freezeDatabase(OClientConnection connection)
                       throws IOException

Throws:

IOException

releaseDatabase

protected void releaseDatabase(OClientConnection connection)
                        throws IOException

Throws:

IOException

getRecordSerializerName

public String getRecordSerializerName(OClientConnection connection)

getVersion

public int getVersion()

Specified by:

getVersion in class ONetworkProtocol

getChannel

public OChannelBinary getChannel()

Specified by:

getChannel in class ONetworkProtocol

writeIdentifiable

public void writeIdentifiable(OClientConnection connection,
                              OIdentifiable o)
                       throws IOException

Write a OIdentifiable instance using this format:
- 2 bytes: class id [-2=no record, -3=rid, -1=no class id, > -1 = valid]
- 1 byte: record type [d,b,f]
- 2 bytes: cluster id
- 8 bytes: position in cluster
- 4 bytes: record version
- x bytes: record content

Throws:

IOException

getType

public String getType()

Specified by:

getType in class ONetworkProtocol

fillRecord

public void fillRecord(OClientConnection connection,
                       ORecordId rid,
                       byte[] buffer,
                       int version,
                       ORecord record)

sendErrorOrDropConnection

protected void sendErrorOrDropConnection(OClientConnection connection,
                                         int iClientTxId,
                                         Throwable t)
                                  throws IOException

Throws:

IOException

checkStorageExistence

protected void checkStorageExistence(String iDatabaseName)

createDatabase

protected ODatabaseDocumentInternal createDatabase(ODatabaseDocumentInternal iDatabase,
                                                   String dbUser,
                                                   String dbPasswd,
                                                   String backupPath)

getDatabaseInstance

protected ODatabaseDocumentInternal getDatabaseInstance(String dbName,
                                                        String dbType,
                                                        String storageType)

Returns a database instance giving the database name, the database type and storage type.

Parameters:

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

deleteRecord

protected int deleteRecord(ODatabaseDocument iDatabase,
                           ORID rid,
                           int version)

hideRecord

protected int hideRecord(ODatabaseDocument iDatabase,
                         ORID rid)

cleanOutRecord

protected int cleanOutRecord(ODatabaseDocument iDatabase,
                             ORID rid,
                             int version)

createRecord

protected ORecord createRecord(OClientConnection connection,
                               ORecordId rid,
                               byte[] buffer,
                               byte recordType)

updateRecord

protected int updateRecord(OClientConnection connection,
                           ORecordId rid,
                           byte[] buffer,
                           int version,
                           byte recordType,
                           boolean updateContent)

getRecordBytes

public byte[] getRecordBytes(OClientConnection connection,
                             ORecord iRecord)

trimCsvSerializedContent

protected int trimCsvSerializedContent(OClientConnection connection,
                                       byte[] stream)

getRequestType

public int getRequestType()

getRemoteAddress

public String getRemoteAddress()

importDatabase

public void importDatabase(OClientConnection connection)
                    throws IOException

Throws:

IOException