Deprecated API

Contents

• Interfaces
• Classes
• Enums
• Fields
• Methods
• Enum Constants
• Annotation Type Elements

Deprecated Interfaces

Interface	Description
org.hibernate.search.backend.elasticsearch.aws.spi.ElasticsearcAwsCredentialsProvider	Implement ElasticsearchAwsCredentialsProvider instead.
org.hibernate.search.engine.backend.types.converter.FromDocumentFieldValueConverter	Implement FromDocumentValueConverter instead.
org.hibernate.search.engine.backend.types.converter.runtime.FromDocumentFieldValueConvertContext	Use FromDocumentValueConverter with FromDocumentValueConvertContext instead.
org.hibernate.search.engine.backend.types.converter.runtime.FromDocumentFieldValueConvertContextExtension	Use FromDocumentValueConverter with FromDocumentValueConvertContext and FromDocumentValueConvertContextExtension instead.
org.hibernate.search.engine.backend.types.converter.runtime.ToDocumentFieldValueConvertContext	Use ToDocumentValueConverter with ToDocumentValueConvertContext instead.
org.hibernate.search.engine.backend.types.converter.runtime.ToDocumentFieldValueConvertContextExtension	Use ToDocumentValueConverter with ToDocumentValueConvertContext and ToDocumentValueConvertContextExtension instead.
org.hibernate.search.engine.backend.types.converter.ToDocumentFieldValueConverter	Implement ToDocumentValueConverter instead.
org.hibernate.search.engine.search.predicate.dsl.NestedPredicateFieldStep	Use SearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.predicate.dsl.NestedPredicateNestStep	Use SearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.predicate.dsl.NestedPredicateOptionsStep	Use SearchPredicateFactory.nested(String) instead.
org.hibernate.search.mapper.orm.automaticindexing.session.AutomaticIndexingSynchronizationConfigurationContext	Use IndexingPlanSynchronizationStrategyConfigurationContext
org.hibernate.search.mapper.orm.automaticindexing.session.AutomaticIndexingSynchronizationStrategy	See IndexingPlanSynchronizationStrategy
org.hibernate.search.mapper.orm.automaticindexing.spi.AutomaticIndexingStrategyStartContext	This SPI was introduced by mistake and was never used.
org.hibernate.search.mapper.orm.massindexing.MassIndexingFailureHandler	move to MassIndexingFailureHandler.
org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor	move to MassIndexingMonitor.
org.hibernate.search.mapper.pojo.model.path.spi.PojoPathsDefinition	Implement PojoPathDefinitionProvider instead.
org.hibernate.search.util.common.reflect.spi.ValueReadHandleFactory	Use/implement ValueHandleFactory instead.

Deprecated Classes

Class	Description
org.hibernate.search.backend.elasticsearch.cfg.spi.ElasticsearchBackendImplSettings	Use ElasticsearchBackendImplSettings instead.
org.hibernate.search.engine.backend.session.spi.DetachedBackendSessionContext	SPIs should simply pass around a string representing the tenant ID instead of using this class. In cases where the mapping context is also necessary, it should be passed around as a separate parameter.
org.hibernate.search.mapper.orm.automaticindexing.session.AutomaticIndexingSynchronizationStrategyNames	See IndexingPlanSynchronizationStrategyNames

Deprecated Enums

Enum	Description
org.hibernate.search.mapper.orm.automaticindexing.AutomaticIndexingStrategyName	Use HibernateOrmMapperSettings.AUTOMATIC_INDEXING_ENABLED instead.

Deprecated Fields

