All Classes and Interfaces
Class
Description
An abstract controller that provides convenience methods and resource declarations for its children.
Abstract implementatino of
AdminAbstractControllerExtensionHandler.Abstract implementation of
AdminBasicOperationsControllerExtensionHandler.Abstract implementation of
AdminNavigationServiceExtensionHandler.Abstract implementation of
AdminSectionCustomCriteriaExtensionHandler.Implements behavior shared by auditable listener implementations
Abstract handler for
AuthSuccessHandlerExtensionHandler so that actual implementations of this handler
do not need to implemenet every single method.Convenience implementation of interface so that subclasses do not have to implement uninteresting methods
This abstract class contains the plumbing that sets up the context for handling a
BroadleafApplicationEvent.Provides no-op implementations to optional methods
Support for any class that wishes to utilize a query miss cache.
An abstract controller that provides convenience methods and resource declarations for its
children.
An abstract controller that provides convenience methods and resource declarations for its
children.
Common functionality between checking availability between adds and updates
An abstract controller that provides convenience methods and resource declarations for its
children.
This provides a useful mechanism to pre-load/initialize classes that are required by a child class during class transformation,
but that may not have been loaded or initialized by the JVM.
Abstract implementation of
ContentProcessorExtensionHandlerAn abstract controller that provides convenience methods and resource declarations for its children.
Implements
AbstractEntityDuplicationHelper.getCopyHints() and AbstractEntityDuplicationHelper.addCopyHint(String, String),
using a HashMap as the underlying data structure for storing the hints.Base
ExtensionHandler class that provide basic extension handler properties including
priority (which drives the execution order of handlers) and enabled (which if false informs the
manager to skip this handler).All payment gateway classes that intend to make an external call, either manually
from an HTTP Post or through an SDK which makes its own external call, should
extend this class.
Abstract class to provide convenience for determining how to handle form
extensions in the admin
An abstract GeneratedResourceHandler that is capable of responding to a single specified filename and generate
contents for that filename.
Provides common logic for
GenericFilterBean implementations to allow for ignoring behavior based on the presence (or absence)
of a request param.Provides common logic for
OncePerRequestFilter implementations to allow for ignoring behavior based on the presence (or absence)
of a request param.
Contains useful processing code for merge bean post processors.
Modules that need to be configured via the database should extend this.
Abstract persistence provider that provides a method to actually handle formatting moneys.
Only the product is required to add an item to an order.
Abstract Extension handler for
ProductCustomPersistenceHandlerExtensionHandler
Contains useful processing code for merge bean post processors.
An abstract tag replacement processor that provides methods to help get resource/bundle information
Dummy implementation of a
RowLevelSecurityProvider.Abstract extension listener for rule builder enum options that handles the boilerplate code required for setting up
the response to the client.
An
AbstractSeoPropertyGenerator understands how to gather a specific set of SEO properties for the given domain objectDefault implementation of
SiteServiceExtensionHandlerImplementors of the SolrIndexServiceExtensionHandler interface should extend this class so that if
additional extension points are added which they don't care about, their code will not need to be
modified.
Component to provide basic functionality around handling SolrUpdateCommands.
This component is an abstract component that will be extended by more concrete implementations for updating
or reindexing Solr.
Implementors of the SolrSearchServiceExtensionHandler interface should extend this class so that if
additional extension points are added which they don't care about, their code will not need to be
modified.
Extension handler for the
StructuredContentServiceAn Abstract implementation of the TRCreditCardExtensionHandler.
Interface to be used for workflows in Broadleaf.
ActivityMessageDTO will hold messages that will be passed between activities/workflows.
Manages activity state for the current thread during workflow execution.
Contains the requested field, metadata and support classes.
Contains the
Entity instance and unfiltered property list.this interface indicates if the domain objects use additional fields
It is not mandatory, but it is useful in order to process those fields in a generic way when generating JAXB Wrappers
Contains the requested field, property name and support classes.
Contains the requested Hibernate type, metadata and support classes.
Contains the metadata and support classes.
Define whether a new collection member is searched for or constructed.
Allows for pluggable address validators.
Contains the requested ctoConverter, cto and support classes.
A Thymeleaf processor that generates a search query href that will reflect the current
search criteria in addition to the requested sort string
Deprecated.
As of Broadleaf version 3.1.0, saves of individual aspects of an Order (such as OrderItems and FulfillmentGroupItems) no
longer happen in their respective activities.
The AdjustOrderPaymentsActivity is responsible for adjusting any of the order payments
that have already been applied to the order.
An abstract controller that provides convenience methods and resource declarations for the Admin.
Extension handler for methods present in
AdminAbstractController.Manager for the
AdminAbstractControllerExtensionHandlerExtension handler for
ListGrid.Manager for the
AdminAbstractListGridExtensionHandler
Created by Reginald ColeHandles admin operations for the
Asset entity.AdminAssetUploadController handles uploading or selecting assets.
The default implementation of the
AdminAbstractController.The operations in this controller are actions that do not necessarily depend on a section key being present.
Extension handler for methods present in
AdminBasicOperationsController.Manager for the
AdminAbstractControllerExtensionHandlerController that responds to custom catalog actions.
Extension handler for
AdminCatalogServiceExtension manager for
AdminCatalogServiceImplHandles admin operations for the
Category entity.A Thymeleaf processor that will generate the appropriate ID for a given admin component.
This class is designed to be the default handler mapping for
Controller/RequestMapping annotations in
the admin for classes that have AdminBasicEntityController as an ancestor.Deprecated.
Deprecated.
NO LONGER REQUIRED AND SHOULD NOT BE USED.
AdminLoginController handles login related needs for the BLC admin including:
Forgot Password
Forgot Username
Reset Password
When viewing entities that implement this interface in the admin, the
AdminMainEntity.getMainEntityName() method will be
invoked to determine the title of the entity to be rendered.Class to hold the admin menus and sections for which the passed in user has permissions to view.
A Thymeleaf processor that will add the appropriate AdminModules to the model.
Borrows much of its config from
MultipartAutoConfiguration but overrides the default property
used for max upload sizeExtension handler for methods present in
AdminNavigationService.Manager for the
AdminNavigationServiceExtensionHandlerThis service is used to build the left hand navigation for the admin
Handles admin operations for the
Offer entity.This class is specifically used as a temporary workaround for
ConditionalOnAdmin
and ConditionalOnNotAdmin to allow them to work correctly when using
application servers such as JBoss.Handles admin operations for the
Order entity.Handles admin operations for the
Page entity.Created by IntelliJ IDEA.
Created by IntelliJ IDEA.
Adorned target collections are a variant of the basic collection type (@see AdminPresentationCollection).
This annotation is used to describe a simple persistent collection
for use by the admin tool.
This annotation is used to describe a persisted map structure for use in the
admin tool
This annotation is used to describe a member of a Map structure that should be
displayed as a regular field in the admin tool.
This annotation is used to describe an array of map fields that allow map members
to be displayed as regular fields in the admin tool.
Represents a single key value presented to a user in a selectable
list when editing a map value in the admin tool
Represents a override value for a specific admin presentation property.
Allows a non-comprehensive override of admin presentation annotation
property values for a target entity field.
Allows a non-comprehensive override of admin presentation annotation
property values for a target entity field.
Annotation for defining how CRUD operations are performed on an advanced collection in Broadleaf Commerce.
Handles admin operations for the
Product entity.This class is designed to be the default handler mapping for
Controller/RequestMapping annotations in
the admin so long as the class doesn't have AdminBasicEntityController as an ancestor.Extension handler for methods present in
AdminSectionCustomCriteriaExtensionHandler.Manager for the
AdminSectionCustomCriteriaExtensionHandlerCreated by Jon on 1/27/16.
Created by Jon on 1/27/16.
A Thymeleaf processor that will generate the HREF of a given Admin Section.
This class attempts the work flow of the CsrfFilter, but in the event of a Csrf token mismatch
(Session reset for example) the User will be redirected to login, if not session reset User is sent to previous location.
Extension handler for
AdminSecurityServiceExtension manager for
AdminSecurityServiceImplService for handeling security with Ajax components.
Handles admin operations for the
StructuredContent entity.Stores additional attributes for
AdminUsersExtended DTO class to support salts based on the primary key of the admin user.
A Thymeleaf processor that will add the appropriate AdminUser to the model.
Utility to add or update the AdminUser object in the database after authentication from an external system.
This component allows for the default provisioning of an AdminUser and roles in the Broadleaf database, based on the
external authentication of a user (e.g.
Configure WebMvc for the admin application.
In absence of Spring Boot's auto-configuration
WebMvcAutoConfiguration class, this ensures
that we still have the required override of the default RequestMappingHandlerAdapterDefine whether a new collection member is searched for or constructed.
Extension handler for methods present in
AdminBasicEntityController.Manager for the
AdornedTargetAutoPopulateExtensionHandlerA basic entity persistence validation hook into validation provided by instances of
AdornedTargetAutoPopulateExtensionHandlerAdd advanced offer support to an Offer
Checks to make sure that the end date being updated is after the start date
This
BroadleafClassTransformer changes the name of the Table for an
entity before Hibernate sees it.Deprecated.
do not use this class, use
DirectCopyClassTransformer insteadThis interface is the super interface for all classes that will provide a JAXB unwrapper
around classes.
This interface is the super interface for all classes that will provide a JAXB wrapper
around classes.
Convenient class to hold the Spring application context.
The ArchivedPagePublisher will be notified when a page has
been marked as archived.
The ArchivedStructuredContentPublisher will be notified when a StructuredContent item has
been marked as archived.
Adds
FilterMapping to the CriteriaTransferObject's CriteriaTransferObject.getAdditionalFilterMappings()
in order to exclude by default any entities that are archived.Allows for custom conditions to avoid ArchiveStatusPersistenceEventHandler's preFetch functionality
Created by IntelliJ IDEA.
Created by IntelliJ IDEA.
Created by IntelliJ IDEA.
Exception thrown by the
StaticAssetService indicating that the asset requested does not exist.For HTML fields maintained in the admin, redactor allows the user to select images.
DTO used to carry back the found
ProductOptionValue.getId() and
ProductOption.getAttributeName() on a given
ProductUtility class that utilizes NIO support for atomic filesystem move operations.
Merge the attributes of a source and patch node, only adding attributes from
the patch side.
Mark a field to exclude the actual field value change during standard auditing.
Extension handler for actions that should take place after a user has authenticated on the front-end site.
Manager for the
AuthSuccessHandlerExtensionHandlerThis pricing workflow step will automatically bundle items in the cart.
MBean registered in JMX to keep track of which persistence units are marked with auto.ddl 'create'.
Allows a module to specify a sql file and some ordering information to use during Hibernate auto import.
This filter is based conceptually on the auto-levels feature of Photoshop and functions in the same way.
Deprecated.
This is no longer required and is instead implemented as a third-party inventory module
Used in conjunction with
BandedPriceFulfillmentOption and BandedWeightFulfillmentOption.Entity associated with sensitive, secured bank account data.
Convenience base class which all handler implementations extend.
Base class for all Workflow Processors.
Responsible for providing the base url for the site / admin applications.
Base class for APIWrapper implementations to inject the EntityConfiguration reference.
For internal usage.
For internal usage.
Validates that values are actually of their required types before trying to populate it.
For internal usage.
For internal usage.
The BasicSeoPropertyGeneratorImpl knows how to generate properties for the following basic SEO elements:
Title
Meta-Description
Canonical URLs
Implementation of the
EntityValidatorService that runs entities through JSR-303 validations.This class allows us to round Big Decimals to 2 decimal places, generally for
marshalling purposes.
Ehcache 3 cache event listener for monitoring cache changes using the Big memory hydrated cache.
Jcache cache event listener for monitoring cache changes using the Big memory hydrated cache.
A form to model adding the Billing Address to the Order
Adds some convenience methods to the Spring AbstractHandlerMapping for
BLC specific HandlerMappings.
Convenience methods for interacting with arrays
Convenience methods for interacting with collections.
Convenience class to facilitate cron interpretation.
Convenience class to facilitate date manipulation.
Utility class used primarily for retrieving fields on domain classes.
Extension manager that holds the list of
BLCICacheExtensionHandler.A
ResourceResolver that replaces the //BLC-SERVLET-CONTEXT and //BLC-SITE-BASEURL"
tokens before serving the BLC.js file.A
ResourceResolver that replaces the //BLC-SERVLET-CONTEXT and //BLC-SITE-BASEURL"
tokens before serving the BLC.js file.Convenience methods for interacting with maps
Deprecated.
this class should not be used to statically retrieve localized messages.
Convenience class to format prices for front-end display.
Convenience methods for interacting with Java number types
Convenience class to payment method data for front-end display.
Convenience methods for interacting with
PromotionMessagesConvenience methods for interacting with the request
Deprecated.
this class should not be used to statically obtain referenes to properties.
A
ResourceResolver that replaces system properties in BLC-system-property.jsExposes "blc" to expressions to the Thymeleaf expression context.
Exposes the
BroadleafRequestContext to the Thymeleaf expression contextRepresents a single crumb in a Breadcrumb list
An extensible enumeration of breadcrumb types.
Contains a list of static priority fields for commonly used Breadcrumb elements.
An abstract controller that provides convenience methods and resource declarations for its children
Deprecated.
NO LONGER REQUIRED AND SHOULD NOT BE USED.
This is used to map LDAP principal and authorities into BLC security model.
Created by IntelliJ IDEA.
Responsible for setting the necessary attributes on the BroadleafRequestContext
Responsible for setting the necessary attributes on the BroadleafRequestContext
Base abstract ApplicationEvent that provides a marker for Broadleaf events and provides a default
context map.
This class is a simple extension to Spring's SimpleApplicationEventMulticaster.
BroadleafApplicationListener<E extends org.springframework.context.ApplicationEvent>
Works in conjection with
org.broadleafcommerce.common.event.BroadleafApplicationEventMulticaster except
the event listener can indicate if the event should be run in a background thread.Extends the Spring DefaultRedirectStrategy with support for ajax redirects.
Designed to be manually instantiated in client-specific security settings
If the incoming request is an ajax request, the system will add the desired redirect path to the session and
then redirect to the path configured for the redirectPath property.
Prefixes a default Spring-generated bean name with 'bl', and also uppercases the first character of the default bean name.
Used in conjunction with
SpringBootBootstrappingServletContextListener.A ResourceResolver that handles using the theme as part of the cache key and adds in
support to disable with environment properties.
Wraps Spring's
CachingResourceResolver but adds in support to disable with
environment properties.In charge of performing the various modify cart operations
This class works in combination with the CategoryHandlerMapping which finds a category based upon
the passed in URL.
This controller handles password changes for a customer's account
In charge of performing the various checkout operations
Extension handler for the checkout controller
Extension manager for the checkout controller
Deprecated.
Use
SimpleUrlHandlerMapping insteadGeneric Address Validator not specific to a particular Country.
Main configuration class for the broadleaf-common module
Customized property source for broadleaf-common
Support introduction of customized or additional services to the Hibernate service registry.
Some resource handlers need a valid site, theme, or sandbox to be available when serving request.
Commonly used Broadleaf Controller operations
Specific Spring component to override the default behavior of
CookieLocaleResolver so that the default Broadleaf
Locale looked up in the database is used.Author: jerryocanas
Date: 9/6/12
Author: jerryocanas
Date: 9/6/12
Author: jerryocanas
Date: 9/6/12
Author: jerryocanas Date: 9/6/12
Responsible for returning the currency to use for the current request.
Responsible for returning the currency to use for the current request.
Author: jerryocanas
Date: 9/6/12
Author: jerryocanas
Date: 9/6/12
Utility methods for common currency operations
This is a straight copy of Spring's DefaultResourceResolverChain (as of 4.1.6).
A Spring bean extending this class will automatically be called when validation is done on the entity specified by
the generic type.
In order for the Broadleaf Administration to display enumerated values with meaningful labels,
enumerations should implement this interface.
Created as a common class for adding property sources to the Spring
Environment.
In non-boot this class should be hooked up in your web.xml as shown below
This is by default added into
META-INF/spring.factories with the EnvironmentPostProcessor key.Base exception class for BroadleafExceptions that understands root cause messages.
This component provides an expression parser, most typically for SPEL expressions.
This is an extension of Spring's User class to provide additional data to the UserDetails interface.
Many components in the Broadleaf Framework can benefit from creating and manipulating temporary files as well
as storing and accessing files in a remote repository (such as AmazonS3).
Extension manager for
BroadleafFileServiceMany components in the Broadleaf Framework can benefit from creating and manipulating temporary files as well
as storing and accessing files in a remote repository (such as AmazonS3).
This is the override of Hibernate transformer that adds filtration based on class/package name to prevernt
parsing unwanted classes
Responsible for returning the Locale to use for the current request.
Responsible for returning the Locale to use for the current request.
The controller responsible for login and login related activities including
forgot username, forgot password, and reset password.
This is the page controller for adding, updating, and deleting a customer's saved payments.
The controller responsible for wishlist management activities, including
viewing a wishlist, moving items from the wishlist to the cart, and
removing items from the wishlist
Replaces the older BLResourceBundleMessageSource by using a
ReloadableResourceBundleMessageSource
instead.
Provides the ability for modules to register themselves with Broadleaf to be used with
ConditionalOnBroadleafModule and ModulePresentUtil
in order to provide different behavior in inter-module dependencies.List of modules that are known to have declared a
BroadleafModuleRegistration in their spring.factories.This is an extension of BroadleafRegisterController
that utilizes Spring Social to register a customer from a Service Provider
such as Facebook or Twitter.
This class works in combination with the PageHandlerMapping which finds a page based upon
the request URL.
Wraps Spring's
PathResourceResolver for ordering purposes.Allow a class transformer to explicitly declare which persistence unit it will influence
This custom dialect will treat all Clob types as if they contain a string instead of an OID.
Deprecated.
In favor of org.broadleafcommerce.common.web.BroadleafRequestFilter.
This class works in combination with the ProductHandlerMapping which finds a product based upon
the passed in URL.
This controller works in conjunction with the broadleaf-ajax style redirect.
The controller responsible for registering a customer.
Convenient holder class for various objects to be automatically available on thread local without invoking the various
services yourself
This resolver is responsible for returning the Customer object that is currently present on the request.
By default, we'll resolve the customer from the "customer" attribute on the request.
The BroadleafCurrencyResolver can be implemented to set the currency (e.g.
Responsible for setting up the site and locale used by Broadleaf Commerce components.
Interceptor responsible for setting up the BroadleafRequestContext for the life of the request.
Provides a PostConstruct method that sorts the
ResourceResolver, ResourceTransformer,
or location (Resource) collections based on the Ordered interface.Constants representing out of box Broadleaf Resource Resolvers.
Constants representing out of box Broadleaf Resource Transformer ordering.
This class serves up the Robots.txt file.
Responsible for determining the SandBox to use for the current request.
Responsible for determining the SandBox to use for the current request.
Handles searching the catalog for a given search term.
Holder for a folder of properties resources comprised of something like the following on the classpath:
classpath:/runtime-properties/
common.properties
common-shared.properties
[profile].properties
[profile]-shared.properties
In charge of performing the various checkout operations
This exception resolver can be used to handle exceptions in a user friendly way by displaying an error template.
Controller to generate and retrieve site map files.
Responsible for returning the site used by Broadleaf Commerce for the current request.
MVC configuration required by Broadleaf site to operate correctly.
This class works in combination with the SkuHandlerMapping which finds a category based upon
the passed in URL.
A BroadleafApplicationEvent used so that we can communicate with the ScheduledJobsAndEvents module without having a dependency on it.
Constant for how the event should be consumed
Which type of worker is qualified to handle the event
Effectively a copy of com.broadleafcommerce.jobsevents.domain.dto.SystemEventDetailDTO
to be used when creating a org.broadleafcommerce.common.event.BroadleafSystemEvent
Responsible for returning the theme used by Broadleaf Commerce for the current request.
Responsible for setting up the theme used by Broadleaf Commerce components.
Responsible for returning the TimeZone to use for the current request.
Responsible for returning the timezone to use for the current request.
Classes that implement this interface will be exposed to the Thymeleaf expression evaluation context.
Wraps Spring's
VersionResourceResolver but adds in support to disable with
environment properties.Generic interface that should be used for processing requests from Servlet Filters, Spring interceptors or Portlet
filters.
Tracks a bundle version name and path/file information for a dynamically created resource bundle.
Deprecated.
instead, see the ProductType Module's Product Add-On's usage of
DiscreteOrderItemsDeprecated.
A
ResourceResolver that is used to serve previously bundled files.Utility class that sets the correct response headers (especially browser cache related headers) using the existing
Spring request pipeline configuration by mimetype.
Provides either dynamic, or cached static compression of response data.
OrderItem level offer that has been qualified for an order,
but may still be ejected based on additional pricing
and stackability concerns once the order has been processed
through the promotion engine.
Provides a method that creates the seed ProcessContext object for a cart
operation.
This class represents the basic context necessary for the execution
of a particular order process workflow operation.
This filter should be configured after the BroadleafCommerce CustomerStateFilter listener from Spring Security.
Interceptor responsible for putting the current cart on the request.
ApplicationListener responsible for updating CartState with a new version that was persisted.Ensures that the customer's current cart is available to the request.
Convenience methods for determining the state of the active cart
Marker interface.
For use with category and product entities.
Marker interface.
Default command handler to handle Catalog Solr index commands.
Command service for issuing (queuing) Catalog (re)index commands.
Lightweight bean representation of
This service provides some URL manipulation capabilities.
Implementations of this interface are used to hold data about a Category.
Created by brandon on 8/28/15.
Extension handler for
CategoryCustomPersistenceHandlerExtension manager for
CategoryCustomPersistenceHandlerCategoryDao provides persistence access to Category instances.An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Category entity
This handler mapping works with the Category entity to determine if a category has been configured for
the passed in URL.
This generator generates structured data specific to the category pages.
This field persistence provider manages the default CategoryXref reference for a Category instance through
the "defaultParentCategory" pseudo field.
Extension handler for
CategoryParentCategoryFieldPersistenceProviderExtension manager for
ProductParentCategoryFieldPersistenceProviderImplementations of this interface are used to hold data about the many-to-many relationship between
the Category table and the Product table.
The Class CategoryProductXrefImpl is the default implmentation of
Category.Responsible for generating site map entries for Category.
CategorySiteMapGenerator is controlled by this configuration.
CategorySiteMapGenerator is controlled by this configuration.
Implementations of this interface are used to hold data about the many-to-many relationship between
the Category table and a parent Category.
CategoryXrefDao provides persistence access to the relationship
between a category and its sub-categories.The CRUD type requested by the admin
This activity handles both adds and updates.
Very similar to the
CheckAddAvailabilityActivity but in the blUpdateItemWorkflow insteadConvenience passthrough for
CustomPersistenceHandlerAdapter that provides a method for class detection
based on the provided constructor.Validation service for reviewing any fully qualified classname data that is part of a Http request.
Persistence for some collection fields is managed outside the admin pipeline.
Configuration class for defining cache regions via Java config when either not using ehcache or when jcache.create.cache.forceJavaConfig is true
Default configuration to load up CMS properties
Handle admin form UI modification for CMS related entitites
Registers the content management module properties
Deprecated.
Deprecated.
Deprecated.
Deprecated.
This is an optional activity to allow a committal of taxes to a tax sub system.
Configuration class for defining cache regions via Java config when either not using ehcache or when jcache.create.cache.forceJavaConfig is true
Rollback handler to execute after an order has been marked as 'completed' and there is an exception.
Simple POJO for storing a String value as a compressed byte array.
Responsible for determining if an entity has been conditionally enabled for loadtime weaving for the enterprise and/or
multitenant modules.
Simple data object to hold direct copy transform config information.
The purpose of this class is to allow the conditional addition or removal of annotations to a target entity based on template class.
Indicates that this bean should not be created unless the broadleaf-open-admin-platform exists on the classpath.
Allows for conditional registration of beans depending only if a particular Broadleaf module is present.
Used to indicate that a class should be instantiated as a bean if ehcache is on the classpath
Used to indicate that a class should be instantiated as a bean if ehcache is missing fromm the classpath
Allows for conditional registration of beans depending only if a particular Broadleaf module is absent.
Indicates that this bean should not be created unless the broadleaf-open-admin-platform does not exists on the classpath.
Configuration items to be used in conjunction with
ValidationConfiguration and used by an instace of
org.broadleafcommerce.openadmin.server.service.persistence.validation.PropertyValidatorRolls back all payments that have been processed or were confirmed in
ValidateAndConfirmPaymentActivity.An extendible enumeration of container shape types.
An extendible enumeration of container size types.
Provides deep links for
StructuredContent items.Processor used to display structured content that is maintained with the Broadleaf CMS.
Extension handler for the
ContentProcessorAn extensible enumeration for a Security Context Type.
Provides the same methods from
InventoryService but with optional, additional context information.ContextVariableNames can be added as a Job or Event detail in order to establish the context.
Add configured cookies as fields to request-based rule builder.
Populate configured cookie values on the http request thread for use by MVEL request-based rules
Populate configured cookie values on the http request thread for use by MVEL request-based rules
This entity should be used only for lookup and filtering purposes only.
Represents a principal subdivision of a Country (e.g. province or state).
Represents a category that describes a Countries subdivision.
This class is used in conjunction with the
DetermineOfferChangeActivity to determine if the number
of offers changed on the order during the pricing workflow.Typically, clients will utilize 3rd party payment integrations as the final
checkout step.
Entity associated with sensitive, secured credit card data.
An extendible enumeration of credit card types.
The following processor will add any Payment Gateway specific Card Type 'codes' to the model if
the gateway requires that a 'Card Type' (e.g.
Thrown when a problem converting a particular
FieldPath
from a FilterMapping is detected
during JPA criteria translation for fetch operation.Generic persistent entity criteria transfer object.
Event handler for adding restrictions to criteria created for admin fetch requests
Checks to make sure that the provided cron expression is valid
A service responsible for allowing secure authentication for a user between the admin and site applications.
Marker class that allows the auditable fields to be udpated from either the site or the admin.
A service responsible for allowing secure authentication for a user between the admin and site applications.
This is a specific interface for CrossSaleProductImpl and is needed for entity mapping and translations
Deprecated.
Use
SecurityFilter insteadService that's used to minify CSS
Unfortunately, JAXB doesn't know how to deal with java.util.Currency because it doesn't have a
default constructor.
Simple interface for returning a
PaymentRequestDTO based on the current customer in the system
(like something on threadlocal).Simple interface for returning a
PaymentRequestDTO based on the current order in the system (like something on
threadlocal).An extendible enumeration of customer address types.
Created by brandon on 9/4/15.
Implementations of this interface are used to hold data about a Customers Attributes.
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Customer entity
Created by bpolster.
Determines how the Offer.getMaxUsesPerCustomer() will be applied.
This entity is designed to deal with payments associated to an
Customer and is used to refer to a saved
payment that is stored at the Payment Gateway level.Abstract controller that provides convenience methods and resource declarations to facilitate payment gateway
communication between the implementing module and the Spring injected customer profile engine.
The default implementation of this interface is represented in the core Broadleaf framework at
DefaultCustomerPaymentGatewayService.The main function of this entity listener is to publish a Spring event that the customer has been persisted.
An event for whenever a
CustomerImpl has been persistedCreated by ckittrell on 12/9/15.
Provides access and mutator functions to manage a customer's phones.
Simple container for Customer-related rules used to decouple Customers from Offers.
Convenient class to get the active customer from the current request.
This filter should be configured after the RememberMe listener from Spring Security.
Interceptor responsible for putting the current customer on the current request.
ApplicationListener responsible for updating CustomerState as well as invalidating the session-based
customer, if one existed previously.Created in order to utilize the Customer's primary key to salt passwords with.
Modifies Username/EmailAddress fields based on the 'use.email.for.site.login' property
This Thymeleaf variable expression class serves to expose elements from the BroadleafRequestContext
Custom Persistence Handlers provide a hook to override the normal persistence
behavior of the admin application.
Convenience class for those
CustomPersistenceHandler implementations
that do not wish to implement all the methods of the interface.Responsible for generating site map entries.
CustomSiteMapGenerator is controlled by this configuration.
CustomSiteMapGenerator is controlled by this configuration.
An implementation of the
OrderLockManager that relies on the database to provide synchronization
for locks on Orders.Extension handler for resolving templates from the database.
Deprecated.
Variable expression that looks up a list of
DataDrivenEnumerationValues based on its enum keyUtility class to convert a DataDTO/ExpressionDTO into an MVEL string
A Thymeleaf processor that formats the date
An extendible enumeration of container shape types.
An extendible enumeration of container shape types.
Decrements inventory
Decrements inventory that was put on by the
DecrementInventoryActivityDTO Class that contains enough information to allow the client site application to generate
the necessary information for a link to an admin screen
This abstract class should be extended by services that provide deep links for specific entities.
Default implementation used by the core framework.
Default implementation used by the core framework.
Default implementation for the core framework.
Core framework implementation of the
CustomerPaymentGatewayService.Register this filter via Spring DelegatingFilterProxy, or register your own implementation
that provides additional, desirable members to the pricingConsiderations Map
that is generated from the getPricingConsiderations method.
Default implementation of the
DynamicSkuPricingService which simply ignores the considerations hashmap in all
method implementationsAllows an encapsulated way to create caches programmatically from an EhCache
CacheManager.Defines a default ExpiryPolicy for EhCache.
Default pass-through implementation of
FetchWrapperDefault utility to access and programmatically create JCache instances via the JCache
CacheManager.This generator runs for all pages.
Convenience class to deal with the common actions on most list grids.
Default implementation of OfferCodeDaoExtensionHandler.
Passthrough implementation for the
FrameworkCommonClasspathPropertySource that sets the default orderDefault implementation of
OverridePreCacheService.Core framework implementation of the
PaymentGatewayCheckoutService.Default ProcessContext implementation
Adds a default property source to look for a
runtime-environment folder and apply the -shared overriding
mechanics to it.Encapsulates a block of code that should be run at a later time, usually in order to guarantee the proper state
or conditions for its execution.
Wrapper implementation of Solr that delegates to an
HttpSolrClient.The idea of this class if to iterate over props of the passed class and if found prop with annotation @OneToMany
recurse into it.
A HSQL DB dialect specifically for the demo.
This is a utility class that is only meant to be used for testing the BLC demo on HSQLDB.
This is a utility class that is only meant to be used for testing the BLC demo on Oracle.
Command extractor that does Postgres specific logic in order for the DemoSite load scripts to import correctly.
This is a utility class that is only meant to be used for testing the BLC demo on SQL Server.
This class is used in conjunction with the
CountTotalOffersActivity to determine if the number
of offers changed on the order during the pricing workflow.An extendible enumeration of units of measure types.
This class transformer will copy fields, methods, and interface definitions from a source class to a target class,
based on the xformTemplates map.
Constants for tagging an entity class to receive byte code transformation upon
being loaded by the classloader
An implementation of SupportLoggerAdapter that would disable SupportLogger logging.
Marker interface for a class that is included in one way or another in the multitenant architecture.
Interface that defines a distributed
BlockingQueue, which means that this queue can be created, distributed, and operated on by multipleRuntimeException indicating that there was an error operating on the queue, or changing queue state.Interface to define a lock as distributed and safe to use across nodes or JVMs.
RuntimeException to identify that there was an issue obtaining or otherwise releasing a distributed lock.
Component to build a Solr document from an
Indexable.Provides utility methods for interacting with dynamic entities
Used to setup what data will be needed to create add dynamic form fields to an entity.
Rather than using this clas directly, it might be more appropraite to utilize
AdminEntityService instead.Commonalities between
PageTemplateCustomPersistenceHandler and StructuredContentTypeCustomPersistenceHandler
since they share similar issues in regards to dynamic fieldsThis class serves as a basic iterator for a list of source files to be
merged.
Interface for dynamically determining the activity dates.
DTO to represent pricing overrides returned from invocations to
DynamicSkuPricingServiceResponsible for setting up the
SkuPricingConsiderationContext.Interceptor version of the
DynamicSkuPricingFilter.Interface for calculating dynamic pricing for a
Sku.This extensible enumeration controls the field types that are available for users to choose from when creating
FieldDefinitions in the admin tool.
Convenience class to provide dynamic field translations.
Use this merge bean post processor for merging tasks that should take place before the persistence layer is
initialized.
Use this merge bean post processor for collection member removal tasks that should take place before the persistence layer is
initialized.
This class provides an LRUMap structure that defaults to a more efficient ConcurrentHashMap if the
size has not yet been reached.
Ehcache 3 cache event listener for monitoring cache changes using the Ehcache hydrated cache.
JCache cache event listener for monitoring cache changes using the Ehcache hydrated cache.
Deprecated.
- This email approach is no longer recommended.
An extendible enumeration of email property types.
Deprecated.
in favor of
NotificationDispatcherDeprecated.
The EmailTarget interface is used to specify the recipients of the email.
Basic implementation of EmailTarget
Convenience class for creating an empty workflow.
Enables
FrameworkController and FrameworkRestController annotations.
Bootstraps Broadleaf admin configuration XML for both servlet and non-servlet.
Bootstraps the Broadleaf root admin configuration XML for only non-servlet beans.
We are deliberately leaving off the
Configuration annotation since
this inner class is being included in the Import above, which interprets this as a
Configuration.
Bootstraps Broadleaf admin configuration XML for both servlet and non-servlet beans.
We are deliberately leaving off the
Configuration annotation since
this inner class is being included in the Import above, which interprets this as a
Configuration.STOP.
STOP.
We are deliberately leaving off the
Configuration annotation since
this inner class is being included in the Import above, which interprets this as a
Configuration.STOP.
We are deliberately leaving off the
Configuration annotation since
this inner class is being included in the Import above, which interprets this as a
Configuration.
Bootstraps Broadleaf customer-facing configuration XML for both servlet and non-servlet beans in use with a traditional MVC application.
Bootstraps Broadleaf root site configuration XML for only non-servlet beans.
We are deliberately leaving off the
Configuration annotation since
this inner class is being included in the Import above, which interprets this as a
Configuration.
Bootstraps Broadleaf site configuration XML for only servlet beans in use with a traditional MVC application.
We are deliberately leaving off the
Configuration annotation since
this inner class is being included in the Import above, which interprets this as a
Configuration.Enables only
FrameworkController annotations, which are the MVC controllers.Enables only
FrameworkRestController annotations, which are the RESTful controllers.Basic extension point for modules handling encryption.
Defines the state in which sandboxable collections in the Enterprise module should adhere to Broadleaf defined behavior.
Generic DTO for a domain object.
Deprecated.
Implement
EntityDuplicationHelper insteadProvides additional metadata and performs final modifications for an entity before persistence.
Creates a production duplicate of an entity.
Allow other modules to contribute to the duplication lifecycle
Manage the interaction between a duplication operation and other modules that wish to contribute to that lifecycle
Qualified instances are expected to manipulate the
EntityForm instance passed in the request.A wrapping class meant to house a list of
EntityFormModifier instances and any relevant configuration data
for those modifiers, in the form of EntityFormModifierData, organized by modifierType.Hold generic key/value data for configuring a
EntityFormModifier, along with a modifierType value
that should be used to qualify EntityFormModifier instances capable of consuming this configuration.Simple key/value pair configuration for a
EntityFormModifier.A request to modify an
EntityForm, or ListGrid instance.Validator used at the controller level to ensure that an Entity has passed validation from the PersistenceModule or
CustomPersistenceHandler.
A
BroadleafVariableExpression that assists with operations for Thymeleaf-layer operations on entity forms.Utility class that will search for the entity identifier property and/or property value
This class holds information about an entity.
Class that provides guidance to modules that need to react when running in a multi-tenant mode.
ExtensionHandler for methods within
EntityInformationServiceExtension manager that holds the list of
EntityInformationServiceExtensionHandler.Provides a
Runnable implementation that allows the execution of the run() method inside the context of a thread-bound EntityManager.
Used to validate usages of em.find() when querying for a primary key specifically across sibling Multi-Tenant sites.
This class transformer will check to see if there is class that should have been loaded by the
MergePersistenceUnitManager
(meaning, it has an @Entity, @MappedSuperclass or @Embeddable annotation on it and will be inside of a persistence.xml).Classes implementing this interface are capable of manipulating metadata from the inspection
phase for the admin.
Created by Jon on 6/24/15.
Allow other modules to provide a parent id for a given entity/id combination
Manage the handling of EntityParentIdServiceExtensionHandlers
The DynamicEntityDao infrastructure provides a generic representation of an entity in
the system.
Validates all of the populated properties for entities
This implementation validates each
Property from the given Entity according to the
ValidationConfigurations associated with it.For special
RowLevelSecurityProvider instances, add special behavior that allows for modifying an EntityForm
that has been marked as read only.An extension handler represents a generic pattern used in BroadleafCommerce when an out-of-box service
with complex logic provides implementation hooks.
The ExtensionManager pattern is intended for out of box components to be extended by Broadleaf modules.
Responsible for exercising a method on an
ExtensionHandler.If a service extension using the
ExtensionManager pattern expects a result from the extension, it should
pass in an instance of this class into the method call.Contains the requested value, property and support classes.
This interface is a lightweight replacement of gateway-specific classes extending AbstractExternalPaymentGatewayCall, and it helps expose some f the QoS inner methods, for testing purposes.
POJO for useful params dictating
FetchWrapper behaviorEncapsulate params related to fetch paging
POJO for useful params dictating
FetchWrapper behaviorDefines the type of fetch and paging technique to be used:
FetchType.LARGERESULTSET denotes a lastid approach, rather than an offset, while
FetchType.DEFAULT denotes a standard offset and page size technique.Detect the type of fetch and paging being used for a particular admin pipeline fetch request
Wrap calls to
BasicPersistenceModule.getPersistentRecords(String, List, Integer, Integer),
BasicPersistenceModule.getTotalRecords(String, List), and BasicPersistenceModule.getRecords(FetchExtractionRequest),
presumably to provide additional configuration or state modification before calling those methods on BasicPersistenceModule.Represents a String-based mapping of entities and properties.
DAO to facilitate interaction with Broadleaf fields.
Created by bpolster.
Created by bpolster.
An extensible enumeration of entities that are used for searching and reporting
Created by bpolster.
Created by bpolster.
Ensures that field values submitted in the admin are less than or equal to the length specified in the metadata
This interface is responsible for modifying the behavior of
FieldManager.setFieldValue(Object, String, Object)
and FieldManager.getFieldValue(Object, String).Classes implementing this interface are capable of manipulating metadata for a field resulting from the inspection
phase for the admin.
Manages execution of field value modification for reads and writes against one or more modifiers.
Marker interface for any validator that contains field names as part of its configuration.
Classes implementing this interface are capable of handling persistence related events for fields whose values
are being requested or set for the admin.
Supported field types within the Broadleaf CMS admin.
An extensible enumeration of entities that are used for searching and reporting
Field Value Configurations are be used in conjunction with the `showIfFieldEquals` option in AdminPresentation
configurations.
Any module within the BLC framework that needs to store and retrieve files from a remote storage such as
Rackspace CloudFiles or AmazonS3 should declare an application file type.
Marker exception that just extends RuntimeException to be used by the
BroadleafFileServiceInterface to be implemented by a FileProvider.
Default implementation of FileServiceProvider that uses the local file system to store files created by Broadleaf
components.
Buffer an HTTP response to the file system, rather than streaming directly to the HTTP caller.
XML based Index Status provider.
Represents a temporary location on the fileSystem.
Configuration bean that represents a Hibernate filter.
Configuration bean that represents a Hibernate FilterDefinition
For Spring Boot implementations, use the
Ordered interface, in conjunction with these
order values, on any Filter implementation beans instantiated through Spring.Extension manager for
FilterProductTypePersistenceHandlerExtensionHandlerCreated by IntelliJ IDEA.
Used in conjunction with the
FixedPriceFulfillmentPricingProvider to allow for a single price
for fulfilling an order (e.g. $5 shipping)Processor used in conjunction with
FixedPriceFulfillmentOption.Created by bpolster.
Extension handler for various methods from
FormBuilderServiceUsed as a replacement to the HTML
<form> element which adds a CSRF token input field to forms that are submitted
via anything but GET.
A holder for a folder containing a
common.properties file to be added to the Spring Environment in a programmatic way without Spring Boot and with very specific
ordering semantics.Indicates that an annotated class is a "Framework Controller" (default MVC controller).
HandlerMapping to find and map
FrameworkMappings inside FrameworkController and FrameworkRestController classes.This annotation behaves exactly like
RequestMapping except it is used inside FrameworkController and
FrameworkRestController controllers.This class has been copied from spring-webmvc:4.3.7-RELEASE in order to provide URI building functionality for
FrameworkMapping annotations.Indicates that an annotated class is a "Framework REST Controller" (default RESTful controller).
Ensures that any beans registered using this reader have a lower precedence than any beans defined in @Configuration
classes, which otherwise have a lesser /priority than XML resources.
This entity is a collection of properties shared between different band implementations.
DTO to allow FulfillmentProcessors to respond to estimation requests for a particular FulfillmentGroup
for a particular FulfillmentOptions
This is the main entity used to hold fulfillment information about an Order.
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Fulfillment Group entity
The methods in this class are invoked by the add and update item to cart workflows.
Called during the pricing workflow to set the merchandise total for each FulfillmentGroup
in an Order.
Called during the pricing workflow to compute all of the fulfillment costs
for all of the FulfillmentGroups on an Order and updates Order with the
total price of all of the FufillmentGroups
An extendible enumeration of fulfillment group status types.
Called during the pricing workflow to set each item's merchandise total and taxable total
This can be used by various third-party fulfillment pricing services in order to
resolve a location that items will be shipped from in order to properly calculate the
cost of fulfilling that particular fulfillment group.
A FulfillmentOption is used to hold information about a particular type of Fulfillment implementation.
This entity defines the bands that can be specified for
BandedPriceFulfillmentOption.Main extension interface to allow third-party integrations to respond to fulfillment pricing
This service can be used in a couple of different ways.
An extendible enumeration of fulfillment group types.
Rule Builder enum options provider for
HourOfDayTypeThis entity defines the bands that can be specified for
BandedWeightFulfillmentOption.An in memory generated resource.
Provides methods to easily access entities managed by the 'blPU'
PersistenceUnit.CRUD methods for generic entities
Allows for a generic operation that can be executed in a particular context.
Provides a mechanism to allow for retriable logic.
Entity associated with sensitive, secured bank account data.
This class serves as a marker interface to indicate that the resource comes from a shared area of the
filesystem.
Analagous to
PropertyValidator except this does not attempt to use any ValidationConfiguration from an
AdminPresentation annotation.Rebuilds the entire Solr index.
DTO representing a boolean whether or not it passed validation and String error message.
Takes advantage of the new-type gtag.js from Google Analytics rather than the deprecated analytics.js.
Javascript minification service implemented using the Google Closure Compiler
This will be used for minification if the Google Closure Compiler dependency is included in the project
Deprecated.
use
GoogleAnalytics4Processor instead
Hibernate SPI implementor that harvests metadata about all of the entity classes
Hibernate convenience methods
Contributes a breadcrumb (typically the first breadcrumb).
This generator generates structured data specific for a homepage, namely the search action.
An extendible enumeration of container shape types.
Similar to
UrlRewriteProcessor but handles href tags.Enable html minification.
If the field is translatable, then this method prefixes the field with supported locales.
If the field is translatable, then this method prefixes the field with supported locales.
The utility methods in this class provide a way to ignore the currently configured site/catalog contexts and instead
explicitly run operations in the specified context.
A thread local context to store the unique name for this request thread.
Simple bean that can represent a key/value pair used by arbitrary components for the purpose of engaging exclusion behavior.
OpenEntityManagerInViewFilter implementation that can be "ignored" based on state set by SecurityBasedIgnoreFilter.Marker annotation for any field on a sandboxable entity that should not undergo enterprise sandbox config validation
(if applicable).
Created by IntelliJ IDEA.
A bean designed to hold general information about an image
Created by IntelliJ IDEA.
Created by bpolster.
This class serves to parse any passed in source application context files and
look for the Spring "import" element.
Mainly a marker interface denoting that the entity should be indexed for search
Represents a field that gets stored in the search index
DAO used to interact with the database search fields
This interface is used for representing a
FieldType for an IndexFieldGeneral information about the current status of a (embedded) Solr instance's index
Convenience class providing a 10 minute expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.This handler implementation provides behavior where the child nodes from an
element in the patch document are added to the same node in the source
document.
This handler implementation provides behavior where a list of elements from the
patch document are appended to the same parent element in the source document.
This basic inventory service checks and adjusts the current inventory of a sku.
Marker interface to dictate the overridden methods within
ContextualInventoryService.Enumeration to specify whether inventory should be checked or not.
Rule Builder enum options provider for
HourOfDayTypeInvocation handler for unit testing byte-weaved classes.
An extensible enumeration of ISO Code Status Types.
This domain object represents the ISO 3166 standard published by the International Organization for Standardization (ISO),
and defines codes for the names of countries, dependent territories, and special areas of geographical interest.
By default, we will filter all ISOCountries to return only those that have names.
Service that provide methods to look up the
standards published by the International Organization for Standardization (ISO)
StructuredContent data is converted into a DTO since it requires
pre-processing.
This interface is used as a part of a template pattern in ItemOfferProcessor that allows reuse to other BLC modules.
Filter and apply order item offers.
The same as
ItemOfferComparator but uses the PromotableCandidateItemOffer.getPotentialSavingsQtyOne()
method instead.Event that may be raised to indicate that items have been fulfilled.
Service that's used to minify Javascript
Helper class for building
Configuration classesPersistence unit post processor for dynamically modifying the persistence unit.
DTO object to represent the configuration of a cache region
Provides the URI to be used for JCache configuration
Generic utility to allow one access to the JCache
CacheManager.JMS implementation of ArchivedPagePublisher.
Receives JMS message with a String that indicates the cache key
to invalidate.
JMS implementation of ArchivedPagePublisher.
Receives JMS message with a String that indicates the cache key
to invalidate.
This class allows us to override Persistence Unit properties on a per-environment basis.
Used when a controller typically returns a String that represents a view path but would like to return a
JSON response in other scenarios, such as an error case.
An extendible enumeration representing the status of the last attempted payment
in CustomerPayment
Contains the requested field, metadata and support classes.
Use this merge processor for merging duties that should take place later in the Spring startup lifecycle.
Use this merge processor for collection member removal duties that should take place later in the Spring startup lifecycle.
This interface represents an Offer instance that has some additional, deprecated fields related to uses and maxUses
Holds the backwards compatibility field for uses.
This handler is responsible for replacing nodes in the source document
with the same nodes from the patch document.
A customization of
JdbcServicesImpl that allows further usage of the sql statement logging.StandardServiceInitiator implementation for introducing the custom JdbcServices implementation
to the Hibernate service registry.A customized
JpaTransactionManager that will send Spring events at key lifecycle points during a transaction.Enumeration describes the type of event that is being logged in the
SupportLogger.lifecycle method.
This linked data generator provides structured metadata relevant for a page's SEO.
Extension handler for extending functionality of
LinkedDataGenerator.Manage extension points for
LinkedDataGenerators.This processor replaces linkedData tags with metadata for search engine optimization.
Buttons to display on the frontend for a list grid.
Grouping of buttons to display on the frontend for a list grid.
An extension handler to allow a custom error key or error message to be added to the ListGridRecord.
Allows extension handlers to add a custom error message or error key to the list grid record.
View class for the icon that can potentially appear on list grid rows.
Created by jfischer
Created by bpolster.
Created by bpolster.
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Locale entity
Created by jfischer
Represents a cached translation pair.
Created by bpolster.
Created by bpolster.
An extendible enumeration of locale types.
Author: jerryocanas
Date: 9/17/12
This class insures that if using the successUrl or failureUrl request
parameter, then the urls are valid and are local to the application
(preventing a user modifying to go somewhere else on login success/failure)
This is not hooked up by default so that Log4j2 is not required.
Specific implementation used with a Log4j2 dependency
Deprecated.
in favor of
Log4j2ManagementBean (following Apache's EOL declaration for log4j 1.x)Defines whether or not a to-one lookup should be rendered in a modal to be selected or
through a pre-populated dropdown.
This is a JAXB wrapper to encapsulate a Map<String, Object>
Checks for equality between this field and a configured 'otherField'
Validator that checks if a max value field is actually greater than or equal to a min value field.
A null safe media object.
For internal usage.
For internal usage.
Provides a convenience annotation for declaring a bean merge into an existing collection of beans (presumably a
pre-existing Broadleaf Commerce collection).
This processor is responsible for registering Early/LateStageMergeBeanPostProcessors for
Merge annotated
beans and ensuring the correct prioritization of these post processors.Deprecated.
this has been replaced by invoking the merge cart service explicitly within the cart state request processor
Deprecated.
this has been replaced by invoking
MergeCartService explicitly within the
CartStateRequestProcessorExtension handler for merge cart
Extension manager for merge cart.
The 2.0 implementation of merge cart service.
This exception is thrown when a problem is encountered during
the actual merge of the source and patch documents.
All handlers must implement the MergeHandler interface.
This adapter class allows the developer to create a merge handler
instance and only override a subset of the functionality, instead of
having to provide an independent, full implementation of the MergeHandler
interface.
Generic Spring Bean Factory to merge various XML files together and pass them to the JCache
CachingProvider to create a CacheManager.This class manages all xml merge interactions with callers.
This exception is thrown when a problem is encountered during
the MergeManager initialization
Merges jars, class names and mapping file names from several persistence.xml files.
This class provides the xml merging apparatus at a defined XPath merge point in
2 xml documents.
Allows XML beans to be merged together with existing bean definitions rather than always doing a wholesale replacement
When beans are discovered using this reader this will take the previous definition and merge it with the new definition
using
AbstractBeanDefinition.overrideFrom(BeanDefinition).Generated resource resolver for Admin Javascript Messages
An extendible enumeration of type of messages.
The MetadataMBeanInfoAssembler provided by Spring does not allow the usage of JDK dynamic proxies.
The MetadataNamingStrategy provided by Spring does not allow the usage of JDK dynamic proxies.
This handler is responsible for replacing nodes in the source document
with the same nodes from the patch document.
For
FieldMetadataProvider and
FieldPersistenceProvider, message
the system on how it should interpret the provider's handling of the call.A
ResourceTransformer that minifies
the resource.This interface can be used with an Offer implementation to indicate that an offer supports minimum required targets.
An extendible enumeration of container shape types.
An extendible enumeration of modal header types.
Marker interface that all modules should use when adding activities to Broadleaf workflows.
A simple bean that when declared in app context will cause a lifecycle
logging message to appear in the logging output.
Utility class that checks for the presence of registered Broadleaf modules.
A Thymeleaf Variable Expression intended to provide various information about the modules enabled for this application.
Persistence provider capable of extracting friendly display values for Money fields
An extendible enumeration of container shape types.
Condition to use if the Multi-Tenant module is available at runtime
This form is used to bind multiship options in a way that doesn't require
the actual objects to be instantiated -- we handle that at the controller
level.
Describes an entity (or @Embeddable) that is able to be cloned for the purpose of multiple tenancy.
Abstract class for copying entities to a new catalog as required during derived catalog propagation.
This
MergeBeanStatusProvider can be utilized by modules that are trying to provide functionality that
is only required when MultiTenant is loaded.Helper class for some common rule functions that can be called from mvel as well as utility functions
to make calling MVEL rules within Broadleaf easier.
Utility class to convert an MVEL string into a DataWrapper object
which can then be serialized on your view.
Convenience methods for converting simple MVEL rules to Solr SearchCriteria
Convenience methods for converting simple MVEL rules to Solr SearchCriteria
Deprecated.
Extension handler used for contributions to native Object methods on entity like equals() clone() and hashCode().
This handler is responsible for replacing nodes in the source document
with the same nodes from the patch document.
This handler is responsible for replacing nodes in the source document
with the same nodes from the patch document.
An API for w3c.Nodes manipulation
a simple implementation of the Comparator interface, (applied to the Node class) that uses the value of a given
node attribute as comparison criterion.
MergeHandler implementation that provides merging for the white space
delimited text values of a source and patch node.
Used in non-boot projects where AutoConfiguration does not occur.
This handler is responsible for replacing nodes in the source document
with the same nodes from the patch document.
Property editor for Booleans that will set the boolean to false if it came in as a null
An implementation of StatisticsServiceLogAdapter that does nothing.
The admin will throw this exception when a query is attempted across multiple class hierarchies
because it is impossible for such a query to produce any results.
This event listener is responsible for sending any notifications in response to an
OrderSubmittedEvent.Returns null for the Site (typical for non-multi-site implementations of
Broadleaf Commerce.
Returns null for the Site (typical for non-multi-site implementations of
Broadleaf Commerce.
A null implementation of
BroadleafVariableExpressionThis class transformer will do nothing.
Implementation of EmailInfo that will not send an Email.
This null implementation class can be used during development to work around
the need to have a working SMTP service to route emails through.
This predicate provider is very similar to the
EqPredicateProvider, except that it will treat
nulls equal to false.This class provides the implementation of a strategy that does not touch
FulfillmentGroupItems when cart add or update operations have been performed.
Generates a shared, static instance of NullOrderImpl.
NullOrderImpl is a class that represents an unmodifiable, empty order.
A NullPageDTO is an object that is used by the PageService caching to indicate a "cache-miss".
Class created for caching misses as some cache implementations, such as Redis, are unable to serialize a proxy (see
AbstractCacheMissAware and SystemPropertiesDaoImpl)A Null instance of a URLHandler.
Implementation of
URLProcessor that indicates the URL was not able to be
processed by any of the configured processors.This indicates how an Offer should be fulfilled to the customer, defaulting to order time discount.
Captures when an offer was applied to a customer.
DAO for auditing what went on with offers being added to an order
Service for managing
OfferAudits.Created by Jon on 11/23/15.
An extendible enumeration of discount types.
Modify new Offer duplicates before persistence
An extendible enumeration of offer item restriction types.
Represents tokens for optional fields to be weaved into OfferImpl
An extendible enumeration of offer types.
An extendible enumeration of offer rule types.
The Interface OfferService.
The Class OfferServiceImpl.
This class serves to allow reuse of logic between the core offer service and related offer service extensions.
Checks to make sure that the TargetItemCriteria is not empty if required
Represents a tier and amount combination for an offer.
An extendible enumeration of offer types.
An extendible enumeration of offer types.
Allows convert offer values for offers with OfferDiscountType.AMOUNT_OFF
and OfferDiscountType.FIX_PRICE types based on the used PriceList
Detects whether or not a Broadleaf module has been registered via am
spring.factories entry for BroadleafModuleRegistrationCondition for checking if ehcache is on the classpath
Condition specifying that ehcache is not on the classpath
Convenience class providing a 60 minute expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.Convenience class providing a 1 minute expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.Configuration class for defining cache regions via Java config when either not using ehcache or when jcache.create.cache.forceJavaConfig is true
Security configuration common to the open admin platform.
Created by IntelliJ IDEA.
Created by IntelliJ IDEA.
Describes the target of an admin operation.
To be thrown when an optimistic lock is being used to update an entity and the maximum retry count is reached,
causing the update to be aborted.
Utility class for operations on entities that support optimistic locking.
Performs an update operation on an entity within an optimistic lock aware transaction.
Checks if the state of the entity is valid then performs an update operation on an entity within an optimistic
lock aware transaction.
Based on a Spring property value resolving to a boolean, this ClassTransformer will optionally perform
bytecode transformations.
Deprecated.
Deprecated.
Deprecated.
Describes additional filter parameters used to refine the list of items returned from a query for
a DataDrivenEnumeration
Oracle-only field modifier that is used to ensure that non-nullable fields are not persisted with empty strings and
instead use single-space strings.
Defines an order in Broadleaf.
The Interface OrderAttribute.
The Class OrderAttributeImpl
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for an Order entity
Service for gathering previously completed orders
A form to model checking out as guest
The Interface OrderItemAttribute.
Arbitrary attributes to add to an order-item.
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for an Order Item entity
Class that contains a reference to an OrderItem
Records the actual adjustments that were made to an OrderItemPriceDetail.
Only the product and quantity are required to add an item to an order.
An extendible enumeration of order item types.
Domain object used to synchronize
Order operations.It is recommended to only allow one write operation on orders at a time.
Represents a given set of options for an OrderItem in an Order in the
multiship context.
Provides support for reading OrderMultishipOptions.
This DTO is used to bind multiship options in a way that doesn't require
the actual objects to be instantiated -- we handle that at the controller
level.
This form is used to bind multiship options in a way that doesn't require
the actual objects to be instantiated -- we handle that at the controller
level.
Service to interact with OrderMultishipOptions
This entity is designed to deal with payments associated to an
Order and is usually unique for a particular
amount, PaymentGatewayType and PaymentType combination.Implementation to "confirm" an unconfirmed transaction.
Strategy to handle confirming "UNCONFIRMED" transactions on an Order Payment during the checkout workflow.
Used to determine the status of an
OrderPayment
which is calculated based on the state of its containing
PaymentTransactionsThis service provides a mechanism to calculate order payment status which
is dynamically calculated based on the state of the containing transactions.
The main function of this entity listener is to publish a Spring event that the customer has been persisted.
An event for whenever an
OrderImpl has been persistedThe general interface for interacting with shopping carts and completed Orders.
This class is used as a request-scope container for the current
orderid.
An extendible enumeration of order status types.
Concrete event that is raised when an order is submitted.
Service that translates various pieces of information such as:
-
Order
- PaymentTransaction
into a PaymentRequestDTO so that the gateway can create
the appropriate request for a specific transaction.
Holder for mapping files (orm.xml) and entity classes to be contributed to the
MergePersistenceUnitManager without being specified directly
in a persistence.xml file.Responsible for compiling the set of
ORMConfigDto and adding the configuration items to a persistence unit.Performs cache item initialization for a specific entity type.
Describes a service capable of maintaining a cache of standard site level overrides.
Contains the requested entity, metadata and support classes.
Contains the requested config key, ceiling entity, metadata and support classes.
Created by bpolster.
Created by brandon on 9/3/15.
Stores additional attributes for
PagesCreated by bpolster.
Created by bpolster.
Created by bpolster.
By default, this rule processor combines all of the rules from
Page.getPageMatchRules()
into a single MVEL expression.Page fields must be pre-processed (for example to fix image paths).
Created by bpolster.
Created by bpolster.
This handler mapping works with the Page entity to determine if a page has been configured for
the passed in URL.
Created by bpolster.
Implementations of this interface contain item rule data that is used for targeting
Pages.Provide specialized cache keys for Pages.
Implementations hold the values for a rule used to determine if a
Page
should be displayed.An extendible enumeration of offer rule types.
REQUEST - indicates a rule based on the incoming http request.
TIME - indicates a rule based on
PRODUCT - indicates a rule based on
REQUEST - indicates a rule based on the incoming http request.
TIME - indicates a rule based on
timePRODUCT - indicates a rule based on
product
CUSTOMER - indicates a rule based on org.broadleafcommerce.profile.core.domainCreated by bpolster.
Extension handler for
PageServiceThis method is able to convert a fieldKey
Created by bpolster.
Responsible for generating site map entries for Page.
Created by bpolster.
Created by jfischer
Created by bpolster.
A Thymeleaf processor that processes the value attribute on the element it's tied to
with a predetermined value based on the SearchFacetResultDTO object that is passed into this
processor.
Created by IntelliJ IDEA.
Container object for the results from a lightweight query that retrieves parent categories
for a child category
Container object for the results of a lightweight query that retrieves the parent category
for a child product
Specific class of PersistenceException used in FieldPersistenceProviders that attempt to perform their own persistence
operations in addition to the normal entity field population duties.
A Do-nothing activity used to test proper merge ordering in workflows
The default encryption module simply passes through the decrypt and encrypt text.
A Default Configuration to handle Passthrough Payments, for example COD payments.
A Default Configuration to handle Passthrough Payments, for example COD payments.
This default implementation will create a compensating transaction response based on the transaction type passed in
for any Passthrough Order Payments on the order.
Adds a new 'passwordConfirm' field to the metadata as well as ensures that the field type for the password field is
actually a password
when a payment returns in error, this value indicates whether it is a "soft" decline (apt to be retried) or a "hard" one.
Abstract controller that provides convenience methods and resource declarations to facilitate payment gateway
communication between the implementing module and the Spring injected checkout engine.
The default implementation of this interface is represented in the core Broadleaf framework at
oorg.broadleafcommerce.core.payment.service.DefaultPaymentGatewayCheckoutService.The intention of this API is to generate the necessary parameters and fields
needed by the payment gateway's JavaScript library in order to create a tokenization request.
This API is intended to define the specific configuration parameters
that this gateway implementation currently supports.
Each payment gateway module should configure an instance of this.
This represents the main servic bus for grabbing configurations to configured payment gateways to execute service calls
programmatically.
Several payment gateways allow you to manage Customer and Credit Card Information from the gateway allowing
you to create a transaction from the tokenized customer or payment method at a later date.
Several payment gateways allow you to manage Customer and Credit Card Information from the gateway allowing
you to create a transaction from the tokenized customer or payment method at a later date.
A Thymeleaf Variable Expression implementation for Payment Gateway Specific fields.
Certain Payment Integrations allow you to use Fraud Services like Address Verification and Buyer Authentication,
such as PayPal Payments Pro (PayFlow Edition)
Certain Payment Integrations allow you to use a Hosted Solution,
such as PayPal Express and SagePay Form.
This API provides the ability to get the status of a Transaction after it has been submitted to the Gateway.
Gateways/processors support a vast array of different features, and in some cases
a single API will perform several different functions based on the state of the request.
Default Resolver implementation.
This API allows each module to provide its own implementation for rollback.
Some gateways allow you to create a form of recurring billing by creating a subscription profile.
Several Gateways have a method of communication that uses the HTTP Request/Response model
and the client's browser to transmit transaction result information back to the system.
This default implementation encodes the seal using a URL-Safe Base64 encoder
and 'HmacSHA1'
This API is intended to be called by the Checkout Workflow
to confirm all Payments on the order that have not yet been confirmed/finalized.
This is a decoupled interface that provides
the basic functions needed to create the normal BILLABLE Credit Card Transactions
The purpose of this class, is to provide an API that will create
any gateway specific parameters needed for a Transparent Redirect/Silent Order Post etc...
This is designed such that individual payment modules will extend this to add their own type.
This is a utility service that aids in translating the Request Attribute and
Request Parameters to a single String.
This default implementation produces the Request Attributes and Request Paremeters
in JSON notation.
The purpose of this class, is to provide an API that will translate a web response
returned from a Payment Gateway into a PaymentResponseDTO
An extendible enumeration of payment log types.
A DTO that is comprised of all the information that is sent to a Payment Gateway
to complete a transaction.
The DTO object that represents the response coming back from any call to the Gateway.
Used to store individual transactions about a particular payment.
The PaymentTransactionType is used to represent the types of operations/transactions that could occur against a single payment.
This represents types of payments that can be applied to an order.
An extendible enumeration of container permission types.
Interface for handling various lifecycle event for the
PersistenceManager.Convenience adapter for PersistenceManagerEventHandler implementations that don't need to implement every
method of the interface.
Responsible for creating different persistence packages for different operations
A DTO class used to seed a persistence package.
Simple marker interface for persistence perspective members
Service to help gather the correct
EntityManager or PlatformTransactionManager,
based on a class and TargetModeType.Represents a block of work to execute during a call to
AbstractCacheMissAware.getCachedObject(Class, String, String, PersistentRetrieval, String...)
should a missed cache item not be detected.The Form Backing Bean used by the CustomerPhoneController.
Contains the requested value, instance and support classes.
This is injected into the
BasicPersistenceModule and invoked prior to any attempts to actually populate values
from the Entity DTO representation into the Hibernate entity using the FieldPersistenceProvider paradigm.
Marker annotation indicating that the current class is both an
@Configuration class
and should be executed after any Spring Boot EnableAutoConfiguration.
Deferred import loader that, when used in an {@link @Configuration} class, executes _after_ the set
of Spring
EnableAutoConfiguration classes brought in by the .Loads the given set of classes after Spring's
EnableAutoConfiguration.Utility class for working with proxied entities.
Interface that exposes properties useful for determining if an entity is intended for preview only,
as opposed to standard production entities
A Thymeleaf processor that renders a Money object according to the currently set locale options.
Extra logging facility whose design intent is to handle detailed production logging for complex interactions.
Deprecated.
in favor of Spring MVC mechanisms (@see PageHandlerMapping)
Enum that indicates the action to take when processing a URL.
Implementations of this interface are used to hold data for a Product.
The Interface ProductAttribute.
The Class ProductAttributeImpl.
Adds a product breadcrumb using the product on the BroadleafRequestContext.
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Created by bpolster.
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Validates that a ProductBundle cannot have its own Default Sku selected as a Sku Bundle Item
Extension handler for
ProductCustomPersistenceHandlerExtension manager for
ProductCustomPersistenceHandlerProductDao provides persistence access to Product instancesAn implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Product entity
This handler mapping works with the Product entity to determine if a product has been configured for
the passed in URL.
The Class ProductImpl is the default implementation of
Product.Holder for the
ProductionOnlyRequest.CRITERIA constantThis generator generates structured data specific to product pages.
A product option represents a value that is entered to specify more information about
a product prior to entering into the cart.
This class is used to prevent updates to Product Options if "Use in Sku generation" is true but no "Allowed Values"
have been set.
This processor will add the following information to the model, available for consumption by a template:
-pricing for a sku based on the product option values selected
-the complete set of product options and values for a given product
An extendible enumeration of product option types.
An extendible enumeration of product option validation strategy types.
An extendible enumeration of product option validation types.
Stores the values for a given product option.
This field persistence provider manages the default CategoryProductXref reference for a Product instance through
the "defaultCategory" pseudo field.
Extension handler for
ProductParentCategoryFieldPersistenceProviderExtension manager for
ProductParentCategoryFieldPersistenceProviderContainer object for the results of a lightweight query that retrieves the product ids
for a category along with their display order.
Responsible for generating site map entries for Product.
An extendible enumeration of product types.
Marker interface for entity classes whose SITE_DISCRIMINATOR value should be harvested from the
BroadleafRequestContext.currentProfile valueThis class holds adjustment records during the discount calculation
processing.
This class holds adjustment records during the discount calculation
processing.
Modules that extend offer engine behavior can benefit from a wrapped PromotableOrderItemPriceDetail.
Records the usage of this item as qualifier or target of
the promotion.
A Generic DTO object that represents the information to display a
PromotionMessage.A
PromotionMessageGenerator understands how to gather applicable PromotionMessages
for the given Product or OrderItem.An extendible enumeration of promotion message location types.
An extendible enumeration of promotion message types.
Records the usage of this item as qualifier or target of
the promotion.
Wraps the promotion qualifier.
Interface to centralize the promotion rounding functionality found in several of the Promotable classes.
This Thymeleaf variable expression class provides access to runtime configuration properties that are configured
in development.properties, development-shared.properties, etc, for the current environment.
Empty DTO for now that just denotes that this validation error is from a property
Interface for performing validation on a property.
This class is designed to work in both a load-balanced and non load-balanced environment by replacing the existing
default Spring channel processors which do not work in a load balanced environment.
Very similar to the
InsecureChannelProcessor except that instead of relying on only the HttpServletRequest
this also allows
inspection of the X-Forwarded-Proto header to determine if the request is secure.Very similar to the
SecureChannelProcessor except that instead of relying on only the HttpServletRequest this
also allows
inspection of the X-Forwarded-Proto header to determine if the request is secure.Special exception thrown when a problem is encountered while trying to retrieve the original implementation
class for a proxy.
Represents a class containing an MVEL rule and an associated quantity.
Interface for classes annotated with
NamedQueries and NamedNativeQueries.Detects any externally registered
NamedQueries or NamedNativeQueries and adds them to the first detected
entity implementation class for the target persistence unit.Extension handler (generally for DAO usage) that allows contribution to a query (presumably from another module).
Provide a helper component for assigning custom hints during query execution.
Hints available to be leveraged by Broadleaf components for different query result behavior.
Default implementation of
QueryHelper.Helper class for criteria queries.
A Thymeleaf processor that will add the product ratings and reviews to the model
Useful in concert with the enterprise module.
Helper interface for serializing/deserializing the generic
Entity DTO to/from its actual domain object
representation.Saves an instance of OfferAudit for each offer in the passed in order.
Rolls back audits that were saved in the database from
RecordOfferUsageActivity.This is similar to a
ReentrantLock, except that it uses Zookeeper to
share the lock state across multiple nodes, allowing for a distributed lock.The main interface used to store extra-secure data such as credit card, bank accounts and gift card data.
This WorkOnChange implementation is for a narrow case where the work to be done is simply calling a method on a target object
and passing to that method the changed collection.
Validates a field against a configured 'regularExpression' item
Holder to contain cross-thread state during Solr reindexing.
Interface for finding related products.
Extensible enumeration indicating types of product relations such as upsell, crosssell, or featured.
Strip a candidate annotation from candidate classes and their fields.
Strip the cache annotation from classes and the class fields
A Thymeleaf processor that processes the value attribute on the element it's tied to
with a predetermined value based on the SearchFacetResultDTO object that is passed into this
processor.
This class is responsible for determining which OrderItems should be removed from the order, taking into account
the fact that removing an OrderItem should also remove all of its child order items.
Created by bpolster.
Created by bpolster.
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Request entity
This runtime exception will be thrown when an attempt to add to cart without specifying
all required product options has been made.
Makes a field required if the value of another field matches another value.
Created by jfischer
Ensures that every property that is required from
BasicFieldMetadata.getRequired() has a non-empty value being
set.Created by bpolster.
Created by bpolster.
Works with the blc:bundle tag.
This service is responsible for interaction with
ResourceBundleProcessor and
ResourcePreloadProcessor to generate bundles for static resources.Service responsible for interacting with YUI-compressor or Google Closure Compiler to minify JS/CSS resources.
Adds <link> tags to the model that preload resources.
Adds capability to delete old or defunct entities from the persistence layer (e.g.
Service capable of deleting old or defunct entities from the persistence layer (e.g.
Service capable of deleting old or defunct entities from the persistence layer (e.g.
Provides extension points for dealing with requests for resources
Keeps track of the resources needed for <blc:bundle> and <blc:bundlepreload> tags so that the list
of files does not need to be duplicated across both tags.
Holds information about bundles used during the current request.
Builder class that holds attributes relevant to resources, namely those that go on <blc:bundle> and
<blc:bundlepreload> tags.
This is a basic filter for finding the customer ID on the request and setting the customer object on the request.
Responsible for providing a JPA
Predicate instance for query construction based
on several objects that define query construction behavior for the target field.Factory that provide
Restriction instances
based on the type provided (RestrictionType).An extendible enumeration of service status types.
Used in conjunction with
SparselyPopulatedQueryExtensionHandler.This exception is thrown to indicate a problem while trying to rollback
state for any and all activities during a failed workflow.
Implementations are responsible for performing compensating operations to revert the state of the activity to what it
was prior to execution.
Handles the identification of the outermost workflow and the current thread so that the StateManager can
operate on the appropriate RollbackHandlers.
Interface indicating that the exception knows how to return the root cause message.
A component that can apply row-level security to the admin
Provides row-level security to the various CRUD operations in the admin
Extension Listener interface to provide option values for
BroadleafEnumerationType for admin rule builders.Extension Manager used to aggregate option values for all registered
RuleBuilderEnumOptionsExtensionListenerGenerated resource handler for blc-rulebuilder-options.js.
Allows Broadleaf Add-On modules to manipulate the list of rule fields.
Factory class that returns the appropriate RuleBuilderFieldService
given the service name.
Factory class that returns the appropriate RuleBuilderFieldService
given the service name.
Work with dates in rule builder mvel
ResourceResolver for ruleBuilder-options.js.Provide confiration information about arbitrary field data used to drive rule builders in the admin.
Commonality shared between
RuleFieldPersistenceProvider and RuleFieldValidatorProvides persistence (read/write) behavior for rule builder fields.
Special case - Handle propagated state for rules.
For internal usage.
For internal usage.
For internal usage.
Validates that a rule can be parsed out successfully.
Utility class for working with sandboxable entities.
This class is required mostly as a workaround for an issue in Hibernate.
Ensures that the SandBox name is unique within a given site.
The workflow code will not persist an entity if the changes detected are limited to fields whose type is assignable
from this interface, and the persistence is being requested for a production record outside of a production deploy
step.
Created by bpolster.
Designed to specifically handle the merge of schemaLocation references.
This contains a map of objects representing the context dtos for a search.
Container that holds additional criteria to consider when performing searches for Products
A SearchFacet is an object that represents a particular facet that can be used to guide faceted
searching on a results page.
When deleting a
SearchFacet, we want to make sure it is a soft delete.DAO used to interact with the database search facets
Provides methods that facilitate interactions with SearchFacetDTOs and SearchFacetResultDTOs
Resolves which field of an entity should be used for searching when targeting
an entity directly and not a specific field on that entity.
SearchFilterUtil exposes a simple static method for filtering out products that do not match the
criteria POSTed to a controller by a
SearchFilterTag.Deprecated.
Replaced in functionality by
SearchRedirectDeprecated.
Replaced in functionality by
SearchRedirectDaoDeprecated.
Replaced in functionality by
SearchRedirectDaoImplDeprecated.
Replaced in functionality by
SearchRedirectImplCreated by ppatel.
Created by ppatel.
Created by bpolster.
Created by ppatel.
Container that holds the result of a ProductSearch or a SkuSearch
DTO object to represent the components of a Section (a Module has many of these)
Thrown when the admin controller setup detects a section key that is not valid for the system.
Acquisition of Primary Account Number (PAN) and other sensitive information
is retrieved through a service separate from the order.
Sets a request attribute that informs all concerned Broadleaf filters that they should pass the request through and
ignore all normal operation.
Checks the validity of the CSRF token on every POST request.
Form of ServiceException thrown when their is a security
failure while attempting to execute the operation.
CollectionUtils wrapper
to support collection intersection methods needed for rule builder selectize components.The SeoDefaultPropertyService is responsible for providing default values for a Product, Category, or Page's SEO properties.
A
SeoPropertyGenerator understands how to gather a specific set of SEO properties for the given domain objectThe SeoPropertyService is responsible for generating the appropriate properties representing the known metadata about that page.
Detect inconsistencies between the values in the SEQUENCE_GENERATOR and the primary
keys of the managed tables.
This is a modified version of the ServerCookie implementation taken from
the Apache Tomcat source.
Exception thrown when a
service method fails.An extendible enumeration of service status types.
Delegate standard
ServletOutputStream write calls to standard buffered IO.Clear the static entity metadata caches from
DynamicEntityDao
upon recycling of the session factory.Deprecated.
Use
SessionFixationProtectionStrategy insteadDeprecated.
Use
SessionFixationProtectionStrategy insteadA form to model adding a shipping address with shipping options.
Default implementation of
FulfillmentLocationResolver that stores a
single Address.Represents a class containing an MVEL rule
Provides a simple breadcrumb or search, based solely on whether the "q" parameter is present.
Simple factor-based tax module that can be configured by adding rates for
specific postalCodes, city, state, or country.
Created by bpolster.
Control tab layout and grouping for the SiteImpl entity
Used to mark collections for multi-tenancy when the commercial multi-tenant module is loaded.
Represents the columns that get weaved into entities that are marked as site-specific.
Created by bpolster.
Handles creating the various sitemap files.
An enumeration of Sitemap change frequency values
The SiteMapConfiguration is a class that drives the building of the SiteMap.
Sitemap exception
Represents the outcome of a SiteMap generation request.
Responsible for generating site map entries.
Sample URL tag generated and controlled by this configuration.
An extendible enumeration of site map generator types.
Representation the sitemapindex element defined in the schema definition at
http://www.sitemaps.org/schemas/sitemap/0.9.
Reasonsable set of SiteMap URL priorities
Class responsible for generating the SiteMap.xml and related files.
Component responsible for generating a sitemap.
Sample URL entry
http://www.heatclinic.com/hot-sauces
2009-11-07
weekly
0.5
Representation the urlset element defined in the schema definition at
http://www.sitemaps.org/schemas/sitemap/0.9.
Representation of SiteMapURLEntry that can be used to generate an XML element.
Representation the sitemap element defined in the schema definition at
http://www.sitemaps.org/schemas/sitemap/0.9.
An extendible enumeration of order status types.
Most of the methods below return a
Site which is not attached to a Hibernate session (which is what is referred
to as 'non-persistent').
ExtensionHandler for methods within
SiteServiceImplExtension manager that holds the list of
SiteServiceExtensionHandler.Implementations of this interface are used to hold data about a SKU.
Interface indicating that an item contains a getSku method.
Convenient place to store the active date context and the related service on thread local.
Implementations of this interface are used to hold data about a SKU's Attributes.
The Class SkuAttributeImpl is the default implementation of
SkuAttribute.Deprecated.
This is no longer required and is instead implemented as a third-party inventory module
Deprecated.
This is no longer required and is instead implemented as a third-party inventory
module
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Overridden to provide the option values field on the SkuBundleItem list
Deprecated.
instead, use the ProductType Module's Product Add-Ons to build and configure bundles
Allows special behavior to be defined when a sku is updated via the admin.
For internal usage.
SkuDao provides persistence access to Sku instancesUsed to represent Sku-specific surcharges when fulfilling this item.
An implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Sku entity
Persistence provider for populating the display value of all Sku fields to invoke the getter if the entity property
itself is null.
This handler mapping works with the Sku entity to determine if a sku has been configured for
the passed in URL.
The Class SkuImpl is the default implementation of
Sku.This persistence handler handles all
Sku inspects and fetches where the `toOneLookup` custom criteria is on the
persistence package and the lookup is product specific.SkuMediaDao provides persistence access to SkuMediaXref instancesConvenient place to store the pricing considerations context and the pricing service on thread local.
Persistence provider capable of extracting friendly display values for Sku prices, taking currency into consideration.
Join entity between
Sku and ProductOptionValue.Deprecated.
this was originally designed to search for Skus by the default Sku property if it was not set on an additional
sku.
Responsible for generating site map entries for Sku.
An SLF4J implementation of SupportLoggerAdapter that will delegate to the
configured SLF4J logging framework.
Provides a class that will statically hold the Solr server.
Provides utility methods that are used by other Solr service classes
Provides a single cache while exposing a block of code for execution to
SolrIndexService.performCachedOperation(org.broadleafcommerce.core.search.service.solr.SolrIndexCachedOperation.CacheOperation).Basic interface representing a block of work to perform with a single cache instance
Provides some specialized catalog retrieval methods for
SolrIndexService for maximum
efficiency of solr document creation during indexing.Defines the lifecylce of an indexing operation used in
SolrIndexService.Provides a FIFO
Queue to hold a series of commands to be executed in sequence.Service exposing several methods for creating a Solr index based on catalog product data.
Extension handler for indexing operations in Solr.
Manages extension points for SolrSearchService
Responsible for building and rebuilding the Solr index
Responsible for reading and writing the index status to some persistent store (e.g. the file system).
Responsible for reading and writing the status using one or more
SolrIndexStatusProvider
instances.Implementations of this interface do the heavy lifting with respect to executing the provided commands.
This is the entry point for issuing commands to update Solr indexes / collections.
Manages extension points for SolrSearchService
An implementation of SearchService that uses Solr.
Extension handler (generally for DAO usage) that allows contribution to a query (presumably from another module).
A retrieval and caching strategy for translations.
Provides a means for classes that do not normally have access to
a servlet context or application context to be able to obtain
the current Spring ApplicationContext instance.
Bootstraps a Spring Boot application using a ServletContextListener rather than the default of using a ServletContextInitializer.
Capable of logging sql statements
An extendible enumeration of offer types.
Handle page requests for the HTTP status 409 error in the admin.
This service is responsible for monitoring key changes in state for a given session.
This exception is thrown when the system detects a request from a "stale" page.
Represents a member of a query result list for a multitenant sparsely populated cache scenario (see
SparselyPopulatedQueryExtensionHandler).The current state of an entity
Sets a request attribute that informs all Broadleaf Filters that follow NOT to use the HTTP Session.
Created by bpolster.
Created by Jon on 11/2/15.
Created by bpolster.
Created by bpolster.
Created by bpolster.
Created by bpolster.
Created by bpolster.
Extension manager for
BroadleafFileServiceCreated by bpolster.
Created by jerryocanas on 8/28/14.
Extension manager for
StaticAssetServiceImplCreated by bpolster.
Created by IntelliJ IDEA.
Created by IntelliJ IDEA.
Created by jfischer
Created by jfischer
Created by jfischer
Interface that denotes whether or not an entity is archived.
Code is largely copied from StackOverflow post made by David Rabinowitz with contributions
by others in the same thread.
Used by StaticAssets to communicate where the asset is stored.
Utility used for running transactional operations.
Convenience methods for interacting with Java String types
StructuredContent implementations provide a representation of a generic content
item with a set of predefined fields.
Created by bpolster.
Responsible for querying and updating
StructuredContent itemsCreated by bpolster.
By default, this rule processor combines all of the rules from
StructuredContent.getStructuredContentMatchRules()
into a single MVEL expression.Scoped as a prototype bean via bl-cms-applicationContext-entity.
Provides a wrapper class that can be used to alter the priority of a structuredcontentdto.
Holds the values for custom fields that are part of a
StructuredContent item.
XREF entity between a
StructuredContentFieldTemplate and a FieldGroupCreated by bpolster.
A structured content field template holds the structure for a
structured content.
Created by bpolster.
Created by bpolster.
Implementations of this interface contain item rule data that is used for targeting
StructuredContent items.Implementations hold the values for a rule used to determine if a
StructuredContent
item should be displayed.An extendible enumeration of offer rule types.
REQUEST - indicates a rule based on the incoming http request.
TIME - indicates a rule based on
PRODUCT - indicates a rule based on
REQUEST - indicates a rule based on the incoming http request.
TIME - indicates a rule based on
timePRODUCT - indicates a rule based on
product
CUSTOMER - indicates a rule based on org.broadleafcommerce.profile.core.domainProvides services to manage
StructuredContent items.Extension handler for the
StructuredContentServiceA content type corresponds to an area where content should be targeted.
Created by jfischer
Created by bpolster.
SupportLogger class that provides support for the new SUPPORT log level type.
LogManager class that adds support for retrieving a specialized
Logger instance (SupportLogger).
This DAO enables access to manage system properties that can be stored in the database.
This DAO enables access to manage system properties that can be stored in the database.
Registers the
SystemPropertiesService with the Spring Environment.Hook point for our database-backed properties to the Spring Environment
To change this template use File | Settings | File Templates.
Service that retrieves property settings from the database.
This interface represents a System Property (name/value pair) stored in the database.
Validates that a SystemProperty's AttributeName field does not contain a reserved key word surrounded by ".".
Custom persistence handler for SystemProperty to ensure that the value is validated against the type appropriately.
Allows the storage and retrieval of System Properties in the database
Default Implementation of SupportLoggerAdapter that sends all support log messages to the console (
System.out).Validator that ensures that an offer of type
OfferType.ORDER_ITEM has at least one rule for the target criteriaAn extendible enumeration of target mode types.
Utilized within the blPricingWorkflow to calculate tax for an
OrderThe Interface TaxDetail.
Generic service to calculate taxes.
An extensible enumeration of tax detail types
Extension handler (generally for DAO usage) that allows contribution to a query (presumably from another module).
Provides specialized filter and restriction behavior for template-related (MT concept) queries.
Certain objects may have templates that resolve differently based on Broadleaf modules.
Interface used to indicate that an entity contains a path to a preferred display template.
An extendible enumeration of template types
Rule Builder enum options provider for
TemplateTypeConvenience class providing a 10 minute expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.Pass-through activity to test that a workflow with a
ModuleActivity marker interface in it performs correctlyAdd an ErrorHandler that does nothing and does not stop the workflow
Create an activity that simply throws an exception in order to engage the rollback behavior for the workflow
Demonstrate a call to a RollbackHandler
Created by bpolster.
Stores the path to the theme.
Filter that wraps the HttpServletResponse allowing the encodeURL method to be
overwritten in order to append a Theme reference to the URL.
Simple workflow activity to simulate an amount of latency introduced by communicating
with a third party provider (e.g. credit card processing).
Convenience class providing a 30 minute expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.This utility class provides methods that simplify thread operations.
Default
TranslationOverrideStrategy.Created by bpolster.
Created by IntelliJ IDEA.
JCache does not provide direct APIs for Per-Mapping expiry.
Rule Builder enum options provider for
HourOfDayTypeAn implementation of a RuleBuilderFieldService
that constructs metadata necessary
to build the supported fields for a Time entity
Provides an abstraction from the current system time.
A Thymeleaf processor that processes the value attribute on the element it's tied to
with a predetermined value based on the SearchFacetResultDTO object that is passed into this
processor.
The TotalActivity is responsible for calculating and setting totals for a given order.
Specify the attributes of a JOIN that should appear in the TypedQuery.
Specify the attributes of a ORDER BY that should appear in the TypedQuery.
Utilized in conjunction with
TypedQueryBuilder to generate TypedQueries programmatically.POJO for in-progress transaction information.
Allows further customization of
TransactionInfo instances upon transaction begin.Desribes the key transaction lifecycle events being monitored by the system
Custom
SqlStatementLogger that will log sql statements during a transaction with TransactionLifecycleMonitor.Spring event published at key transaction lifecycle points.
Responsible for most of the work related to monitoring and logging transaction state.
An exception whose message can be translated into a message suitable for a user.
An extensible enumeration of entities that have translatable fields.
This domain object represents a translated value for a given property on an entity for a specific locale.
Thread-local cache structure that contains all of the
Translations for a batch of processing.Container for ThreadLocal attributes that relate to Translation.
Custom persistence handler for Translations, it verifies on "add" that the combination of the 4 "key" fields
is not repeated (as in a software-enforced unique index, which is not utilized because of sandboxing and multitenancy concerns).
Provides data access for the
Translation entity.Responsible for setting the necessary attributes on the
TranslationConsiderationContext.The type of action the translation form is built for
Created by gdiaz.
Interceptor for use with portlets that calls the
TranslationRequestProcessor.Provides translations at both the standard site catalog and template catalog level, whichever is appropriate.
This processor is responsible for setting up the translation context.
Provide specialized cache population queries for price lists.
TranslationService functionality, primarily in support of TranslationOverrideStrategy instances.The following processor will modify the declared Credit Card Form
and call the Transparent Redirect Service of the configured payment gateway.
This Tuple class can be used when you want to return two elements from a function in a type safe way.
Convenience class providing a 12 hour expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.Convenience class providing a 24 hour expiry policy, along with the ability to override it on a per entry basis when
using a
TimedValueHolder as the cached value.A class that provides for a typed closure that will return a the specified type value from the specified type
Adds special behavior specific for Typed Entities during any entity persistence flows.
This field persistence provider manages the type field for
TypedEntitys and ensures that they are always
marked as dirty when they change, regardless of PreAdd state.A class that provides for a typed predicat
Utility class to construct typed query-language queries.
A class that provides for a typed transformer.
This processor outputs a SCRIPT tag with JSON data that can be used to update a mostly cached page followed by
a call to a javascript function.
Provides internal extension points for functionality in the
org.broadleafcommerce.core.web.processor.extension.UncacheableDataProcessorChecks for uniqueness of this field's value among other entities of this type
Provides methods to facilitate order repricing.
Author: jerryocanas
Date: 9/26/12
The purpose for this class is to provide an alternate approach to an HQL UPDATE query for batch updates on Hibernate filtered
entities (such as sandboxable and multi-tenant entities).
This is a specific interface for CrossSaleProductImpl and is needed for entity mapping and translations
Validates a field as being a valid URI to ensure compatibility with Broadleaf handlers including
PageHandler, ProductHandler, and CategoryHandlers.
Created by ppatel.
Created by ppatel.
A bean representation of a URLHandler
Responsible for setting up the site and locale used by Broadleaf Commerce components.
Created by bpolster.
Created by bpolster.
Deprecated.
This interface is intended for use by processors that will determine whether a given URL
requires special treatment.
A Thymeleaf processor that processes the given url through the StaticAssetService's
StaticAssetService.convertAssetPath(String, String, boolean) method to determine
the appropriate URL for the asset to be served from.This class creates the following BLC domain object for the Spring Social User Connection.
This class is being un-deprecated because we want the query for the customer to happen through Hibernate instead of
through raw JDBC, which is the case when <sec:jdbc-user-service /> is used.
This activity is responsible for validating and processing several aspects of an order's payment so that
it may successfully complete the checkout workflow.
This will check the availability and quantities (if applicable) all order items in checkout request.
This activity is responsible for providing an extension point for validating a checkout request.
This is an required activity to valiate if required product options are in the order.
Provides a default validate method that uses the validation configuration map to pull out the error key and pre-populate
the
PropertyValidationResult based on ConfigurationItem.ERROR_MESSAGE.Thrown when an entity fails validation when attempting to populate an actual Hibernate entity based on its DTO
representation
Describes simple classes that can be assigned a name and value
Checks the offers being used in the order to make sure that the customer
has not exceeded the max uses for the
Offer.Created by IntelliJ IDEA.
Provide a template class that holds interfaces, fields and methods to be optionally, dynamically introduced
into OfferImpl at runtime.
An extendible enumeration of units of measure types.
Encapsulate some amount of work to perform whenever a change aware collection is modified.
Utility interface for items that wrap an internal, delegate item
Wrapper classes implementing this interface expose their additionalFields, and they can
make use of the utility methods in BaseWrapper to transfer said fields between the wrapper and
the corresponding domain object
CSS minification service implemented using the YUICompressor library
Represents a
Queue that is distributed (used by multiple JVMs or nodes) and managed by Zookeeper.Simple utility to assist in basic operations related to Zookeeper.
AdminSecurityFilterinstead