com.sap.cloud.sdk.cloudplatform.auditlog

Interface AuditLog

All Known Implementing Classes:

DefaultLoggerAuditLog, ScpCfAuditLog, ScpNeoAuditLog

public interface AuditLog

Interface for audit logging.

Important: For performance reasons, use only efficiently for logging of relevant events. The logging methods allow to log:

• security relevant events,
• read access to sensitive personal data,
• changes to configuration data,
• and changes to personal data.

Method Summary

Modifier and Type	Method and Description
void	logConfigChange(AccessRequester initiator, AuditedDataObject object, Iterable<AccessedAttribute> attributesAffected, Throwable error) Logs the change of some attributes of configuration data.
void	logConfigChangeBeginning(AccessRequester initiator, AuditedDataObject object, Iterable<AccessedAttribute> attributesAffected) Logs the start of a change of some attributes of configuration data.
void	logDataRead(AccessRequester initiator, AuditedDataObject object, AuditedDataSubject subject, Iterable<AccessedAttribute> attributesAffected, Throwable error) Logs the read access to some attributes of an object.
void	logDataReadAttempt(AccessRequester initiator, AuditedDataObject object, AuditedDataSubject subject, Iterable<AccessedAttribute> attributesAffected) Logs the attempt to read some attributes from an object.
void	logDataWrite(AccessRequester initiator, AuditedDataObject object, AuditedDataSubject subject, Iterable<AccessedAttribute> attributesAffected, Throwable error) Logs the modification of some attributes of an object.
void	logDataWriteAttempt(AccessRequester initiator, AuditedDataObject object, AuditedDataSubject subject, Iterable<AccessedAttribute> attributesAffected) Logs the attempt to write to some attributes of an object.
void	logSecurityEvent(AccessRequester initiator, String message, Throwable throwable) Logs a generic security event.
void	logSecurityEventBeginning(AccessRequester initiator, String message) Logs the start of a generic security event.

Method Detail

logSecurityEventBeginning

void logSecurityEventBeginning(@Nonnull
                               AccessRequester initiator,
                               @Nullable
                               String message)

Logs the start of a generic security event.

Parameters:

initiator - Information about the user that starts performing the security event.

message - Descriptive log message.

logSecurityEvent

void logSecurityEvent(@Nonnull
                      AccessRequester initiator,
                      @Nullable
                      String message,
                      @Nullable
                      Throwable throwable)

Logs a generic security event.

Parameters:

initiator - Information about the user that performed the security event.

message - Descriptive log message.

throwable - The exception in case of an error.

logConfigChangeBeginning

void logConfigChangeBeginning(@Nonnull
                              AccessRequester initiator,
                              @Nonnull
                              AuditedDataObject object,
                              @Nullable
                              Iterable<AccessedAttribute> attributesAffected)

Logs the start of a change of some attributes of configuration data.

Parameters:

initiator - Information about the user starting to modify the configuration.

object - An instance of AuditedDataObject that represents the object that will be modified.

attributesAffected - A list containing the attributes that will be changed.

logConfigChange

void logConfigChange(@Nonnull
                     AccessRequester initiator,
                     @Nonnull
                     AuditedDataObject object,
                     @Nullable
                     Iterable<AccessedAttribute> attributesAffected,
                     @Nullable
                     Throwable error)

Logs the change of some attributes of configuration data.

Parameters:

initiator - Information about the user modifying the configuration.

object - An instance of AuditedDataObject that represents the object that has been modified.

attributesAffected - A list containing the attributes that were changed.

error - The exception in case of an error.

logDataReadAttempt

void logDataReadAttempt(@Nonnull
                        AccessRequester initiator,
                        @Nonnull
                        AuditedDataObject object,
                        @Nonnull
                        AuditedDataSubject subject,
                        @Nullable
                        Iterable<AccessedAttribute> attributesAffected)

Logs the attempt to read some attributes from an object.

Parameters:

initiator - Information about the user trying to the read the attributes.

object - An instance of AuditedDataObject that represents the object to be read.

subject - An instance of AuditedDataSubject that represents the owner of the data to be read.

attributesAffected - A list containing the attributes that were read.

logDataRead

void logDataRead(@Nonnull
                 AccessRequester initiator,
                 @Nonnull
                 AuditedDataObject object,
                 @Nonnull
                 AuditedDataSubject subject,
                 @Nullable
                 Iterable<AccessedAttribute> attributesAffected,
                 @Nullable
                 Throwable error)

Logs the read access to some attributes of an object.

Parameters:

initiator - Information about the user reading the attributes.

object - An instance of AuditedDataObject that represents the object that has been read.

subject - An instance of AuditedDataSubject that represents the owner of the data that has been read.

attributesAffected - A list containing the attributes that were read.

error - The exception in case of an error.

logDataWriteAttempt

void logDataWriteAttempt(@Nonnull
                         AccessRequester initiator,
                         @Nonnull
                         AuditedDataObject object,
                         @Nonnull
                         AuditedDataSubject subject,
                         @Nullable
                         Iterable<AccessedAttribute> attributesAffected)

Logs the attempt to write to some attributes of an object.

Parameters:

initiator - Information about the user trying to write to some attributes.

object - An instance of AuditedDataObject that represents the object that is about to be modified.

subject - An instance of AuditedDataSubject that represents the owner of the data that is about to be modified.

attributesAffected - A list containing the attributes that should be modified, containing the old and new values.

logDataWrite

void logDataWrite(@Nonnull
                  AccessRequester initiator,
                  @Nonnull
                  AuditedDataObject object,
                  @Nonnull
                  AuditedDataSubject subject,
                  @Nullable
                  Iterable<AccessedAttribute> attributesAffected,
                  @Nullable
                  Throwable error)

Logs the modification of some attributes of an object.

Parameters:

initiator - Information about the user changing the attributes.

object - An instance of AuditedDataObject that represents the object that has been modified.

subject - An instance of AuditedDataSubject that represents the owner of the data that has been modified.

attributesAffected - A list containing the attributes that should were modified, containing the old and new values.

error - The exception in case of an error.