Package com.broadleafcommerce.audit.domain

Class AuditHeader

java.lang.Object

com.broadleafcommerce.audit.domain.AuditHeader

public class AuditHeader
extends Object

Projection audit header for a changed entity. Analogous to AuditEventHeader.

Constructor Summary

Constructors

Constructor	Description
AuditHeader()
AuditHeader(String id, Instant timestamp, String eventType, String entityType, String entityRef, String containerEventType, String containerRef, String customerId, String accountId, String tenantId, String catalogId, String applicationId, String detailType, String primaryAuthor, String secondaryAuthor, Map<String,String> additionalAttributes)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAccountId()	Identifier for an account entity.
Map<String,String>	getAdditionalAttributes()	Any additional information, possibly required in extension scenarios.
String	getApplicationId()	The application to which this audit record belongs.
String	getCatalogId()	The catalog to which this audit record belongs.
String	getContainerEventType()	In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT".
String	getContainerRef()	Identifying reference to the containing entity.
String	getCustomerId()	Identifier for a customer entity.
String	getDetailType()	The type of detail information associated with this audit event.
String	getEntityRef()	Identifying reference to the entity.
String	getEntityType()	Fully qualified class name of the top-level entity being changed.
String	getEventType()	In the case of Trackable entity change, The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT".
String	getId()	Primary key
String	getPrimaryAuthor()	The primary author of the change.
String	getSecondaryAuthor()	Any additional author for the change.
String	getTenantId()	The tenant to whom this audit record belongs.
Instant	getTimestamp()	The time at which the change was reported to the system.
int	hashCode()
void	setAccountId(String accountId)	Identifier for an account entity.
void	setAdditionalAttributes(Map<String,String> additionalAttributes)	Any additional information, possibly required in extension scenarios.
void	setApplicationId(String applicationId)	The application to which this audit record belongs.
void	setCatalogId(String catalogId)	The catalog to which this audit record belongs.
void	setContainerEventType(String containerEventType)	In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT".
void	setContainerRef(String containerRef)	Identifying reference to the containing entity.
void	setCustomerId(String customerId)	Identifier for a customer entity.
void	setDetailType(String detailType)	The type of detail information associated with this audit event.
void	setEntityRef(String entityRef)	Identifying reference to the entity.
void	setEntityType(String entityType)	Fully qualified class name of the top-level entity being changed.
void	setEventType(String eventType)	In the case of Trackable entity change, The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT".
void	setId(String id)	Primary key
void	setPrimaryAuthor(String primaryAuthor)	The primary author of the change.
void	setSecondaryAuthor(String secondaryAuthor)	Any additional author for the change.
void	setTenantId(String tenantId)	The tenant to whom this audit record belongs.
void	setTimestamp(Instant timestamp)	The time at which the change was reported to the system.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AuditHeader

public AuditHeader()

AuditHeader

public AuditHeader(String id,
 Instant timestamp,
 String eventType,
 String entityType,
 String entityRef,
 String containerEventType,
 String containerRef,
 String customerId,
 String accountId,
 String tenantId,
 String catalogId,
 String applicationId,
 String detailType,
 String primaryAuthor,
 String secondaryAuthor,
 Map<String,String> additionalAttributes)

Method Details

getId

public String getId()

Primary key

getTimestamp

public Instant getTimestamp()

The time at which the change was reported to the system. Required.

getEventType

public String getEventType()

In the case of Trackable entity change, The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT". Arbitrary audit events may use this field to represent the type of event. Required.

getEntityType

public String getEntityType()

Fully qualified class name of the top-level entity being changed. Optional. For audit changes to a particular entity.

getEntityRef

public String getEntityRef()

Identifying reference to the entity. Usually a contextId for Trackable domain. Optional. For audit changes to a particular entity.

getContainerEventType

public String getContainerEventType()

In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT". This is a grouping concept for correlating multiple related changes to a singular concept. For example, a marketing message change, which from the admin perspective looks like a change to an offer. Optional.

getContainerRef

public String getContainerRef()

Identifying reference to the containing entity. Usually a contextId for Trackable domain. Optional. See containerEventType.

