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 follow SAP's security standards:

• SEC-215 "SAP software shall be able to log security relevant events."
• SEC-254 "SAP software shall log read access to sensitive personal data."
• SEC-257 "SAP software shall be able to log changes to configuration data."
• SEC-265 "SAP software shall log changes to personal data."

Method Summary

Modifier and Type	Method and Description
void	logConfigChange(AccessRequester initiator, String objectId, String objectName, Iterable<AccessedAttribute> attributesAffected, String message, Throwable error) Logs the change of some attributes of configuration data.
void	logConfigChangeBeginning(AccessRequester initiator, String objectId, String objectName, Iterable<AccessedAttribute> attributesAffected, String message) Logs the start of a change of some attributes of configuration data.
void	logDataRead(AccessRequester initiator, String objectId, String objectName, Iterable<AccessedAttribute> attributesAffected, String message, Throwable error) Logs the read access to some attributes of an object.
void	logDataReadAttempt(AccessRequester initiator, String objectId, String objectName, Iterable<AccessedAttribute> attributesAffected, String message) Logs the attempt to read some attributes from an object.
void	logDataWrite(AccessRequester initiator, String objectId, String objectName, Iterable<AccessedAttribute> attributesAffected, String message, Throwable error) Logs the modification of some attributes of an object.
void	logDataWriteAttempt(AccessRequester initiator, String objectId, String objectName, Iterable<AccessedAttribute> attributesAffected, String message) 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(AccessRequester initiator,
                               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(AccessRequester initiator,
                      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(AccessRequester initiator,
                              String objectId,
                              @Nullable
                              String objectName,
                              @Nullable
                              Iterable<AccessedAttribute> attributesAffected,
                              @Nullable
                              String message)

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

Parameters:

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

objectId - A unique identifier of the configuration from which some attributes will be changed, for example a UUID or a primary key of a database entry.

objectName - Human readable identifier of the configuration from which some attributes will be changed.

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

message - Descriptive log message.

logConfigChange

void logConfigChange(AccessRequester initiator,
                     String objectId,
                     @Nullable
                     String objectName,
                     @Nullable
                     Iterable<AccessedAttribute> attributesAffected,
                     @Nullable
                     String message,
                     @Nullable
                     Throwable error)

Logs the change of some attributes of configuration data.

Parameters:

initiator - Information about the user modifying the configuration.

objectId - A unique identifier of the configuration from which some attributes were changed, for example a UUID or a primary key of a database entry.

objectName - Human readable identifier of the configuration from which some attributes were changed.

attributesAffected - A list containing the attributes that were changed.

message - Descriptive log message.

error - The exception in case of an error.

logDataReadAttempt

void logDataReadAttempt(AccessRequester initiator,
                        String objectId,
                        @Nullable
                        String objectName,
                        @Nullable
                        Iterable<AccessedAttribute> attributesAffected,
                        @Nullable
                        String message)

Logs the attempt to read some attributes from an object.

Parameters:

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

objectId - A unique identifier of the object from which some attributes are attempted to be read, for example a UUID or a primary key of a database entry.

objectName - Human readable identifier of the object from which some attributes are attempted to be read.

attributesAffected - A list containing the attributes that were read.

message - Descriptive log message.

logDataRead

void logDataRead(AccessRequester initiator,
                 String objectId,
                 @Nullable
                 String objectName,
                 @Nullable
                 Iterable<AccessedAttribute> attributesAffected,
                 @Nullable
                 String message,
                 @Nullable
                 Throwable error)

Logs the read access to some attributes of an object.

Parameters:

initiator - Information about the user reading the attributes.

objectId - A unique identifier of the object from which some attributes are read, for example a UUID or a primary key of a database entry.

objectName - Human readable identifier of the object from which some attributes are read.

attributesAffected - A list containing the attributes that were read.

message - Descriptive log message.

error - The exception in case of an error.

logDataWriteAttempt

void logDataWriteAttempt(AccessRequester initiator,
                         String objectId,
                         @Nullable
                         String objectName,
                         @Nullable
                         Iterable<AccessedAttribute> attributesAffected,
                         @Nullable
                         String message)

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

Parameters:

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

objectId - A unique identifier of the object from which some attributes should be modified, for example a UUID or a primary key of a database entry.

objectName - Human readable identifier of the object from which some attributes should be modified.

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

message - Descriptive log message.

logDataWrite

void logDataWrite(AccessRequester initiator,
                  String objectId,
                  @Nullable
                  String objectName,
                  @Nullable
                  Iterable<AccessedAttribute> attributesAffected,
                  @Nullable
                  String message,
                  @Nullable
                  Throwable error)

Logs the modification of some attributes of an object.

Parameters:

initiator - Information about the user changing the attributes.

objectId - A unique identifier of the object from which some attributes are modified, for example a UUID or a primary key of a database entry.

objectName - Human readable identifier of the object from which some attributes are modified.

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

message - Descriptive log message.

error - The exception in case of an error.