Package org.hibernate.search.engine.logging.impl

Interface Log

  • All Superinterfaces:
    BasicLogger
    All Known Implementing Classes:
    Log_$logger
    @MessageLogger(projectCode="HSEARCH")
@ValidIdRanges(@ValidIdRange(min=0,max=9999))
public interface Log
extends BasicLogger

    • Method Detail

      • startingExecutor

        @LogMessage(level=DEBUG)
@Message(id=230,
         value="Starting executor \'%1$s\'")
void startingExecutor​(String name)

      • stoppingExecutor

        @LogMessage(level=DEBUG)
@Message(id=231,
         value="Stopping executor \'%1$s\'")
void stoppingExecutor​(String indexName)

      • rangePredicateCannotMatchNullValue

        @Message(id=237,
         value="Invalid range: at least one bound in range predicates must be non-null.")
SearchException rangePredicateCannotMatchNullValue​(@Param
                                                   EventContext context)

      • noPublicNoArgConstructor

        @Message(id=242,
         value="Invalid type \'%1$s\': missing constructor. The type must expose a public, no-arguments constructor.")
SearchException noPublicNoArgConstructor​(@FormatWith(ClassFormatter.class)
                                         Class<?> clazz)

      • unableToConvertConfigurationProperty

        @Message(id=501,
         value="Invalid value for configuration property \'%1$s\': \'%2$s\'. %3$s")
SearchException unableToConvertConfigurationProperty​(String key,
                                                     Object rawValue,
                                                     String errorMessage,
                                                     @Cause
                                                     Exception cause)

      • invalidPropertyValue

        @Message(id=502,
         value="Invalid value: expected either an instance of \'%1$s\' or a String that can be parsed into that type. %2$s")
SearchException invalidPropertyValue​(@FormatWith(ClassFormatter.class)
                                     Class<?> expectedType,
                                     String errorMessage,
                                     @Cause
                                     Exception cause)

      • invalidBooleanPropertyValue

        @Message(id=503,
         value="Invalid Boolean value: expected either a Boolean, the String \'true\' or the String \'false\'. %1$s")
SearchException invalidBooleanPropertyValue​(String nestedErrorMessage,
                                            @Cause
                                            Exception cause)

      • invalidIntegerPropertyValue

        @Message(id=504,
         value="Invalid Integer value: expected either a Number or a String that can be parsed into an Integer. %1$s")
SearchException invalidIntegerPropertyValue​(String nestedErrorMessage,
                                            @Cause
                                            Exception cause)

      • invalidLongPropertyValue

        @Message(id=505,
         value="Invalid Long value: expected either a Number or a String that can be parsed into a Long. %1$s")
SearchException invalidLongPropertyValue​(String nestedErrorMessage,
                                         @Cause
                                         Exception cause)

      • invalidMultiPropertyValue

        @Message(id=506,
         value="Invalid multi value: expected either a single value of the correct type, a Collection, or a String, and interpreting as a single value failed with the following exception. %1$s")
SearchException invalidMultiPropertyValue​(String nestedErrorMessage,
                                          @Cause
                                          Exception cause)

      • relativeFieldNameCannotBeNullOrEmpty

        @Message(id=514,
         value="Invalid index field name \'%1$s\': field names cannot be null or empty.")
SearchException relativeFieldNameCannotBeNullOrEmpty​(String relativeFieldName,
                                                     @Param
                                                     EventContext context)

      • relativeFieldNameCannotContainDot

        @Message(id=515,
         value="Invalid index field name \'%1$s\': field names cannot contain a dot (\'.\'). Remove the dot from your field name, or if you are declaring the field in a bridge and want a tree of fields, declare an object field using the objectField() method.")
SearchException relativeFieldNameCannotContainDot​(String relativeFieldName,
                                                  @Param
                                                  EventContext context)

      • invalidGeoPolygonFirstPointNotIdenticalToLastPoint

        @Message(id=516,
         value="Invalid polygon: the first point \'%1$s\' should be identical to the last point \'%2$s\' to properly close the polygon.")
