All Classes and Interfaces
Class
Description
Special ApiError capable of passing back the identities of diverged ChangeSummary instances.
Special ApiError capable of passing back the identities of items for which a operation was
requested on, but whose state at the time of the requested operation was incorrect.
The exception results from an attempt to archive
ChangeSummary if there are any in an
active state.Summary entity that is aware of state related to index status and index target.
Responsible for persisting state changes related to sandbox transition lifecycle using a batch
approach for optimal efficiency.
Produce a stream of data objects based on a list of identifying values.
A
Spliterator capable of iterating through a partitioned list of identifying values
and producing resulting, streamable data based on each partition.The Sandbox Microservice's own specific implementation of
ApplicationInfo, independent of
database provider.The Sandbox Microservice's own specific implementation of
CatalogBasicInfo, independent
of database provider.The Sandbox Microservice's own specific implementation of
CatalogInfo, independent of
database provider.Domain describing the changes that are pushed to production together.
Repository for working with repository domain related to the
ChangeDeploy business
domain.Service for working with
instances.Validations for
ChangeDeploy.The Sandbox Microservice's own specific implementation of
FieldOverride, independent of
database provider.Request payload data to use for populating
ChangeSummary.DTO holder for a list of ChangeInfos with which to respond from an endpoint.
The Sandbox Microservice's own specific implementation of
NotificationState, independent
of database provider.The Sandbox Microservice's own specific implementation of
SandboxInfo, independent of
database provider.Used to keep track of the current state of
ChangeSummaries and
ChangeSummaryGroups.The current status of a
ChangeEvent.Request construct that details a list of
ChangeSummary.getId() values to operate on.The exception is thrown when the change summaries with the specified ids are not found.
Detailed summary information of a change made to an instance of a sandboxable entity.
This channel is primarily responsible for async IO related to receiving a
ChangeEvent
indicating that a local user sandbox change has been made for an item at a resource tier.A group of
ChangeSummary instances.Repository for working with repository domain related to the
ChangeSummaryGroup business
domain.Request construct that details a list of
ChangeSummaryGroup.getId() values to operate on.Service for working with
instances.Validations for
ChangeSummaryGroup.Exception that results from an attempt to remove a
ChangeSummary from a
ChangeSummaryGroup.Payload object for informing the API (
TransitionRequestEndpoint.removeSummariesFromGroup(jakarta.servlet.http.HttpServletRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo, com.broadleafcommerce.sandbox.domain.ChangeSummaryRemovalRequest))
on which ChangeSummaries should be removed from their current
ChangeSummaryGroup and added to a new one.DTO object for holding request information to find a change summary
Service for working with
instances.Validations for
ChangeSummary.The Sandbox Microservice's own specific implementation of
Tracking, independent of
database provider.The Sandbox Microservice's own specific implementation of
ChangeDetail, independent of
database provider.Some of the field values in
Tracking based embeddables are represented in the Java entity
classes as object structures, but are saved in the database as JSON.A module to add a mapping between
Tracking and ChangeTracking.Emitted upon every polling execution of one of the cleanup services.
Configuration related to batch completion of transition related artifacts once all
ChangeSummary instances have completed transition.A message representing a request to the sandbox service to create a given sandbox.
Spring cloud data channel description for messaging input.
A handler that accepts a
CreateSandboxRequest and creates the requested sandbox.Additional persistence operations to perform on
ChangeDeploy repository domain.Additional persistence operations to perform on ChangeSummaryGroup repository domain.
Additional persistence operations to perform on ChangeSummary repository domain.
CustomizedSandboxRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>
Additional persistence operations to perform on the
Sandbox repository domain.ClusterService responsible for interval polling of fully transitioned
ChangeDeploy instances and converting into their finished state.Assists in handling the logic for scheduling deployment requests.
ClusterService responsible for interval polling of fully deployed
ChangeSummaryGroup instances and converting into their deployed state.ClusterService responsible for interval polling of fully promoted
ChangeSummaryGroup instances and converting into their promoted state.ClusterService responsible for interval polling of fully rejected
ChangeSummaryGroup instances and converting into their rejected state.Default implementation of
IndexNotificationServiceDefault implementation of
JpaVendorNarrowingCriteriaManager.Default implementation of
JpaVendorNarrowingQueryCustomizer.The default implementation of the
PreviewTokenService interface that makes use of
PreviewTokenEncoder for the encoding of the PreviewToken.ClusterService responsible for interval polling of fully defunct, temporary
Sandbox instances and converting into their archived state.Simple constants for colors to use on sandboxes.
A message representing a request to the sandbox service to delete the sandbox for a failed bulk
update operation.
Spring cloud data channel description for messaging input.
A handler that accepts a
DeleteSandboxRequest and deletes the requested sandbox.Flush context related to the sandbox deploy transition lifecycle
This handler deals with updating the states and statuses of
ChangeDeploys
that have just finished being scheduled.This handler deals with updating the states and statuses of
ChangeDeploys
that have just finished being unscheduled.Spring cloud data channel description for messaging output.
Responsible for scheduling and executing deployments.
This handler deals with cleaning up deployed
ChangeDeploys' states and
statuses.Spring cloud stream messaging interface for receiving triggered job execution from the scheduled
job microservice.
A change that has been promoted in advance of the current change represented in a
ChangeDetail.Thrown to indicate one or more
ChangeSummary instances are diverged.Communicates any
ChangeSummary.getId() values determined to belong to divergent change
summaries during a promote.Denotes the divergent status of a
ChangeSummary, meaning it is a ChangeState.USER
change that requires a rebase due to a higher level change that has caused the base to diverge.As transition completions are consumed, notify the indexer service via message of a batch of
Indexable instances to index.Contains common functionality useful for converting values between Java/JDBC representation.
JpaChangeDeploy.getAffectedVendorRefs() need to be query-able and thus need to be in a
separate table.The ID class representing the composite key for
JpaChangeDeployAffectedVendor.Domain specific repository declaration for
ChangeDeploy, i.e., for managing
JpaChangeDeploys.Can build criteria to narrow queries on
JpaChangeDeploy to only produce records matching
the appropriate vendor restrictions.JpaChangeSummaryGroup.getAffectedVendorRefs() need to be query-able and thus need to be
in a separate table.The ID class representing the composite key for
JpaChangeSummaryGroupAffectedVendor.Domain specific repository declaration.
Can build criteria to narrow queries on
JpaChangeSummaryGroup to only produce records
matching the appropriate vendor restrictions.Domain specific repository declaration.
Can build criteria to narrow queries on
JpaChangeSummary to only produce records matching
the appropriate vendor restrictions.Map new
NotificationStateAware instances with ready-to-use NotificationState
values for the TransitionRequest class of producers.Contains common functionality useful for creating/initializing
JpaNotificationState in
flows specific to SandboxServices' custom repository method implementations.Repository domain representing a configured sandbox.
Domain specific repository declaration.
A specialized component that can understand how to build vendor-narrowing criteria for a specific
entity.
This is a higher-level component that understands how to build criteria to perform
vendor-narrowing-related operations relating to various entities in the sandbox microservice.
Domains such as
ChangeSummary, ChangeSummaryGroup, and ChangeDeploy are
not Trackable and have lots of customized query behavior.A default implementation of the
PreviewTokenEncoder that encodes the PreviewToken
into a JWT token string.Properties used to support the
JWTPreviewTokenEncoder in encoding preview tokens as JWTs.Map new
NotificationStateAware instances with ready-to-use NotificationState
values for the TransitionRequest class of producers.Exception that results from a failure to create a
PreviewToken within the
PreviewTokenService.An interface used for encoding preview tokens.
An exception thrown when there is a failure to encode the preview token.
Endpoint used for handling the creation of a preview token for use when previewing sandbox data
in an application.
The request object used to communicate the sandbox IDs a user wishes to generate a preview token
for.
An interface used for the creation of a preview token for the preview sandbox flow.
The details provided when a preview token is validated.
Exception that results from a failure to validate a preview token string within the
PreviewTokenService.Flush context related to the sandbox promote transition lifecycle
The state change information for a single
ChangeSummaryGroup instanceValidations for
PromoteSummaries.Spring cloud data channel description for messaging output.
Handles any
WorkflowRequestCompletions resulting from WorkflowPromoteRequestException thrown when an item is requested, but its state does not match the expected state
Flush context related to the sandbox rebase transition lifecycle
Spring cloud data channel description for messaging output.
This handler deals with cleaning up rebased
ChangeSummaries' statuses.Flush context related to the sandbox reject transition lifecycle
Spring cloud data channel description for messaging output.
This handler deals with cleaning up rejected
ChangeSummaryGroups'
states and statuses.Spring cloud data channel description for messaging output.
Flush context related to the sandbox revert transition lifecycle
TODO what __is__ a sandbox Business domain representing a configured sandbox.
Classes implementing this interface handle
ApplicationChangedEvents for the sandbox service.Defines the contract for a class that awaits the transmission of
ApplicationChangedEvents so that the sandbox service can respond appropriately.Since the persisted-domain counterpart of
Sandbox is tenant-trackable, the default
context state mutability of a sandbox from an application context will be false.Handles sandbox actions in response to an
Application being created.MessageFactory for creating SandboxDeleteEvent messages for archiving of the
sandboxed entities when the sandbox is deleted.Spring cloud data channel description for messaging output.
API for managing
Sandbox instances.A function that does not accept arguments and does not return a result.
General exception handler registry for handlers not exclusive to a single controller.
Jpa specific config for the repository and domain.
Properties configuring behavior of
SandboxNotificationPruneService and
SandboxNotificationPruneRepository.This "repo" is responsible to delete "stale" notification states
Expected to work with
SandboxNotificationPruneServiceThis service is intended to be "singleton" on a cluster level It will be run its job - clean up
through
SandboxNotificationPruneRepository every 23 hoursCustomizes the
ContextInfo with the original author of the request if the request is
coming from an admin-scoped service client.Auto-configuration to instrument the services to support the creation and encoding of preview
tokens.
SandboxRepository<D extends com.broadleafcommerce.data.tracking.core.Trackable>
Enumerates the possible types of sandbox related
ScheduledJobDetailRef names.Defines the expected values of types of sandbox-related scheduled jobs.
Sandbox business domain specific version of
CrudEntityService.Sandbox-specific configuration for validation.
Validations for
Sandbox.MessageFactory for creating WorkflowJobSchedulingRequest messages for scheduling
a deployment job with the scheduled job service.Spring cloud data channel description for messaging output.
Fetch a list of data objects based a provided list of identifying values.
Basic information pertaining to a batch queue of
ChangeSummary and
ChangeSummaryGroup state changes to persist.The state change information for a single
ChangeSummaryGroup instanceThe state change information for a single
ChangeSummary instanceThe information to update universally across all
StateChangeOnlyBatchFlushContext.SummaryUpdate and
StateChangeOnlyBatchFlushContext.SummaryGroupUpdate instances.Communicates any id values determined to be in an incorrect state from that expected to perform a
transition operation.
Utility class to help validate states of sandbox entities during completion and error flows.
Basic information pertaining to a batch queue of
ChangeSummary state changes to persist.Information required to appropriately call
DefaultNotificationHandler.handle(NotificationStateRepository, NotificationStateAware, String)The state change information for a single
ChangeSummary instanceAPI for managing sandbox workflow operations.
Service responsible for managing workflow state transitions.
Configure the durable notification components related to TransitionRequest class of producers
Configuration properties for the
NotificationHandler and RetryHandler related to
the TransitionRequest class of producersTriggeredSandboxJobEventHandler responsible for kicking off WorkflowDeployRequests once the scheduled job has been triggered for it.Classes implementing this interface handle triggered scheduled jobs relating to the sandbox
service.
Defines the contract for a class that awaits the transmission of sandbox-related
scheduled jobs.MessageFactory for creating WorkflowJobUnschedulingRequest messages for
cancelling a previously scheduled deployment job with the scheduled job service.Spring cloud data channel description for messaging output.
A message representing a request to the sandbox service to update the select sandbox fields.
A handler that accepts a
UpdateSandboxRequest and updates the requested sandbox.Contains supporting utilities for vendor-processing.
Classes implementing this interface handle follow-up actions (like cleaning up
ChangeSummary states/statuses) for specific types of transition completions.Defines the contract for a class that awaits the transmission of
TransitionRequestCompletions (by listening on the
WorkflowRequestCompletionConsumer channel).Classes implementing this interface handle error resolution actions (like cleaning up
ChangeSummary states/statuses) for specific types of transition completions.