Index

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

A

ACTIVE - Enum constant in enum class com.broadleafcommerce.common.messaging.repository.LockStatus

Lock exists and is active.

addConsumers(List<Consumer<RetryHandlerStatus>>) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryHandler

addConsumers(List<Consumer<RetryHandlerStatus>>) - Method in interface com.broadleafcommerce.common.messaging.notification.RetryHandler

Register a list of consumers of retry handler lifecycle events.

afterSuccessfulAcknowledgement(Object, NotificationStateAware, NotificationStateRepository) - Method in class com.broadleafcommerce.common.messaging.PersistenceMessageNotificationHandler

Invokes each PersistenceMessageAckedHandler.

afterSuccessfulAcknowledgement(Object, NotificationStateAware, NotificationStateRepository) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationHandler

A hook point intended to allow implementations to perform some behavior after a message has been successfully sent and the NotificationState has been marked as acknowledged.

afterSuccessfulAcknowledgement(Object, NotificationStateAware, NotificationStateRepository) - Method in interface com.broadleafcommerce.common.messaging.PersistenceMessageAckedHandler

A hook point intended to allow implementations to perform some behavior after a PersistenceMessage has been successfully sent and the NotificationState has been marked as acknowledged.

authenticationMessageOutput() - Method in interface com.broadleafcommerce.common.messaging.authentication.AuthenticationMessageProducer

AuthenticationMessageProducer - Interface in com.broadleafcommerce.common.messaging.authentication

Spring cloud data channel description for messaging output.

B

BindingModificationAware - Interface in com.broadleafcommerce.common.messaging

Component that is aware of Spring Cloud Stream channel destination modifications.

buildRetryHandler(NotificationStateRepository) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

C

camelContextEarlySetup(Environment) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.CamelSetupAutoConfiguration

CamelEnvironmentPostProcessor - Class in com.broadleafcommerce.common.messaging.autoconfigure

Configure which camel cluster service implementation is active from the default supported: file, zookeeper, and kubernetes.

CamelEnvironmentPostProcessor() - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.CamelEnvironmentPostProcessor

CamelSetupAutoConfiguration - Class in com.broadleafcommerce.common.messaging.autoconfigure

Workaround for a camel idiosyncrasy.

CamelSetupAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.CamelSetupAutoConfiguration

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

canEqual(Object) - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

CHANNEL - Static variable in interface com.broadleafcommerce.common.messaging.authentication.AuthenticationMessageProducer

CHANNEL - Static variable in interface com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer

CHANNEL - Static variable in interface com.broadleafcommerce.common.messaging.service.messaging.PurgeLockTriggeredJobEventConsumer

ChannelModifierProperties - Class in com.broadleafcommerce.common.messaging.notification

Configuration related to channel modifier keys for sorting relevant messages.

ChannelModifierProperties() - Constructor for class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

ChannelSupplier - Interface in com.broadleafcommerce.common.messaging.notification

General supplier representing the acquisition of a MessageChannel from a producer.

checkoutCompletionOutput() - Method in interface com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer

CheckoutCompletionProducer - Interface in com.broadleafcommerce.common.messaging.checkout

Spring cloud data channel description for messaging output.

CLUSTER_SERVICE - Enum constant in enum class com.broadleafcommerce.common.messaging.notification.RetryClusterServiceRequirementType

The CamelClusterService has issued an event denoting the targeted RetryClusterService is the leader.

com.broadleafcommerce.common.messaging - package com.broadleafcommerce.common.messaging

com.broadleafcommerce.common.messaging.authentication - package com.broadleafcommerce.common.messaging.authentication

com.broadleafcommerce.common.messaging.autoconfigure - package com.broadleafcommerce.common.messaging.autoconfigure

com.broadleafcommerce.common.messaging.autoconfigure.kafka - package com.broadleafcommerce.common.messaging.autoconfigure.kafka

com.broadleafcommerce.common.messaging.checkout - package com.broadleafcommerce.common.messaging.checkout

com.broadleafcommerce.common.messaging.data - package com.broadleafcommerce.common.messaging.data

com.broadleafcommerce.common.messaging.domain - package com.broadleafcommerce.common.messaging.domain

com.broadleafcommerce.common.messaging.environment - package com.broadleafcommerce.common.messaging.environment

com.broadleafcommerce.common.messaging.error - package com.broadleafcommerce.common.messaging.error

com.broadleafcommerce.common.messaging.exception - package com.broadleafcommerce.common.messaging.exception

com.broadleafcommerce.common.messaging.notification - package com.broadleafcommerce.common.messaging.notification

com.broadleafcommerce.common.messaging.notification.domain - package com.broadleafcommerce.common.messaging.notification.domain

com.broadleafcommerce.common.messaging.provider.jpa.autoconfigure - package com.broadleafcommerce.common.messaging.provider.jpa.autoconfigure

com.broadleafcommerce.common.messaging.provider.jpa.domain - package com.broadleafcommerce.common.messaging.provider.jpa.domain

com.broadleafcommerce.common.messaging.provider.jpa.repository - package com.broadleafcommerce.common.messaging.provider.jpa.repository

com.broadleafcommerce.common.messaging.repository - package com.broadleafcommerce.common.messaging.repository

com.broadleafcommerce.common.messaging.repository.autoconfigure - package com.broadleafcommerce.common.messaging.repository.autoconfigure

com.broadleafcommerce.common.messaging.service - package com.broadleafcommerce.common.messaging.service

com.broadleafcommerce.common.messaging.service.autoconfigure - package com.broadleafcommerce.common.messaging.service.autoconfigure

com.broadleafcommerce.common.messaging.service.messaging - package com.broadleafcommerce.common.messaging.service.messaging

CommonMessagingAutoConfiguration - Class in com.broadleafcommerce.common.messaging.autoconfigure

Autoconfiguration entry point for the messaging library

CommonMessagingAutoConfiguration(MessagingProperties) - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.CommonMessagingAutoConfiguration

CommonMessagingDefaultRepositoryAutoConfiguration - Class in com.broadleafcommerce.common.messaging.repository.autoconfigure

CommonMessagingDefaultRepositoryAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.repository.autoconfigure.CommonMessagingDefaultRepositoryAutoConfiguration

CommonMessagingJpaAutoConfiguration - Class in com.broadleafcommerce.common.messaging.provider.jpa.autoconfigure

Auto configuration entry point for jpa data tracking library

CommonMessagingJpaAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.provider.jpa.autoconfigure.CommonMessagingJpaAutoConfiguration

CommonMessagingRepositorySupportAutoConfiguration - Class in com.broadleafcommerce.common.messaging.repository.autoconfigure

Beans that are common to repository implementations of data-tracking

CommonMessagingRepositorySupportAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.repository.autoconfigure.CommonMessagingRepositorySupportAutoConfiguration

CommonMessagingServiceAutoConfiguration - Class in com.broadleafcommerce.common.messaging.service.autoconfigure

CommonMessagingServiceAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.service.autoconfigure.CommonMessagingServiceAutoConfiguration

compileChangeDetails() - Element in annotation interface com.broadleafcommerce.common.messaging.notification.SuppressNotification

Whether or not entities managed by the ignored repository should have change details compiled at the time of edit.

compressAndEncode(List<String>) - Static method in class com.broadleafcommerce.common.messaging.MessageUtils

consumeMessage(Message<T>, String, Consumer<Message<T>>) - Method in class com.broadleafcommerce.common.messaging.service.DefaultIdempotentMessageConsumptionService

