Deprecated List (BroadleafCommerce Common Libraries 6.2.9-GA API)

Deprecated Interfaces
Interface and Description
org.broadleafcommerce.common.email.service.EmailService in favor of `NotificationDispatcher`
org.broadleafcommerce.common.persistence.EntityDuplicateModifier Implement `EntityDuplicationHelper` instead
org.broadleafcommerce.common.security.MergeCartProcessor this has been replaced by invoking the merge cart service explicitly within the cart state request processor

Deprecated Classes
Class and Description
org.broadleafcommerce.common.extensibility.jpa.copy.AnnotationsCopyClassTransformer do not use this class, use `DirectCopyClassTransformer` instead
org.broadleafcommerce.common.util.BLCAnnotationUtils use Spring's `AnnotationUtils` instead.
org.broadleafcommerce.common.util.BLCSystemProperty this class should not be used to statically obtain referenes to properties. Instead, you should either inject an instead of the `SystemPropertiesService` directly _or_ inject an `Environment` to get properties that way, since `SystemPropertiesPropertySourceRegistrar` adds a `SystemPropertiesService` `PropertySource`
org.broadleafcommerce.common.util.BLResourceBundleMessageSource use `BroadleafMergeResourceBundleMessageSource` instead
org.broadleafcommerce.common.dialect.Broadleaf2CompatibilityMySQL5InnoDBDialect use org.hibernate.dialect.MySQL5InnoDBDialect instead
org.broadleafcommerce.common.security.ldap.BroadleafActiveDirectoryUserDetailsMapper NO LONGER REQUIRED AND SHOULD NOT BE USED. SEE BroadleafAdminLdapUserDetailsMapper.
org.broadleafcommerce.common.web.processor.ConfigVariableProcessor use `PropertiesVariableExpression` instead
org.broadleafcommerce.common.security.handler.CsrfFilter Use `SecurityFilter` instead
org.broadleafcommerce.common.web.processor.DataDrivenEnumerationProcessor use `DataDrivenEnumVariableExpression` instead
org.broadleafcommerce.common.email.service.EmailServiceImpl
org.broadleafcommerce.common.extensibility.InstrumentationRuntimeFactory Because of classloader differences, this approach is not reliable for some containers. Use the javaagent jvm argument instead to set instrumentation.
org.broadleafcommerce.common.logging.Log4jManagementBean in favor of `Log4j2ManagementBean` (following Apache's EOL declaration for log4j 1.x)
org.broadleafcommerce.common.sitemap.domain.weave.OptionalEnterpriseSiteMapConfigurationSiteMapGeneratorConfigurationTemplate
org.broadleafcommerce.common.util.ResourceBundleExtensionPoint instead, use `BroadleafMergeResourceBundleMessageSource`

Deprecated Fields
Field and Description
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentation.GROUPCOLLAPSED
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentation.GROUPORDER
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentationAdornedTargetCollection.TAB
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentationCollection.TAB
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentationMap.TAB
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentation.TABORDER
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentationAdornedTargetCollection.TABORDER
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentationCollection.TABORDER
org.broadleafcommerce.common.presentation.override.PropertyType.AdminPresentationMap.TABORDER

Deprecated Methods
Method and Description
org.broadleafcommerce.common.web.processor.ResourceBundleProcessor.addDependentBundleRestrictionToModel(String, boolean, boolean, String, BroadleafTemplateContext, BroadleafTemplateModel) Use `ResourceBundleProcessor.addDependencyRestrictionToModel(List, ResourceTagAttributes, BroadleafTemplateContext, BroadleafTemplateModel)` instead
org.broadleafcommerce.common.web.processor.ResourceBundleProcessor.addElementToModel(String, boolean, boolean, BroadleafTemplateContext, BroadleafTemplateModel) Use `ResourceBundleProcessor.addElementToModel(ResourceTagAttributes, BroadleafTemplateContext, BroadleafTemplateModel)` instead
org.broadleafcommerce.common.web.processor.ResourceBundleProcessor.addElementToModel(String, boolean, boolean, String, BroadleafTemplateContext, BroadleafTemplateModel) Use `ResourceBundleProcessor.addElementToModel(ResourceTagAttributes, BroadleafTemplateContext, BroadleafTemplateModel)` instead
org.broadleafcommerce.common.file.service.BroadleafFileUtils.addLeadingSlash(String) this is now just a pass-through to `#addLeadingUnixSlash(String, String)`. The original method was a misnomer.
org.broadleafcommerce.common.file.service.BroadleafFileService.addOrUpdateResource(FileWorkArea, File, boolean) use `BroadleafFileService.addOrUpdateResourceForPath(FileWorkArea, File, boolean)`
org.broadleafcommerce.common.file.service.BroadleafFileService.addOrUpdateResources(FileWorkArea, boolean) use `BroadleafFileService.addOrUpdateResourcesForPaths(FileWorkArea, boolean)` instead
org.broadleafcommerce.common.file.service.FileServiceProvider.addOrUpdateResources(FileWorkArea, List<File>, boolean) use `FileServiceProvider.addOrUpdateResourcesForPaths(FileWorkArea, List, boolean)`
org.broadleafcommerce.common.file.service.BroadleafFileService.addOrUpdateResources(FileWorkArea, List<File>, boolean) use `BroadleafFileService.addOrUpdateResourcesForPaths(FileWorkArea, List, boolean)` instead
org.broadleafcommerce.common.file.service.FileSystemFileServiceProvider.addOrUpdateResources(FileWorkArea, List<File>, boolean)
org.broadleafcommerce.common.extensibility.cache.JCacheConfigurationBuilder.buildConfiguration(int, int, Class<K>, Class<V>) use `JCacheConfigurationBuilder.buildConfiguration(JCacheRegionConfiguration)` as this will be removed in the future
org.broadleafcommerce.common.file.service.BroadleafFileUtils.buildFilePath(String, String) this is now just a pass-through to `BroadleafFileUtils.appendUnixPaths(String, String)`. The original method was a misnomer.
org.broadleafcommerce.common.persistence.EntityDuplicator.copy(Class<T>, Long, Map<String, String>, EntityDuplicateModifier...) use `EntityDuplicator.copy(Class, Long)`. Modifiers have been moved to a list bean to allow easier inclusion (see `EntityDuplicationHelpers`) and copy hints can be added to implementations of `EntityDuplicationHelper`s
org.broadleafcommerce.common.persistence.EntityDuplicatorImpl.copy(Class<T>, Long, Map<String, String>, EntityDuplicateModifier...)
org.broadleafcommerce.common.persistence.EntityDuplicator.copy(MultiTenantCopyContext, MultiTenantCloneable<T>, Map<String, String>, EntityDuplicateModifier...) use `EntityDuplicator.copy(MultiTenantCopyContext, MultiTenantCloneable)`. Modifiers have been moved to a list bean to allow easier inclusion (see `EntityDuplicationHelpers`) and copy hints can be added to implementations of `EntityDuplicationHelper`s
org.broadleafcommerce.common.persistence.EntityDuplicatorImpl.copy(MultiTenantCopyContext, MultiTenantCloneable<T>, Map<String, String>, EntityDuplicateModifier...)
org.broadleafcommerce.common.util.UpdateExecutor.executeUpdateQuery(EntityManager, String, Object[], Type[], List<Long>) Highly recommended not to use this method. This method results in global L2 cache region clearing. Use `UpdateExecutor.executeUpdateQuery(EntityManager, String, String, Object[], Type[], List)` instead.
org.broadleafcommerce.common.extension.TemplateOnlyQueryExtensionHandler.filterResults(Class<?>, Object, List) It's difficult to determine this efficiently at runtime. The current implementation will no longer check the use case described above.
org.broadleafcommerce.common.site.service.SiteServiceImpl.findAllActiveSites()
org.broadleafcommerce.common.site.service.SiteService.findAllActiveSites() use `SiteService.findAllNonPersistentActiveSites()` instead
org.broadleafcommerce.common.web.controller.FrameworkMvcUriComponentsBuilder.fromMethod(Method, Object...) as of 4.2, this is deprecated in favor of the overloaded method that also accepts a controllerType argument
org.broadleafcommerce.common.util.BLCAnnotationUtils.getAnnotationFromClassOrInterface(Class<A>, Class) use SPring's `AnnotationUtils` instead
org.broadleafcommerce.common.site.domain.Site.getCatalogs() Not used by Broadleaf - scheduled to remove on or after 3.3
org.broadleafcommerce.common.extensibility.context.merge.AbstractMergeBeanPostProcessor.getCollectionRef() use `AbstractMergeBeanPostProcessor.getSourceRef()` instead
org.broadleafcommerce.common.web.processor.ResourceBundleProcessor.getLinkAttributes(String) Use `ResourceBundleProcessor.getNormalCssAttributes(ResourceTagAttributes)` instead
org.broadleafcommerce.common.enumeration.domain.DataDrivenEnumeration.getOrderItems() use `DataDrivenEnumeration.getEnumValues()` instead
org.broadleafcommerce.common.enumeration.domain.DataDrivenEnumerationImpl.getOrderItems()
org.broadleafcommerce.common.web.processor.ResourceBundleProcessor.getScriptAttributes(String, boolean, boolean) Use `ResourceBundleProcessor.getScriptAttributes(ResourceTagAttributes)` instead
org.broadleafcommerce.common.web.BroadleafRequestContext.getSite() this has been changed to `BroadleafRequestContext.getNonPersistentSite()` to explicitly indicate that the site being returned is not attached to a Hibernate session
org.broadleafcommerce.common.site.domain.Site.getSiteIdentifierType() use `Site.getSiteResolutionType()` Intended to be used along with the #getSiteIdentifierValue() by the SiteResolver to determine if this is the current site.
org.broadleafcommerce.common.site.domain.Catalog.getSites()
org.broadleafcommerce.common.site.domain.Site.isTemplateSite() Not used by Broadleaf - scheduled to remove on or after 3.3
org.broadleafcommerce.common.persistence.EntityDuplicatorImpl.performCopy(MultiTenantCopyContext, MultiTenantCloneable<T>, Map<String, String>, EntityDuplicateModifier...)
org.broadleafcommerce.common.file.service.BroadleafFileUtils.removeLeadingSlash(String) this is now just a pass-through to `#removeLeadingUnixSlash(String, String)`. The original method was a misnomer.
org.broadleafcommerce.common.web.BroadleafCurrencyResolver.resolveCurrency(HttpServletRequest) use `BroadleafCurrencyResolver.resolveCurrency(WebRequest)` instead
org.broadleafcommerce.common.web.BroadleafLocaleResolver.resolveLocale(HttpServletRequest) Use `BroadleafLocaleResolver.resolveLocale(WebRequest)` instead
org.broadleafcommerce.common.web.BroadleafSandBoxResolver.resolveSandBox(HttpServletRequest, Site) use `BroadleafSandBoxResolver.resolveSandBox(WebRequest, Site)` instead
org.broadleafcommerce.common.web.BroadleafSiteResolver.resolveSite(HttpServletRequest) Use `BroadleafSiteResolver.resolveSite(WebRequest)` instead
org.broadleafcommerce.common.web.BroadleafThemeResolver.resolveTheme(HttpServletRequest, Site) Use `BroadleafThemeResolver.resolveTheme(WebRequest)` instead
org.broadleafcommerce.common.sandbox.dao.SandBoxDaoImpl.retrieveAllUserSandBoxes(Long)
org.broadleafcommerce.common.sandbox.dao.SandBoxDao.retrieveAllUserSandBoxes(Long) Not used in BLC. In a Multi-site context, may return results outside of a given tenant. Reads all SandBoxes that are of type `SandBoxType.USER` and belong to the given user.
org.broadleafcommerce.common.sandbox.service.SandBoxServiceImpl.retrieveAllUserSandBoxes(Long)
org.broadleafcommerce.common.sandbox.service.SandBoxService.retrieveAllUserSandBoxes(Long) Not used in BLC. May return incorrect results in MT installations. Reads all SandBoxes that are of type `SandBoxType.USER` and belong to the given user.
org.broadleafcommerce.common.site.service.SiteServiceImpl.retrieveDefaultSite()
org.broadleafcommerce.common.site.service.SiteService.retrieveDefaultSite() use `SiteService.retrieveNonPersistentDefaultSite()` instead
org.broadleafcommerce.common.site.service.SiteServiceImpl.retrieveSiteByDomainName(String)
org.broadleafcommerce.common.site.service.SiteService.retrieveSiteByDomainName(String) use `SiteService.retrieveNonPersistentSiteByDomainName(String)` instead
org.broadleafcommerce.common.site.service.SiteServiceImpl.retrieveSiteById(Long)
org.broadleafcommerce.common.site.service.SiteService.retrieveSiteById(Long) use `SiteService.retrieveNonPersistentSiteById(Long)` instead
org.broadleafcommerce.common.site.service.SiteServiceImpl.save(Site)
org.broadleafcommerce.common.site.service.SiteService.save(Site) use `SiteService.saveAndReturnNonPersisted(Site)` instead
org.broadleafcommerce.common.site.domain.Site.setCatalogs(List<Catalog>) Not used by Broadleaf - scheduled to remove on or after 3.3
org.broadleafcommerce.common.extensibility.context.merge.AbstractMergeBeanPostProcessor.setCollectionRef(String) use `AbstractMergeBeanPostProcessor.setSourceRef(String)` instead
org.broadleafcommerce.common.enumeration.domain.DataDrivenEnumeration.setOrderItems(List<DataDrivenEnumerationValue>) use `#setEnumValues()` instead
org.broadleafcommerce.common.enumeration.domain.DataDrivenEnumerationImpl.setOrderItems(List<DataDrivenEnumerationValue>)
org.broadleafcommerce.common.web.BroadleafRequestContext.setSite(Site) this has been changed to `#setNonPersistentSite()` to explicitly indicate that the site being set is not attached to an active Hibernate session
org.broadleafcommerce.common.site.domain.Site.setSiteIdentifierType(String) Use `Site.setSiteResolutionType(SiteResolutionType)` Sets the site identifier type.
org.broadleafcommerce.common.site.domain.Catalog.setSites(List<Site>)

Deprecated Constructors
Constructor and Description
org.broadleafcommerce.common.web.controller.FrameworkMvcUriComponentsBuilder.MethodArgumentBuilder(Method) as of 4.2, this is deprecated in favor of alternative constructors that accept a controllerType argument

Deprecated Annotation Type Elements
Annotation Type Element and Description
org.broadleafcommerce.common.presentation.AdminPresentation.groupCollapsed not supported
org.broadleafcommerce.common.presentation.AdminPresentation.securityLevel not supported
org.broadleafcommerce.common.presentation.AdminPresentationCollection.tab
org.broadleafcommerce.common.presentation.AdminPresentationAdornedTargetCollection.tab
org.broadleafcommerce.common.presentation.AdminPresentationMap.tab
org.broadleafcommerce.common.presentation.AdminPresentationCollection.tabOrder
org.broadleafcommerce.common.presentation.AdminPresentationAdornedTargetCollection.tabOrder
org.broadleafcommerce.common.presentation.AdminPresentationMap.tabOrder

Deprecated API

Contents