IllegalArgumentException invalidGeoPolygonFirstPointNotIdenticalToLastPoint​(GeoPoint firstPoint,
                                                                            GeoPoint lastPoint)

      • collectedFailureLimitReached

        @Message(id=519,
         value="Hibernate Search encountered %3$s failures during %1$s. Only the first %2$s failures are displayed here. See the logs for extra failures.")
String collectedFailureLimitReached​(String process,
                                    int failureLimit,
                                    int failureCount)

      • collectedFailures

        @Message(id=520,
         value="Hibernate Search encountered failures during %1$s. Failures:\n%2$s")
SearchException collectedFailures​(String process,
                                  String renderedFailures)

      • newCollectedFailure

        @LogMessage(level=ERROR)
@Message(id=521,
         value="Hibernate Search encountered a failure during %1$s; continuing for now to list all problems, but the process will ultimately be aborted.\nContext: %2$s\nFailure:")
void newCollectedFailure​(String process,
                         String context,
                         @Cause
                         Throwable failure)

      • exceptionWhileCollectingFailure

        @LogMessage(level=WARN)
@Message(id=522,
         value="Exception while collecting a failure -- this may indicate a bug or a missing test in Hibernate Search. Please report it: https://hibernate.org/community/ Nested exception: %1$s")
void exceptionWhileCollectingFailure​(String causeMessage,
                                     @Cause
                                     Throwable cause)

      • cannotCallDslExtensionIfSupportedAfterOrElse

        @Message(id=525,
         value="Invalid call of ifSupported(...) after orElse(...). Use a separate extension() context, or move the orElse(...) call last.")
SearchException cannotCallDslExtensionIfSupportedAfterOrElse()

      • dslExtensionNoMatch

        @Message(id=526,
         value="None of the provided extensions can be applied to the current context.  Attempted extensions: %1$s. If you want to ignore this, use .extension().ifSupported(...).orElse(ignored -> { }).")
SearchException dslExtensionNoMatch​(List<?> attemptedExtensions)

      • securityManagerLoadingError

        @Message(id=528,
         value="Security manager does not allow access to the constructor of type \'%1$s\': %2$s")
SearchException securityManagerLoadingError​(@FormatWith(ClassFormatter.class)
                                            Class<?> classToLoad,
                                            String causeMessage,
                                            @Cause
                                            Exception cause)

      • unknownNameForBackend

        @Message(id=533,
         value="No backend with name \'%1$s\'. Check that at least one entity is configured to target that backend. The following backends can be retrieved by name: %2$s. %3$s")
SearchException unknownNameForBackend​(String backendName,
                                      Collection<String> validBackendNames,
                                      String defaultBackendMessage)

      • defaultBackendAvailable

        @Message("The default backend can be retrieved")
String defaultBackendAvailable()

      • defaultBackendUnavailable

        @Message("The default backend cannot be retrieved, because no entity is mapped to that backend")
String defaultBackendUnavailable()

      • unknownNameForIndexManager

        @Message(id=534,
         value="No index manager with name \'%1$s\'. Check that at least one entity is configured to target that index. The following indexes can be retrieved by name: %2$s.")
SearchException unknownNameForIndexManager​(String indexManagerName,
                                           Collection<String> validIndexNames)

      • unableToInstantiateClass

        @Message(id=540,
         value="Unable to instantiate class \'%1$s\': %2$s")
SearchException unableToInstantiateClass​(String className,
                                         String causeMessage,
                                         @Cause
                                         Exception cause)

      • implementationRequired

        @Message(id=543,
         value="Invalid type \'%1$s\': this type is an interface. An implementation class is required.")
SearchException implementationRequired​(@FormatWith(ClassFormatter.class)
                                       Class<?> classToLoad)

      • noPublicMapArgConstructor

        @Message(id=544,
         value="Invalid type \'%1$s\': missing constructor. The type must expose a public constructor with a single parameter of type Map.")
