com.orientechnologies.security.auditing

Class OAuditingHook

java.lang.Object

com.orientechnologies.orient.core.hook.ORecordHookAbstract

com.orientechnologies.security.auditing.OAuditingHook

All Implemented Interfaces:

ODatabaseListener, ORecordHook

public class OAuditingHook
extends ORecordHookAbstract
implements ODatabaseListener

Hook to audit database access.

Author:

Luca Garulli

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.hook.ORecordHook

ORecordHook.DISTRIBUTED_EXECUTION_MODE, ORecordHook.HOOK_POSITION, ORecordHook.RESULT, ORecordHook.SCOPE, ORecordHook.TYPE

Constructor Summary

Constructors

Constructor and Description
OAuditingHook(ODocument iConfiguration)
OAuditingHook(ODocument iConfiguration, OServer server)
OAuditingHook(OServer server)
OAuditingHook(String iConfiguration)
OAuditingHook(String iConfiguration, OServer server)

Method Summary

Modifier and Type	Method and Description
ODocument	getConfiguration()
ORecordHook.DISTRIBUTED_EXECUTION_MODE	getDistributedExecutionMode()
protected void	log(OAuditingOperation operation, ORecord iRecord)
void	log(OAuditingOperation operation, String dbName, String username, String message)
protected void	logClass(OAuditingOperation operation, OClass cls)
protected void	logClass(OAuditingOperation operation, String note)
protected void	logCommand(String command)
void	onAfterCommand(OCommandRequestText iCommand, OCommandExecutor executor, Object result)
void	onAfterTxCommit(ODatabase iDatabase)
void	onAfterTxRollback(ODatabase iDatabase)
void	onBeforeCommand(OCommandRequestText iCommand, OCommandExecutor executor)
void	onBeforeTxBegin(ODatabase iDatabase)
void	onBeforeTxCommit(ODatabase iDatabase)
void	onBeforeTxRollback(ODatabase iDatabase)
void	onClose(ODatabase iDatabase)
boolean	onCorruptionRepairDatabase(ODatabase iDatabase, String iReason, String iWhatWillbeFixed) Callback to decide if repair the database upon corruption.
void	onCreate(ODatabase iDatabase)
void	onCreateClass(OClass iClass)
void	onDelete(ODatabase iDatabase)
void	onDropClass(OClass iClass)
void	onOpen(ODatabase iDatabase)
void	onRecordAfterCreate(ORecord iRecord) It's called just after the iRecord is created.
void	onRecordAfterDelete(ORecord iRecord) It's called just after the iRecord is deleted.
void	onRecordAfterRead(ORecord iRecord) It's called just after the iRecord is read.
void	onRecordAfterUpdate(ORecord iRecord) It's called just after the iRecord is updated.
void	shutdown(boolean waitForAllLogs)

Methods inherited from class com.orientechnologies.orient.core.hook.ORecordHookAbstract

onRecordAfterReplicaAdd, onRecordAfterReplicaDelete, onRecordAfterReplicaUpdate, onRecordBeforeCreate, onRecordBeforeDelete, onRecordBeforeRead, onRecordBeforeReplicaAdd, onRecordBeforeReplicaDelete, onRecordBeforeReplicaUpdate, onRecordBeforeUpdate, onRecordCreateFailed, onRecordCreateReplicated, onRecordDeleteFailed, onRecordDeleteReplicated, onRecordFinalizeCreation, onRecordFinalizeDeletion, onRecordFinalizeUpdate, onRecordReadFailed, onRecordReadReplicated, onRecordReplicaAddFailed, onRecordReplicaDeleteFailed, onRecordReplicaUpdateFailed, onRecordUpdateFailed, onRecordUpdateReplicated, onTrigger, onUnregister

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.orientechnologies.orient.core.db.ODatabaseListener

onCommandEnd, onCommandStart, onCreateClass, onDropClass

Methods inherited from interface com.orientechnologies.orient.core.hook.ORecordHook

getScopes

Constructor Detail

OAuditingHook

public OAuditingHook(String iConfiguration)

OAuditingHook

public OAuditingHook(String iConfiguration,
                     OServer server)

OAuditingHook

public OAuditingHook(ODocument iConfiguration)

OAuditingHook

