com.sap.cds.repackaged.audit.api.ConfigurationChangeAuditMessage 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.ConfigurationChangeAuditMessage
 *             instead. 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, information on the key identifiers that identify the
 *             object.
 * 
 *             The configuration change interface allows the logging of changes to any configuration
 *             data. The log message should reflect which configuration data have been changed.
 */
@Deprecated
public interface ConfigurationChangeAuditMessage extends TransactionalAuditLogMessage {

    /**
     * Sets the object id.
     * 
     * @param objectId
     *            Unique object id.
     * @deprecated Use
     *             {@link com.sap.cds.repackaged.audit.api.v2.ConfigurationChangeAuditMessage#setObject(com.sap.cds.repackaged.audit.api.v2.AuditedObject)}
     *             instead
     */
    @Deprecated
    void setObjectId(String objectId);

    /**
     * Adds a new value to an already existing key and value pair from the modified data set.
     * 
     * @param key
     *            Data set key.
     * @param oldValue
     *            The old key value of the modified data set. Must be null for a new
     *            data set key.
     * @param newValue
     *            The new key value of the modified data set. Must be null for a
     *            deleted data set key.
     * @deprecated Use
     *             {@link com.sap.cds.repackaged.audit.api.v2.ConfigurationChangeAuditMessage#addValue(String, String, String)}
     *             instead
     */
    @Deprecated
    void addValue(String key, String oldValue, String newValue);

}