com.orientechnologies.security.auditing

Class ODefaultAuditing

java.lang.Object

com.orientechnologies.security.auditing.ODefaultAuditing

All Implemented Interfaces:

ODatabaseLifecycleListener, ODistributedLifecycleListener, OAuditingService, OSecurityComponent

public class ODefaultAuditing
extends Object
implements OAuditingService, ODatabaseLifecycleListener, ODistributedLifecycleListener

Created by Enrico Risa on 10/04/15.

Nested Class Summary

Nested classes/interfaces inherited from interface com.orientechnologies.orient.core.db.ODatabaseLifecycleListener

ODatabaseLifecycleListener.PRIORITY

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUDITING_LOG_CLASSNAME
protected static String	DEFAULT_FILE_AUDITING_DB_CONFIG
protected static String	FILE_AUDITING_DB_CONFIG
static String	IMPORTER_FLAG

Constructor Summary

Constructors

Constructor and Description
ODefaultAuditing()

Method Summary

Modifier and Type	Method and Description
void	active()
void	changeConfig(OSecurityUser user, String iDatabaseName, ODocument cfg)
void	config(OServer oServer, OServerConfigurationManager serverCfg, ODocument jsonConfig)
void	dispose()
static String	getClassName(String dbName)
static String	getClusterName(String dbName) Deprecated.
ODocument	getConfig(String iDatabaseName)
ODatabaseLifecycleListener.PRIORITY	getPriority()
String	getString(InputStream is)
boolean	isEnabled()
void	log(OAuditingOperation operation, OSecurityUser user, String message) Primarily used for global logging events (e.g., NODEJOINED, NODELEFT).
void	log(OAuditingOperation operation, String message) Primarily used for global logging events (e.g., NODEJOINED, NODELEFT).
void	log(OAuditingOperation operation, String dbName, OSecurityUser user, String message) Primarily used for global logging events (e.g., NODEJOINED, NODELEFT).
void	onClose(ODatabaseInternal iDatabase)
void	onCreate(ODatabaseInternal iDatabase)
void	onCreateClass(ODatabaseInternal iDatabase, OClass iClass)
void	onDatabaseChangeStatus(String iNode, String iDatabaseName, ODistributedServerManager.DB_STATUS iNewStatus) Called upon change of database status on a node.
void	onDrop(ODatabaseInternal iDatabase)
void	onDropClass(ODatabaseInternal iDatabase, OClass iClass)
void	onLocalNodeConfigurationRequest(ODocument iConfiguration) Event called during the retrieving of distributed configuration, usually at startup and when the cluster shape changes.
void	onNodeJoined(String iNode) Called right after a node joined the cluster.
boolean	onNodeJoining(String iNode) Called when a node is joining the cluster.
void	onNodeLeft(String iNode) Called right after a node left the cluster.
void	onOpen(ODatabaseInternal iDatabase)
void	retainLogs()
void	retainLogs(Date date)
protected void	updateConfigOnDisk(String iDatabaseName, ODocument cfg)

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.ODatabaseLifecycleListener

onCreateView, onDropView

Methods inherited from interface com.orientechnologies.orient.server.distributed.ODistributedLifecycleListener

onMessageAfterOp, onMessageBeforeOp, onMessageCurrentPayload, onMessagePartitionCalculated, onMessageProcessEnd, onMessageProcessStart, onMessageReceived

Field Detail

AUDITING_LOG_CLASSNAME

public static final String AUDITING_LOG_CLASSNAME

See Also:

Constant Field Values

DEFAULT_FILE_AUDITING_DB_CONFIG

protected static final String DEFAULT_FILE_AUDITING_DB_CONFIG

See Also:

Constant Field Values

FILE_AUDITING_DB_CONFIG

protected static final String FILE_AUDITING_DB_CONFIG

See Also:

Constant Field Values

IMPORTER_FLAG

public static final String IMPORTER_FLAG

See Also:

Constant Field Values

Constructor Detail

ODefaultAuditing

public ODefaultAuditing()

Method Detail

getPriority

public ODatabaseLifecycleListener.PRIORITY getPriority()

Specified by:

getPriority in interface ODatabaseLifecycleListener

onCreate

public void onCreate(ODatabaseInternal iDatabase)

Specified by:

onCreate in interface ODatabaseLifecycleListener