consumeMessage(Message<T>, String, Consumer<Message<T>>) - Method in interface com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService

Executes the provided operation if the message's idempotency check passes.

consumeMessage(Message<T>, String, Function<Message<T>, R>) - Method in class com.broadleafcommerce.common.messaging.service.DefaultIdempotentMessageConsumptionService

consumeMessage(Message<T>, String, Function<Message<T>, R>) - Method in interface com.broadleafcommerce.common.messaging.service.IdempotentMessageConsumptionService

Executes the provided operation if the message's idempotency check passes.

create(CamelClusterService, DurableNotificationProperties, List<NotificationStateRepository>, NotificationHandler, String, List<IgnoredNotificationStateRepository>, DataRouteReference) - Static method in class com.broadleafcommerce.common.messaging.notification.RetryServiceFactory

Create a new RetryClusterService instance

create(CamelClusterService, DurableNotificationProperties, List<NotificationStateRepository>, NotificationHandler, String, List<IgnoredNotificationStateRepository>, DataRouteReference, List<Consumer<RetryHandlerStatus>>) - Static method in class com.broadleafcommerce.common.messaging.notification.RetryServiceFactory

createMessage(Object) - Method in interface com.broadleafcommerce.common.messaging.notification.MessageFactory

Create a Message based on an entity instance.

createMessage(Object) - Method in class com.broadleafcommerce.common.messaging.PersistenceMessageFactory

createMessage(Object, Map<String, Object>) - Method in interface com.broadleafcommerce.common.messaging.notification.MessageFactory

Create a Message based on an entity instance.

createMessageSafely(NotificationStateAware, NotificationState) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

createMessageSupplier(NotificationStateAware, NotificationState) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

D

decodeAndUncompress(String) - Static method in class com.broadleafcommerce.common.messaging.MessageUtils

DEFAULT_THREAD_POOL_SIZE - Static variable in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

DefaultIdempotentMessageConsumptionService - Class in com.broadleafcommerce.common.messaging.service

Service responsible for enforcing idempotency checks on a message before executing an operation against the message.

DefaultIdempotentMessageConsumptionService(MessageLockService) - Constructor for class com.broadleafcommerce.common.messaging.service.DefaultIdempotentMessageConsumptionService

DefaultMessageLockService - Class in com.broadleafcommerce.common.messaging.service

Service that is responsible for managing locks for the processing of a Message.

DefaultMessageLockService(ResourceLockRepository<?, ?>) - Constructor for class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

DefaultNotificationHandler - Class in com.broadleafcommerce.common.messaging.notification

DefaultNotificationHandler(ChannelSupplier, DurableNotificationProperties, String, List<IgnoredNotificationStateRepository>, MessageFactory<?>, MessageSerializationHelper) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

DefaultNotificationHandler(ChannelSupplier, DurableNotificationProperties, String, List<IgnoredNotificationStateRepository>, MessageSerializationHelper) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

DefaultNotificationManager - Class in com.broadleafcommerce.common.messaging.notification

DefaultNotificationManager(List<NotificationHandler>) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

DefaultNotificationManager.VoidWork - Interface in com.broadleafcommerce.common.messaging.notification

Perform a task without response or exception notification

DefaultNotificationStateService - Class in com.broadleafcommerce.common.messaging.notification

Default implementation of NotificationStateService.

DefaultNotificationStateService(TypeFactory) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultNotificationStateService

DefaultRetryClusterService - Class in com.broadleafcommerce.common.messaging.notification

DefaultRetryClusterService(List<NotificationStateRepository>, NotificationHandler, DurableNotificationProperties, String, List<IgnoredNotificationStateRepository>, DataRouteReference) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

DefaultRetryClusterServiceLifecycleManager - Class in com.broadleafcommerce.common.messaging.notification

Responsible for setting a late-phase requirement on all instances of RetryClusterService.

DefaultRetryClusterServiceLifecycleManager(List<RetryClusterService>) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterServiceLifecycleManager

DefaultRetryHandler - Class in com.broadleafcommerce.common.messaging.notification

DefaultRetryHandler(NotificationStateRepository, NotificationHandler, DurableNotificationProperties, String, TaskScheduler, DataRouteReference) - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultRetryHandler

DefaultSuppressNotificationAspect - Class in com.broadleafcommerce.common.messaging.notification

Handle establishment of SuppressNotificationContext when SuppressNotification annotation is detected.

DefaultSuppressNotificationAspect() - Constructor for class com.broadleafcommerce.common.messaging.notification.DefaultSuppressNotificationAspect

DELIMITER - Static variable in class com.broadleafcommerce.common.messaging.notification.IdInformation

deserializeMessage(String) - Static method in class com.broadleafcommerce.common.messaging.notification.IdInformation

DetachedDurableMessageSender - Interface in com.broadleafcommerce.common.messaging.notification

Utility for sending a durable message without requiring an explicit NotificationStateAware entity in which to deposit the durable tracking NotificationState instance for the message send.

DOES_NOT_EXIST - Enum constant in enum class com.broadleafcommerce.common.messaging.repository.LockStatus

Lock does not exist in the database.

doWithLock(String, Class<?>, String, String, Supplier<V>) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

doWithLock(String, Class<?>, String, String, Supplier<V>) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

doWithLock(String, Class<?>, String, String, Supplier<V>) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtainin a lock, perform an operation and then unlock

doWithTemporaryLock(String, Class<?>, String, String, Supplier<V>) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

doWithTemporaryLock(String, Class<?>, String, String, Duration, Supplier<V>) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

doWithTemporaryLock(String, Class<?>, String, String, Duration, Supplier<V>) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

doWithTemporaryLock(String, Class<?>, String, String, Duration, Supplier<V>) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtainin a lock, perform an operation and then unlock

doWithTemporaryLock(String, Class<?>, String, String, Supplier<V>) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

doWithTemporaryLock(String, Class<?>, String, String, Supplier<V>) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

A convenience method for ResourceLockRepository.lockResource(String, Class, String, String) and ResourceLockRepository.unlockResource(String) to obtain a temporary lock, perform an operation and then unlock

DurableNotificationAutoConfiguration - Class in com.broadleafcommerce.common.messaging.autoconfigure

DurableNotificationAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.DurableNotificationAutoConfiguration

DurableNotificationProperties - Interface in com.broadleafcommerce.common.messaging.notification

Properties that control behavior of the combination of a NotificationHandler and a RetryHandler.

E

EntityAwareNotificationState - Interface in com.broadleafcommerce.common.messaging.notification.domain

EntityUtils - Class in com.broadleafcommerce.common.messaging

Dynamically perform operations related to repository domain classes.

equals(Object) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

equals(Object) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

equals(Object) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

equals(Object) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

equals(Object) - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

equals(Object) - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

equals(Object) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

equals(Object) - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

ErrorMessagingAutoConfiguration - Class in com.broadleafcommerce.common.messaging.error

Autoconfiguration for common messaging error handling.

ErrorMessagingAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.error.ErrorMessagingAutoConfiguration

ErrorMessagingAutoConfiguration.LoggingGlobalErrorConfiguration - Class in com.broadleafcommerce.common.messaging.error

A configuration that logs global error messages to standard output.

exec() - Method in interface com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager.VoidWork

exec(ThrowingSupplier<V, T>, boolean, String...) - Static method in class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

exec(ThrowingSupplier<V, T>, String...) - Static method in class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

