Index (Broadleaf Audit Common 1.0.0-RC1 API)

A B C D E F G H I J K M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

accountid(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Identifier for an account entity.
accountId(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The account id associated with the current flow.
additionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: Any additional information, possibly required in extension scenarios
additionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent.AuditEventBuilder
additionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Any additional information, possibly required in extension scenarios.
additionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail.RawAuditEventDetailBuilder: Any additional information, possibly required in extension scenarios
AdminAuditEventDetail - Class in com.broadleafcommerce.common.audit.domain: Field-by-field detail information about changes to an entity.
AdminAuditEventDetail(String, Instant, String, String, String, String, String, String, String, Map<String, String>) - Constructor for class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail
AdminAuditEventDetail.AdminAuditEventDetailBuilder - Class in com.broadleafcommerce.common.audit.domain
afterRepresentation(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The value for the field after the change was made.
append(String) - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder: Append a json converted value of an AuditEvent to batch storage.
append(String) - Method in interface com.broadleafcommerce.common.audit.batch.Batch: Add a single serialized record
append(String) - Method in class com.broadleafcommerce.common.audit.batch.FileSystemBatch
applicationId(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: The application to which this audit record belongs.
applicationId(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The application id associated with the current flow.
AtomicMoveException - Exception in com.broadleafcommerce.common.audit.batch: Exception thrown specifically during a file system atomic move for a particular file
AtomicMoveException(Path, String) - Constructor for exception com.broadleafcommerce.common.audit.batch.AtomicMoveException
AuditApplicationEvent - Class in com.broadleafcommerce.common.audit.domain: Container Spring event for AuditEvent.
AuditApplicationEvent(Object, AuditEvent) - Constructor for class com.broadleafcommerce.common.audit.domain.AuditApplicationEvent
AuditEvent - Class in com.broadleafcommerce.common.audit.domain: Represents the entire change information for an entity during a sandbox transition (usually deploy).
AuditEvent(AuditEventHeader, List<AuditEventDetail>, Map<String, String>) - Constructor for class com.broadleafcommerce.common.audit.domain.AuditEvent
AuditEvent(AuditEventHeader, Map<String, String>) - Constructor for class com.broadleafcommerce.common.audit.domain.AuditEvent
AuditEvent.AuditEventBuilder - Class in com.broadleafcommerce.common.audit.domain
AuditEventDetail - Interface in com.broadleafcommerce.common.audit.domain: Details about the change.
AuditEventHeader - Class in com.broadleafcommerce.common.audit.domain: Header information for an audit record.
AuditEventHeader(Instant, String, String, String, String, String, String, String, String, Map<String, String>, Duration, String, String, String, String, String) - Constructor for class com.broadleafcommerce.common.audit.domain.AuditEventHeader
AuditEventHeader.AuditEventHeaderBuilder - Class in com.broadleafcommerce.common.audit.domain
auditEventRecorder(TaskScheduler, AuditProcessingProperties, ThreadPoolTaskExecutor, ObjectMapper, StorageProvider, ApplicationEventPublisher) - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
AuditEventRecorder - Class in com.broadleafcommerce.common.audit: Async recorder of AuditEvent instances fired from ChangeAuditHandler.
AuditEventRecorder(TaskScheduler, AuditProcessingProperties, ThreadPoolTaskExecutor, ObjectMapper, StorageProvider, ApplicationEventPublisher) - Constructor for class com.broadleafcommerce.common.audit.AuditEventRecorder
AuditEventUtility - Class in com.broadleafcommerce.common.audit.event: Generic utility for interacting with AuditEvent, specifically for custom firing of this type of event from anywhere in the Spring application.
AuditInformation - Class in com.broadleafcommerce.common.audit.event: Represents some contextual information for an audit event.
AuditInformation(String, String, String, String, String, String, String) - Constructor for class com.broadleafcommerce.common.audit.event.AuditInformation
AuditInformation.AuditInformationBuilder - Class in com.broadleafcommerce.common.audit.event
AuditProcessingProperties - Class in com.broadleafcommerce.common.audit.env: Configuration related to audit processing
AuditProcessingProperties() - Constructor for class com.broadleafcommerce.common.audit.env.AuditProcessingProperties
AuditRequestEvent - Class in com.broadleafcommerce.common.audit.domain: Container event for requesting an audit event.
AuditRequestEvent(Object, AuditEvent) - Constructor for class com.broadleafcommerce.common.audit.domain.AuditRequestEvent
auditRequestEventConverter() - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
author(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The author of the change.
author(String) - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail.RawAuditEventDetailBuilder: The author of the change.

B

BasicProperties - Class in com.broadleafcommerce.common.audit.env
BasicProperties() - Constructor for class com.broadleafcommerce.common.audit.env.BasicProperties
Batch - Interface in com.broadleafcommerce.common.audit.batch: A storage representation for a collection of serialized AuditEvent instances.
beforeRepresentation(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The value for the field before the change was made.
build() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder
build() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent.AuditEventBuilder
build() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder
build() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail.RawAuditEventDetailBuilder
build() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder
builder() - Static method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail
builder() - Static method in class com.broadleafcommerce.common.audit.domain.AuditEvent
builder() - Static method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader
builder() - Static method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail
builder() - Static method in class com.broadleafcommerce.common.audit.event.AuditInformation

C

canEqual(Object) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.env.BasicProperties
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties
canEqual(Object) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation
catalogId(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: The catalog to which this audit record belongs.
catalogId(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The catalog id associated with the current flow.
CHANGE_DETAIL - Enum constant in enum class com.broadleafcommerce.common.audit.domain.DetailType: The AdminAuditEventDetail records are harvested from ChangeDetail instances taken from the admin CRUD flow.
changeAuditHandler(ThreadPoolTaskExecutor, List<Converter<MutationNotifyEvent, AuditEvent>>, ApplicationEventPublisher) - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
ChangeAuditHandler - Class in com.broadleafcommerce.common.audit: Async handler responsible for converting MutationNotifyEvent instances into AuditEvent instances for subsequent consumption by the audit processing system.
ChangeAuditHandler(ThreadPoolTaskExecutor, List<Converter<MutationNotifyEvent, AuditEvent>>, ApplicationEventPublisher) - Constructor for class com.broadleafcommerce.common.audit.ChangeAuditHandler
changeType(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The operation type that mutated this field value.
com.broadleafcommerce.common.audit - package com.broadleafcommerce.common.audit
com.broadleafcommerce.common.audit.autoconfigure - package com.broadleafcommerce.common.audit.autoconfigure
com.broadleafcommerce.common.audit.batch - package com.broadleafcommerce.common.audit.batch
com.broadleafcommerce.common.audit.converter - package com.broadleafcommerce.common.audit.converter
com.broadleafcommerce.common.audit.domain - package com.broadleafcommerce.common.audit.domain
com.broadleafcommerce.common.audit.env - package com.broadleafcommerce.common.audit.env
com.broadleafcommerce.common.audit.event - package com.broadleafcommerce.common.audit.event
CommonAuditAutoConfiguration - Class in com.broadleafcommerce.common.audit.autoconfigure
CommonAuditAutoConfiguration() - Constructor for class com.broadleafcommerce.common.audit.autoconfigure.CommonAuditAutoConfiguration
commonAuditEventRecorderScheduler() - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
commonAuditEventRecorderThreadPoolTaskExecutor(AuditProcessingProperties) - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
commonAuditThreadPoolTaskExecutor(AuditProcessingProperties) - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
completeBatch(Batch) - Method in class com.broadleafcommerce.common.audit.batch.FileSystemStorageProvider
completeBatch(Batch) - Method in interface com.broadleafcommerce.common.audit.batch.StorageProvider: Complete a Batch to its completion state
containerEventType(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT".
containerRef(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Identifying reference to the containing entity.
convert(AuditRequestEvent) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractAuditRequestEventConverter
convert(AuditRequestEvent) - Method in class com.broadleafcommerce.common.audit.DefaultAuditRequestEventConverter
convert(MutationNotifyEvent) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter
count() - Method in interface com.broadleafcommerce.common.audit.batch.Batch: The quantity of records currently in this batch
count() - Method in class com.broadleafcommerce.common.audit.batch.FileSystemBatch
customerid(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Identifier for a customer entity.
customerId(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The customer id associated with the current flow.

D

DefaultAbstractAuditRequestEventConverter - Class in com.broadleafcommerce.common.audit.converter: Basic converter that contains much of the plumbing required for conversion.
DefaultAbstractAuditRequestEventConverter() - Constructor for class com.broadleafcommerce.common.audit.converter.DefaultAbstractAuditRequestEventConverter
DefaultAbstractMutationNotifyEventConverter - Class in com.broadleafcommerce.common.audit.converter: Basic converter that contains much of the plumbing required for conversion.
DefaultAbstractMutationNotifyEventConverter(TypeFactory) - Constructor for class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter
DefaultAuditRequestEventConverter - Class in com.broadleafcommerce.common.audit: Default pass-through converter for AuditRequestEvent to AuditEvent.
DefaultAuditRequestEventConverter() - Constructor for class com.broadleafcommerce.common.audit.DefaultAuditRequestEventConverter
DefaultMutationNotifyEventConverter - Class in com.broadleafcommerce.common.audit.converter: Default implementation of DefaultAbstractMutationNotifyEventConverter that filters applicability based on any type matches found comparing the changed entity to AuditProcessingProperties.getDefaultMutationNotifyEventTypes().
DefaultMutationNotifyEventConverter(AuditProcessingProperties, TypeFactory) - Constructor for class com.broadleafcommerce.common.audit.converter.DefaultMutationNotifyEventConverter
details(List<AuditEventDetail>) - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent.AuditEventBuilder
detailType(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: The type of detail information associated with this audit event.
DetailType - Enum Class in com.broadleafcommerce.common.audit.domain: The types of detail information that may be associated with an audit event

E

entityRef(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Identifying reference to the entity.
entityType(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Fully qualified class name of the top-level entity being changed.
equals(Object) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail
equals(Object) - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
equals(Object) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader
equals(Object) - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail
equals(Object) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties
equals(Object) - Method in class com.broadleafcommerce.common.audit.env.BasicProperties
equals(Object) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties
equals(Object) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation
eventType(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: 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".

F

FILE_MATCH_EXP - Static variable in class com.broadleafcommerce.common.audit.env.BasicProperties: Expressions that facilitates the use of broadleaf.basic.audit.group to enable broadleaf.audit.file.enabled and broadleaf.audit.processing.enabled
FileSystemBatch - Class in com.broadleafcommerce.common.audit.batch: File system version of Batch
FileSystemBatch(Path) - Constructor for class com.broadleafcommerce.common.audit.batch.FileSystemBatch
fileSystemStorageProvider(FileSystemStorageProviderProperties) - Method in class com.broadleafcommerce.common.audit.autoconfigure.CommonAuditAutoConfiguration
FileSystemStorageProvider - Class in com.broadleafcommerce.common.audit.batch: File system version of StorageProvider
FileSystemStorageProvider(FileSystemStorageProviderProperties) - Constructor for class com.broadleafcommerce.common.audit.batch.FileSystemStorageProvider
FileSystemStorageProviderProperties - Class in com.broadleafcommerce.common.audit.env: Config related to the FileSystemStorageProvider.
FileSystemStorageProviderProperties() - Constructor for class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties
FileSystemUtils - Class in com.broadleafcommerce.common.audit.batch
fire(AuditEvent) - Static method in class com.broadleafcommerce.common.audit.event.AuditEventUtility
flush(Batch) - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder: Push a Batch to completion storage.
FlushApplicationEvent - Class in com.broadleafcommerce.common.audit.domain: Container Spring event for a completed Batch.
FlushApplicationEvent(Object, Batch) - Constructor for class com.broadleafcommerce.common.audit.domain.FlushApplicationEvent

G

getAccountid() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Identifier for an account entity.
getAccountId() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The account id associated with the current flow.
getAdditionalAttributes() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: Any additional information, possibly required in extension scenarios
getAdditionalAttributes() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
getAdditionalAttributes() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Any additional information, possibly required in extension scenarios.
getAdditionalAttributes() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail: Any additional information, possibly required in extension scenarios
getAfterRepresentation() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The value for the field after the change was made.
getApplicationId() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: The application to which this audit record belongs.
getApplicationId() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The application id associated with the current flow.
getAuditEvent() - Method in class com.broadleafcommerce.common.audit.domain.AuditApplicationEvent
getAuditEvent() - Method in class com.broadleafcommerce.common.audit.domain.AuditRequestEvent
getAuthor() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The author of the change.
getAuthor() - Method in interface com.broadleafcommerce.common.audit.domain.AuditEventDetail: The author of the change.
getAuthor() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail: The author of the change.
getBatchName() - Method in class com.broadleafcommerce.common.audit.domain.IngestedApplicationEvent
getBeforeRepresentation() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The value for the field before the change was made.
getCatalogId() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: The catalog to which this audit record belongs.
getCatalogId() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The catalog id associated with the current flow.
getChangeType() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The operation type that mutated this field value.
getCompleted() - Method in class com.broadleafcommerce.common.audit.domain.FlushApplicationEvent
getCompletionDirectory() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: The directory where completed batch files containing serialized AuditEvent instances are stored.
getContainerEventType() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: In the case of Trackable entity change, The name of the containing entity, which is typically snake-cased and capitalized, i.e., "PRODUCT".
getContainerRef() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Identifying reference to the containing entity.
getCustomerid() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Identifier for a customer entity.
getCustomerId() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The customer id associated with the current flow.
getDefaultMutationNotifyEventTypes() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: List of Trackable domain types by arbitrary subject name that should be audited according to the default converter behavior provided by DefaultAbstractMutationNotifyEventConverter.
getDetail(MutationNotifyEvent, Trackable, ChangeDetail) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter: Compile a AdminAuditEventDetail instance for the changed field on the changed entity
getDetails() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
getDetailType() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: The type of detail information associated with this audit event.
getEnabledTypes() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Whether the conversion specified by AuditProcessingProperties.defaultMutationNotifyEventTypes should be enabled for the given arbitrary subject name.
getEntityRef() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Identifying reference to the entity.
getEntityType() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Fully qualified class name of the top-level entity being changed.
getEventRecorderBatchFileCompletionTimeout() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Duration of time (milliseconds) that should not be exceeded for a batch file to be considered complete.
getEventRecorderBatchFileMaxRecordCount() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Max number of AuditEvent records to include in a single batch file for subsequent ingestion.
getEventRecorderCoreThreadCount() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Core thread count for the ThreadPoolTaskExecutor backing the event recorder thread pool.
getEventRecorderMaxThreadCount() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: The number of threads AuditEventRecorder uses to process incoming AuditEvent instances.
getEventRecorderQueueCapacity() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Queue capacity for the ThreadPoolTaskExecutor backing the event recorder thread pool.
getEventType() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: 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".
getEventType(Trackable) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter
getFailed() - Method in exception com.broadleafcommerce.common.audit.batch.AtomicMoveException
getHandlerCoreThreadCount() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Core thread count for the ThreadPoolTaskExecutor backing the handler thread pool.
getHandlerMaxThreadCount() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: The number of threads ChangeAuditHandler uses to process incoming DeployCompletedEvent instances.
getHandlerQueueCapacity() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Queue capacity for the ThreadPoolTaskExecutor backing the handler thread pool.
getHeader() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
getHeader(MutationNotifyEvent, Trackable) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter: Compile a AuditEventHeader instance for the changed entity
getInfo(ContextInfo) - Static method in class com.broadleafcommerce.common.audit.event.AuditEventUtility: Retrieve the current Spring Authentication instance associated with the current flow and derive username information from it.
getIngestionDirectory() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: The directory where completed batch files undergoing ingestion are stored.
getJavaType() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The fully qualified classname of the Java type for this field.
getMaxFilesPerWorkingPartition() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: Batch files are placed into partitioned directories inside of FileSystemStorageProviderProperties.workingDirectory and FileSystemStorageProviderProperties.completionDirectory in order to avoid OS filesystem limitations regarding max file count per directory.
getMessage() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: Optional message included giving more information about the change.
getOrder() - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractAuditRequestEventConverter
getOrder() - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter
getOrder() - Method in class com.broadleafcommerce.common.audit.DefaultAuditRequestEventConverter
getPrimary() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The primary user associated with the current flow.
getPrimaryAuthor() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: The primary author of the change.
getProjectionField() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The name of the field in a projection domain.
getRawDetail() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail: Raw information about the change.
getRepositoryField() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The name of the field on the repository domain.
getRetentionPeriod() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Optional.
getSecondary() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The secondary user associated with the current flow (acting on behalf of the primary user).
getSecondaryAuthor() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: Any additional author for the change.
getTempDirectory(String) - Static method in class com.broadleafcommerce.common.audit.batch.FileSystemUtils
getTenantId() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: The tenant to whom this audit record belongs.
getTenantId() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation: The tenant id associated with the current flow.
getTimestamp() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail: The timestamp at which the field change took place
getTimestamp() - Method in interface com.broadleafcommerce.common.audit.domain.AuditEventDetail: The timestamp at which the field change took place
getTimestamp() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader: The time at which the change was reported to the system.
getTimestamp() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail: The timestamp at which the field change took place
getWorkingDirectory() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: The directory where in-process batch files containing serialized AuditEvent instances are stored.

H

hashCode() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail
hashCode() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
hashCode() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader
hashCode() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail
hashCode() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties
hashCode() - Method in class com.broadleafcommerce.common.audit.env.BasicProperties
hashCode() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties
hashCode() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation
header(AuditEventHeader) - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent.AuditEventBuilder

I

IngestedApplicationEvent - Class in com.broadleafcommerce.common.audit.domain: Container Spring event for a fully ingested Batch.
IngestedApplicationEvent(Object, String) - Constructor for class com.broadleafcommerce.common.audit.domain.IngestedApplicationEvent
isAutoStartup() - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder
isAutoStartup() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Whether audit processing should begin automatically during application startup.
isEnabled() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Whether audit processing is enabled.
isEnabled() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: Whether audit file system storage is enabled.
isGroup() - Method in class com.broadleafcommerce.common.audit.env.BasicProperties: Enable or disable the AuditProcessingProperties.isEnabled() and FileSystemStorageProviderProperties.isEnabled() as a group.
isRunning() - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder
isStarted() - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder
isValid(AuditRequestEvent) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractAuditRequestEventConverter: Whether the AuditRequestEvent instance is valid for audit tracking.
isValid(MutationNotifyEvent, ChangeDetail) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter: Whether the specific field change (i.e.
isValid(MutationNotifyEvent, Trackable) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractMutationNotifyEventConverter: Whether the Trackable instance is valid for audit tracking
isValid(MutationNotifyEvent, Trackable) - Method in class com.broadleafcommerce.common.audit.converter.DefaultMutationNotifyEventConverter

J

javaType(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The fully qualified classname of the Java type for this field.

K

keyEventAuditHandler(ThreadPoolTaskExecutor, List<Converter<AuditRequestEvent, AuditEvent>>, ApplicationEventPublisher) - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
KeyEventAuditHandler - Class in com.broadleafcommerce.common.audit: Async handler responsible for converting AuditRequestEvent instances into AuditEvent instances for subsequent consumption by the audit processing system.
KeyEventAuditHandler(ThreadPoolTaskExecutor, List<Converter<AuditRequestEvent, AuditEvent>>, ApplicationEventPublisher) - Constructor for class com.broadleafcommerce.common.audit.KeyEventAuditHandler

M

message(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: Optional message included giving more information about the change.
mutationToAuditEventConverter(AuditProcessingProperties, TypeFactory) - Method in class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration

N

name() - Method in interface com.broadleafcommerce.common.audit.batch.Batch: The name of the batch representation.
name() - Method in class com.broadleafcommerce.common.audit.batch.FileSystemBatch
newBatch() - Method in class com.broadleafcommerce.common.audit.batch.FileSystemStorageProvider
newBatch() - Method in interface com.broadleafcommerce.common.audit.batch.StorageProvider: Create a new Batch storage representation
nextIngestionBatch() - Method in class com.broadleafcommerce.common.audit.batch.FileSystemStorageProvider
nextIngestionBatch() - Method in interface com.broadleafcommerce.common.audit.batch.StorageProvider: Grab the next available completed batch from storage for ingestion.
NONE - Enum constant in enum class com.broadleafcommerce.common.audit.domain.DetailType: There is no audit detail.

O

onApplicationEvent(AuditApplicationEvent) - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder
onApplicationEvent(AuditRequestEvent) - Method in class com.broadleafcommerce.common.audit.KeyEventAuditHandler
onApplicationEvent(MutationNotifyEvent) - Method in class com.broadleafcommerce.common.audit.ChangeAuditHandler

P

postProcess(AuditEvent) - Method in class com.broadleafcommerce.common.audit.converter.DefaultAbstractAuditRequestEventConverter: Optionally post process the AuditEvent instance before returning from the conversion.
prepare(boolean) - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder: Prepare a Batch storage representation for flushing to completion storage.
prepareHeader(Consumer<AuditEventHeader.AuditEventHeaderBuilder>, ContextInfo) - Static method in class com.broadleafcommerce.common.audit.event.AuditEventUtility: Pre-fill most of the boilerplate information for an AuditEventHeader instance using context information available to the current flow.
primary(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The primary user associated with the current flow.
primaryAuthor(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: The primary author of the change.
process(AuditEvent) - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder: Convert an event to json, append to a batch file (see Batch), and flush to a completion file, if ready.
PROCESSING_MATCH_EXP - Static variable in class com.broadleafcommerce.common.audit.env.BasicProperties
ProcessingAuditAutoConfiguration - Class in com.broadleafcommerce.common.audit.autoconfigure
ProcessingAuditAutoConfiguration() - Constructor for class com.broadleafcommerce.common.audit.autoconfigure.ProcessingAuditAutoConfiguration
projectionField(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The name of the field in a projection domain.

R

RAW - Enum constant in enum class com.broadleafcommerce.common.audit.domain.DetailType: The change information is not necessarily coming from an admin flow and the data is not harvested from ChangeDetail.
RawAuditEventDetail - Class in com.broadleafcommerce.common.audit.domain: Raw detail information about change or system audit event.
RawAuditEventDetail(String, Instant, String, Map<String, String>) - Constructor for class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail
RawAuditEventDetail.RawAuditEventDetailBuilder - Class in com.broadleafcommerce.common.audit.domain
rawDetail(String) - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail.RawAuditEventDetailBuilder: Raw information about the change.
RECORD_END_MARKER - Static variable in class com.broadleafcommerce.common.audit.AuditEventRecorder
repositoryField(String) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The name of the field on the repository domain.
retentionPeriod(Duration) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Optional.
review(Consumer<Stream<Batch>>) - Method in class com.broadleafcommerce.common.audit.batch.FileSystemStorageProvider
review(Consumer<Stream<Batch>>) - Method in interface com.broadleafcommerce.common.audit.batch.StorageProvider: Preview all completed batches as a stream of Batch instances.

S

secondary(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The secondary user associated with the current flow (acting on behalf of the primary user).
secondaryAuthor(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: Any additional author for the change.
setAutoStartup(boolean) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Whether audit processing should begin automatically during application startup.
setCompletionDirectory(String) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: The directory where completed batch files containing serialized AuditEvent instances are stored.
setDefaultMutationNotifyEventTypes(Map<String, List<Class<?>>>) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: List of Trackable domain types by arbitrary subject name that should be audited according to the default converter behavior provided by DefaultAbstractMutationNotifyEventConverter.
setEnabled(boolean) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Whether audit processing is enabled.
setEnabled(boolean) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: Whether audit file system storage is enabled.
setEnabledTypes(Map<String, Boolean>) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Whether the conversion specified by AuditProcessingProperties.defaultMutationNotifyEventTypes should be enabled for the given arbitrary subject name.
setEventRecorderBatchFileCompletionTimeout(long) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Duration of time (milliseconds) that should not be exceeded for a batch file to be considered complete.
setEventRecorderBatchFileMaxRecordCount(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Max number of AuditEvent records to include in a single batch file for subsequent ingestion.
setEventRecorderCoreThreadCount(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Core thread count for the ThreadPoolTaskExecutor backing the event recorder thread pool.
setEventRecorderMaxThreadCount(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: The number of threads AuditEventRecorder uses to process incoming AuditEvent instances.
setEventRecorderQueueCapacity(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Queue capacity for the ThreadPoolTaskExecutor backing the event recorder thread pool.
setGroup(boolean) - Method in class com.broadleafcommerce.common.audit.env.BasicProperties: Enable or disable the AuditProcessingProperties.isEnabled() and FileSystemStorageProviderProperties.isEnabled() as a group.
setHandlerCoreThreadCount(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Core thread count for the ThreadPoolTaskExecutor backing the handler thread pool.
setHandlerMaxThreadCount(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: The number of threads ChangeAuditHandler uses to process incoming DeployCompletedEvent instances.
setHandlerQueueCapacity(int) - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties: Queue capacity for the ThreadPoolTaskExecutor backing the handler thread pool.
setIngestionDirectory(String) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: The directory where completed batch files undergoing ingestion are stored.
setMaxFilesPerWorkingPartition(long) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: Batch files are placed into partitioned directories inside of FileSystemStorageProviderProperties.workingDirectory and FileSystemStorageProviderProperties.completionDirectory in order to avoid OS filesystem limitations regarding max file count per directory.
setWorkingDirectory(String) - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties: The directory where in-process batch files containing serialized AuditEvent instances are stored.
start() - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder
started - Variable in class com.broadleafcommerce.common.audit.AuditEventRecorder
stop() - Method in class com.broadleafcommerce.common.audit.AuditEventRecorder
StorageProvider - Interface in com.broadleafcommerce.common.audit.batch: Provider responsible for moving Batch representations through storage lifecycle, eventually completing the batch into it's final completion state that is ready for ingestion into AuditServices.

T

tenantId(String) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: The tenant to whom this audit record belongs.
tenantId(String) - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder: The tenant id associated with the current flow.
timestamp(Instant) - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder: The timestamp at which the field change took place
timestamp(Instant) - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder: The time at which the change was reported to the system.
timestamp(Instant) - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail.RawAuditEventDetailBuilder: The timestamp at which the field change took place
toString() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail.AdminAuditEventDetailBuilder
toString() - Method in class com.broadleafcommerce.common.audit.domain.AdminAuditEventDetail
toString() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent.AuditEventBuilder
toString() - Method in class com.broadleafcommerce.common.audit.domain.AuditEvent
toString() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader.AuditEventHeaderBuilder
toString() - Method in class com.broadleafcommerce.common.audit.domain.AuditEventHeader
toString() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail.RawAuditEventDetailBuilder
toString() - Method in class com.broadleafcommerce.common.audit.domain.RawAuditEventDetail
toString() - Method in class com.broadleafcommerce.common.audit.env.AuditProcessingProperties
toString() - Method in class com.broadleafcommerce.common.audit.env.BasicProperties
toString() - Method in class com.broadleafcommerce.common.audit.env.FileSystemStorageProviderProperties
toString() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation.AuditInformationBuilder
toString() - Method in class com.broadleafcommerce.common.audit.event.AuditInformation

U

unwrap(Class<T>) - Method in interface com.broadleafcommerce.common.audit.batch.Batch: Reveal the core object representing the stored batch.
unwrap(Class<T>) - Method in class com.broadleafcommerce.common.audit.batch.FileSystemBatch

V

valueOf(String) - Static method in enum class com.broadleafcommerce.common.audit.domain.DetailType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.broadleafcommerce.common.audit.domain.DetailType: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I J K M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form