Serialized Form

  • Package com.broadleafcommerce.common.audit.batch

  • Package com.broadleafcommerce.common.audit.domain

    • Class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail

      class AdminAuditEventDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,String> additionalAttributes
          Any additional information, possibly required in extension scenarios
        • afterRepresentation
          String afterRepresentation
          The value for the field after the change was made. Json representation. May be simple, or a more complex structure - like a list.
        • author
          String author
          The author of the change. May be an admin user, or an identifier noting an automated system process.
        • beforeRepresentation
          String beforeRepresentation
          The value for the field before the change was made. Json representation. May be simple, or a more complex structure - like a list.
        • changeType
          String changeType
          The operation type that mutated this field value. Maps to OperationType.
        • javaType
          String javaType
          The fully qualified classname of the Java type for this field.
        • message
          String message
          Optional message included giving more information about the change. When included, usually noted by the admin user making the change.
        • projectionField
          String projectionField
          The name of the field in a projection domain. This is generally the name of the field from domain serialized to and deserialized from JSON at the microservice endpoint API. Often this is the same as the repositoryField, but is not required to be.
        • repositoryField
          String repositoryField
          The name of the field on the repository domain. This is generally the name of a field in a JPA domain class.
        • timestamp
          Instant timestamp
          The timestamp at which the field change took place

    • Class com.broadleafcommerce.common.audit.domain.AuditApplicationEvent

      class AuditApplicationEvent extends org.springframework.context.ApplicationEvent implements Serializable

      • Serialized Fields

    • Class com.broadleafcommerce.common.audit.domain.AuditEvent

      class AuditEvent extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.common.audit.domain.AuditEventHeader

      class AuditEventHeader extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountid
          String accountid
          Identifier for an account entity. Useful for identifying an account related to the change. Optional. For audit events related to an account.
        • additionalAttributes
          Map<String,String> additionalAttributes
          Any additional information, possibly required in extension scenarios. Optional.
        • applicationId
          String applicationId
          The application to which this audit record belongs. Optional. For audit events related to an application discriminated entity.
        • catalogId
          String catalogId
          The catalog to which this audit record belongs. Optional. For audit events related to a catalog discriminated entity.
        • containerEventType
          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.
        • containerRef
          String containerRef
          Identifying reference to the containing entity. Usually a contextId for Trackable domain. Optional. See AuditEventHeader.containerEventType.
        • customerid
          String customerid
          Identifier for a customer entity. Useful for identifying a customer related to the change. Optional. For audit events related to a customer.
        • detailType
          String detailType
          The type of detail information associated with this audit event. See DetailType.
        • entityRef
          String entityRef
          Identifying reference to the entity. Usually a contextId for Trackable domain. Optional. For audit changes to a particular entity.
        • entityType
          String entityType
          Fully qualified class name of the top-level entity being changed. Optional. For audit changes to a particular entity.
        • eventType
          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.
        • primaryAuthor
          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.
        • retentionPeriod
          Duration retentionPeriod
          Optional. The amount of time to keep this record in hot storage (i.e. searchable in AuditServices). If set, will override the default retention period defined in AuditServices. See com.broadleafcommerce.audit.env.AuditPruneProperties#retentionPeriod in AuditServices for the system default.
        • secondaryAuthor
          String secondaryAuthor
          Any additional author for the change. Optional. For DetailType.CHANGE_DETAIL events, this field generally represents the user engaged the deployment. For non-CHANGE_DETAIL events, this field represents any CSR impersonating the primary author for the event.
        • tenantId
          String tenantId
          The tenant to whom this audit record belongs. Required.
        • timestamp
          Instant timestamp
          The time at which the change was reported to the system. Required.

    • Class com.broadleafcommerce.common.audit.domain.AuditRequestEvent

      class AuditRequestEvent extends org.springframework.context.ApplicationEvent implements Serializable

      • Serialized Fields

    • Class com.broadleafcommerce.common.audit.domain.FlushApplicationEvent

      class FlushApplicationEvent extends org.springframework.context.ApplicationEvent implements Serializable

      • Serialized Fields

        • completed
          Batch completed

    • Class com.broadleafcommerce.common.audit.domain.IngestedApplicationEvent

      class IngestedApplicationEvent extends org.springframework.context.ApplicationEvent implements Serializable

      • Serialized Fields

    • Class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail

      class RawAuditEventDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • additionalAttributes
          Map<String,String> additionalAttributes
          Any additional information, possibly required in extension scenarios
        • author
          String author
          The author of the change. May be any type of user (including customer), or an identifier noting an automated system process.
        • rawDetail
          String rawDetail
          Raw information about the change.
        • timestamp
          Instant timestamp
          The timestamp at which the field change took place

  • Package com.broadleafcommerce.common.audit.event

    • Class com.broadleafcommerce.common.audit.event.AuditInformation

      class AuditInformation extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • accountId
          String accountId
          The account id associated with the current flow. May be null if unknown. Represented by the acct_id attribute of the JWT token.
        • applicationId
          String applicationId
          The application id associated with the current flow. May be null if unknown. Harvested from the ContextInfo instance (if available).
        • catalogId
          String catalogId
          The catalog id associated with the current flow. May be null if unknown. Harvested from the ContextInfo instance (if available).
        • customerId
          String customerId
          The customer id associated with the current flow. May be null if unknown. Represented by the customer_id attribute of the JWT token.
        • primary
          String primary
          The primary user associated with the current flow. May be null if unknown. Represented by the sub attribute of the JWT token.
        • secondary
          String secondary
          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.
        • tenantId
          String tenantId
          The tenant id associated with the current flow. May be null if unknown. Harvested from the ContextInfo instance (if available).