execute() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryHandler

execute() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryHandler

Perform the retry processing logic

EXECUTED - Enum constant in enum class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatusType

executePostTransactionCommitOrNow(DefaultNotificationManager.VoidWork) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

Do a unit of work upon successful completion of the current transaction, or, execute the work immediately if transaction synchronization is not currently active.

F

findId(Object) - Static method in class com.broadleafcommerce.common.messaging.EntityUtils

findIdField(Class<?>) - Static method in class com.broadleafcommerce.common.messaging.EntityUtils

Find the field marked with the Spring or JPA @Id annotation in the entity class.

findMessageSupportingRoutes() - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

Identifies all data routes that support messaging domain

findNotificationReadyMembers(Object, int, String, Duration, Class<?>) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationStateRepository

Find any entity instances that are unacknowledged and qualified for retry for message sending.

findNotificationState(String) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationStateAware

Looks up a NotificationState from the states within this collection

formatOriginalMessageHeaders(Message<?>) - Method in class com.broadleafcommerce.common.messaging.error.LoggingGlobalErrorChannelListener

Converts the message headers from the original message into a display friendly string.

formatOriginalMessagePayload(Message<?>) - Method in class com.broadleafcommerce.common.messaging.error.LoggingGlobalErrorChannelListener

Formats the original message's payload into a display friendly string.

G

get() - Method in interface com.broadleafcommerce.common.messaging.notification.ChannelSupplier

get() - Method in interface com.broadleafcommerce.common.messaging.notification.MessageSupplier

get() - Static method in class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

get_baseClass() - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

get_class() - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

get_id() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

getAdditionalHeaders() - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

getAdditionalLockTypesToPurge(ScheduledJobRef) - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

getAdditionalParameters() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

Additional information that can be used to add parameters for the scheduled job listeners.

getAssignableTo() - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

Class, interface or superclass that the target repository can be assigned to

getAttempts() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The number of times the system has attempted sending a message for this state change.

getAttributes() - Method in interface com.broadleafcommerce.common.messaging.notification.MessageAdditionalInformationAware

The attributes to leverage during message construction at MessageFactory.createMessage(Object, Map)

getBeanFactory() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

getChangeTimestamp() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Retrieve the last time this entity was updated in a way that requires notification via a message bus.

getChangeTimestampAck() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Retrieve the last time a message was sent for a state change to the message bus.

getChannelModifier() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

getChannelModifier() - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationHandler

Retrieve any modifier for the channel associated with this handler.

getClusterK8sAppLabel() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

If using kubernetes cluster service implementation type, this is the name of the pod label used to group common service instances.

getClusterK8sAppLabelValue() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

If using kubernetes cluster service implementation type, this is the value for the pod label.

getClusterServiceImplementationType() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

Specify which camel cluster service implementation to support.

getClustServiceImplementation() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

Deprecated.

cluster service implementation now supported by MessagingProperties.clusterServiceImplementationType Implementation of CamelClusterService to utilize

getConceptKey() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

A generally descriptive key that identifies the overall concept for which the lock is taking place.