SearchException noPublicMapArgConstructor​(@FormatWith(ClassFormatter.class)
                                          Class<?> classToLoad)

      • indexedEmbeddedCyclicRecursion

        @Message(id=546,
         value="Cyclic recursion starting from \'%1$s\' on %2$s. Index field path starting from that location and ending with a cycle: \'%3$s\'. A type cannot declare an unrestricted @IndexedEmbedded to itself, even indirectly. To break the cycle, you should consider adding filters to your @IndexedEmbedded: includePaths, includeDepth, excludePaths, ...")
SearchException indexedEmbeddedCyclicRecursion​(MappingElement indexedEmbedded,
                                               @FormatWith(EventContextNoPrefixFormatter.class)
                                               EventContext indexedEmbeddedLocation,
                                               String cyclicRecursionPath)

      • invalidBeanReferencePropertyValue

        @Message(id=547,
         value="Invalid BeanReference value: expected an instance of \'%1$s\', BeanReference, String or Class. %2$s")
SearchException invalidBeanReferencePropertyValue​(@FormatWith(ClassFormatter.class)
                                                  Class<?> expectedType,
                                                  String nestedErrorMessage,
                                                  @Cause
                                                  Exception cause)

      • perFieldBoostWithConstantScore

        @Message(id=551,
         value="Invalid use of per-field boost: the predicate score is constant. Cannot assign a different boost to each field when the predicate score is constant.")
SearchException perFieldBoostWithConstantScore()

      • invalidPhrasePredicateSlop

        @Message(id=553,
         value="Invalid slop: %1$d. The slop must be positive or zero.")
SearchException invalidPhrasePredicateSlop​(int slop)

      • invalidFuzzyMaximumEditDistance

        @Message(id=554,
         value="Invalid maximum edit distance: %1$d. The value must be 0, 1 or 2.")
SearchException invalidFuzzyMaximumEditDistance​(int maximumEditDistance)

      • invalidExactPrefixLength

        @Message(id=555,
         value="Invalid exact prefix length: %1$d. The value must be positive or zero.")
SearchException invalidExactPrefixLength​(int exactPrefixLength)

      • nonSingleHit

        @Message(id=561,
         value="Multiple hits when a single hit was expected.")
SearchException nonSingleHit()

      • threadInterruptedWhileSubmittingWork

        @Message(id=562,
         value="Unable to submit work to \'%1$s\': thread received interrupt signal. The work has been discarded.")
SearchException threadInterruptedWhileSubmittingWork​(String orchestratorName)

      • submittedWorkToStoppedOrchestrator

        @Message(id=563,
         value="Unable to submit work to \'%1$s\': this orchestrator is stopped. The work has been discarded.")
SearchException submittedWorkToStoppedOrchestrator​(String orchestratorName)

      • unableToParseGeoPoint

        @Message(id=564,
         value="Invalid geo-point value: \'%1$s\'. The expected format is \'<latitude as double>, <longitude as double>\'.")
SearchException unableToParseGeoPoint​(String value)

      • unknownAggregationKey

        @Message(id=565,
         value="Unknown aggregation key \'%1$s\'. This key was not used when building the search query.")
SearchException unknownAggregationKey​(AggregationKey<?> key)

      • invalidConfigurationPropertyCheckingStrategyName

        @Message(id=566,
         value="Invalid configuration property checking strategy name: \'%1$s\'. Valid names are: %2$s.")
SearchException invalidConfigurationPropertyCheckingStrategyName​(String invalidRepresentation,
                                                                 List<String> validRepresentations)

      • configurationPropertyTrackingDisabled

        @LogMessage(level=INFO)
@Message(id=567,
         value="Configuration property tracking is disabled; unused properties will not be logged.")
void configurationPropertyTrackingDisabled()

      • configurationPropertyTrackingUnusedProperties

        @LogMessage(level=WARN)
@Message(id=568,
         value="Invalid configuration passed to Hibernate Search: some properties in the given configuration are not used. There might be misspelled property keys in your configuration. Unused properties: %1$s. To disable this warning, set the property \'%2$s\' to \'%3$s\'.")
