Adjust for Removed Deprecations
Update your implementation to address removed deprecations when upgrading from brXM 16.x to 17.y.
Removed Jackrabbit RMI References
Bloomreach Content 17 uses Jackrabbit 2.22.2, which no longer includes RMI support. For more information, see JCR-4972.
If your project connects to the repository using RMI, migrate to a supported connection method before upgrading.
Removed RGB Autoconversion Option
Prior to version 16.7, images uploaded with CMYK or YCCK color models were automatically converted to RGB. Starting with 16.7, this conversion was disabled due to image quality issues. In 17.0, the configuration option to re-enable the previous behavior has been removed.
The following items have been removed:
- Configuration node:
/hippo:configuration/hippo:frontend/cms/cms-services/galleryProcessorService/convertToRGB - Method:
org.hippoecm.frontend.plugins.gallery.imageutil.ImageUtils#convertToRGB
Additionally, org.hippoecm.frontend.plugins.gallery.imageutil.ImageBinary now provides only a single constructor.
If your project references the convertToRGB configuration or calls ImageUtils#convertToRGB, remove these references before upgrading.
HippoWorkflowEvent — Removed Deprecated Event Keys
Code that listens to the event bus and accesses workflow events by key name will now receive null for removed keys. Three deprecated event property keys and their associated getter/setter methods have been removed from the underlying HippoEvent map.
| Removed method | Removed JCR log key | Use instead |
|---|---|---|
| methodName() / methodName(String) | "methodName" | action() / action(String) |
| handleUuid() / handleUuid(String) | "handleUuid" | subjectId() / subjectId(String) |
| documentPath() / documentPath(String) | "documentPath" | subjectPath() / subjectPath(String) |
Impact on persisted event data:
WorkflowLogger no longer writes the methodName, handleUuid, or documentPath keys to JCR workflow log nodes under /hippo:log. Update any queries (such as Groovy scripts or custom dashboards) that reference these properties to use action, subjectId, or subjectPath instead.
List of Removed Deprecated Classes and Methods
The following deprecated classes and methods have been removed.
Community Module
CMS (community/cms)
org.hippoecm.addon.workflow.AbstractWorkflowDialog— deprecated since 13.1; useorg.hippoecm.addon.workflow.WorkflowDialogorg.hippoecm.frontend.editor.plugins.resource.ImageInfo— deprecated since 14.7.0; no replacementorg.hippoecm.frontend.plugins.standards.browse.BreadcrumbPlugin— deprecated since 10.0.x; useorg.hippoecm.frontend.widgets.breadcrumb.NodeBreadcrumbWidget(included by default inLinkPickerDialogandAbstractBrowserDialog)org.hippoecm.frontend.plugins.standards.list.resolvers.CssClass— deprecated; useorg.hippoecm.frontend.attributes.ClassAttributeorg.hippoecm.frontend.editor.plugins.linkpicker.FacetSelectTemplatePlugin— deprecated; no replacementorg.hippoecm.frontend.plugins.login.BrowserCheckBehavior— deprecated since 15.2.3; server-side browser detection is no longer supportedorg.hippoecm.frontend.plugins.cms.browse.model.BrowserSectionsModel— deprecated; no replacementorg.hippoecm.frontend.plugins.reviewedactions.dialogs.DatePickerComponent— deprecated since 16.3.0; useorg.hippoecm.frontend.component.DatePickerComponentorg.hippoecm.addon.workflow.StdWorkflowconstructors withStringorStringResourceModelarguments — use constructors with explicitWorkflowDescriptorModelargumentorg.hippoecm.frontend.validation.SvgValidator— deprecated since 16.7; usecom.bloomreach.cms.services.mediavalidation.svg.SvgValidationServiceorg.hippoecm.frontend.validation.SvgValidationResult— deprecated since 16.7; usecom.bloomreach.cms.services.mediavalidation.svg.SvgValidationResultorg.hippoecm.frontend.plugins.gallery.imageutil.ScalingParametersconstructors — useScalingParameters.Builderorg.hippoecm.frontend.plugins.gallery.imageutil.ScalingParameters#getUpscaling()— useisUpscaling()org.hippoecm.frontend.plugins.gallery.imageutil.ScalingParameters#getCompressionQuality()— usegetLossyCompressionQuality()org.hippoecm.frontend.plugins.gallery.imageutil.ScaleImageOperationconstructors — useScalingParameters.Builderorg.hippoecm.frontend.plugins.gallery.imageutil.AbstractScaleImageOperation#getCompressionQuality()— useScalingParameters#getLossyCompressionQuality()org.hippoecm.frontend.plugins.gallery.imageutil.AbstractScaleImageOperation#getScaledData()— useImageOperationResult#getData()org.hippoecm.frontend.plugins.gallery.imageutil.AbstractScaleImageOperation#getScaledWidth()— useImageOperationResult#getWidth()org.hippoecm.frontend.plugins.gallery.imageutil.AbstractScaleImageOperation#getScaledHeight()— useImageOperationResult#getHeight()org.hippoecm.frontend.plugins.gallery.imageutil.AbstractScaleImageOperation#calculateResizeRatio(double, double, int, int)— useImageUtils#determineResizeRatio(double, double, int, int)org.hippoecm.frontend.plugins.gallery.imageutil.ImageUtils#writeImage(ImageWriter, BufferedImage)— usewriteImage(ImageWriter, BufferedImage, float, float)org.hippoecm.frontend.plugins.gallery.imageutil.ImageUtils#writeImage(ImageWriter, BufferedImage, float compressionQuality)— deprecated since 16.7.0; usewriteImage(ImageWriter, BufferedImage, float, float)org.hippoecm.frontend.plugins.gallery.imageutil.ImageUtils#scaleImage(BufferedImage, Rectangle, Dimension, Object hint, boolean)— usecropImage()andscaleImage(BufferedImage, int, int, ScalingStrategy)org.hippoecm.frontend.plugins.gallery.imageutil.ImageUtils#scaleImage(BufferedImage, int xOff, int yOff, int srcW, int srcH, int tgtW, int tgtH, Object hint, boolean)— usecropImage()andscaleImage(BufferedImage, int, int, ScalingStrategy)org.hippoecm.frontend.plugins.gallery.model.GalleryProcessor#isUpscalingEnabled(Node)— useScalingParameters#isUpscaling()org.hippoecm.frontend.plugins.gallery.model.GalleryProcessor#getScalingParametersMap()— usegetScalingParameters(Node)org.hippoecm.frontend.plugins.jquery.upload.AbstractFileUploadWidget(String id, IPluginConfig, FileUploadValidationService)— use the constructor withFileUploadPreProcessorServiceorg.hippoecm.frontend.plugins.jquery.upload.single.SingleFileUploadWidget(String, IPluginConfig, FileUploadValidationService, boolean)— deprecated since 16.7; use the constructor withFileUploadPreProcessorServiceorg.hippoecm.frontend.plugins.standards.DocumentListFilter(DocumentListFilter parent, String state)— deprecated since 15.7.1; useDocumentListFilter(IPluginConfig)org.hippoecm.frontend.plugins.standards.DocumentListFilter#filter(Node current, NodeIterator)— deprecated since 15.7.1; usefilter(NodeIterator)org.hippoecm.frontend.model.PropertyValueProvider.EMPTY_DATE_VALUE— useorg.onehippo.repository.util.DateConstants.EMPTY_DATE_VALUEorg.hippoecm.frontend.model.PropertyValueProvider.EMPTY_DATE— useorg.onehippo.repository.util.DateConstants.EMPTY_DATE
CRISP Addon (community/crisp)
org.onehippo.cms7.crisp.core.resource.DefaultValueMap— deprecated; useorg.onehippo.cms7.crisp.api.resource.DefaultValueMaporg.onehippo.cms7.crisp.api.exchange.ExchangeHint#getRequest()— usegetRequestHeaders()andgetRequestBody()org.onehippo.cms7.crisp.api.exchange.ExchangeHintBuilder#request(Object)/#request()— userequestBody(Object)/requestHeaders(Map)org.onehippo.cms7.crisp.hst.module.CrispHstServices.getModuleComponent(String name)— usegetModuleComponent(HstServices.getComponentManager(), name)org.onehippo.cms7.crisp.hst.module.CrispHstServices.getDefaultResourceServiceBroker()— usegetDefaultResourceServiceBroker(HstServices.getComponentManager())org.onehippo.cms7.crisp.core.resource.FileBinary— deprecated; useSpringResourceBinary, for example:new SpringResourceBinary(new FileSystemResource(file), true)
Essentials Components (community/essentials-components)
org.onehippo.cms7.essentials.components.utils.query.HstQueryBuilder— deprecated since 3.1.1; useorg.hippoecm.hst.content.beans.query.builder.HstQueryBuilderorg.onehippo.cms7.essentials.components.utils.query.QueryBuilder— deprecated since 3.1.1; useorg.hippoecm.hst.content.beans.query.builder.HstQueryBuilderorg.onehippo.cms7.essentials.components.utils.ComponentsUtils#getPublicRequestParameters(BaseHstComponent, HstRequest, String)— useBaseHstComponent#getPublicRequestParameters(HstRequest, String)org.onehippo.cms7.essentials.components.EssentialsCarouselComponent#getCarouselItems(EssentialsCarouselComponentInfo)— usegetCarouselItems(List)
Repository (community/repository)
org.hippoecm.repository.Log4j1LoggerLevelManager— deprecated; Log4j 1.x is no longer supported, use Log4j 2org.onehippo.repository.events.HippoWorkflowEvent#methodName()/#methodName(String)— useaction()/action(String)org.onehippo.repository.events.HippoWorkflowEvent#handleUuid()/#handleUuid(String)— usesubjectId()/subjectId(String)org.onehippo.repository.events.HippoWorkflowEvent#documentPath()/#documentPath(String)— usesubjectPath()/subjectPath(String)org.hippoecm.repository.util.DateTools#getSupportedDateResolutions()— usegetSupportedResolutions()org.onehippo.repository.scheduling.RepositoryJobExecutionContext#getSession(Credentials)— usecreateSession(Credentials)org.onehippo.repository.scheduling.RepositoryJobExecutionContext#getSystemSession()— usecreateSystemSession()org.hippoecm.repository.standardworkflow.FolderWorkflow#list()— usehints().get("prototypes")org.onehippo.repository.documentworkflow.DocumentWorkflow#requestPublication(Date publicationDate, Date depublicationDate)— userequestPublicationDepublication(Date, Date)org.hippoecm.repository.PasswordHelper#getHashingAlogrithm()— typo variant; usegetHashingAlgorithm()org.hippoecm.repository.PasswordHelper#setHashingAlogrithm(String)— typo variant; usesetHashingAlgorithm(String)org.hippoecm.repository.gallery.GalleryWorkflow#createGalleryItem(String, String)— deprecated since 5.0 (CMS 12.0); usecreateGalleryItem(String, String, String)org.hippoecm.repository.gallery.impl.GalleryWorkflowImpl(Session, Session, Node)— deprecated since 16.9.0; useGalleryWorkflowImpl(WorkflowContext, Session, Session, Node)org.onehippo.repository.mock.MockNode#addMockNode(String, String)— useaddNode(String, String)org.onehippo.repository.mock.MockPropertyDefinition(String, boolean)— useMockPropertyDefinition(String, int, boolean)org.hippoecm.repository.query.lucene.ServicingIndexingConfiguration#getSkipIndexName()— deprecated since 13.0.0; feature removed, no replacementorg.hippoecm.repository.query.lucene.StandardHippoAnalyzer.CJK_STOP_WORDS— deprecated since 5.0 (CMS 12.0); locale-specific stop words are no longer provided in the public APIorg.hippoecm.repository.query.lucene.StandardHippoAnalyzer.SPANISH_STOP_WORDS— deprecated since 5.0 (CMS 12.0); locale-specific stop words are no longer provided in the public API
Search Service (community/search-service)
org.onehippo.cms7.services.search.query.constraint.SubQueryConstraint— deprecated since 16.5.0; useAppendQueryConstraintorPrependQueryConstraintorg.onehippo.cms7.services.search.query.Query#returnSubquery(String subqueryFilter)— deprecated since 16.5.0; usereturnPrependQuery(String)orreturnAppendQuery(String)
Selections Addon (community/selections)
org.onehippo.forge.selection.frontend.provider.IValueListProvider#getValueList(IPluginConfig)— usegetValueList(String, Locale)org.onehippo.forge.selection.frontend.provider.IValueListProvider#getValueList(String name)— usegetValueList(String, Locale)
Services API (community/services-api)
org.onehippo.cms7.services.googleanalytics.GoogleAnalyticsService— deprecated; Google Universal Analytics is decommissioned, migrate to GA4org.onehippo.cms7.services.HippoServiceRegistry.registerService(T, Class<T>)— deprecated since v13.0; useregister(T, Class<T>)org.onehippo.cms7.services.HippoServiceRegistry.unregisterService(T, Class<T>)— deprecated since v13.0; useunregister(T, Class<T>)org.onehippo.cms7.services.project.Project#getLastModificationDate()/#setLastModificationDate(long)— usegetLastModifiedAt()org.onehippo.cms7.services.project.Project#getStartRunningAt()/#setStartRunningAt(Long)— usegetStartRunningFrom()/setStartRunningFrom(Calendar)org.onehippo.cms7.services.project.Project#getStopRunningAt()/#setStopRunningAt(Long)— usegetStopRunningAfter()/setStopRunningAfter(Calendar)
HST API (community/site-toolkit)
org.hippoecm.hst.core.jcr.RuntimeRepositoryException— deprecated; useorg.hippoecm.repository.api.RuntimeRepositoryExceptionorg.hippoecm.hst.environment.EnvironmentParameters— deprecated since 13.3.0; no replacementorg.hippoecm.hst.platform.configuration.environment.EnvironmentUtils— deprecated since 13.3.0; no replacementorg.hippoecm.hst.platform.configuration.environment.HostConfigListener— deprecated since 13.3.0; no replacementorg.hippoecm.hst.platform.configuration.environment.HostConfigPublisher— deprecated since 13.3.0; no replacementorg.hippoecm.hst.platform.configuration.environment.OptionalEnvironmentEventListenerItemImpl— deprecated since 13.3.0; no replacementorg.hippoecm.hst.core.sitemapitemhandler.HstSiteMapItemHandler#destroy()— deprecated since 13.0.0; not invoked, no replacementorg.hippoecm.hst.core.sitemapitemhandler.AbstractHstSiteMapItemHandler#destroy()— deprecated since 13.0.0; not invoked, no replacementorg.hippoecm.hst.core.jcr.SessionSecurityDelegation#getOrCreateLiveSecurityDelegate(Credentials, String key)— deprecated since 13.0.1; usecreateLiveSecurityDelegate(Credentials, boolean)org.hippoecm.hst.core.jcr.SessionSecurityDelegation#getOrCreatePreviewSecurityDelegate(Credentials, String key)— deprecated since 13.0.1; usecreatePreviewSecurityDelegate(Credentials, boolean)org.hippoecm.hst.pagecomposer.jaxrs.api.PageCopyEvent#getPageCopyContext()— usegetPageActionContext()org.hippoecm.hst.core.channelmanager.ChannelManagerConstants.HST_PAGE_EDITABLE— deprecated since 14.x Experience Pages; no replacementorg.hippoecm.hst.core.parameters.@Parameter#description()annotation element — value was never used; configure hints in the ParametersInfo class resource bundleorg.hippoecm.hst.servlet.utils.HeaderUtils#setExpiresHeaders(HttpServletResponse, BinaryPage)— usesetExpiresHeaders(HttpServletResponse, BinaryPage, long)
Taxonomy (community/taxonomy)
org.onehippo.taxonomy.plugin.model.JcrCategoryInfo(IModel<Node> categoryInfoModel, boolean editable)— deprecated; use the no-argument or other available constructor
Utilities (community/utilities)
org.hippoecm.hst.servlet.ResourceServlet— deprecated; useorg.onehippo.cms7.utilities.servlet.ResourceServlet
Enterprise Module
Reporting Dashboard (enterprise/reporting-dashboard)
com.onehippo.cms7.reports.plugins.chart.AbstractChartStore(Component component)— deprecated; use the constructor that includes a report name
Advanced Search (enterprise/advanced-search)
com.onehippo.cms7.search.frontend.engine.model.QueryResultModel(IModel<Query> queryModel)— deprecated; does not include a limit parameter; use the other constructor
Enterprise Services API (enterprise/services-api)
com.onehippo.cms7.services.wpm.project.Project— deprecated since 16.3.0; useorg.onehippo.cms7.services.project.Projectcom.onehippo.cms7.services.wpm.project.ProjectService— deprecated since 16.3.0; useorg.onehippo.cms7.services.project.ProjectServicecom.onehippo.cms7.services.wpm.project.ProjectState— deprecated since 16.3.0; useorg.onehippo.cms7.services.project.ProjectState