getConceptKeyOrDefault(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

getContextId() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The contextId of the Trackable resource to lock

getDefaultStagnationThreshold() - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

The time, once elapsed, in which the system will consider a lock abandoned and allow another requester to acquire the lock.

getDelayAtStartup() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The amount of time after initialization of the application that must pass before the retry scheduler starts.

getDetails() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

getEntity() - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

getEntityType() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.EntityAwareNotificationState

getEnvironment() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

getExpirationTimestamp() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The time at which the lock will naturally expire

getFailureRateThreshold() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the failure rate threshold in percentage above which the CircuitBreaker should trip open and start short-circuiting calls.

getFileLockRootPath() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

Deprecated.

Not required. Use MessagingProperties.clusterServiceImplementationType support instead. If using FileLockClusterService, the root path to store the lock files

getHandlersInScope(Object) - Method in class com.broadleafcommerce.common.messaging.PersistenceMessageNotificationHandler

getId() - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

getId() - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

getIdempotentConsumptionService() - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

getInitialFaultThreshold() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The amount of time that must elapse before the retry mechanism can kick in on a newly altered and unacknowledged record.

getLastExecuted() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

The date on which the job last executed.

getLifecycleRequirementsMet() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

getLifecycleRequirementsMet() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Retrieve the list of lifecycle requirements that have been met.

getLocked() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

Whether or not the resource is locked

getLockPurgePageSize() - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

getLockTypesToPurge(String) - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

getMaxAttempts() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The maximum number of failed attempts that should be made before ceasing to attempt to send a message for an unacknowledged record.

getMaxAttemptWaitTime() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The maximum amount of time that should elapse before making another attempt on an unacknowledged record.

getMessage() - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

getMessageLockService() - Method in class com.broadleafcommerce.common.messaging.service.DefaultIdempotentMessageConsumptionService

getMessageLockService() - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

getMessageType() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The fully qualified Type for the message information

getMessageType() - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

The type of message the repository should be ignored for.

getMessageType() - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

The unique identifier for the type of message being handled

getMessageTypes() - Method in class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

getMessageValue() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

If message serialization is used, this is the JSON string version of the message information

getMessageValue() - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

getModifier() - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

getName() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

The name of this detail.

getName() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The name identifying this particular message state.

getNamespaceModByBindingProperty() - Method in interface com.broadleafcommerce.common.messaging.BindingModificationAware

A map keyed by the original, fully-qualified property binding (before modification) whose value is the modification string.

getNextAttempt() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The time at which (or beyond which) another retry attempt should be made

getNotification() - Method in interface com.broadleafcommerce.common.messaging.notification.DurableNotificationProperties

Configuration for the NotificationHandler

getNotification() - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

getNotificationStates() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationStateAware

Retrieve the message sending status for one or more NotificationState instances.

getNotificationStates(boolean) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationStateAware

Retrieve the message sending status for one or more NotificationState instances.

getObjectMapper() - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

Return the ObjectMapper to use when handling the message json.

getObjectRepresentation(String, Class<T>) - Method in class com.broadleafcommerce.common.messaging.notification.MessageSerializationHelper

Get an object version of some JSON.

getObjectRepresentation(String, String) - Method in class com.broadleafcommerce.common.messaging.notification.MessageSerializationHelper

Get an object version of some JSON using a string-based class name.

getOrder() - Method in class com.broadleafcommerce.common.messaging.error.ErrorMessagingAutoConfiguration.LoggingGlobalErrorConfiguration

getOrder() - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationHandler

getOrder() - Method in interface com.broadleafcommerce.common.messaging.PersistenceMessageAckedHandler

getOrInitializeNotificationState(NotificationStateAware, String) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationStateService

getOrInitializeNotificationState(NotificationStateAware, String) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationStateService

Search the NotificationState on the NotificationStateAware by its name.

getPageSize() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The number of valid, unacknowledged records to batch process per interval.

getPersistenceMessageAckedHandlers() - Method in class com.broadleafcommerce.common.messaging.PersistenceMessageNotificationHandler

getPhase() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

getPhase() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterServiceLifecycleManager

getRecordProcessingWait() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The amount of time to pause between the processing of each unacknowledged record in the batch.

getReference() - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

getRepository() - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

The repository associated with the durable notification state for the message

getResourceLockRepository() - Method in class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

getRetry() - Method in interface com.broadleafcommerce.common.messaging.notification.DurableNotificationProperties

Configuration for the RetryHandler

getRetry() - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

getRetryClusterServiceNamespace() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

Name used to identify the cluster singleton lock

getRetryInterval() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The length of time to wait between each batch retry attempt.

getRingBufferSizeInClosedState() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the size of the ring buffer when the CircuitBreaker is closed.

getRingBufferSizeInHalfOpenState() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the size of the ring buffer when the CircuitBreaker is half open.

getSandboxId() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The sandboxId in which the workflow operation is taking place.

getSandboxIdOrDefault(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

getSendTimeout() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

The length of time a message send attempt should block before timing out.

getSerializedRepresentation(Object) - Method in class com.broadleafcommerce.common.messaging.notification.MessageSerializationHelper

The message information to convert to JSON string.

getSource() - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

The handler responsible for the activity

getStatus() - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

The lifecycle event type being reported

getSuffix() - Method in class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

If no modifier is provided via MicroCloudStreamBindingCommon configuration, then apply this suffix value as a modifier key during all attempts to match relevant notification state messages.

getSupportedSimpleTypeNames() - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

The simple entity type names supported by this service.

getTenantId() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

The ID of the associated tenant.

getThreadPoolSize() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

The thread pool size used for async handling.

getTimestamp() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The time at which the lock was set to true

getToken() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The token assigned the last time the lock was set to true.

getToken() - Method in interface com.broadleafcommerce.common.messaging.Securable

A Base64 encoded JWT token generally containing the following claims: user - the user name for the user that generated the message via some action.

getType() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

getTypeAlias() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

An alias used to represent the Java type of the resource being locked.

getValue() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

A value for this detail.

getWaitDurationInOpenState() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the wait duration which specifies how long the CircuitBreaker should stay open, before it switches to half open.

getWaitTimeExp(int) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

Provide an exponential backoff wait period based on the number of attempts

GlobalErrorChannelListener - Interface in com.broadleafcommerce.common.messaging.error

This is a marker interface for a listener that listens to the global error channel.

H

handle(NotificationStateRepository, NotificationStateAware, String) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

handle(NotificationStateRepository, NotificationStateAware, String) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

handle(NotificationStateRepository, NotificationStateAware, String) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationHandler

Notify the system in some way about the state change for the notifiable param.

handle(NotificationStateRepository, NotificationStateAware, String) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationManager

Notify the system in some way about the state change for the notifiable param.

handle(String) - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

Entry point for the handler.

handleAsync(NotificationStateRepository, NotificationStateAware, String) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

handleAsync(NotificationStateRepository, NotificationStateAware, String) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationManager

Notify the system in some way about the state change for the notifiable param.

handleAsync(NotificationStateRepository, NotificationStateAware, String, Runnable) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

handleAsync(NotificationStateRepository, NotificationStateAware, String, Runnable) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationManager

Notify the system in some way about the state change for the notifiable param.

handleMessageInternal(Message<?>) - Method in class com.broadleafcommerce.common.messaging.error.LoggingGlobalErrorChannelListener

hashCode() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

hashCode() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

hashCode() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

hashCode() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

hashCode() - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

hashCode() - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

hashCode() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

hashCode() - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

hook(String) - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

Hook point for message listeners to bind to the input channel with @StreamListener.

I

IdempotentMessage - Class in com.broadleafcommerce.common.messaging.notification

IdempotentMessage() - Constructor for class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

IdempotentMessage(String, Map<String, String>, Object) - Constructor for class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

idempotentMessageConsumptionService(MessageLockService) - Method in class com.broadleafcommerce.common.messaging.service.autoconfigure.CommonMessagingServiceAutoConfiguration

IdempotentMessageConsumptionService - Interface in com.broadleafcommerce.common.messaging.service

Service responsible for enforcing idempotency checks on a message before executing an operation against the message.

identifyLocksToBePurged(Class<?>, Duration, String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

Deprecated, for removal: This API element is subject to removal in a future version.

in favor of JpaCustomizedResourceLockRepository.identifyLocksToBePurged(Set, Duration, String)

identifyLocksToBePurged(Set<String>, Duration, String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

Identifies locks that are eligible to be purged

IdInformation - Class in com.broadleafcommerce.common.messaging.notification

For NotificationState handling (especially NotificationStateRepository.setFailedNotificationAttempt(Object, String, int, Instant, Class, boolean)), support a robust identification structure that includes optional modifiers for the message value.

IdInformation(Object, String, String) - Constructor for class com.broadleafcommerce.common.messaging.notification.IdInformation

IgnoredNotificationStateRepository - Class in com.broadleafcommerce.common.messaging.notification

Identify a repository that should not be included in the operation of NotificationHandler and RetryHandler.

IgnoredNotificationStateRepository(Class<?>) - Constructor for class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

IgnoredNotificationStateRepository(Class<?>, String) - Constructor for class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

INACTIVE - Enum constant in enum class com.broadleafcommerce.common.messaging.repository.LockStatus

Lock record exists, but is inactive.

init() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

InternalPersistenceEvent - Class in com.broadleafcommerce.common.messaging.notification.domain

Spring level event (local to the current JVM) that is fired upon Trackable entity persistence.

InternalPersistenceEvent(NotificationStateAware) - Constructor for class com.broadleafcommerce.common.messaging.notification.domain.InternalPersistenceEvent

isAcked() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Whether or not this state has been acknowledged as successfully being sent to the message broker

isAsyncEnabled() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

Whether calls to NotificationManager.handleAsync(NotificationStateRepository, NotificationStateAware, String) will actually use async threading.

isAutoStartup() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

isCompileChangeDetails() - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

Whether or not entities managed by the ignored repository should have change details compiled at the time of edit.

isCompileChangeDetails() - Method in class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

isDeveloperMode() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

Deprecated.

Development state is now handled through the broadleaf.messaging.cluster-service-implementation-type property. The default for that property is file, which is appropriate for local development.

isHandled() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

Whether or not the handler was qualified and processed the handle request

isRunning() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

isRunning() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterServiceLifecycleManager

isSendEnabled() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Whether or not sending on the producer channel is allowed.

isStarted() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

isStarted() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Whether the cluster service is already started.

isStop() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

Whether or not other handlers should be allowed to process as well, or if handling should stop now

isStopped() - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Whether or not retry attempts should cease for this state

isValidType(String, String) - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

Determine if the type (i.e.

J

JpaCustomizedResourceLockRepository - Class in com.broadleafcommerce.common.messaging.provider.jpa.repository

Specialized implementation of JpaResourceLockRepository.

JpaCustomizedResourceLockRepository(TransactionTemplate, ResourceLockProperties) - Constructor for class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

JpaResourceLock - Class in com.broadleafcommerce.common.messaging.provider.jpa.domain

Represents a single lock on a resource held in the current datastore.

JpaResourceLock() - Constructor for class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

JpaResourceLockRepository - Interface in com.broadleafcommerce.common.messaging.provider.jpa.repository

jpaResourceLockRepositoryImpl(PlatformTransactionManager, ResourceLockProperties) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.autoconfigure.CommonMessagingJpaAutoConfiguration

K

KafkaCommonMessagingAutoConfiguration - Class in com.broadleafcommerce.common.messaging.autoconfigure.kafka

Kafka specific messaging configuration.

KafkaCommonMessagingAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.kafka.KafkaCommonMessagingAutoConfiguration

KafkaCommonMessagingAutoConfiguration.SpringKafkaRetryDisablingConfiguration - Class in com.broadleafcommerce.common.messaging.autoconfigure.kafka

Configuration that disables Spring Kafka retries.

L

LATE_PHASE_SPRING - Enum constant in enum class com.broadleafcommerce.common.messaging.notification.RetryClusterServiceRequirementType

Spring lifecycle has reached a late phase in startup.

listen(Message<ScheduledJobRef>) - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

LOCK_INSERT - Static variable in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

LOCK_UPDATE - Static variable in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

lockResource(String, Class<?>, String, String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

lockResource(String, Class<?>, String, String) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

lockResource(String, Class<?>, String, String) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Lock a resource indefinitely based on identifying information.

lockResourceTemporarily(String, Class<?>, String, String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

lockResourceTemporarily(String, Class<?>, String, String, Duration) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

lockResourceTemporarily(String, Class<?>, String, String) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

lockResourceTemporarily(String, Class<?>, String, String) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Lock a resource temporarily based on identifying information.

lockResourceTemporarily(String, Class<?>, String, String, Duration) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

lockResourceTemporarily(String, Class<?>, String, String, Duration) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Lock a resource temporarily based on identifying information.

LockStatus - Enum Class in com.broadleafcommerce.common.messaging.repository

Report on the status of a lock.

log - Static variable in interface com.broadleafcommerce.common.messaging.PersistenceHandler

logErrorMessage(ErrorMessage) - Method in class com.broadleafcommerce.common.messaging.error.LoggingGlobalErrorChannelListener

Logs the given error message.

LoggingGlobalErrorChannelListener - Class in com.broadleafcommerce.common.messaging.error

A global error channel listener that logs the errored messages.

LoggingGlobalErrorChannelListener() - Constructor for class com.broadleafcommerce.common.messaging.error.LoggingGlobalErrorChannelListener

LoggingGlobalErrorConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.error.ErrorMessagingAutoConfiguration.LoggingGlobalErrorConfiguration

M

MESSAGE_IDEMPOTENCY_KEY - Static variable in class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

MESSAGE_LOCK_TTL_IN_SEC - Static variable in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

MESSAGE_LOCK_TYPES - Static variable in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

MESSAGE_VALUE_KEY - Static variable in class com.broadleafcommerce.common.messaging.notification.IdInformation

MessageAdditionalInformationAware - Interface in com.broadleafcommerce.common.messaging.notification

An entity can be wrapped with this interface before passing to DefaultNotificationHandler for processing.

MessageFactory<T> - Interface in com.broadleafcommerce.common.messaging.notification

Factory for creating a Message to be sent via NotificationHandler, based on an entity.

messageLockService - Variable in class com.broadleafcommerce.common.messaging.service.DefaultIdempotentMessageConsumptionService

messageLockService - Variable in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

messageLockService(ResourceLockRepository<?, ?>) - Method in class com.broadleafcommerce.common.messaging.service.autoconfigure.CommonMessagingServiceAutoConfiguration

MessageLockService - Interface in com.broadleafcommerce.common.messaging.service

Service that is responsible for managing locks for the processing of a Message.

messageSerializationHelper(ObjectMapper) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.CommonMessagingAutoConfiguration

MessageSerializationHelper - Class in com.broadleafcommerce.common.messaging.notification

Helper class for managing serialized state of message information.

MessageSerializationHelper(ObjectMapper) - Constructor for class com.broadleafcommerce.common.messaging.notification.MessageSerializationHelper

MessageSupplier<T> - Interface in com.broadleafcommerce.common.messaging.notification

MessageUtils - Class in com.broadleafcommerce.common.messaging

Utility methods useful for creating and working with messages, such as compression and decompression of large payloads.

MessagingDataRouteSupporting - Interface in com.broadleafcommerce.common.messaging.data

MessagingProperties - Class in com.broadleafcommerce.common.messaging.environment

MessagingProperties() - Constructor for class com.broadleafcommerce.common.messaging.environment.MessagingProperties

MODIFIER_KEY - Static variable in class com.broadleafcommerce.common.messaging.notification.IdInformation

MutableDurableNotificationProperties - Interface in com.broadleafcommerce.common.messaging.notification

Represents DurableNotificationProperties whose notification and retry fields may be reset to new objects.

N

NoOpResourceLockRepository - Class in com.broadleafcommerce.common.messaging.repository

Simple ResourceLockRepository implementation that DOES NOTHING.

NoOpResourceLockRepository() - Constructor for class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

NotificationHandler - Interface in com.broadleafcommerce.common.messaging.notification

Notify the system about a state change for a NotificationStateAware entity.

NotificationHandlerResponse - Class in com.broadleafcommerce.common.messaging.notification

Response information from a NotificationHandler.handle(NotificationStateRepository, NotificationStateAware, MessageType) call.

NotificationHandlerResponse(boolean, boolean) - Constructor for class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

notificationManager(List<NotificationHandler>) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.DurableNotificationAutoConfiguration

NotificationManager - Interface in com.broadleafcommerce.common.messaging.notification

Management component for processing a state change on an object through one or more ordered NotificationHandler instances.

NotificationManagerProperties - Class in com.broadleafcommerce.common.messaging.notification

Configuration for instances of NotificationManager

NotificationManagerProperties() - Constructor for class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

NotificationProperties - Class in com.broadleafcommerce.common.messaging.notification

Configuration for a NotificationHandler

NotificationProperties() - Constructor for class com.broadleafcommerce.common.messaging.notification.NotificationProperties

NotificationState - Interface in com.broadleafcommerce.common.messaging.notification.domain

Keep track of message bus notification of state change of a NotificationStateAware entity.

NotificationStateAware - Interface in com.broadleafcommerce.common.messaging.notification.domain

A domain that keeps track of NotificationState

NotificationStateRepository - Interface in com.broadleafcommerce.common.messaging.notification

Additional interface for repository instances that are capable of interacting with NotificationState related information on NotificationStateAware domain.

NotificationStateRepositoryFragment - Interface in com.broadleafcommerce.common.messaging.notification

Marker interface used to differentiate between a full repository implementing NotificationStateRepository and a internal repository fragment component providing the actual implementation.

notificationStateService(TypeFactory) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.CommonMessagingAutoConfiguration

NotificationStateService - Interface in com.broadleafcommerce.common.messaging.notification

Used to retrieve the NotificationState from the NotificationStateAware.

notify(NotificationStateAware, NotificationState, NotificationStateRepository) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

Validate the state requires notification, and if so, send the notification.

O

obtainLock(Message<?>, String) - Method in class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

obtainLock(Message<?>, String) - Method in interface com.broadleafcommerce.common.messaging.service.MessageLockService

Creates a JpaResourceLock based on the contents of the provided Message and listenerName.

of(T) - Static method in class com.broadleafcommerce.common.messaging.PersistenceMessage

P

PACKAGE_FRAGMENT - Static variable in interface com.broadleafcommerce.common.messaging.data.MessagingDataRouteSupporting

PersistenceHandler - Interface in com.broadleafcommerce.common.messaging

PersistenceHandlers are responsible for listening for PersistenceConsumer channel events associated with a specific repository domain type.

PersistenceMessage<T> - Class in com.broadleafcommerce.common.messaging

Formats the message in a way that the PersistenceConsumer expects to receive the payload in

PersistenceMessage(T) - Constructor for class com.broadleafcommerce.common.messaging.PersistenceMessage

PersistenceMessageAckedHandler - Interface in com.broadleafcommerce.common.messaging

Every component implementing this interface is injected and invoked by PersistenceMessageNotificationHandler.afterSuccessfulAcknowledgement(Object, NotificationStateAware, NotificationStateRepository) following successful acknowledgement of a NotificationState for a PersistenceMessage.

persistenceMessageFactory() - Method in class com.broadleafcommerce.common.messaging.autoconfigure.PersistenceNotificationAutoConfiguration

PersistenceMessageFactory - Class in com.broadleafcommerce.common.messaging

MessageFactory for creating messages suitable for the PersistenceProducer channel

PersistenceMessageFactory() - Constructor for class com.broadleafcommerce.common.messaging.PersistenceMessageFactory

PersistenceMessageNotificationHandler - Class in com.broadleafcommerce.common.messaging

The NotificationHandler implementation specifically for sending PersistenceMessage via PersistenceProducer.

PersistenceMessageNotificationHandler(ChannelSupplier, DurableNotificationProperties, List<IgnoredNotificationStateRepository>, MessageFactory<?>, MessageSerializationHelper, List<PersistenceMessageAckedHandler>, DataRouteReference) - Constructor for class com.broadleafcommerce.common.messaging.PersistenceMessageNotificationHandler

PersistenceNotificationAutoConfiguration - Class in com.broadleafcommerce.common.messaging.autoconfigure

Configure the durable notification components related to PersistenceProducer

PersistenceNotificationAutoConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.PersistenceNotificationAutoConfiguration

persistenceNotificationHandler(PersistenceProducer, PersistenceNotificationProperties, List<IgnoredNotificationStateRepository>, MessageFactory<PersistenceMessage<Object>>, MessageSerializationHelper, List<PersistenceMessageAckedHandler>, DataRouteReference) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.PersistenceNotificationAutoConfiguration

PersistenceNotificationProperties - Class in com.broadleafcommerce.common.messaging

Configuration properties for the NotificationHandler and RetryHandler related to PersistenceProducer

PersistenceNotificationProperties() - Constructor for class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

persistenceOutput() - Method in interface com.broadleafcommerce.common.messaging.PersistenceProducer

PersistenceProducer - Interface in com.broadleafcommerce.common.messaging

Spring cloud data channel description for messaging output.

persistenceRetryClusterService(CamelClusterService, PersistenceNotificationProperties, List<NotificationStateRepository>, NotificationHandler, List<IgnoredNotificationStateRepository>, DataRouteReference) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.PersistenceNotificationAutoConfiguration

postProcessBeanDefinitionRegistry(BeanDefinitionRegistry) - Method in class com.broadleafcommerce.common.messaging.error.ErrorMessagingAutoConfiguration.LoggingGlobalErrorConfiguration

postProcessBeanFactory(ConfigurableListableBeanFactory) - Method in class com.broadleafcommerce.common.messaging.error.ErrorMessagingAutoConfiguration.LoggingGlobalErrorConfiguration

postProcessEnvironment(ConfigurableEnvironment, SpringApplication) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.CamelEnvironmentPostProcessor

processStateChange(JsonNode) - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

Handle the entityJson representation of the change that has been deemed appropriate for this handler based on comparing the expected _class parameter in the JSON against the generic type of the handler implementation.

PURGE_MESSAGE_LOCKS_JOB_TYPE - Static variable in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

purgeLocks(Set<String>, Duration) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

This table will be highly susceptible to deadlocks.

purgeLocks(Class<?>, Duration) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Deletes all non-expiring locks that are out of date according to the lockTtl and have JpaResourceLock.getTypeAlias() equal to the provided type.

purgeLocks(Duration) - Method in class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

purgeLocks(Duration) - Method in interface com.broadleafcommerce.common.messaging.service.MessageLockService

Deprecated.

in favor of MessageLockService.purgeLocks(Duration, Set)

purgeLocks(Duration, Set<String>) - Method in class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

purgeLocks(Duration, Set<String>) - Method in interface com.broadleafcommerce.common.messaging.service.MessageLockService

Deletes all message locks that are out of date according to the messageLockTtl.

purgeLocks(Set<String>, Duration) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

purgeLocks(Set<String>, Duration) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Deletes all non-expiring locks that are out of date according to the lockTtl and have JpaResourceLock.getTypeAlias() equal to the provided lockTypes.

purgeLocks(Message<ScheduledJobRef>) - Method in class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

Gathers the message lock TTL from the provided ScheduledJobRef and purges all relevant message locks

PurgeLockTriggeredJobEventConsumer - Interface in com.broadleafcommerce.common.messaging.service.messaging

Spring cloud stream messaging interface for receiving triggered job execution from the scheduled job microservice.

PurgeMessageLocksListener - Class in com.broadleafcommerce.common.messaging.service.messaging

Scheduled Job listener that is responsible for initiating the purging of message locks for all relevant data routes.

PurgeMessageLocksListener(IdempotentMessageConsumptionService, MessageLockService, DataRouteReference) - Constructor for class com.broadleafcommerce.common.messaging.service.messaging.PurgeMessageLocksListener

R

releaseLock(JpaResourceLock) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

Deletes the provided lock

releaseLock(String) - Method in class com.broadleafcommerce.common.messaging.service.DefaultMessageLockService

releaseLock(String) - Method in interface com.broadleafcommerce.common.messaging.service.MessageLockService

Releases the lock so that the relevant message can be processed again.

ResourceLockException - Exception in com.broadleafcommerce.common.messaging.exception

Exception thrown when the system is unable to acquire a lock on a resource.

ResourceLockException() - Constructor for exception com.broadleafcommerce.common.messaging.exception.ResourceLockException

ResourceLockException(String) - Constructor for exception com.broadleafcommerce.common.messaging.exception.ResourceLockException

ResourceLockProperties - Class in com.broadleafcommerce.common.messaging.repository

Configuration for ResourceLockRepository.

ResourceLockProperties() - Constructor for class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

resourceLockRepository() - Method in class com.broadleafcommerce.common.messaging.repository.autoconfigure.CommonMessagingDefaultRepositoryAutoConfiguration

Should only be initialized if a legitimate bean has not been instantiated

ResourceLockRepository<D,ID> - Interface in com.broadleafcommerce.common.messaging.repository

Repository responsible for allowing requesters to lock and unlock a resource.

RetryBreakException - Exception in com.broadleafcommerce.common.messaging.notification

Generally thrown during retry processing to allow the RetryHandler to break out of a processing loop.

RetryBreakException() - Constructor for exception com.broadleafcommerce.common.messaging.notification.RetryBreakException

RetryBreakException(String) - Constructor for exception com.broadleafcommerce.common.messaging.notification.RetryBreakException

RetryClusterService - Interface in com.broadleafcommerce.common.messaging.notification

Used to keep track of start/stop behavior that determines node leadership in a cluster.

retryClusterServiceLifecycleManager(List<RetryClusterService>) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.PersistenceNotificationAutoConfiguration

RetryClusterServiceRequirementType - Enum Class in com.broadleafcommerce.common.messaging.notification

Denotes several key lifecycle events that should occur before a RetryClusterService starts.

retryHandler(NotificationStateRepository, NotificationHandler, DurableNotificationProperties, String, TaskScheduler, DataRouteReference) - Method in class com.broadleafcommerce.common.messaging.autoconfigure.DurableNotificationAutoConfiguration

RetryHandler - Interface in com.broadleafcommerce.common.messaging.notification

Retry notification on a set schedule for unacknowledged NotificationStateAware instances belonging to a specific NotificationStateRepository instance.

RetryHandlerStatus - Class in com.broadleafcommerce.common.messaging.notification

Status description of a retry handler lifecycle event.

RetryHandlerStatus(RetryHandler, RetryHandlerStatusType, NotificationStateRepository, String) - Constructor for class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

RetryHandlerStatusType - Enum Class in com.broadleafcommerce.common.messaging.notification

Lifecycle event that occurred

RetryProperties - Class in com.broadleafcommerce.common.messaging.notification

Configuration for a RetryHandler

RetryProperties(String) - Constructor for class com.broadleafcommerce.common.messaging.notification.RetryProperties

retryScheduler() - Method in class com.broadleafcommerce.common.messaging.autoconfigure.DurableNotificationAutoConfiguration

RetryServiceFactory - Class in com.broadleafcommerce.common.messaging.notification

Factory for constructing new RetryClusterService instances.

RetryServiceFactory() - Constructor for class com.broadleafcommerce.common.messaging.notification.RetryServiceFactory

S

ScheduledJobDetailRef - Class in com.broadleafcommerce.common.messaging.domain

Detailed information for a ScheduledJobRef, which corresponds to a ScheduledJobDetail of the scheduled job microservice.

ScheduledJobDetailRef() - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

ScheduledJobDetailRef(String, Object) - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

ScheduledJobRef - Class in com.broadleafcommerce.common.messaging.domain

A reference to a ScheduledJob of the scheduled job microservice.

ScheduledJobRef() - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

ScheduledJobRef(String, List<ScheduledJobDetailRef>) - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

ScheduledJobRef(String, List<ScheduledJobDetailRef>, String) - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

ScheduledJobRef(String, List<ScheduledJobDetailRef>, String, Instant) - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

ScheduledJobRef(String, List<ScheduledJobDetailRef>, String, Instant, Map<String, Object>) - Constructor for class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

Securable - Interface in com.broadleafcommerce.common.messaging

A Spring Cloud Stream message containing a JWT token that can be verified for authenticity and that contains claims about the messages originating user that can be validated for suitability of consumption in the current context.

send(Object, String, String, String) - Method in interface com.broadleafcommerce.common.messaging.notification.DetachedDurableMessageSender

Send a durable message.

send(Object, String, String, String, Map<String, String>) - Method in interface com.broadleafcommerce.common.messaging.notification.DetachedDurableMessageSender

Send a durable message.

sendRemote(Message<?>, long) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

Send the message on the remote channel.

sendRemoteMessageSafely(Message<?>) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

serializeMessage() - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

set_id(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

setAcked(boolean) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Whether or not this state has been acknowledged as successfully being sent to the message broker

setAdditionalHeaders(Map<String, String>) - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

setAdditionalParameters(Map<String, Object>) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

Additional information that can be used to add parameters for the scheduled job listeners.

setAsyncEnabled(boolean) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

Whether calls to NotificationManager.handleAsync(NotificationStateRepository, NotificationStateAware, String) will actually use async threading.

setAttempts(int) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The number of times the system has attempted sending a message for this state change.

setBeanFactory(BeanFactory) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

setBeanFactory(ListableBeanFactory) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

setChangeTimestamp(Instant) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Set the last time this entity was updated in a way that requires notification via a message bus.

setChangeTimestampAck(Instant) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Set the last time a message was sent for a state change to the message bus.

setChannelModifierProperties(ChannelModifierProperties) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

setClusterK8sAppLabel(String) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

If using kubernetes cluster service implementation type, this is the name of the pod label used to group common service instances.

setClusterK8sAppLabelValue(String) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

If using kubernetes cluster service implementation type, this is the value for the pod label.

setClusterServiceImplementationType(String) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

Specify which camel cluster service implementation to support.

setClustServiceImplementation(Class<?>) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

Deprecated.

cluster service implementation now supported by MessagingProperties.clusterServiceImplementationType Implementation of CamelClusterService to utilize

setCompileChangeDetails(boolean) - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

Whether or not entities managed by the ignored repository should have change details compiled at the time of edit.

setConceptKey(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

A generally descriptive key that identifies the overall concept for which the lock is taking place.

setContextId(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The contextId of the Trackable resource to lock

setDefaultStagnationThreshold(Duration) - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

The time, once elapsed, in which the system will consider a lock abandoned and allow another requester to acquire the lock.

setDelayAtStartup(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The amount of time after initialization of the application that must pass before the retry scheduler starts.

setDetails(List<ScheduledJobDetailRef>) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

setDeveloperMode(boolean) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

Deprecated.

Development state is now handled through the broadleaf.messaging.cluster-service-implementation-type property. The default for that property is file, which is appropriate for local development.

setEntityType(String) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.EntityAwareNotificationState

setEnvironment(Environment) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

setEventPublisher(ApplicationEventPublisher) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

setExpirationTimestamp(Instant) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The time at which the lock will naturally expire

setFailedNotificationAttempt(Object, String, int, Instant, Class<?>, boolean) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationStateRepository

Notate a failed message send attempt for a messageType on the NotificationState of an entity of a particular type.

setFailureRateThreshold(float) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the failure rate threshold in percentage above which the CircuitBreaker should trip open and start short-circuiting calls.

setFileLockRootPath(String) - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

Deprecated.

Not required. Use MessagingProperties.clusterServiceImplementationType support instead. If using FileLockClusterService, the root path to store the lock files

setId(String) - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

setInitialFaultThreshold(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The amount of time that must elapse before the retry mechanism can kick in on a newly altered and unacknowledged record.

setLastExecuted(Instant) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

The date on which the job last executed.

setLifecycleRequirementMet(RetryClusterServiceRequirementType) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

setLifecycleRequirementMet(RetryClusterServiceRequirementType) - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Notify a retry cluster service instance that a particular lifecycle event has been met.

setLocked(Boolean) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

Whether or not the resource is locked

setLockPurgePageSize(int) - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

setMaxAttempts(int) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The maximum number of failed attempts that should be made before ceasing to attempt to send a message for an unacknowledged record.

setMaxAttemptWaitTime(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The maximum amount of time that should elapse before making another attempt on an unacknowledged record.

setMessage(Object) - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

setMessageType(String) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The fully qualified Type for the message information

setMessageType(String) - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

The type of message the repository should be ignored for.

setMessageValue(String) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

If message serialization is used, this is the JSON string version of the message information

setName(String) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

The name of this detail.

setName(String) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The name identifying this particular message state.

setNextAttempt(Instant) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

The time at which (or beyond which) another retry attempt should be made

setNotification(NotificationProperties) - Method in interface com.broadleafcommerce.common.messaging.notification.MutableDurableNotificationProperties

Configuration for the NotificationHandler

setNotification(NotificationProperties) - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

setNotificationAcknowledged(Object, String, int, Class<?>) - Method in interface com.broadleafcommerce.common.messaging.notification.NotificationStateRepository

Establish acknowledged state for a NotificationState of a particular messageType on an entity of a particular type.

setNotificationStates(List<NotificationState>) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationStateAware

Set the message sending status for one or more NotificationState instances.

setPageSize(int) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The number of valid, unacknowledged records to batch process per interval.

setProperties(NotificationManagerProperties) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationManager

setRecordProcessingWait(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The amount of time to pause between the processing of each unacknowledged record in the batch.

setRetry(RetryProperties) - Method in interface com.broadleafcommerce.common.messaging.notification.MutableDurableNotificationProperties

Configuration for the RetryHandler

setRetry(RetryProperties) - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

setRetryClusterServiceNamespace(String) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

Name used to identify the cluster singleton lock

setRetryInterval(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

The length of time to wait between each batch retry attempt.

setRingBufferSizeInClosedState(int) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the size of the ring buffer when the CircuitBreaker is closed.

setRingBufferSizeInHalfOpenState(int) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the size of the ring buffer when the CircuitBreaker is half open.

setSandboxId(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The sandboxId in which the workflow operation is taking place.

setSendEnabled(boolean) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Whether or not sending on the producer channel is allowed.

setSendTimeout(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

The length of time a message send attempt should block before timing out.

setStatusConsumers(List<Consumer<RetryHandlerStatus>>) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

setStatusConsumers(List<Consumer<RetryHandlerStatus>>) - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Set the list of consumers for RetryHandlerStatus on the cluster service.

setStopped(boolean) - Method in interface com.broadleafcommerce.common.messaging.notification.domain.NotificationState

Whether or not retry attempts should cease for this state

setSuffix(String) - Method in class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

If no modifier is provided via MicroCloudStreamBindingCommon configuration, then apply this suffix value as a modifier key during all attempts to match relevant notification state messages.

setTenantId(String) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

The ID of the associated tenant.

setThreadPoolSize(int) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

The thread pool size used for async handling.

setTimestamp(Instant) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The time at which the lock was set to true

setToken(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

The token assigned the last time the lock was set to true.

setToken(String) - Method in interface com.broadleafcommerce.common.messaging.Securable

A Base64 encoded JWT token generally containing the following claims: user - the user name for the user that generated the message via some action.

setType(String) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

setTypeAlias(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

An alias used to represent the Java type of the resource being locked.

setValue(Object) - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

A value for this detail.

setWaitDurationInOpenState(Duration) - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

Configures the wait duration which specifies how long the CircuitBreaker should stay open, before it switches to half open.

SpringKafkaRetryDisablingConfiguration() - Constructor for class com.broadleafcommerce.common.messaging.autoconfigure.kafka.KafkaCommonMessagingAutoConfiguration.SpringKafkaRetryDisablingConfiguration

STAGNATE - Enum constant in enum class com.broadleafcommerce.common.messaging.repository.LockStatus

Lock exists and is active, but it's TTL has expired.

start() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

start() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterServiceLifecycleManager

start() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryHandler

start() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Deprecated.

Use Lifecycle.start() instead

start() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryHandler

Commence the scheduled processing via a new thread

start(List<Consumer<RetryHandlerStatus>>) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

start(List<Consumer<RetryHandlerStatus>>) - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Start the cluster service with a list of consumers for retry handler status events

STARTED - Enum constant in enum class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatusType

status(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

status(String) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

status(String) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Report on the status of the lock.

stop() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

stop() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterServiceLifecycleManager

stop() - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryHandler

stop() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryClusterService

Stop the node as a leader in the cluster.

stop() - Method in interface com.broadleafcommerce.common.messaging.notification.RetryHandler

Stop scheduled processing and exit the processing thread

stop(Runnable) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultRetryClusterService

STOPPED - Enum constant in enum class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatusType

SuppressNotification - Annotation Interface in com.broadleafcommerce.common.messaging.notification

Demarcate a flow during which notification via NotificationHandler should be suppressed for one or more message types.

suppressNotificationAspect() - Method in class com.broadleafcommerce.common.messaging.autoconfigure.CommonMessagingAutoConfiguration

SuppressNotificationContext - Class in com.broadleafcommerce.common.messaging.notification

Threadlocal describing one or more message types for which notification should be suppressed during a flow.

SuppressNotificationContext(String[]) - Constructor for class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

SuppressNotificationContext(String[], boolean) - Constructor for class com.broadleafcommerce.common.messaging.notification.SuppressNotificationContext

T

toString() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobDetailRef

toString() - Method in class com.broadleafcommerce.common.messaging.domain.ScheduledJobRef

toString() - Method in class com.broadleafcommerce.common.messaging.environment.MessagingProperties

toString() - Method in class com.broadleafcommerce.common.messaging.notification.ChannelModifierProperties

toString() - Method in class com.broadleafcommerce.common.messaging.notification.IdempotentMessage

toString() - Method in class com.broadleafcommerce.common.messaging.notification.IdInformation

toString() - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

toString() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationHandlerResponse

toString() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationManagerProperties

toString() - Method in class com.broadleafcommerce.common.messaging.notification.NotificationProperties

toString() - Method in class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatus

toString() - Method in class com.broadleafcommerce.common.messaging.notification.RetryProperties

toString() - Method in class com.broadleafcommerce.common.messaging.PersistenceMessage

toString() - Method in class com.broadleafcommerce.common.messaging.PersistenceNotificationProperties

toString() - Method in class com.broadleafcommerce.common.messaging.provider.jpa.domain.JpaResourceLock

toString() - Method in class com.broadleafcommerce.common.messaging.repository.ResourceLockProperties

triggeredJobEventInputPurgeLock() - Method in interface com.broadleafcommerce.common.messaging.service.messaging.PurgeLockTriggeredJobEventConsumer

TYPE - Static variable in interface com.broadleafcommerce.common.messaging.checkout.CheckoutCompletionProducer

TYPE - Static variable in interface com.broadleafcommerce.common.messaging.PersistenceProducer

U

unlockResource(String) - Method in class com.broadleafcommerce.common.messaging.provider.jpa.repository.JpaCustomizedResourceLockRepository

unlockResource(String) - Method in class com.broadleafcommerce.common.messaging.repository.NoOpResourceLockRepository

unlockResource(String) - Method in interface com.broadleafcommerce.common.messaging.repository.ResourceLockRepository

Unlock the resource so that other requesters can acquire the lock on the resource.

unwrap() - Method in interface com.broadleafcommerce.common.messaging.notification.MessageAdditionalInformationAware

Unwrap the proxy exposing this interface, if applicable, and expose the underlying entity instance.

unwrapNotificationState(NotificationStateAware) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultNotificationHandler

V

validate(JsonNode) - Method in interface com.broadleafcommerce.common.messaging.PersistenceHandler

Verify the signed JWT token and validate the user claims (especially authorities) against the consumption functionality.

validate(ProceedingJoinPoint) - Method in class com.broadleafcommerce.common.messaging.notification.DefaultSuppressNotificationAspect

value() - Element in annotation interface com.broadleafcommerce.common.messaging.notification.SuppressNotification

The message types for which suppression should be enacted.

valueOf(String) - Static method in enum class com.broadleafcommerce.common.messaging.notification.RetryClusterServiceRequirementType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatusType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.common.messaging.repository.LockStatus

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.broadleafcommerce.common.messaging.notification.RetryClusterServiceRequirementType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.common.messaging.notification.RetryHandlerStatusType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.common.messaging.repository.LockStatus

Returns an array containing the constants of this enum class, in the order they are declared.

W

withCompileChangeDetails(boolean) - Method in class com.broadleafcommerce.common.messaging.notification.IgnoredNotificationStateRepository

Z

ZK_DIGEST_PASSWORD - Static variable in class com.broadleafcommerce.common.messaging.autoconfigure.CamelSetupAutoConfiguration

ZK_DIGEST_USERNAME - Static variable in class com.broadleafcommerce.common.messaging.autoconfigure.CamelSetupAutoConfiguration

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