Package org.apache.cassandra.audit

Class AuditLogManager

java.lang.Object

org.apache.cassandra.audit.AuditLogManager

All Implemented Interfaces:

AuditLogManagerMBean, AuthEvents.Listener, QueryEvents.Listener

public class AuditLogManager
extends Object
implements QueryEvents.Listener, AuthEvents.Listener, AuditLogManagerMBean

Central location for managing the logging of client/user-initated actions (like queries, log in commands, and so on).

Field Summary

Fields

Modifier and Type	Field	Description
static final AuditLogManager	instance
static final String	MBEAN_NAME

Method Summary

Modifier and Type	Method	Description
void	authFailure(QueryState state, Exception cause)
void	authSuccess(QueryState state)
void	batchFailure(BatchStatement.Type batchType, List<? extends CQLStatement> statements, List<String> queries, List<List<ByteBuffer>> values, QueryOptions options, QueryState state, Exception cause)
void	batchSuccess(BatchStatement.Type batchType, List<? extends CQLStatement> statements, List<String> queries, List<List<ByteBuffer>> values, QueryOptions options, QueryState state, long queryTime, Message.Response response)
void	disableAuditLog()	Disables AuditLog, designed to be invoked only via JMX/ Nodetool, not from anywhere else in the codepath.
void	enable(AuditLogOptions auditLogOptions)	Enables AuditLog, designed to be invoked only via JMX/ Nodetool, not from anywhere else in the codepath.
void	executeFailure(CQLStatement statement, String query, QueryOptions options, QueryState state, Exception cause)
void	executeSuccess(CQLStatement statement, String query, QueryOptions options, QueryState state, long queryTime, Message.Response response)
AuditLogOptions	getAuditLogOptions()
CompositeData	getAuditLogOptionsData()	Returns the current state of Audit Log framework.
IAuditLogger	getLogger()
void	initialize()
boolean	isEnabled()
void	prepareFailure(CQLStatement stmt, String query, QueryState state, Exception cause)
void	prepareSuccess(CQLStatement statement, String query, QueryState state, long queryTime, ResultMessage.Prepared response)
void	queryFailure(CQLStatement stmt, String query, QueryOptions options, QueryState state, Exception cause)
void	querySuccess(CQLStatement statement, String query, QueryOptions options, QueryState state, long queryTime, Message.Response response)

Methods inherited from class java.lang.Object

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

Field Details

MBEAN_NAME

public static final String MBEAN_NAME

See Also:

• Constant Field Values

instance

public static final AuditLogManager instance

Method Details

initialize

public void initialize()

getLogger

public IAuditLogger getLogger()

isEnabled

public boolean isEnabled()

getAuditLogOptions

public AuditLogOptions getAuditLogOptions()

getAuditLogOptionsData

public CompositeData getAuditLogOptionsData()

Description copied from interface: AuditLogManagerMBean

Returns the current state of Audit Log framework.

Specified by:

getAuditLogOptionsData in interface AuditLogManagerMBean

disableAuditLog

public void disableAuditLog()

Disables AuditLog, designed to be invoked only via JMX/ Nodetool, not from anywhere else in the codepath.

enable

public void enable(AuditLogOptions auditLogOptions)
            throws ConfigurationException

Enables AuditLog, designed to be invoked only via JMX/ Nodetool, not from anywhere else in the codepath.

Parameters:

auditLogOptions - AuditLogOptions to be used for enabling AuditLog

Throws:

ConfigurationException - It can throw configuration exception when provided logger class does not exist in the classpath

querySuccess

public void querySuccess(CQLStatement statement,
 String query,
 QueryOptions options,
 QueryState state,
 long queryTime,
 Message.Response response)

Specified by:

querySuccess in interface QueryEvents.Listener

queryFailure

public void queryFailure(CQLStatement stmt,
 String query,
 QueryOptions options,
 QueryState state,
 Exception cause)

Specified by:

queryFailure in interface QueryEvents.Listener

executeSuccess

public void executeSuccess(CQLStatement statement,
 String query,
 QueryOptions options,
 QueryState state,
 long queryTime,
 Message.Response response)

Specified by:

executeSuccess in interface QueryEvents.Listener

executeFailure

public void executeFailure(CQLStatement statement,
 String query,
 QueryOptions options,
 QueryState state,
 Exception cause)

Specified by:

executeFailure in interface QueryEvents.Listener

batchSuccess

public void batchSuccess(BatchStatement.Type batchType,
 List<? extends CQLStatement> statements,
 List<String> queries,
 List<List<ByteBuffer>> values,
 QueryOptions options,
 QueryState state,
 long queryTime,
 Message.Response response)

Specified by:

batchSuccess in interface QueryEvents.Listener

batchFailure

public void batchFailure(BatchStatement.Type batchType,
 List<? extends CQLStatement> statements,
 List<String> queries,
 List<List<ByteBuffer>> values,
 QueryOptions options,
 QueryState state,
 Exception cause)

Specified by:

batchFailure in interface QueryEvents.Listener

prepareSuccess

public void prepareSuccess(CQLStatement statement,
 String query,
 QueryState state,
 long queryTime,
 ResultMessage.Prepared response)

Specified by:

prepareSuccess in interface QueryEvents.Listener

prepareFailure

public void prepareFailure(@Nullable
 CQLStatement stmt,
 @Nullable
 String query,
 QueryState state,
 Exception cause)

Specified by:

prepareFailure in interface QueryEvents.Listener

authSuccess

public void authSuccess(QueryState state)

Specified by:

authSuccess in interface AuthEvents.Listener

authFailure

public void authFailure(QueryState state,
 Exception cause)

Specified by:

authFailure in interface AuthEvents.Listener