Field	Description
org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings.Defaults.MULTI_TENANCY_STRATEGY	The default for this property is now dynamic and depends on the mapper. If the multi-tenancy is enabled in the mapper, the default is MultiTenancyStrategyName.DISCRIMINATOR. Otherwise, the default is still MultiTenancyStrategyName.NONE.
org.hibernate.search.backend.lucene.cfg.LuceneBackendSettings.Defaults.MULTI_TENANCY_STRATEGY	The default for this property is now dynamic and depends on the mapper. If the multi-tenancy is enabled in the mapper, the default is MultiTenancyStrategyName.DISCRIMINATOR. Otherwise, the default is still MultiTenancyStrategyName.NONE.
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.AUTOMATIC_INDEXING_STRATEGY	Use HibernateOrmMapperSettings.AUTOMATIC_INDEXING_ENABLED instead (caution: it expects a boolean value).
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY	Use HibernateOrmMapperSettings.INDEXING_PLAN_SYNCHRONIZATION_STRATEGY instead.
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.AutomaticIndexingRadicals.STRATEGY	Use HibernateOrmMapperSettings.AutomaticIndexingRadicals.ENABLED instead (caution: it expects a boolean value).
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.AutomaticIndexingRadicals.SYNCHRONIZATION_STRATEGY	Use HibernateOrmMapperSettings.IndexingPlanRadicals.SYNCHRONIZATION_STRATEGY instead.
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.Defaults.AUTOMATIC_INDEXING_STRATEGY	Use the new configuration property instead: HibernateOrmMapperSettings.AUTOMATIC_INDEXING_STRATEGY, (caution: it expects a boolean value, and its default is HibernateOrmMapperSettings.Defaults.ENABLED).
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.Defaults.AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY	Use HibernateOrmMapperSettings.Defaults.INDEXING_PLAN_SYNCHRONIZATION_STRATEGY instead.
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.Radicals.AUTOMATIC_INDEXING_STRATEGY	Use HibernateOrmMapperSettings.Radicals.AUTOMATIC_INDEXING_ENABLED instead (caution: it expects a boolean value).
org.hibernate.search.mapper.orm.cfg.HibernateOrmMapperSettings.Radicals.AUTOMATIC_INDEXING_SYNCHRONIZATION_STRATEGY	Use HibernateOrmMapperSettings.Radicals.INDEXING_PLAN_SYNCHRONIZATION_STRATEGY instead.

Deprecated Methods

