Serialized Form

Package com.broadleafcommerce.data.tracking.core

Class com.broadleafcommerce.data.tracking.core.EmbeddedContextState

class EmbeddedContextState extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

changed

boolean changed

Whether the EmbeddedContextStateAware item to which this state belongs has changed. Defaults to true since, otherwise, the owning item's contextState would likely be null.

fieldsChanged

List<String> fieldsChanged

List of fields on the EmbeddedContextStateAware item to which this state belongs that were changed.

Package com.broadleafcommerce.data.tracking.core.exception

Exception com.broadleafcommerce.data.tracking.core.exception.EntityMissingException

class EntityMissingException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.InvalidContextRequestException

class InvalidContextRequestException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.NotMutableException

class NotMutableException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.NotPermittedException

class NotPermittedException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.NotVisibleException

class NotVisibleException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.ParseException

class ParseException extends RuntimeException implements Serializable

serialVersionUID:

1L

Exception com.broadleafcommerce.data.tracking.core.exception.StaleSandboxStateException

class StaleSandboxStateException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.UnsortablePositionException

class UnsortablePositionException extends RuntimeException implements Serializable

Package com.broadleafcommerce.data.tracking.core.exception.contextstate

Exception com.broadleafcommerce.data.tracking.core.exception.contextstate.ContextStateProcessingException

class ContextStateProcessingException extends RuntimeException implements Serializable

Exception com.broadleafcommerce.data.tracking.core.exception.contextstate.IllegalContextStateException

class IllegalContextStateException extends RuntimeException implements Serializable

Package com.broadleafcommerce.data.tracking.core.filtering

Class com.broadleafcommerce.data.tracking.core.filtering.DefaultNarrowedPageable

class DefaultNarrowedPageable extends DefaultUnnumberedPageable implements Serializable

serialVersionUID:

1L

Serialized Fields

isForward

boolean isForward

underlyingPageSize

int underlyingPageSize

Class com.broadleafcommerce.data.tracking.core.filtering.DefaultPageRequest

class DefaultPageRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

pageRequest

org.springframework.data.domain.PageRequest pageRequest

Class com.broadleafcommerce.data.tracking.core.filtering.DefaultUnnumberedPageable

class DefaultUnnumberedPageable extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

offset

long offset

size

int size

sort

org.springframework.data.domain.Sort sort

Class com.broadleafcommerce.data.tracking.core.filtering.DefaultUntotalledPage

class DefaultUntotalledPage extends Object implements Serializable

Serialized Fields

content

List<T> content

pageable

org.springframework.data.domain.Pageable pageable

Exception com.broadleafcommerce.data.tracking.core.filtering.UnsupportedPageableTypeException

class UnsupportedPageableTypeException extends RuntimeException implements Serializable

Package com.broadleafcommerce.data.tracking.core.filtering.business.domain

Class com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState

class ContextState extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

application

ContextState.ContextApplicationInfo application

Information about the associated application if the business domain is application discriminated.

archived

Boolean archived

Whether or not the entity is marked as archived. This would generally only be true when fetching entities with narrowing disabled.

baseCatalogId

String baseCatalogId

The id of the base catalog that the business domain is a member of.

catalog

ContextState.ContextCatalogInfo catalog

Information about the associated catalog if the business domain is catalog discriminated.

customerContextId

String customerContextId

Returns the customer context id that is used to discriminate entities with TrackableBehavior.CUSTOMER_CONTEXT.

fieldChanges

List<FieldChange> fieldChanges

Field information describing field-level changes that have been made to the entity. This can include overrides in catalog scenarios. It can also include sandbox changes for sandboxable domain.

level

Integer level

Used to determine whether or not a record is a user sandbox record, a higher level sandbox record, or a production record. See TrackingLevel.

mutable

Boolean mutable

Whether or not the entity is mutable given the requesting context. Generally, factors such as permissions and catalog mutability are considered.

overrideCatalogId

String overrideCatalogId

The id of the catalog to which this entity belongs. This value will only be populated if this is an override entity. For example, an application level override of a product defined in a tenant level catalog.

sandbox

String sandbox

The sandbox id if the business domain is a sandbox record.

sandboxChangeType

String sandboxChangeType

The sandbox change type associated with the entity.

See Also:

• SandboxInfo.getChangeType()

tenant

String tenant

The ID of the associated tenant, if the business domain is tenant discriminated.

Class com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState.ContextApplicationInfo

class ContextApplicationInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

defaultLocale

Locale defaultLocale

name

String name

Class com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState.ContextCatalogInfo

class ContextCatalogInfo extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextId

String contextId

level

Long level

locale

Locale locale

name

String name

Class com.broadleafcommerce.data.tracking.core.filtering.business.domain.FieldChange

class FieldChange extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

The user that engaged the change

changeType

String changeType

The CRUD type for the change. See OperationType

fieldName

String fieldName

The name of the field on the repository domain class instance that was changed

level

Integer level

Used to determine whether or not a change is a user sandbox change, a higher level sandbox change, or a production change. See TrackingLevel. This value is often used to determine the origin of a change after a rebase operation. A level equal to TrackingLevel.PRODUCTION indicates the change is a production catalog override of the same entity from a higher catalog.

sandboxId

String sandboxId

A soft reference to the sandbox id. Sandboxes are maintained separately in the sandbox microservice.

sandboxName

String sandboxName

Friendly name for this sandbox

stage

String stage

Arbitrary labelling concept. Can be leveraged to identify entity state belonging to a step in a multi-step approval workflow.

timestamp

Instant timestamp

When this field change occurred. This is usually initialized as LocalDateTime.now() when the original FieldChange tracking was created.

Package com.broadleafcommerce.data.tracking.core.filtering.domain

Class com.broadleafcommerce.data.tracking.core.filtering.domain.DefaultChangeDetail

class DefaultChangeDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

afterValue

String afterValue

author

String author

beforeValue

String beforeValue

businessFieldName

String businessFieldName

changeType

String changeType

embeddedCollection

boolean embeddedCollection

fieldName

String fieldName

fieldType

String fieldType

level

Integer level

message

String message

obsolete

Boolean obsolete

promotionId

String promotionId

propagationId

String propagationId

rebased

Boolean rebased

rejected

Boolean rejected

serializedFieldType

String serializedFieldType

timestamp

Instant timestamp

version

String version

Package com.broadleafcommerce.data.tracking.core.mapping

Exception com.broadleafcommerce.data.tracking.core.mapping.ChangeDetailApplyException

class ChangeDetailApplyException extends RuntimeException implements Serializable

Package com.broadleafcommerce.data.tracking.core.messaging

Class com.broadleafcommerce.data.tracking.core.messaging.SandboxDeleteEvent

class SandboxDeleteEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

entityTypesByRouteKeys

Map<String,Set<String>> entityTypesByRouteKeys

When the sandbox is deleted, the summary of the change made to the sandboxed non-production entities should be archived as well. This map contains the entity types, represented as the fully qualified class name grouped by the data route keys. For example the key can be "catalog" and one of the value is "com.broadleafcommerce.catalog.provider.jpa.domain.product.JpaProduct"

sandboxId

String sandboxId

The ID of the sandbox that was deleted.

Package com.broadleafcommerce.data.tracking.core.messaging.domain

Class com.broadleafcommerce.data.tracking.core.messaging.domain.ChangeEvent

class ChangeEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

The author responsible for the change.

changeTracking

Tracking changeTracking

All of the information contained within Tracking for the record of this change.

createSandboxIfDoesNotExist

boolean createSandboxIfDoesNotExist

Whether or not the sandbox denoted with ChangeEvent.getSandbox() should be created if it does not already exist. The information supplied in ChangeEvent.getSandboxName() and ChangeEvent.isTemporarySandbox() will be used to populate the corresponding fields on the sandbox.

displayName

String displayName

The name to display to the user that represents this change summary. Typically retrieved from Trackable.getDisplay().

domainAlias

String domainAlias

The projection domain alias for this change, represented as the class simple name, i.e., Product.

domainContextId

String domainContextId

The contextId of the domain object that underwent the change.

entityType

String entityType

The entity type for this change, represented as the fully qualified classname.

indexableTargetId

String indexableTargetId

If the change implements Indexable and is a member of BatchIndexableType, reference the id of the target item to be indexed. Note, this may not be the entity actually being changed here. If, for example, this change is for a CatalogProduct, the target item to be indexed is actually the referenced product.

indexableType

String indexableType

If the change implements Indexable and is a member of BatchIndexableType, reference the string value of BatchIndexableType here for the target item to be indexed. Note, this may not be the entity actually being changed here. If, for example, this change is for a CatalogProduct, the target item to be indexed is actually the referenced product.

isPromoted

boolean isPromoted

