com.sap.cds.repackaged.audit.api.DataModificationAuditMessage Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of cds-feature-auditlog-v2 Show documentation
Handler to send auditlog messages to AuditLog Service V2
There is a newer version: 3.2.0
Show newest version
package com.sap.cds.repackaged.audit.api;

/**
 * @deprecated Not GDPR compliant. Use com.sap.cds.repackaged.audit.api.v2.DataModificationAuditMessage instead. 
 * A data subject, describing to whom the modified personal data belongs to, should be provided for the audit log entry. 
 * The data subject should look similar to:
 *  * {
 *    "type": "testType",
 *    "role": "role",
 *    "id": {
 *      "key1": "value1",
 *      "key2": "value2"
 *    }
 * }  , providing more detailed information on the type of the subject whom the modified personal data belongs to, 
 * their role and information on the key identifiers that identify them.
 * Instead of the object id provided so far, the object logged should look similar to:
 *  * {
 *    "type": "testType",
 *    "id": {
 *      "key1": "value1",
 *      "key2": "value2"
 *    }
 * }, providing more detailed information on the type of the object where the changed configuration is located and 
 * information on the key identifiers that identify the object.
 * 
 * Data modification interface for logging successful and unsuccessful modification to any sensitive personal data.
 * Logging shall be done where data is disclosed to a user or a third party.
 * 
 * Examples of such personal data includes: information on racial or ethnic origin, political opinions, religious or philosophical 
 * beliefs, trade-union membership, health or sex life, bank account data and any other data that can identify certain individual 
 * or entity.
 */
@Deprecated
public interface DataModificationAuditMessage extends TransactionalAuditLogMessage {
    
    /**
     * Sets the object id.
     * 
     * @param objectId Unique object id.
     * @deprecated Use {@link com.sap.cds.repackaged.audit.api.v2.DataModificationAuditMessage#setObject(com.sap.cds.repackaged.audit.api.v2.AuditedObject)} instead
     */

    @Deprecated
    void setObjectId(String objectId);
    
    /**
     * @deprecated The method is deprecated and its use reflects in performance impact. Please use the 
     * {@link #addAttribute(String, String, String) addAttribute(String name, String oldValue, String newValue)} method instead.
     * 
     * Sets the heading name for the attribute that has been modified, either successfully or not.
     * 
     * @param name The attribute name.
     * @param isSuccessful Whether or not the modification of the attribute was successful.
     *
     */
    @Deprecated
    void addAttribute(String name, boolean isSuccessful);
    
    /**
     * Used when a new value is added, and existing one is modified or removed. Sets the heading name for the attribute that has been modified.
     * 
     * @param name The attribute name.
     * @param oldValue The old value of the attribute. Must be null for a new data set key.
     * @param newValue The new value of the attribute. Must be null for a deleted data set key.
     * @deprecated Use {@link com.sap.cds.repackaged.audit.api.v2.DataModificationAuditMessage#addAttribute(String, String, String)} instead
     */
    @Deprecated
    void addAttribute(String name, String oldValue, String newValue);

}