Method	Description
org.hibernate.search.engine.backend.orchestration.spi.BatchingExecutor.submit(W)	Use BatchingExecutor.submit(BatchedWork, OperationSubmitter) instead.
org.hibernate.search.engine.backend.types.converter.runtime.spi.FromDocumentValueConvertContextImpl.extension(FromDocumentFieldValueConvertContextExtension<T>)
org.hibernate.search.engine.backend.types.converter.runtime.spi.ToDocumentValueConvertContextImpl.extension(ToDocumentFieldValueConvertContextExtension<T>)
org.hibernate.search.engine.cfg.spi.KeyContext.asInteger()	Use KeyContext.asIntegerPositiveOrZeroOrNegative() instead.
org.hibernate.search.engine.cfg.spi.KeyContext.asLong()	Use KeyContext.asLongPositiveOrZeroOrNegative() instead.
org.hibernate.search.engine.mapper.mapping.spi.MappedIndexManager.createWorkspace(DetachedBackendSessionContext)	Use MappedIndexManager.createWorkspace(BackendMappingContext, String) instead.
org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory.bool(Consumer<? super BooleanPredicateClausesStep<?>>)	Use .bool().with(...) instead.
org.hibernate.search.engine.search.predicate.dsl.SearchPredicateFactory.nested()	Use SearchPredicateFactory.nested(String) instead.
org.hibernate.search.engine.search.predicate.dsl.spi.AbstractSearchPredicateFactory.nested()
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(BiFunction<P1, P2, T>, ProjectionFinalStep<P1>, ProjectionFinalStep<P2>)	Use .composite().from( dslFinalStep1, dslFinalStep2 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(BiFunction<P1, P2, T>, SearchProjection<P1>, SearchProjection<P2>)	Use .composite().from( projection1, projection2 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<List<?>, T>, ProjectionFinalStep<?>...)	Use .composite().from( dslFinalSteps ).asList( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<List<?>, T>, SearchProjection<?>...)	Use .composite().from( projections ).asList( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<P, T>, ProjectionFinalStep<P>)	Use .composite().from( dslFinalStep ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(Function<P, T>, SearchProjection<P>)	Use .composite().from( projection ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(TriFunction<P1, P2, P3, T>, ProjectionFinalStep<P1>, ProjectionFinalStep<P2>, ProjectionFinalStep<P3>)	Use .composite().from( dslFinalStep1, dslFinalStep2, dslFinalStep3 ).as( transformer ) instead.
org.hibernate.search.engine.search.projection.dsl.SearchProjectionFactory.composite(TriFunction<P1, P2, P3, T>, SearchProjection<P1>, SearchProjection<P2>, SearchProjection<P3>)	Use .composite().from( projection1, projection2, projection3 ).as( transformer ) instead.
org.hibernate.search.engine.Version.getVersionString()	Use Version.versionString() instead.
org.hibernate.search.mapper.orm.HibernateOrmExtension.extendOptional(FromDocumentFieldValueConvertContext, BackendSessionContext)	Use FromDocumentValueConverter and FromDocumentValueConvertContext instead.
org.hibernate.search.mapper.orm.HibernateOrmExtension.extendOptional(ToDocumentFieldValueConvertContext, BackendMappingContext)	Use ToDocumentFieldValueConverter and ToDocumentFieldValueConvertContext instead.
org.hibernate.search.mapper.orm.massindexing.MassIndexingFailureHandler.handle(MassIndexingEntityFailureContext)	move to MassIndexingFailureHandler.handle(MassIndexingEntityFailureContext).
org.hibernate.search.mapper.orm.massindexing.MassIndexingFailureHandler.handle(MassIndexingFailureContext)	move to MassIndexingFailureHandler.handle(MassIndexingFailureContext).
org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor.addToTotalCount(long)	move to MassIndexingMonitor.addToTotalCount(long).
org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor.documentsAdded(long)	move to MassIndexingMonitor.documentsAdded(long).
org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor.documentsBuilt(long)	move to MassIndexingMonitor.documentsBuilt(long).
org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor.entitiesLoaded(long)	move to MassIndexingMonitor.entitiesLoaded(long).
org.hibernate.search.mapper.orm.massindexing.MassIndexingMonitor.indexingCompleted()	move to MassIndexingMonitor.indexingCompleted().
org.hibernate.search.mapper.orm.session.SearchSession.automaticIndexingSynchronizationStrategy(AutomaticIndexingSynchronizationStrategy)	Use SearchSession.indexingPlanSynchronizationStrategy(IndexingPlanSynchronizationStrategy) instead.
org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded.prefix()	Use IndexedEmbedded.name() instead. Note that IndexedEmbedded.name() does not allow dots.
org.hibernate.search.mapper.pojo.mapping.definition.programmatic.PropertyMappingIndexedEmbeddedStep.prefix(String)	Pass a field name to PropertyMappingStep.indexedEmbedded(String) instead. Note that the name passed to that method does not allow dots.
org.hibernate.search.mapper.pojo.mapping.spi.AbstractPojoMappingInitiator.annotatedTypeDiscoveryEnabled(boolean)	Use AnnotationMappingConfigurationContext.discoverAnnotationsFromReferencedTypes(boolean) on the object returned by AbstractPojoMappingInitiator.annotationMapping() instead.
org.hibernate.search.mapper.pojo.model.additionalmetadata.building.spi.PojoAdditionalMetadataCollectorTypeNode.markAsEntity(String, PojoPathsDefinition)	Use PojoAdditionalMetadataCollectorTypeNode.markAsEntity(String, PojoPathDefinitionProvider) instead.
org.hibernate.search.mapper.pojo.model.spi.PojoBootstrapIntrospector.annotationValueReadHandleFactory()	Use/implement PojoBootstrapIntrospector.annotationValueHandleFactory() instead.
org.hibernate.search.mapper.pojo.schema.management.spi.PojoScopeSchemaManager.createIfMissing(FailureCollector)
org.hibernate.search.mapper.pojo.schema.management.spi.PojoScopeSchemaManager.createOrUpdate(FailureCollector)
org.hibernate.search.mapper.pojo.schema.management.spi.PojoScopeSchemaManager.createOrValidate(FailureCollector)
org.hibernate.search.mapper.pojo.schema.management.spi.PojoScopeSchemaManager.dropAndCreate(FailureCollector)
org.hibernate.search.mapper.pojo.schema.management.spi.PojoScopeSchemaManager.dropIfExisting(FailureCollector)
org.hibernate.search.mapper.pojo.schema.management.spi.PojoScopeSchemaManager.validate(FailureCollector)
org.hibernate.search.mapper.pojo.scope.spi.PojoScopeDelegate.massIndexer(PojoMassIndexingContext, DetachedBackendSessionContext)	Use PojoScopeDelegate.massIndexer(PojoMassIndexingContext, Collection) instead.
org.hibernate.search.mapper.pojo.scope.spi.PojoScopeDelegate.workspace(DetachedBackendSessionContext)	Use PojoScopeDelegate.workspace(String) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexer.add(PojoRawTypeIdentifier<?>, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy)	Use PojoIndexer.add(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexer.addOrUpdate(PojoRawTypeIdentifier<?>, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy)	Use PojoIndexer.addOrUpdate(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexer.delete(PojoRawTypeIdentifier<?>, Object, DocumentRoutesDescriptor, Object, DocumentCommitStrategy, DocumentRefreshStrategy)	Use PojoIndexer.delete(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexer.delete(PojoRawTypeIdentifier<?>, Object, DocumentRoutesDescriptor, DocumentCommitStrategy, DocumentRefreshStrategy)	Use PojoIndexer.delete(PojoRawTypeIdentifier, Object, DocumentRoutesDescriptor, DocumentCommitStrategy, DocumentRefreshStrategy, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexingPlan.executeAndReport(EntityReferenceFactory<R>)	Use PojoIndexingPlan.executeAndReport(EntityReferenceFactory, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexingQueueEventProcessingPlan.executeAndReport(EntityReferenceFactory<R>)	Use PojoIndexingQueueEventProcessingPlan.executeAndReport(EntityReferenceFactory, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoIndexingQueueEventSendingPlan.sendAndReport(EntityReferenceFactory<R>)	Use PojoIndexingQueueEventSendingPlan.sendAndReport(EntityReferenceFactory, OperationSubmitter) instead.
org.hibernate.search.mapper.pojo.work.spi.PojoScopeWorkspace.flush()
org.hibernate.search.mapper.pojo.work.spi.PojoScopeWorkspace.mergeSegments()
org.hibernate.search.mapper.pojo.work.spi.PojoScopeWorkspace.purge(Set<String>)
org.hibernate.search.mapper.pojo.work.spi.PojoScopeWorkspace.refresh()
org.hibernate.search.util.common.reflect.spi.ValueReadHandleFactory.usingJavaLangReflect()	Use ValueHandleFactory.usingJavaLangReflect() instead.
org.hibernate.search.util.common.reflect.spi.ValueReadHandleFactory.usingMethodHandle(MethodHandles.Lookup)	Use ValueHandleFactory.usingMethodHandle(MethodHandles.Lookup) instead.

Deprecated Enum Constants

Enum Constant	Description
org.hibernate.search.backend.lucene.lowlevel.directory.FileSystemAccessStrategyName.SIMPLE	This strategy will be removed in a future version of Lucene.
org.hibernate.search.mapper.orm.automaticindexing.AutomaticIndexingStrategyName.NONE	Use HibernateOrmMapperSettings.AUTOMATIC_INDEXING_ENABLED instead.
org.hibernate.search.mapper.orm.automaticindexing.AutomaticIndexingStrategyName.SESSION	Use HibernateOrmMapperSettings.AUTOMATIC_INDEXING_ENABLED instead.

Deprecated Annotation Type Elements

Annotation Type Element	Description
org.hibernate.search.mapper.pojo.mapping.definition.annotation.IndexedEmbedded.prefix()	Use IndexedEmbedded.name() instead. Note that IndexedEmbedded.name() does not allow dots.