Whether or not the resulting state in the sandbox service represents a promoted item. Note, the related entity in the resource tier must be persisted in the appropriate promoted state as well.

isRemoveTemporaryOverride

boolean isRemoveTemporaryOverride

Whether or not to remove temporary application catalog override state at the edges of sandbox transition. This includes revert or deploy. Temporary application override state can occur during parent catalog deployment propagation. See VendorSandboxPropagationHandler for more information.

isTemporarySandbox

boolean isTemporarySandbox

Whether or not the sandbox denoted at ChangeEvent.getSandbox() is temporary and should be removed at the end of the sandbox transition lifecycle.

This will only be used if ChangeEvent.isCreateSandboxIfDoesNotExist() is true.

promotionId

String promotionId

The promotion id to associate with this change event when ChangeEvent.isPromoted() is true.

sandbox

String sandbox

The sandbox that contains the change.

sandboxName

String sandboxName

The sandbox name to use if creating a sandbox.

This is generally only used if ChangeEvent.isCreateSandboxIfDoesNotExist() is true.

vendorRef

String vendorRef

The vendor code or vendor ID associated to the changed entity.

If the entity is not vendor-discriminated or simply doesn't have an associated vendor, this will be null.

Package com.broadleafcommerce.data.tracking.core.messaging.search.domain

Class com.broadleafcommerce.data.tracking.core.messaging.search.domain.BatchIndexRequest

class BatchIndexRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

batchIndexableType

String batchIndexableType

The string representation of the valid BatchIndexableType

idPayload

String idPayload

The ids representing the items that should be indexed. This is really a Base64 encoded GZip representation of a List of Strings.

Class com.broadleafcommerce.data.tracking.core.messaging.search.domain.SingleIndexRequest

class SingleIndexRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_class

String _class

The class name of the entity on which a CRUD operation was performed that resulted in this request. This is not necessarily the entity on which the reindex will actually occur - it may just be a related entity.

payload

T extends Identifiable payload

The payload which will be unwrapped into the final JSON. Allows flexibility since an index request may look different for each entity.

Package com.broadleafcommerce.data.tracking.core.policy

Class com.broadleafcommerce.data.tracking.core.policy.PolicyResponse.StackInfomation

class StackInfomation extends Throwable implements Serializable

Serialized Fields

trace

StackTraceElement[] trace

Package com.broadleafcommerce.data.tracking.core.preview

Class com.broadleafcommerce.data.tracking.core.preview.PreviewToken

class PreviewToken extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

The ID of the application this preview token is authorized for.

author

String author

The username of the author associated with the preview token.

expirationTime

Instant expirationTime

The expiration time of the preview token in UTC. This is used to inform clients of when to expect the token to be expired.

sandboxIds

Set<String> sandboxIds

The set of sandbox IDs the preview token is authorized for.

tenantId

String tenantId

The ID of the tenant this preview token is authorized for.

token

String token

The token string that is used to authorize that a request has access to preview data for a given sandbox.

This token should be provided as part of the `X-Context-Request` header as the `previewToken` property along with the `sandboxId` the user wishes to access.

Package com.broadleafcommerce.data.tracking.core.preview.exception

Exception com.broadleafcommerce.data.tracking.core.preview.exception.PreviewTokenParseException

class PreviewTokenParseException extends Exception implements Serializable

Package com.broadleafcommerce.data.tracking.core.service

Class com.broadleafcommerce.data.tracking.core.service.MutationNotifyEvent

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

Serialized Fields

context

ContextInfo context

domain

Trackable domain

repository

com.broadleafcommerce.common.messaging.notification.NotificationStateRepository repository

Class com.broadleafcommerce.data.tracking.core.service.NotificationInitializeEvent

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

Serialized Fields

context

ContextInfo context

domain

Trackable domain

repository

com.broadleafcommerce.common.messaging.notification.NotificationStateRepository repository

Package com.broadleafcommerce.data.tracking.core.tenant.domain

Class com.broadleafcommerce.data.tracking.core.tenant.domain.Application

class Application extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

allowedCurrencies

List<Currency> allowedCurrencies

List of Currencies that are available to be selected for use with this application. All Catalogs that are related to this application should be restricted to this currency set. However, note that this can be empty, in which case, APIs will respond to requests with a list of currencies that the system determines to be the defaults for each locale in Application.allowedLocales.

allowedLocales

List<Locale> allowedLocales

