Deprecated List (Apache Sling 12 API)

Deprecated Interfaces
Interface and Description
org.apache.sling.api.resource.AttributableResourceProvider Use the `ResourceProvider`
org.apache.sling.engine.auth.AuthenticationHandler use `AuthenticationHandler` instead
org.apache.sling.engine.auth.Authenticator use `AuthenticationSupport` instead
org.apache.sling.caconfig.spi.ConfigurationPersistenceStrategy Please use `ConfigurationPersistenceStrategy2` instead.
org.apache.sling.caconfig.management.ContextPathStrategyMultiplexer Please use `ContextPathStrategyMultiplexer` instead.
org.apache.sling.commons.classloader.DynamicClassLoaderProvider The dynamic class loader provider is not supported anymore and any service implementing this is not considered for dynamic class loading anymore!
org.apache.sling.api.resource.DynamicResourceProvider Use the `ResourceProvider`
org.apache.sling.hc.api.HealthCheck Use Apache Felix Health Checks now, see `https://sling.apache.org/documentation/bundles/sling-health-check-tool.html` for migration guide.
org.apache.sling.hc.api.execution.HealthCheckExecutionResult
org.apache.sling.hc.api.execution.HealthCheckExecutor
org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor Use `InjectAnnotationProcessor2` instead
org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessorFactory Use `StaticInjectAnnotationProcessorFactory` preferably or in case of a dependency to the adaptable `InjectAnnotationProcessorFactory2`
org.apache.sling.i18n.LocaleResolver The `RequestLocaleResolver` should be used instead.
org.apache.sling.api.resource.ModifyingResourceProvider Use the `ResourceProvider`
org.apache.sling.jcr.api.NamespaceMapper Per session namespace mapping is not supported anymore.
org.apache.sling.api.resource.ParametrizableResourceProvider Use the `ResourceProvider`
org.apache.sling.api.resource.PersistableValueMap Use the `ModifiableValueMap` instead.
org.apache.sling.api.resource.QueriableResourceProvider Use the `ResourceProvider`
org.apache.sling.api.resource.RefreshableResourceProvider Use the `ResourceProvider`
org.apache.sling.engine.RequestLog Use the request progress tracker instead.
org.apache.sling.api.resource.ResourceProvider Use the `ResourceProvider`
org.apache.sling.api.resource.ResourceProviderFactory
org.apache.sling.servlets.post.SlingPostOperation as of 2.0.8 (Bundle version 2.2.0) and replaced by `PostOperation`.
org.apache.sling.api.scripting.SlingScriptResolver The SlingScriptResolver interface is intended to be implemented and also used by project specific code. To keep the API as clean as possible this interface was deprecated
org.apache.sling.engine.SlingSettingsService Use the `SlingSettingsService`

Deprecated Classes
Class and Description
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler since Bundle 1.0.8; `AuthenticationHandler` implementations should extend `DefaultAuthenticationFeedbackHandler` directly and use the utility methods in the `AuthUtil` class.
org.apache.sling.models.spi.injectorspecific.AbstractInjectAnnotationProcessor Use `AbstractInjectAnnotationProcessor2` instead
org.apache.sling.servlets.post.AbstractPostOperation (SLING-6722): this class mixes Sling and JCR APIs which is not optimal as nowadays we favor the Sling APIs. There's no intention to remove it however, if you're using JCR APIs anyways in your project it's fine to use it. Theres no public replacement for it as I write this.
org.apache.sling.engine.servlets.AbstractServiceReferenceConfig
org.apache.sling.servlets.post.AbstractSlingPostOperation as of 2.0.8 (Bundle version 2.2.0) and replaced by `AbstractPostOperation`.
org.apache.sling.engine.auth.AuthenticationInfo see `AuthenticationHandler`
org.apache.sling.api.wrappers.CompositeValueMap Use `ValueMapUtil.merge(ValueMap...)` instead. Note that it does not support the parameter `merge = false`. However, this could easily be achieved with another decorator that restricts the set of allowed keys.
org.apache.sling.hc.util.FormattingResultLog
org.apache.sling.hc.api.execution.HealthCheckExecutionOptions
org.apache.sling.hc.util.HealthCheckFilter
org.apache.sling.hc.util.HealthCheckMetadata
org.apache.sling.hc.api.execution.HealthCheckSelector
org.apache.sling.api.servlets.HtmlResponse use org.apache.sling.servlets.post.HtmlResponse instead.
org.apache.sling.scripting.sightly.java.compiler.JavaEscapeUtils since version 2.1.0 of the API; see `JavaEscapeHelper` for a replacement.
org.apache.sling.scripting.sightly.compiler.util.ObjectModel This class has been moved to `ObjectModel`.
org.apache.sling.commons.osgi.OsgiUtil Use `org.osgi.util.converter.Converters` and `ServiceUtil` instead
org.apache.sling.servlets.post.PostResponseWithErrorHandling
org.apache.sling.commons.osgi.PropertiesUtil Use `org.osgi.util.converter.Converters` instead
org.apache.sling.engine.RequestUtil Use `RequestUtil`
org.apache.sling.engine.ResponseUtil Use `ResponseUtil`
org.apache.sling.hc.api.Result
org.apache.sling.hc.api.ResultLog
org.apache.sling.scripting.sightly.compiler.RuntimeFunction constants are available in `RuntimeCall` starting with version 1.2.0 of the `org.apache.sling.scripting.sightly.compiler.expression.nodes` API.
org.apache.sling.hc.util.SimpleConstraintChecker
org.apache.sling.adapter.SlingAdaptable Use the `SlingAdaptable` instead