public OAuditingHook(ODocument iConfiguration,
                     OServer server)

OAuditingHook

public OAuditingHook(OServer server)

Method Detail

onCreate

public void onCreate(ODatabase iDatabase)

Specified by:

onCreate in interface ODatabaseListener

onDelete

public void onDelete(ODatabase iDatabase)

Specified by:

onDelete in interface ODatabaseListener

onOpen

public void onOpen(ODatabase iDatabase)

Specified by:

onOpen in interface ODatabaseListener

onBeforeTxBegin

public void onBeforeTxBegin(ODatabase iDatabase)

Specified by:

onBeforeTxBegin in interface ODatabaseListener

onBeforeTxRollback

public void onBeforeTxRollback(ODatabase iDatabase)

Specified by:

onBeforeTxRollback in interface ODatabaseListener

onAfterTxRollback

public void onAfterTxRollback(ODatabase iDatabase)

Specified by:

onAfterTxRollback in interface ODatabaseListener

onBeforeTxCommit

public void onBeforeTxCommit(ODatabase iDatabase)

Specified by:

onBeforeTxCommit in interface ODatabaseListener

onAfterTxCommit

public void onAfterTxCommit(ODatabase iDatabase)

Specified by:

onAfterTxCommit in interface ODatabaseListener

onClose

public void onClose(ODatabase iDatabase)

Specified by:

onClose in interface ODatabaseListener

onBeforeCommand

public void onBeforeCommand(OCommandRequestText iCommand,
                            OCommandExecutor executor)

Specified by:

onBeforeCommand in interface ODatabaseListener

onAfterCommand

public void onAfterCommand(OCommandRequestText iCommand,
                           OCommandExecutor executor,
                           Object result)

Specified by:

onAfterCommand in interface ODatabaseListener

onCorruptionRepairDatabase

public boolean onCorruptionRepairDatabase(ODatabase iDatabase,
                                          String iReason,
                                          String iWhatWillbeFixed)

Description copied from interface: ODatabaseListener

Callback to decide if repair the database upon corruption.

Specified by:

onCorruptionRepairDatabase in interface ODatabaseListener

Parameters:

iDatabase - Target database

iReason - Reason of corruption

iWhatWillbeFixed - TODO

Returns:

true if repair must be done, otherwise false

getConfiguration

public ODocument getConfiguration()

onRecordAfterCreate

public void onRecordAfterCreate(ORecord iRecord)

Description copied from class: ORecordHookAbstract

It's called just after the iRecord is created.

Overrides:

onRecordAfterCreate in class ORecordHookAbstract

Parameters:

iRecord - The iRecord just created

onRecordAfterRead

public void onRecordAfterRead(ORecord iRecord)

Description copied from class: ORecordHookAbstract

It's called just after the iRecord is read.

Overrides:

onRecordAfterRead in class ORecordHookAbstract

Parameters:

iRecord - The iRecord just read

onRecordAfterUpdate

public void onRecordAfterUpdate(ORecord iRecord)

Description copied from class: ORecordHookAbstract

It's called just after the iRecord is updated.

Overrides:

onRecordAfterUpdate in class ORecordHookAbstract

Parameters:

iRecord - The iRecord just updated

onRecordAfterDelete

public void onRecordAfterDelete(ORecord iRecord)

Description copied from class: ORecordHookAbstract

It's called just after the iRecord is deleted.

Overrides:

onRecordAfterDelete in class ORecordHookAbstract

Parameters:

iRecord - The iRecord just deleted

getDistributedExecutionMode

public ORecordHook.DISTRIBUTED_EXECUTION_MODE getDistributedExecutionMode()

Specified by:

getDistributedExecutionMode in interface ORecordHook

logCommand

protected void logCommand(String command)

log

protected void log(OAuditingOperation operation,
                   ORecord iRecord)

shutdown

public void shutdown(boolean waitForAllLogs)

logClass

protected void logClass(OAuditingOperation operation,
                        String note)

logClass

protected void logClass(OAuditingOperation operation,
                        OClass cls)

onCreateClass

public void onCreateClass(OClass iClass)

onDropClass

public void onDropClass(OClass iClass)

log

public void log(OAuditingOperation operation,
                String dbName,
                String username,
                String message)