com.sap.cds.repackaged.audit.api.DataAccessAuditMessage 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.DataAccessAuditMessage instead. A
 *             data subject, describing to whom the accessed 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 accessed
 *             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 access interface for logging successful and unsuccessful access 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 DataAccessAuditMessage extends AuditLogMessage {

    /**
     * Sets the data access channel type. For example - RFC, web service, IDOC, file based
     * interfaces, user interface, spool, printing, etc.
     * 
     * @param key
     *            The type of data access channel.
     * @deprecated Use {@link com.sap.cds.repackaged.audit.api.v2.DataAccessAuditMessage#setChannel(String)}
     *             instead
     */
    @Deprecated
    void setChannel(String key);

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

    /**
     * Sets the heading name for the attribute that has been read, either successfully or not.
     * 
     * @param name
     *            The attribute name.
     * @param isSuccessful
     *            Whether or not the access to the attribute was successful.
     * @deprecated Use
     *             {@link com.sap.cds.repackaged.audit.api.v2.DataAccessAuditMessage#addAttribute(String, boolean)}
     *             instead
     */
    @Deprecated
    void addAttribute(String name, boolean isSuccessful);

    /**
     * Sets the attachment name and id in case the event is triggered by the download or display of
     * some attachments or files.
     * 
     * @param id
     *            Attachment id.
     * @param name
     *            Attachment name.
     * @deprecated Use
     *             {@link com.sap.cds.repackaged.audit.api.v2.DataAccessAuditMessage#addAttachment(String, String)}
     *             instead
     */
    @Deprecated
    void addAttachment(String id, String name);

}