getString

public String getString(InputStream is)

onOpen

public void onOpen(ODatabaseInternal iDatabase)

Specified by:

onOpen in interface ODatabaseLifecycleListener

onClose

public void onClose(ODatabaseInternal iDatabase)

Specified by:

onClose in interface ODatabaseLifecycleListener

onDrop

public void onDrop(ODatabaseInternal iDatabase)

Specified by:

onDrop in interface ODatabaseLifecycleListener

onCreateClass

public void onCreateClass(ODatabaseInternal iDatabase,
                          OClass iClass)

Specified by:

onCreateClass in interface ODatabaseLifecycleListener

onDropClass

public void onDropClass(ODatabaseInternal iDatabase,
                        OClass iClass)

Specified by:

onDropClass in interface ODatabaseLifecycleListener

onLocalNodeConfigurationRequest

public void onLocalNodeConfigurationRequest(ODocument iConfiguration)

Description copied from interface: ODatabaseLifecycleListener

Event called during the retrieving of distributed configuration, usually at startup and when the cluster shape changes. You can use this event to enrich the ODocument sent to the client with custom properties.

Specified by:

onLocalNodeConfigurationRequest in interface ODatabaseLifecycleListener

updateConfigOnDisk

protected void updateConfigOnDisk(String iDatabaseName,
                                  ODocument cfg)
                           throws IOException

Throws:

IOException

onNodeJoining

public boolean onNodeJoining(String iNode)

Description copied from interface: ODistributedLifecycleListener

Called when a node is joining the cluster. Return false to deny the join.

Specified by:

onNodeJoining in interface ODistributedLifecycleListener

Parameters:

iNode - Node name that is joining

Returns:

true to allow the join, otherwise false

onNodeJoined

public void onNodeJoined(String iNode)

Description copied from interface: ODistributedLifecycleListener

Called right after a node joined the cluster.

Specified by:

onNodeJoined in interface ODistributedLifecycleListener

Parameters:

iNode - Node name that is joining

onNodeLeft

public void onNodeLeft(String iNode)

Description copied from interface: ODistributedLifecycleListener

Called right after a node left the cluster.

Specified by:

onNodeLeft in interface ODistributedLifecycleListener

Parameters:

iNode - Node name that left

onDatabaseChangeStatus

public void onDatabaseChangeStatus(String iNode,
                                   String iDatabaseName,
                                   ODistributedServerManager.DB_STATUS iNewStatus)

Description copied from interface: ODistributedLifecycleListener

Called upon change of database status on a node. Available statuses are defined in ODistributedServerManager.DB_STATUS.

Specified by:

onDatabaseChangeStatus in interface ODistributedLifecycleListener

Parameters:

iNode - The node name

iDatabaseName - Database name

iNewStatus - The new status

getClusterName

@Deprecated
public static String getClusterName(String dbName)

Deprecated.

getClassName

public static String getClassName(String dbName)

changeConfig

public void changeConfig(OSecurityUser user,
                         String iDatabaseName,
                         ODocument cfg)
                  throws IOException

Specified by:

changeConfig in interface OAuditingService

Throws:

IOException

getConfig

public ODocument getConfig(String iDatabaseName)

Specified by:

getConfig in interface OAuditingService

log

public void log(OAuditingOperation operation,
                String message)

Primarily used for global logging events (e.g., NODEJOINED, NODELEFT).

Specified by:

log in interface OAuditingService

log

public void log(OAuditingOperation operation,
                OSecurityUser user,
                String message)

Primarily used for global logging events (e.g., NODEJOINED, NODELEFT).

Specified by:

log in interface OAuditingService

log

public void log(OAuditingOperation operation,
                String dbName,
                OSecurityUser user,
                String message)

Primarily used for global logging events (e.g., NODEJOINED, NODELEFT).

Specified by:

log in interface OAuditingService

active

public void active()

Specified by:

active in interface OSecurityComponent

retainLogs

public void retainLogs()

retainLogs

public void retainLogs(Date date)

config

public void config(OServer oServer,
                   OServerConfigurationManager serverCfg,
                   ODocument jsonConfig)

Specified by:

config in interface OSecurityComponent

dispose

public void dispose()

Specified by:

dispose in interface OSecurityComponent

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface OSecurityComponent