getCustomerId

public String getCustomerId()

Identifier for a customer entity. Useful for identifying a customer related to the change. Optional. For audit events related to a customer.

getAccountId

public String getAccountId()

Identifier for an account entity. Useful for identifying an account related to the change. Optional. For audit events related to an account.

getTenantId

public String getTenantId()

The tenant to whom this audit record belongs. Required.

getCatalogId

public String getCatalogId()

The catalog to which this audit record belongs. Optional. For audit events related to a catalog discriminated entity.

getApplicationId

public String getApplicationId()

The application to which this audit record belongs. Optional. For audit events related to an application discriminated entity.

getDetailType

public String getDetailType()

The type of detail information associated with this audit event. See DetailType. Default is DetailType.NONE

getPrimaryAuthor

public String getPrimaryAuthor()

The primary author of the change. Optional. For DetailType.CHANGE_DETAIL events, this field generally represents the approver of the overall entity change. See AuditEventDetail.getAuthor() for more specific ownership of field-level changes. For non-CHANGE_DETAIL events, this field represents the user driving the event.

getSecondaryAuthor

public String getSecondaryAuthor()

Any additional author for the change. Optional. For DetailType.CHANGE_DETAIL events, this field generally represents the user engaged the deployment.

getAdditionalAttributes

public Map<String,String> getAdditionalAttributes()

Any additional information, possibly required in extension scenarios. Optional.

setId

public void setId(String id)

Primary key

setTimestamp

public void setTimestamp(Instant timestamp)

The time at which the change was reported to the system. Required.

setEventType

public void setEventType(String eventType)

In the case of Trackable entity change, The name of the top-level entity that changed, which is typically snake-cased and capitalized, i.e., "PRODUCT". Arbitrary audit events may use this field to represent the type of event. Required.

setEntityType

public void setEntityType(String entityType)

Fully qualified class name of the top-level entity being changed. Optional. For audit changes to a particular entity.

setEntityRef

public void setEntityRef(String entityRef)

Identifying reference to the entity. Usually a contextId for Trackable domain. Optional. For audit changes to a particular entity.

setContainerEventType

public void setContainerEventType(String containerEventType)

In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT". This is a grouping concept for correlating multiple related changes to a singular concept. For example, a marketing message change, which from the admin perspective looks like a change to an offer. Optional.

setContainerRef

public void setContainerRef(String containerRef)

Identifying reference to the containing entity. Usually a contextId for Trackable domain. Optional. See containerEventType.

setCustomerId

public void setCustomerId(String customerId)

Identifier for a customer entity. Useful for identifying a customer related to the change. Optional. For audit events related to a customer.

setAccountId

public void setAccountId(String accountId)

Identifier for an account entity. Useful for identifying an account related to the change. Optional. For audit events related to an account.

setTenantId

public void setTenantId(String tenantId)

The tenant to whom this audit record belongs. Required.

setCatalogId

public void setCatalogId(String catalogId)

The catalog to which this audit record belongs. Optional. For audit events related to a catalog discriminated entity.

setApplicationId

public void setApplicationId(String applicationId)

The application to which this audit record belongs. Optional. For audit events related to an application discriminated entity.

setDetailType

public void setDetailType(String detailType)

The type of detail information associated with this audit event. See DetailType. Default is DetailType.NONE

setPrimaryAuthor

public void setPrimaryAuthor(String primaryAuthor)

The primary author of the change. Optional. For DetailType.CHANGE_DETAIL events, this field generally represents the approver of the overall entity change. See AuditEventDetail.getAuthor() for more specific ownership of field-level changes. For non-CHANGE_DETAIL events, this field represents the user driving the event.

setSecondaryAuthor

public void setSecondaryAuthor(String secondaryAuthor)

Any additional author for the change. Optional. For DetailType.CHANGE_DETAIL events, this field generally represents the user engaged the deployment.

setAdditionalAttributes

public void setAdditionalAttributes(Map<String,String> additionalAttributes)

Any additional information, possibly required in extension scenarios. Optional.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object