List of Locales that are available to be selected for this application. All Catalogs within that are related to this application's should be restricted to this locale set.

contextState

ContextState contextState

A subset of Tracking information to expose the context state for this object.

customerContextId

String customerContextId

The customer context id that is used to discriminate entities with TrackableBehavior.CUSTOMER_CONTEXT.

deactivated

boolean deactivated

Determines whether this application is active.

defaultCurrency

Currency defaultCurrency

The Currency that this application, by default, assumes all data is within and can drive the default currency selection on a frontend. If not set, the system will use the default currency for Application.defaultLocale in response to API requests.

defaultLocale

Locale defaultLocale

The Locale that this application, by default, assumes all data is within and can drive the default Locale selection as a result.

id

String id

The context id, which is a separate identifier from the database primary key. This may be auto generated, or may be explicity provided upon entity creation.

identifierType

String identifierType

Defines the type of the application identifier: Whether a domain or a domain prefix.

See Also:

• ResolutionIdentifierType

identifierValue

String identifierValue

Determines how applications are distinguished from each other using all or part of their domains or hostnames. Values could be the myapplication.mycompany.com in https://myapplication.mycompany.com/ or the myapplication in https://myapplication.mycompany.com/ depending on Application.identifierType.

See Also:

• Application.identifierType

inheritanceLines

InheritanceLines inheritanceLines

Context list of the contextIds for the deep catalog tree parenting the Application.isolatedCatalogs. These values are generally not included in reported Json, but instead are calculated and leveraged internally during catalog visibility and mutability determinations.

isMarketplace

boolean isMarketplace

Whether or not the application is a marketplace application. Marketplace applications leverage MarketplaceApplicationCatalog relationships to catalogs, in addition to the explicit relationships declared in Application.getIsolatedCatalogs().

Generally, all relationships to vendor catalogs should be defined exclusively with MarketplaceApplicationCatalog, and any additional relationships to non-vendor catalogs would be in Application.getIsolatedCatalogs().

isolatedCatalogs

List<ApplicationCatalogRef> isolatedCatalogs

Individual catalogs assigned to this application. ApplicationCatalogRefs provide additional control over the mutability and visibility of the contents of the catalogs assigned.

See Also:

• ApplicationCatalogRef

name

String name

The general name for the application

tenantId

String tenantId

The tenant to which this application belongs

Class com.broadleafcommerce.data.tracking.core.tenant.domain.ApplicationCatalogRef

class ApplicationCatalogRef extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

catalogStatus

String catalogStatus

The status of the catalog's visibility for this assignment.

excludeFromAdd

boolean excludeFromAdd

Determines whether the admin users of the related Application can select the catalog as a destination for entity add operations.

id

String id

The context id of the Catalog instance.

implicit

String implicit

The context id of the hidden Catalog that is owned by this application and receives any catalog overrides enacted on behalf of this application for the catalog referenced by ApplicationCatalogRef.id.

mutabilityType

String mutabilityType

The modifiability of the entities inherited from the catalog.

See Also:

• MutabilityType

visibleAsAssigned

boolean visibleAsAssigned

Determines whether the catalog is visible to the admin users of the related Application as being assigned.

Class com.broadleafcommerce.data.tracking.core.tenant.domain.InheritanceLines

class InheritanceLines extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

lines

List<InheritanceLine> lines

The upward catalog hierarchies for one or more assigned Catalog instances

Class com.broadleafcommerce.data.tracking.core.tenant.domain.MarketplaceApplicationCatalog

class MarketplaceApplicationCatalog extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

application

String application

The id of the related Application

catalog

String catalog

The id of the related Catalog

catalogStatus

String catalogStatus

The status of the catalog's visibility for this assignment.

contextState

ContextState contextState

A subset of Tracking information to expose the context state for this object.

id

String id

The context id of the MarketplaceApplicationCatalog instance.

implicit

String implicit

The id of the implicit catalog for the application that will contain the application's overrides of items from MarketplaceApplicationCatalog.catalog.

propagationType

String propagationType

The PropagationType of the how changes from a vendor will be received into the marketplace application. The default is PropagationType.DIRECT.

Package com.broadleafcommerce.data.tracking.core.tenant.service

Class com.broadleafcommerce.data.tracking.core.tenant.service.ApplicationChangedEvent

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

serialVersionUID:

1L

Serialized Fields

application

Trackable application

operation

OperationType operation

Class com.broadleafcommerce.data.tracking.core.tenant.service.CatalogChangedEvent

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

