com.sap.cloud.yaas.servicesdk.auditbase.event.AuditEventBuilderFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of service-sdk-audit-base Show documentation

Contains base utility classes for audit event logging

The newest version!

/*
 * © 2017 SAP SE or an SAP affiliate company.
 * All rights reserved.
 * Please see http://www.sap.com/corporate-en/legal/copyright/index.epx for additional trademark information and
 * notices.
 */
package com.sap.cloud.yaas.servicesdk.auditbase.event;

/**
 * Convenience class for creating audit event publishers.
 */
public final class AuditEventBuilderFactory
{

	private AuditEventBuilderFactory()
	{
		// nothing
	}

	/**
	 * Creates audit event logger for logging of personal data changes using a custom logger.See
	 * {@link PersonalDataChangeAuditEvent}.
	 *
	 * @return the {@link PersonalDataChangeAuditEvent.PersonalDataChangeAuditEventBuilder}
	 */
	public static PersonalDataChangeAuditEvent.PersonalDataChangeAuditEventBuilder personalDataChange()
	{
		return PersonalDataChangeAuditEvent.builder();
	}

	/**
	 * Creates audit event builder for publishing of configuration data changes. See {@link ConfigurationChangeAuditEvent}.
	 *
	 * @return the {@link ConfigurationChangeAuditEvent.ConfigurationChangeAuditEventBuilder}
	 */
	public static ConfigurationChangeAuditEvent.ConfigurationChangeAuditEventBuilder configurationChange()
	{
		return ConfigurationChangeAuditEvent.builder();
	}

	/**
	 * Creates audit event logger for logging of security relevant events. See {@link SecurityAuditEvent}.
	 *
	 * @return the {@link SecurityAuditEvent.SecurityAuditEventBuilder}
	 */
	public static SecurityAuditEvent.SecurityAuditEventBuilder securityEvent()
	{
		return SecurityAuditEvent.builder();
	}
}