void configurationPropertyTrackingUnusedProperties​(Set<String> propertyKeys,
                                                   String disableWarningKey,
                                                   String disableWarningValue)

      • failureInFailureHandler

        @LogMessage(level=ERROR)
@Message(id=569,
         value="The background failure handler threw an exception while handling a previous failure. The failure may not have been reported.")
void failureInFailureHandler​(@Cause
                             Throwable t)

      • fieldTemplateNameCannotBeNullOrEmpty

        @Message(id=570,
         value="Invalid index field template name \'%1$s\': field template names cannot be null or empty.")
SearchException fieldTemplateNameCannotBeNullOrEmpty​(String templateName,
                                                     @Param
                                                     EventContext context)

      • fieldTemplateNameCannotContainDot

        @Message(id=571,
         value="Invalid index field template name \'%1$s\': field template names cannot contain a dot (\'.\').")
SearchException fieldTemplateNameCannotContainDot​(String relativeFieldName,
                                                  @Param
                                                  EventContext context)

      • unexpectedMultiValuedField

        @Message(id=572,
         value="Inconsistent index data: a supposedly single-valued field returned multiple values. Values: [%1$s, %2$s].")
SearchException unexpectedMultiValuedField​(Object value1,
                                           Object value2)

      • obsoleteConfigurationPropertiesFromSearch5

        @Message(id=573,
         value="Invalid configuration passed to Hibernate Search: some properties in the given configuration are obsolete.Configuration properties changed between Hibernate Search 5 and Hibernate Search 6 Check out the reference documentation and upgrade your configuration. Obsolete properties: %1$s.")
SearchException obsoleteConfigurationPropertiesFromSearch5​(Set<String> propertyKeys)

      • noDefaultBackendRegistered

        @Message(id=575,
         value="No default backend. Check that at least one entity is configured to target the default backend. The following backends can be retrieved by name: %1$s.")
SearchException noDefaultBackendRegistered​(Collection<String> validBackendNames)

      • multipleConfiguredBeanReferencesForType

        @Message(id=576,
         value="Ambiguous bean reference to type \'%1$s\': multiple beans are explicitly defined for this type in Hibernate Search\'s internal registry. Explicitly defined beans: %2$s.")
BeanNotFoundException multipleConfiguredBeanReferencesForType​(@FormatWith(ClassFormatter.class)
                                                              Class<?> exposedType,
                                                              List<? extends BeanReference<?>> references)

      • noConfiguredBeanReferenceForType

        @Message(id=577,
         value="No beans defined for type \'%1$s\' in Hibernate Search\'s internal registry.")
BeanNotFoundException noConfiguredBeanReferenceForType​(@FormatWith(ClassFormatter.class)
                                                       Class<?> exposedType)

      • noConfiguredBeanReferenceForTypeAndName

        @Message(id=578,
         value="No beans defined for type \'%1$s\' and name \'%2$s\' in Hibernate Search\'s internal registry.")
BeanNotFoundException noConfiguredBeanReferenceForTypeAndName​(@FormatWith(ClassFormatter.class)
                                                              Class<?> exposedType,
                                                              String nameReference)

      • failedToResolveBeanUsingInternalRegistry

        @Message("Failed to resolve bean from Hibernate Search\'s internal registry with exception: %1$s")
String failedToResolveBeanUsingInternalRegistry​(String exceptionMessage)

      • failedToResolveBeanUsingBeanManager

        @Message("Failed to resolve bean from bean manager with exception: %1$s")
String failedToResolveBeanUsingBeanManager​(String exceptionMessage)

      • failedToResolveBeanUsingReflection

        @Message("Failed to resolve bean using reflection with exception: %1$s")
String failedToResolveBeanUsingReflection​(String exceptionMessage)

      • noBackendFactoryRegistered

        @Message(id=581,
         value="Unable to resolve backend type: configuration property \'%1$s\' is not set, and there isn\'t any backend in the classpath. Check that you added the desired backend to your project\'s dependencies.")
