All Classes and Interfaces
Class
Description
Abstract implementatino of
AdminAbstractControllerExtensionHandler.Abstract implementation of
AdminBasicOperationsControllerExtensionHandler.Abstract implementation of
AdminNavigationServiceExtensionHandler.Abstract implementation of
AdminSectionCustomCriteriaExtensionHandler.Convenience implementation of interface so that subclasses do not have to implement uninteresting methods
Abstract class to provide convenience for determining how to handle form
extensions in the admin
Abstract persistence provider that provides a method to actually handle formatting moneys.
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.
Contains the requested field, metadata and support classes.
Contains the
Entity instance and unfiltered property list.Contains the requested field, property name and support classes.
Contains the requested Hibernate type, metadata and support classes.
Contains the metadata and support classes.
Contains the requested ctoConverter, cto and support classes.
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 ColeThe 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
AdminAbstractControllerExtensionHandlerA 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
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.
Extension handler for methods present in
AdminNavigationService.Manager for the
AdminNavigationServiceExtensionHandlerThis service is used to build the left hand navigation for the admin
Created by IntelliJ IDEA.
Created by IntelliJ IDEA.
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.
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 RequestMappingHandlerAdapterExtension handler for methods present in
AdminBasicEntityController.Manager for the
AdornedTargetAutoPopulateExtensionHandlerA basic entity persistence validation hook into validation provided by instances of
AdornedTargetAutoPopulateExtensionHandlerChecks to make sure that the end date being updated is after the start date
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.
This filter is based conceptually on the auto-levels feature of Photoshop and functions in the same way.
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.
Implementation of the
EntityValidatorService that runs entities through JSR-303 validations.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
A Spring bean extending this class will automatically be called when validation is done on the entity specified by
the generic type.
The CRUD type requested by the admin
Convenience 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.
An extensible enumeration for a Security Context Type.
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
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.Utility class to convert a DataDTO/ExpressionDTO into an MVEL string
Default implementation used by the core framework.
Default implementation for the core framework.
Default pass-through implementation of
FetchWrapperConvenience class to deal with the common actions on most list grids.
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.Generic DTO for a domain object.
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.Classes implementing this interface are capable of manipulating metadata from the inspection
phase for the admin.
Created by Jon on 6/24/15.
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.Contains the requested value, property and support classes.
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.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.
Extension manager for
FilterProductTypePersistenceHandlerExtensionHandlerCreated by IntelliJ IDEA.
Created by bpolster.
Extension handler for various methods from
FormBuilderServiceAnalagous to
PropertyValidator except this does not attempt to use any ValidationConfiguration from an
AdminPresentation annotation.DTO representing a boolean whether or not it passed validation and String error message.
Created by IntelliJ IDEA.
A bean designed to hold general information about an image
Contains the requested field, metadata and support classes.
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.
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.
For internal usage.
For internal usage.
Generated resource resolver for Admin Javascript Messages
For
FieldMetadataProvider and
FieldPersistenceProvider, message
the system on how it should interpret the provider's handling of the call.An extendible enumeration of modal header types.
Persistence provider capable of extracting friendly display values for Money fields
Utility class to convert an MVEL string into a DataWrapper object
which can then be serialized on your view.
Property editor for Booleans that will set the boolean to false if it came in as a null
This predicate provider is very similar to the
EqPredicateProvider, except that it will treat
nulls equal to false.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.
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.
Contains the requested entity, metadata and support classes.
Contains the requested config key, ceiling entity, metadata and support classes.
Created by IntelliJ IDEA.
Specific class of PersistenceException used in FieldPersistenceProviders that attempt to perform their own persistence
operations in addition to the normal entity field population duties.
Adds a new 'passwordConfirm' field to the metadata as well as ensures that the field type for the password field is
actually a password
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
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.Empty DTO for now that just denotes that this validation error is from a property
Interface for performing validation on a property.
Useful in concert with the enterprise module.
Helper interface for serializing/deserializing the generic
Entity DTO to/from its actual domain object
representation.Validates a field against a configured 'regularExpression' item
Makes a field required if the value of another field matches another value.
Ensures that every property that is required from
BasicFieldMetadata.getRequired() has a non-empty value being
set.Created by bpolster.
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.
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.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.
Ensures that the SandBox name is unique within a given site.
Resolves which field of an entity should be used for searching when targeting
an entity directly and not a specific field on that entity.
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.
Clear the static entity metadata caches from
DynamicEntityDao
upon recycling of the session factory.Handle page requests for the HTTP status 409 error in the admin.
The current state of an entity
Custom persistence handler for SystemProperty to ensure that the value is validated against the type appropriately.
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).
The type of action the translation form is built for
Created by gdiaz.
Checks for uniqueness of this field's value among other entities of this type
Validates a field as being a valid URI to ensure compatibility with Broadleaf handlers including
PageHandler, ProductHandler, and CategoryHandlers.
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
AdminSecurityFilterinstead