Deprecated Exceptions
Exceptions and Description
org.apache.sling.engine.auth.NoAuthenticationHandlerException see `Authenticator`
org.apache.sling.jcr.api.TooManySessionsException Session pooling has been removed and thus this exception is not used any more.

Deprecated Fields
Field and Description
org.apache.sling.engine.EngineConstants.FILTER_ORDER Use `"service.ranking"` (org.osgi.framework.Constants.SERVICE_RANKING) instead
org.apache.sling.engine.EngineConstants.FILTER_SCOPE Use `EngineConstants.SLING_FILTER_SCOPE` instead
org.apache.sling.api.resource.ResourceMetadata.INTERNAL_CONTINUE_RESOLVING This flag is not supported anymore when implementing the SPI based `org.apache.sling.spi.resource.provider.ResourceProvider`
org.apache.sling.api.SlingConstants.PROPERTY_ADAPTABLE_CLASSES Use a service listener listening for service removed events for `org.apache.sling.adapter.Adaption`.
org.apache.sling.api.SlingConstants.PROPERTY_ADAPTER_CLASSES Use a service listener listening for service removed events for `org.apache.sling.adapter.Adaption`.
org.apache.sling.api.resource.ResourceResolver.REQUEST_ATTR_WORKSPACE_INFO
org.apache.sling.engine.EngineConstants.SESSION as of bundle version 2.1
org.apache.sling.engine.EngineConstants.SLING_CURRENT_SERVLET_NAME Use `SlingConstants.SLING_CURRENT_SERVLET_NAME`
org.apache.sling.engine.EngineConstants.SLING_HOME Use `SlingSettingsService.SLING_HOME`
org.apache.sling.engine.EngineConstants.SLING_HOME_URL Use `SlingSettingsService.SLING_HOME_URL`
org.apache.sling.engine.EngineConstants.SLING_SERLVET_NAME
org.apache.sling.api.SlingConstants.TOPIC_ADAPTER_FACTORY_ADDED Use a service listener listening for service removed events for `org.apache.sling.adapter.Adaption`.
org.apache.sling.api.SlingConstants.TOPIC_ADAPTER_FACTORY_REMOVED Use a service listener listening for service removed events for `org.apache.sling.adapter.Adaption`.
org.apache.sling.api.SlingConstants.TOPIC_RESOURCE_ADDED Register a `ResourceChangeListener` instead
org.apache.sling.api.SlingConstants.TOPIC_RESOURCE_CHANGED Register a `ResourceChangeListener` instead
org.apache.sling.api.SlingConstants.TOPIC_RESOURCE_REMOVED Register a `ResourceChangeListener` instead