SearchException noBackendFactoryRegistered​(String propertyKey)

      • multipleBackendFactoriesRegistered

        @Message(id=582,
         value="Ambiguous backend type: configuration property \'%1$s\' is not set, and multiple backend types are present in the classpath. Set property \'%1$s\' to one of the following to select the backend type: %2$s")
SearchException multipleBackendFactoriesRegistered​(String propertyKey,
                                                   Collection<String> backendTypeNames)

      • notExactTotalHitCount

        @Message(id=587,
         value="Unable to provide the exact total hit count: only a lower-bound approximation is available. This is generally the result of setting query options such as a timeout or the total hit count threshold. Either unset these options, or retrieve the lower-bound hit count approximation through \'.total().hitCountLowerBound()\'.")
SearchException notExactTotalHitCount()

      • twoTypesTargetSameIndex

        @Message(id=588,
         value="Multiple entity types mapped to index \'%1$s\': \'%2$s\', \'%3$s\'. Each indexed type must be mapped to its own, dedicated index.")
SearchException twoTypesTargetSameIndex​(String indexName,
                                        String mappedTypeName,
                                        String anotherMappedTypeName)

      • unableToCreateBeanUsingReflection

        @Message(id=589,
         value="Unable to create bean using reflection: %1$s")
BeanNotFoundException unableToCreateBeanUsingReflection​(String causeMessage,
                                                        @Cause
                                                        Exception e)

      • noConfiguredBeanManager

        @Message(id=590,
         value="No configured bean manager.")
BeanNotFoundException noConfiguredBeanManager()

      • invalidBeanRetrieval

        @Message(id=592,
         value="Invalid bean reference: \'%1$s\'. The reference is prefixed with \'%2$s\', which is not a valid bean retrieval prefix. If you want to reference a bean by name, and the name contains a colon, use \'bean:%1$s\'. Otherwise, use a valid bean retrieval prefix among the following: %3$s.")
BeanNotFoundException invalidBeanRetrieval​(String beanReference,
                                           String invalidPrefix,
                                           List<String> validPrefixes,
                                           @Cause
                                           Exception e)

      • relativeNamedPredicateNameCannotBeNullOrEmpty

        @Message(id=593,
         value="Named predicate name \'%1$s\' is invalid: field names cannot be null or empty.")
SearchException relativeNamedPredicateNameCannotBeNullOrEmpty​(String relativeNamedPredicateName,
                                                              @Param
                                                              EventContext context)

      • relativeNamedPredicateNameCannotContainDot

        @Message(id=594,
         value="Named predicate name \'%1$s\' is invalid: field names cannot contain a dot (\'.\'). Remove the dot from your named predicate name.")
SearchException relativeNamedPredicateNameCannotContainDot​(String relativeNamedPredicateName,
                                                           @Param
                                                           EventContext context)

      • differentMultiTenancyNamedBackend

        @Message(id=596,
         value="Different mappings trying to define two backends with the same name \'%1$s\' but having different expectations on multi-tenancy.")
SearchException differentMultiTenancyNamedBackend​(String backendName)

      • differentMultiTenancyDefaultBackend

        @Message(id=597,
         value="Different mappings trying to define default backends having different expectations on multi-tenancy.")
SearchException differentMultiTenancyDefaultBackend()

      • differentAttribute

        @Message(id=603,
         value="Attribute \'%1$s\' differs: \'%2$s\' vs. \'%3$s\'.")
SearchException differentAttribute​(String attributeName,
                                   Object component1,
                                   Object component2)

      • missingSupportHintForValueField

        @Message("Make sure the field is marked as searchable/sortable/projectable/aggregable/highlightable (whichever is relevant). If it already is, then \'%1$s\' is not available for fields of this type.")
String missingSupportHintForValueField​(SearchQueryElementTypeKey<?> key)

      • missingSupportHintForCompositeNode

        @Message("Some object field features require a nested structure; try setting the field structure to \'NESTED\' and reindexing all your data. If you are trying to use another feature, it probably isn\'t available for this field.")