serialVersionUID:

1L

Serialized Fields

catalog

Trackable catalog

operation

OperationType operation

Package com.broadleafcommerce.data.tracking.core.transition

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowDeployRequest

class WorkflowDeployRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

isRemoveTemporaryOverride

boolean isRemoveTemporaryOverride

Whether or not to remove temporary application catalog override state at the edges of sandbox transition. This includes revert or deploy. Temporary application override state can occur during parent catalog deployment propagation. See VendorSandboxPropagationHandler for more information.

transitionRequest

WorkflowTransitionRequest transitionRequest

version

String version

The maximum version of ChangeDetail instances on an entity to deploy to production.

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowJobSchedulingRequest

class WorkflowJobSchedulingRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

Identifies the user who is scheduling or creating this request.

dateScheduled

Instant dateScheduled

The time when the workflow operation is scheduled to occur.

displayName

String displayName

The name to display to the user that represents the scheduled operation.

message

String message

A message describing the operation being scheduled. This could be used when scheduling recurring workflow operations.

token

String token

transferId

String transferId

ID of the transfer item involved in a workflow request being scheduled. Could be the id of a change summary, summary group, or deployment.

transferType

String transferType

Type of the transfer item involved in a workflow request being scheduled.

See Also:

• TransferType

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowJobUnschedulingRequest

class WorkflowJobUnschedulingRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

author

String author

Identifies the user who scheduled the deployment.

displayName

String displayName

The name to display to the user that represents the scheduled operation.

token

String token

transferId

String transferId

ID of the transfer item whose workflow request should be cancelled. Could be the id of a change summary, summary group, or deployment.

transferType

String transferType

Type of the transfer item whose workflow request should be cancelled.

See Also:

• TransferType

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowPromoteRequest

class WorkflowPromoteRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

promotionId

String promotionId

targetLevel

Integer targetLevel

targetSandboxId

String targetSandboxId

targetStage

String targetStage

transitionRequest

WorkflowTransitionRequest transitionRequest

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowRebaseRequest

class WorkflowRebaseRequest extends Object implements Serializable

Serialized Fields

targetLevel

Integer targetLevel

targetSandboxId

String targetSandboxId

targetStage

String targetStage

transitionRequest

WorkflowTransitionRequest transitionRequest

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowRejectRequest

class WorkflowRejectRequest extends Object implements Serializable

Serialized Fields

promotionId

String promotionId

receiver

String receiver

The admin user that should receive the rejected state. This field provides a avenue to override the default destination, which is the original author of the change. This field is useful in situations where a change is generated by the system and the determination of target user cannot be effectively deduced from the original change author.

targetLevel

Integer targetLevel

targetSandboxId

String targetSandboxId

targetStage

String targetStage

transitionRequest

WorkflowTransitionRequest transitionRequest

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowRequestCompletion

class WorkflowRequestCompletion extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

changeTracking

Tracking changeTracking

All of the information contained within Tracking for the target record of this transition. This field is optional and is generally employed by the rebase and promotion flows, as both of these cause unique change details to be created to represent the latest state

errorMessage

String errorMessage

If an error was encountered, this is the related message.

errorTrace

String errorTrace

If an error was encountered, this is the related stack trace.

requestType

Class<?> requestType

The type of the request. Could be any of the implementations of TransitionRequest such as WorkflowPromoteRequest, WorkflowRebaseRequest, &c. or a WorkflowJobSchedulingRequest or a WorkflowJobUnschedulingRequest.

success

boolean success

Whether the request was successfully handled or encountered an error.

timestamp

Instant timestamp

Time of completion.

token

String token

transferTypeIdMap

Map<String,String> transferTypeIdMap

ID of the transfer items involved in a workflow request mapped by the TransferType. Could be the id of a change summary, summary group, or deployment.

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowRevertRequest

class WorkflowRevertRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

transitionRequest

WorkflowTransitionRequest transitionRequest

Class com.broadleafcommerce.data.tracking.core.transition.WorkflowTransitionRequest

class WorkflowTransitionRequest extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

applicationId

String applicationId

author

String author

catalogId

String catalogId

contextId

String contextId

entity

String entity

level

Integer level

message

String message

routeKey

String routeKey

sandboxId

String sandboxId

stage

String stage

token

String token

transferTypeIdMap

Map<String,String> transferTypeIdMap

visibleFromCatalog

Set<String> visibleFromCatalog