Deprecated Methods
Method and Description
org.apache.sling.installer.api.tasks.InstallationContext.addAsyncTask(InstallTask) A async task should return `true` for `InstallTask.isAsynchronousTask()` and be add with `InstallationContext.addTaskToCurrentCycle(InstallTask)`
org.apache.sling.commons.scheduler.Scheduler.addJob(String, Object, Map<String, Serializable>, String, boolean) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.commons.scheduler.Scheduler.addPeriodicJob(String, Object, Map<String, Serializable>, long, boolean) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.commons.scheduler.Scheduler.addPeriodicJob(String, Object, Map<String, Serializable>, long, boolean, boolean) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.installer.api.tasks.InstallationContext.addTaskToNextCycle(InstallTask)
org.apache.sling.jcr.jackrabbit.accessmanager.post.AbstractAccessPostServlet.createHtmlResponse(SlingHttpServletRequest) use `AbstractAccessPostServlet.createPostResponse(SlingHttpServletRequest)` instead
org.apache.sling.api.resource.ResourceDecorator.decorate(Resource, HttpServletRequest) since 2.3.0 (and JCR Resource 2.1.0), this method will not be invoked.
org.apache.sling.api.scripting.SlingScriptHelper.dispose() This method is deprecated since version 2.1 and will be removed. It should never be called by clients.
org.apache.sling.scripting.core.ScriptHelper.dispose()
org.apache.sling.hc.api.execution.HealthCheckExecutor.execute(HealthCheckExecutionOptions, String...) use execute(HealthCheckFilter.Options, HealthCheckExecutionOptions)
org.apache.sling.hc.api.execution.HealthCheckExecutor.execute(String...) use execute(HealthCheckFilter.Options)
org.apache.sling.api.resource.ResourceUtil.findResourceSuperType(Resource) Use `ResourceResolver.getParentResourceType(Resource)`
org.apache.sling.commons.scheduler.Scheduler.fireJob(Object, Map<String, Serializable>) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.commons.scheduler.Scheduler.fireJob(Object, Map<String, Serializable>, int, long) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.commons.scheduler.Scheduler.fireJobAt(String, Object, Map<String, Serializable>, Date) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.commons.scheduler.Scheduler.fireJobAt(String, Object, Map<String, Serializable>, Date, int, long) Use `Scheduler.schedule(Object, ScheduleOptions)` instead.
org.apache.sling.commons.osgi.RankedServices.get() Use `RankedServices.getList()` instead
org.apache.sling.api.resource.observation.ResourceChange.getAddedPropertyNames() As there is no guarantee that this information is contained in the change event, this should not be used anymore.
org.apache.sling.api.resource.ResourceProviderFactory.getAdministrativeResourceProvider(Map<String, Object>) as of 2.4 (bundle version 2.5.0) because of inherent security issues. Implementations may implement this method at their discretion but must support the new service based resource provider generation in the `ResourceProviderFactory.getResourceProvider(Map)` method honoring the `ResourceProviderFactory.SERVICE_BUNDLE` and `ResourceResolverFactory.SUBSERVICE` properties.
org.apache.sling.api.resource.ResourceResolverFactory.getAdministrativeResourceResolver(Map<String, Object>) as of 2.4 (bundle version 2.5.0) because of inherent security issues. Services requiring specific permissions should use the `ResourceResolverFactory.getServiceResourceResolver(Map)` instead.
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.getAttributeOrParameter(HttpServletRequest, String, String) since Bundle 1.0.8, use `AuthUtil.getAttributeOrParameter(HttpServletRequest, String, String)`
org.apache.sling.api.resource.observation.ResourceChange.getChangedPropertyNames() As there is no guarantee that this information is contained in the change event, this should not be used anymore.
org.apache.sling.commons.osgi.ServiceUtil.getComparableForServiceRanking(Map<String, Object>) Use `ServiceUtil.getComparableForServiceRanking(Map, Order)` instead.
org.apache.sling.provisioning.model.ModelUtility.getEffectiveModel(Model, ModelUtility.VariableResolver) Use `ModelUtility.getEffectiveModel(Model)` or `ModelUtility.getEffectiveModel(Model, ResolverOptions)` instead
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.getLoginResource(HttpServletRequest, String) since Bundle 1.0.8, use `AuthUtil.getLoginResource(HttpServletRequest, String)`
org.apache.sling.commons.threads.ThreadPoolConfig.getMaxThreadAge() Since version 3.4.0 always returns -1 as threads are no longer retired but instead the thread locals are cleaned up (SLING-6261)
org.apache.sling.commons.threads.jmx.ThreadPoolMBean.getMaxThreadAge() Since version 1.1.1 always returns -1 as threads are no longer retired but instead the thread locals are cleaned up (SLING-6261)
org.apache.sling.api.resource.ResourceUtil.getName(Resource) since 2.1.0, use `Resource.getName()` instead
org.apache.sling.api.resource.ResourceUtil.getParent(Resource) since 2.1.0, use `Resource.getParent()` instead
org.apache.sling.caconfig.management.ConfigurationManager.getPersistenceResourcePath(String) Please use `ConfigurationPersistenceStrategyMultiplexer` instead.
org.apache.sling.commons.osgi.OsgiUtil.getProperty(Object, double) since 2.0.4, use `OsgiUtil.toDouble(Object, double)` instead
org.apache.sling.jcr.jackrabbit.accessmanager.post.AbstractAccessPostServlet.getRedirectUrl(HttpServletRequest, AbstractPostResponse) use `AbstractAccessPostServlet.getRedirectUrl(HttpServletRequest, PostResponse)` instead
org.apache.sling.api.resource.observation.ResourceChange.getRemovedPropertyNames() As there is no guarantee that this information is contained in the change event, this should not be used anymore.
org.apache.sling.api.resource.ResourceProvider.getResource(ResourceResolver, HttpServletRequest, String) since 2.2.0 (and JCR Resource 2.1.0), this method will not be invoked.
org.apache.sling.api.resource.ResourceUtil.getResourceSuperType(ResourceResolver, String) Use `ResourceResolver.getParentResourceType(String)`
org.apache.sling.serviceusermapping.ServiceUserMapper.getServiceUserID(Bundle, String) Use `ServiceUserMapper.getServicePrincipalNames(Bundle, String)` instead.
org.apache.sling.hc.util.HealthCheckFilter.getTaggedHealthChecks(String...) use getHealthChecks() instead
org.apache.sling.hc.util.HealthCheckFilter.getTaggedHealthCheckServiceReferences(boolean, String...) use getHealthCheckServiceReferences() instead
org.apache.sling.hc.util.HealthCheckFilter.getTaggedHealthCheckServiceReferences(String...) use getHealthCheckServiceReferences() instead
org.apache.sling.jcr.jackrabbit.accessmanager.post.AbstractAccessPostServlet.handleOperation(SlingHttpServletRequest, AbstractPostResponse, List<Modification>) use `AbstractAccessPostServlet.handleOperation(SlingHttpServletRequest, PostResponse, List)` instead
org.apache.sling.api.resource.ResourceUtil.isA(Resource, String) Use `ResourceResolver.isResourceType(Resource, String)`
org.apache.sling.models.factory.ModelFactory.isModelClass(Object, Class<?>) Use `ModelFactory.isModelClass(Class)` instead!
org.apache.sling.models.spi.injectorspecific.InjectAnnotationProcessor.isOptional() use `InjectAnnotationProcessor2.getInjectionStrategy()` instead
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.isRedirectValid(HttpServletRequest, String) This method has been introduced after Bundle release 1.0.6 but has been replaced with `AuthUtil.isRedirectValid(HttpServletRequest, String)`. Use the latter method.
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.isValidateRequest(HttpServletRequest) since Bundle 1.0.8, use `AuthUtil.isValidateRequest(HttpServletRequest)`
org.apache.sling.scripting.javascript.wrapper.ScriptableResource.jsFunction_getMetadata() since 2.1.0 because the method is named incorrectly.
org.apache.sling.scripting.javascript.wrapper.ScriptableResource.jsGet_meta() since 2.1.0 because it maps the method name incorrectly.
org.apache.sling.scripting.javascript.wrapper.ScriptableResource.jsGet_type() since 2.1.0 because it maps the method name incorrectly.
org.apache.sling.api.resource.ResourceUtil.listChildren(Resource) since 2.1.0, use `Resource.listChildren()` instead
org.apache.sling.jcr.api.SlingRepository.loginAdministrative(String) as of 2.2 (bundle version 2.2.0) because of inherent security issues. Services requiring specific permissions should use the `SlingRepository.loginService(String, String)` instead.
org.apache.sling.provisioning.model.ModelUtility.merge(Model, Model) Use {link `MergeUtility.merge(Model, Model)`
org.apache.sling.provisioning.model.ModelUtility.merge(Model, Model, boolean) Use {link `MergeUtility.merge(Model, Model, org.apache.sling.provisioning.model.MergeUtility.MergeOptions)`
org.apache.sling.caconfig.management.multiplexer.ConfigurationOverrideMultiplexer.overrideProperties(String, String, Resource) Please use `ConfigurationOverrideMultiplexer.overrideProperties(String, String, Resource, ResourceResolver)` instead.
org.apache.sling.commons.scheduler.Scheduler.removeJob(String) Use `Scheduler.unschedule(String)` instead.
org.apache.sling.jcr.base.util.AccessControlUtil.replaceAccessControlEntry(Session, String, Principal, String[], String[], String[]) use @link `AccessControlUtil.replaceAccessControlEntry(Session, String, Principal, String[], String[], String[], String)` instead.
org.apache.sling.api.resource.ResourceResolver.resolve(HttpServletRequest) as of 2.0.4, use `ResourceResolver.resolve(HttpServletRequest, String)` instead.
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.sendInvalid(HttpServletRequest, HttpServletResponse) since Bundle 1.0.8, use `AuthUtil.sendInvalid(HttpServletRequest, HttpServletResponse)`
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.sendRedirect(HttpServletRequest, HttpServletResponse, String, Map<String, String>) since Bundle 1.0.8, use `AuthUtil.sendRedirect(HttpServletRequest, HttpServletResponse, String, Map)`
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.sendValid(HttpServletResponse) since Bundle 1.0.8, use `AuthUtil.sendValid(HttpServletResponse)`
org.apache.sling.auth.core.spi.AbstractAuthenticationHandler.setLoginResourceAttribute(HttpServletRequest, String) since Bundle 1.0.8, use `AuthUtil.setLoginResourceAttribute(HttpServletRequest, String)`
org.apache.sling.commons.threads.ModifiableThreadPoolConfig.setMaxThreadAge(long) Since version 3.4.0 should no longer be called, as threads are no longer retired but instead the thread locals are cleaned up (SLING-6261)
org.apache.sling.jcr.base.AbstractSlingRepositoryManager.start(BundleContext, String, boolean) use `AbstractSlingRepositoryManager.start(BundleContext, AbstractSlingRepositoryManager.Config)` instead.

Deprecated Constructors
Constructor and Description
org.apache.sling.caconfig.resource.spi.ContextResource(Resource, String) Use `ContextResource(Resource, String, int)`
org.apache.sling.discovery.commons.InitDelayingTopologyEventListener(long, TopologyEventListener, Scheduler) Use `InitDelayingTopologyEventListener(long, TopologyEventListener)`
org.apache.sling.discovery.commons.InitDelayingTopologyEventListener(long, TopologyEventListener, Scheduler, Logger) Use `InitDelayingTopologyEventListener(long, TopologyEventListener, Logger)`
org.apache.sling.commons.osgi.RankedServices() Use `RankedServices(Order)` to explicitly give the order.
org.apache.sling.commons.osgi.RankedServices(RankedServices.ChangeListener) Use `RankedServices(Order order, ChangeListener changeListener)` instead
org.apache.sling.api.resource.observation.ResourceChange(ResourceChange.ChangeType, String, boolean, Set<String>, Set<String>, Set<String>) The sets of property names are not supported anymore.

Deprecated Enum Constants
Enum Constant and Description
org.apache.sling.jackrabbit.usermanager.AuthorizablePrivilegesInfo.PropertyUpdateTypes.addNestedProperty use `AuthorizablePrivilegesInfo.PropertyUpdateTypes.ADD_NESTED_PROPERTY` instead
org.apache.sling.jackrabbit.usermanager.AuthorizablePrivilegesInfo.PropertyUpdateTypes.addProperty use `AuthorizablePrivilegesInfo.PropertyUpdateTypes.ADD_PROPERTY` instead
org.apache.sling.jackrabbit.usermanager.AuthorizablePrivilegesInfo.PropertyUpdateTypes.alterProperty use `AuthorizablePrivilegesInfo.PropertyUpdateTypes.ALTER_PROPERTY` instead
org.apache.sling.jackrabbit.usermanager.AuthorizablePrivilegesInfo.PropertyUpdateTypes.removeProperty use `AuthorizablePrivilegesInfo.PropertyUpdateTypes.REMOVE_PROPERTY` instead

Deprecated Annotation Type Elements
Annotation Type Element and Description
org.apache.sling.models.annotations.injectorspecific.Self.optional Use `Self.injectionStrategy()` instead
org.apache.sling.models.annotations.injectorspecific.OSGiService.optional Use `OSGiService.injectionStrategy()` instead.
org.apache.sling.models.annotations.injectorspecific.ScriptVariable.optional Use `ScriptVariable.injectionStrategy()` instead.
org.apache.sling.models.annotations.injectorspecific.ResourcePath.optional Use `ResourcePath.injectionStrategy()` instead.
org.apache.sling.models.annotations.injectorspecific.RequestAttribute.optional Use `RequestAttribute.injectionStrategy()` instead.
org.apache.sling.models.annotations.injectorspecific.ChildResource.optional Use `ChildResource.injectionStrategy()` instead.
org.apache.sling.models.annotations.injectorspecific.ValueMapValue.optional Use `ValueMapValue.injectionStrategy()` instead
org.apache.sling.models.annotations.injectorspecific.SlingObject.optional Use `SlingObject.injectionStrategy()` instead

Deprecated API

Contents