String missingSupportHintForCompositeNode()

      • partialSupportForQueryElement

        @Message(id=606,
         value="\'%1$s\' can be used in some of the targeted indexes, but not all of them. %2$s")
SearchException partialSupportForQueryElement​(SearchQueryElementTypeKey<?> key,
                                              String hint)

      • partialSupportHintForValueField

        @Message("Make sure the field is marked as searchable/sortable/projectable/aggregable/highlightable (whichever is relevant) in all indexes, and that the field has the same type in all indexes.")
String partialSupportHintForValueField()

      • partialSupportHintForCompositeNode

        @Message("If you are trying to use the \'nested\' predicate, set the field structure is to \'NESTED\' in all indexes, then reindex all your data.")
String partialSupportHintForCompositeNode()

      • conflictingFieldModel

        @Message(id=609,
         value="This field is a value field in some indexes, but an object field in other indexes.")
SearchException conflictingFieldModel()

      • unknownFieldForSearch

        @Message(id=610,
         value="Unknown field \'%1$s\'.")
SearchException unknownFieldForSearch​(String absoluteFieldPath,
                                      @Param
                                      EventContext context)

      • unableToCloseSavedValue

        @Message(id=612,
         value="Unable to close saved value for key %1$s: %2$s")
SearchException unableToCloseSavedValue​(String keyName,
                                        String message,
                                        @Cause
                                        Exception e)

      • noIntegrationBecauseInitializationNotComplete

        @Message(id=613,
         value="Unable to access the Search integration: initialization hasn\'t completed yet.")
SearchException noIntegrationBecauseInitializationNotComplete()

      • cannotCreateEntityProjection

        @Message(id=614,
         value="Cannot project on entity type \'%1$s\': this type cannot be loaded from an external datasource, and the documents from the index cannot be projected to its Java class \'%2$s\'. %3$s")
SearchException cannotCreateEntityProjection​(String name,
                                             @FormatWith(ClassFormatter.class)
                                             Class<?> javaClass,
                                             String hint)

      • ignoringServiceConfigurationError

        @LogMessage(level=DEBUG)
@Message(id=616,
         value="Ignoring ServiceConfigurationError caught while trying to instantiate service \'%s\'.")
void ignoringServiceConfigurationError​(Class<?> serviceContract,
                                       @Cause
                                       ServiceConfigurationError error)

      • paramNotDefined

        @Message(id=617,
         value="Parameter with name \'%1$s\' was not defined on projection definition \'%2$s\'.")
SearchException paramNotDefined​(String paramName,
                                ProjectionDefinition<?> definition)

      • invalidTypeForEntityProjection

        @Message(id=618,
         value="Invalid type for entity projection on type \'%1$s\': the entity type\'s Java class \'%2$s\' does not extend the requested projection type \'%3$s\'.")
SearchException invalidTypeForEntityProjection​(String name,
                                               @FormatWith(ClassFormatter.class)
                                               Class<?> entityType,
                                               @FormatWith(ClassFormatter.class)
                                               Class<?> requestedEntityType)

      • cannotIncludeAndExcludePathsWithinSameFilter

        @Message(id=619,
         value="\'includePaths\' and \'excludePaths\' cannot be used together in the same filter. Use either `includePaths` or `excludePaths` leaving the other one empty. Included paths are: \'%1$s\', excluded paths are: \'%2$s\'.")
SearchException cannotIncludeAndExcludePathsWithinSameFilter​(Set<String> includePaths,
                                                             Set<String> excludePaths)

      • multipleConfigurationProvidersAvailable

        @LogMessage(level=DEBUG)
@Message(id=620,
         value="Multiple configuration providers are available for scope \'%1$s\'. They will be taken under consideration in the following order: \'%2$s\'.")
void multipleConfigurationProvidersAvailable​(String scope,
                                             List<ConfigurationProvider> configurationProviders)