Package com.broadleafcommerce.common.audit.event

Class AuditInformation

java.lang.Object

com.broadleafcommerce.common.audit.event.AuditInformation

All Implemented Interfaces:

Serializable

public class AuditInformation
extends Object
implements Serializable

Represents some contextual information for an audit event. This serves to inform a number of the values for AuditEventHeader. Values are generally harvested from a combination of Spring Security Authentication and any available ContextInfo instance.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AuditInformation.AuditInformationBuilder

Constructor Summary

Constructors

Constructor	Description
AuditInformation(String primary, String secondary, String customerId, String accountId, String tenantId, String catalogId, String applicationId)

Method Summary

Modifier and Type	Method	Description
static AuditInformation.AuditInformationBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAccountId()	The account id associated with the current flow.
String	getApplicationId()	The application id associated with the current flow.
String	getCatalogId()	The catalog id associated with the current flow.
String	getCustomerId()	The customer id associated with the current flow.
String	getPrimary()	The primary user associated with the current flow.
String	getSecondary()	The secondary user associated with the current flow (acting on behalf of the primary user).
String	getTenantId()	The tenant id associated with the current flow.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

AuditInformation

public AuditInformation(@Nullable
 String primary,
 @Nullable
 String secondary,
 @Nullable
 String customerId,
 @Nullable
 String accountId,
 @Nullable
 String tenantId,
 @Nullable
 String catalogId,
 @Nullable
 String applicationId)

Method Details

builder

public static AuditInformation.AuditInformationBuilder builder()

getPrimary

public String getPrimary()

The primary user associated with the current flow. May be null if unknown. Represented by the sub attribute of the JWT token.

getSecondary

public String getSecondary()

The secondary user associated with the current flow (acting on behalf of the primary user). May be null if unknown. Represented by the csr_sub attribute of the JWT token.

getCustomerId

public String getCustomerId()

The customer id associated with the current flow. May be null if unknown. Represented by the customer_id attribute of the JWT token.

getAccountId

public String getAccountId()

The account id associated with the current flow. May be null if unknown. Represented by the acct_id attribute of the JWT token.

getTenantId

public String getTenantId()

The tenant id associated with the current flow. May be null if unknown. Harvested from the ContextInfo instance (if available).

getCatalogId

public String getCatalogId()

The catalog id associated with the current flow. May be null if unknown. Harvested from the ContextInfo instance (if available).

getApplicationId

public String getApplicationId()

The application id associated with the current flow. May be null if unknown. Harvested from the ContextInfo instance (if available).

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