Skip to content

Commit

Permalink
HSEARCH-3464 Use consistent naming for *Settings class with respect t…
Browse files Browse the repository at this point in the history
…o Maven modules
  • Loading branch information
yrodiere authored and fax4ever committed Jan 23, 2019
1 parent f292039 commit 344a805
Show file tree
Hide file tree
Showing 38 changed files with 145 additions and 145 deletions.
Expand Up @@ -7,14 +7,14 @@
package org.hibernate.search.backend.elasticsearch.analysis;

import org.hibernate.search.backend.elasticsearch.analysis.model.dsl.ElasticsearchAnalysisDefinitionContainerContext;
import org.hibernate.search.backend.elasticsearch.cfg.SearchBackendElasticsearchSettings;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings;

/**
* An object responsible for configuring analysis in an Elasticsearch backend,
* providing analysis-related definitions that can be referenced from the mapping.
* <p>
* Users can select an analysis configurer through the
* {@link SearchBackendElasticsearchSettings#ANALYSIS_CONFIGURER configuration properties}.
* {@link ElasticsearchBackendSettings#ANALYSIS_CONFIGURER configuration properties}.
*
* @author Yoann Rodiere
*/
Expand Down
Expand Up @@ -14,9 +14,9 @@
*
* @author Gunnar Morling
*/
public final class SearchBackendElasticsearchSettings {
public final class ElasticsearchBackendSettings {

private SearchBackendElasticsearchSettings() {
private ElasticsearchBackendSettings() {
}

public static final String HOST = "host";
Expand Down
Expand Up @@ -9,9 +9,9 @@
/**
* Configuration properties common to all Hibernate Search indexes regardless of the underlying technology.
*/
public final class SearchIndexElasticsearchSettings {
public final class ElasticsearchIndexSettings {

private SearchIndexElasticsearchSettings() {
private ElasticsearchIndexSettings() {
}

public static final String REFRESH_AFTER_WRITE = "refresh_after_write";
Expand Down
Expand Up @@ -13,9 +13,9 @@
/**
* Configuration properties for the Elasticsearch backend that are considered SPI (and not API).
*/
public final class SearchBackendElasticsearchSpiSettings {
public final class ElasticsearchBackendSpiSettings {

private SearchBackendElasticsearchSpiSettings() {
private ElasticsearchBackendSpiSettings() {
}

public static final String CLIENT_FACTORY = "client_factory";
Expand Down
Expand Up @@ -22,7 +22,7 @@
import org.elasticsearch.client.sniff.NodesSniffer;
import org.elasticsearch.client.sniff.Sniffer;
import org.elasticsearch.client.sniff.SnifferBuilder;
import org.hibernate.search.backend.elasticsearch.cfg.SearchBackendElasticsearchSettings;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings;
import org.hibernate.search.backend.elasticsearch.client.spi.ElasticsearchClientFactory;
import org.hibernate.search.backend.elasticsearch.client.spi.ElasticsearchClientImplementor;
import org.hibernate.search.backend.elasticsearch.gson.spi.GsonProvider;
Expand All @@ -38,67 +38,67 @@
public class ElasticsearchClientFactoryImpl implements ElasticsearchClientFactory {

private static final ConfigurationProperty<List<String>> HOST =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.HOST )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.HOST )
.asString().multivalued( Pattern.compile( "\\s+" ) )
.withDefault( SearchBackendElasticsearchSettings.Defaults.HOST )
.withDefault( ElasticsearchBackendSettings.Defaults.HOST )
.build();

private static final OptionalConfigurationProperty<String> USERNAME =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.USERNAME )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.USERNAME )
.asString()
.build();

private static final OptionalConfigurationProperty<String> PASSWORD =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.PASSWORD )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.PASSWORD )
.asString()
.build();

private static final ConfigurationProperty<Integer> REQUEST_TIMEOUT =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.REQUEST_TIMEOUT )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.REQUEST_TIMEOUT )
.asInteger()
.withDefault( SearchBackendElasticsearchSettings.Defaults.REQUEST_TIMEOUT )
.withDefault( ElasticsearchBackendSettings.Defaults.REQUEST_TIMEOUT )
.build();

private static final ConfigurationProperty<Integer> READ_TIMEOUT =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.READ_TIMEOUT )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.READ_TIMEOUT )
.asInteger()
.withDefault( SearchBackendElasticsearchSettings.Defaults.READ_TIMEOUT )
.withDefault( ElasticsearchBackendSettings.Defaults.READ_TIMEOUT )
.build();

private static final ConfigurationProperty<Integer> CONNECTION_TIMEOUT =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.CONNECTION_TIMEOUT )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.CONNECTION_TIMEOUT )
.asInteger()
.withDefault( SearchBackendElasticsearchSettings.Defaults.CONNECTION_TIMEOUT )
.withDefault( ElasticsearchBackendSettings.Defaults.CONNECTION_TIMEOUT )
.build();

private static final ConfigurationProperty<Integer> MAX_TOTAL_CONNECTION =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.MAX_TOTAL_CONNECTION )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.MAX_TOTAL_CONNECTION )
.asInteger()
.withDefault( SearchBackendElasticsearchSettings.Defaults.MAX_TOTAL_CONNECTION )
.withDefault( ElasticsearchBackendSettings.Defaults.MAX_TOTAL_CONNECTION )
.build();

private static final ConfigurationProperty<Integer> MAX_TOTAL_CONNECTION_PER_ROUTE =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.MAX_TOTAL_CONNECTION_PER_ROUTE )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.MAX_TOTAL_CONNECTION_PER_ROUTE )
.asInteger()
.withDefault( SearchBackendElasticsearchSettings.Defaults.MAX_TOTAL_CONNECTION_PER_ROUTE )
.withDefault( ElasticsearchBackendSettings.Defaults.MAX_TOTAL_CONNECTION_PER_ROUTE )
.build();

private static final ConfigurationProperty<Boolean> DISCOVERY_ENABLED =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.DISCOVERY_ENABLED )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.DISCOVERY_ENABLED )
.asBoolean()
.withDefault( SearchBackendElasticsearchSettings.Defaults.DISCOVERY_ENABLED )
.withDefault( ElasticsearchBackendSettings.Defaults.DISCOVERY_ENABLED )
.build();

private static final ConfigurationProperty<Integer> DISCOVERY_REFRESH_INTERVAL =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.DISCOVERY_REFRESH_INTERVAL )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.DISCOVERY_REFRESH_INTERVAL )
.asInteger()
.withDefault( SearchBackendElasticsearchSettings.Defaults.DISCOVERY_REFRESH_INTERVAL )
.withDefault( ElasticsearchBackendSettings.Defaults.DISCOVERY_REFRESH_INTERVAL )
.build();

private static final ConfigurationProperty<String> DISCOVERY_SCHEME =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.DISCOVERY_SCHEME )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.DISCOVERY_SCHEME )
.asString()
.withDefault( SearchBackendElasticsearchSettings.Defaults.DISCOVERY_SCHEME )
.withDefault( ElasticsearchBackendSettings.Defaults.DISCOVERY_SCHEME )
.build();

/* TODO ElasticsearchHttpClientConfigurer
Expand Down
Expand Up @@ -13,8 +13,8 @@
import org.hibernate.search.backend.elasticsearch.analysis.model.dsl.impl.ElasticsearchAnalysisDefinitionContainerContextImpl;
import org.hibernate.search.backend.elasticsearch.analysis.model.impl.ElasticsearchAnalysisDefinitionRegistry;
import org.hibernate.search.backend.elasticsearch.cfg.MultiTenancyStrategyConfiguration;
import org.hibernate.search.backend.elasticsearch.cfg.SearchBackendElasticsearchSettings;
import org.hibernate.search.backend.elasticsearch.cfg.spi.SearchBackendElasticsearchSpiSettings;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings;
import org.hibernate.search.backend.elasticsearch.cfg.spi.ElasticsearchBackendSpiSettings;
import org.hibernate.search.backend.elasticsearch.client.spi.ElasticsearchClientFactory;
import org.hibernate.search.backend.elasticsearch.client.spi.ElasticsearchClientImplementor;
import org.hibernate.search.backend.elasticsearch.document.model.impl.esnative.FieldDataType;
Expand Down Expand Up @@ -58,25 +58,25 @@ public class ElasticsearchBackendFactory implements BackendFactory {
private static final Log log = LoggerFactory.make( Log.class, MethodHandles.lookup() );

private static final ConfigurationProperty<MultiTenancyStrategyConfiguration> MULTI_TENANCY_STRATEGY =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.MULTI_TENANCY_STRATEGY )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.MULTI_TENANCY_STRATEGY )
.as( MultiTenancyStrategyConfiguration.class, MultiTenancyStrategyConfiguration::fromExternalRepresentation )
.withDefault( SearchBackendElasticsearchSettings.Defaults.MULTI_TENANCY_STRATEGY )
.withDefault( ElasticsearchBackendSettings.Defaults.MULTI_TENANCY_STRATEGY )
.build();

private static final ConfigurationProperty<Boolean> LOG_JSON_PRETTY_PRINTING =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.LOG_JSON_PRETTY_PRINTING )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.LOG_JSON_PRETTY_PRINTING )
.asBoolean()
.withDefault( SearchBackendElasticsearchSettings.Defaults.LOG_JSON_PRETTY_PRINTING )
.withDefault( ElasticsearchBackendSettings.Defaults.LOG_JSON_PRETTY_PRINTING )
.build();

private static final ConfigurationProperty<BeanReference<? extends ElasticsearchClientFactory>> CLIENT_FACTORY =
ConfigurationProperty.forKey( SearchBackendElasticsearchSpiSettings.CLIENT_FACTORY )
ConfigurationProperty.forKey( ElasticsearchBackendSpiSettings.CLIENT_FACTORY )
.asBeanReference( ElasticsearchClientFactory.class )
.withDefault( SearchBackendElasticsearchSpiSettings.Defaults.CLIENT_FACTORY )
.withDefault( ElasticsearchBackendSpiSettings.Defaults.CLIENT_FACTORY )
.build();

private static final OptionalConfigurationProperty<BeanReference<? extends ElasticsearchAnalysisConfigurer>> ANALYSIS_CONFIGURER =
ConfigurationProperty.forKey( SearchBackendElasticsearchSettings.ANALYSIS_CONFIGURER )
ConfigurationProperty.forKey( ElasticsearchBackendSettings.ANALYSIS_CONFIGURER )
.asBeanReference( ElasticsearchAnalysisConfigurer.class )
.build();

Expand Down
Expand Up @@ -12,7 +12,7 @@
import java.util.concurrent.ConcurrentHashMap;

import org.hibernate.search.backend.elasticsearch.analysis.model.impl.ElasticsearchAnalysisDefinitionRegistry;
import org.hibernate.search.backend.elasticsearch.cfg.SearchIndexElasticsearchSettings;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchIndexSettings;
import org.hibernate.search.backend.elasticsearch.gson.spi.GsonProvider;
import org.hibernate.search.backend.elasticsearch.client.spi.ElasticsearchClientImplementor;
import org.hibernate.search.backend.elasticsearch.index.settings.impl.ElasticsearchIndexSettingsBuilder;
Expand Down Expand Up @@ -53,9 +53,9 @@ class ElasticsearchBackendImpl implements BackendImplementor<ElasticsearchDocume
private static final Log log = LoggerFactory.make( Log.class, MethodHandles.lookup() );

private static final ConfigurationProperty<Boolean> REFRESH_AFTER_WRITE =
ConfigurationProperty.forKey( SearchIndexElasticsearchSettings.REFRESH_AFTER_WRITE )
ConfigurationProperty.forKey( ElasticsearchIndexSettings.REFRESH_AFTER_WRITE )
.asBoolean()
.withDefault( SearchIndexElasticsearchSettings.Defaults.REFRESH_AFTER_WRITE )
.withDefault( ElasticsearchIndexSettings.Defaults.REFRESH_AFTER_WRITE )
.build();

private final ElasticsearchClientImplementor client;
Expand Down
Expand Up @@ -7,15 +7,15 @@
package org.hibernate.search.backend.lucene.analysis;

import org.hibernate.search.backend.lucene.analysis.model.dsl.LuceneAnalysisDefinitionContainerContext;
import org.hibernate.search.backend.lucene.cfg.SearchBackendLuceneSettings;
import org.hibernate.search.backend.lucene.cfg.LuceneBackendSettings;

/**
* A provider of analysis-related definitions that can be referenced from the mapping,
* e.g. with {@literal @Analyzer(definition = "some-name")}
* or {@literal @Normalizer(definition = "some-other-name")}.
* <p>
* Users can select a definition provider through the
* {@link SearchBackendLuceneSettings#ANALYSIS_CONFIGURER configuration properties}.
* {@link LuceneBackendSettings#ANALYSIS_CONFIGURER configuration properties}.
*
* @author Yoann Rodiere
*/
Expand Down
Expand Up @@ -11,9 +11,9 @@
/**
* Configuration properties for Lucene,
*/
public final class SearchBackendLuceneSettings {
public final class LuceneBackendSettings {

private SearchBackendLuceneSettings() {
private LuceneBackendSettings() {
}

/**
Expand Down
Expand Up @@ -19,7 +19,7 @@
import org.hibernate.search.backend.lucene.analysis.model.dsl.impl.InitialLuceneAnalysisDefinitionContainerContext;
import org.hibernate.search.backend.lucene.analysis.model.impl.LuceneAnalysisDefinitionRegistry;
import org.hibernate.search.backend.lucene.cfg.MultiTenancyStrategyConfiguration;
import org.hibernate.search.backend.lucene.cfg.SearchBackendLuceneSettings;
import org.hibernate.search.backend.lucene.cfg.LuceneBackendSettings;
import org.hibernate.search.backend.lucene.index.impl.DirectoryProvider;
import org.hibernate.search.backend.lucene.logging.impl.Log;
import org.hibernate.search.backend.lucene.multitenancy.impl.DiscriminatorMultiTenancyStrategy;
Expand Down Expand Up @@ -51,29 +51,29 @@ public class LuceneBackendFactory implements BackendFactory {
private static final Log log = LoggerFactory.make( Log.class, MethodHandles.lookup() );

private static final ConfigurationProperty<Optional<Version>> LUCENE_VERSION =
ConfigurationProperty.forKey( SearchBackendLuceneSettings.LUCENE_VERSION )
ConfigurationProperty.forKey( LuceneBackendSettings.LUCENE_VERSION )
.as( Version.class, LuceneBackendFactory::parseLuceneVersion )
.build();

private static final OptionalConfigurationProperty<String> DIRECTORY_PROVIDER =
ConfigurationProperty.forKey( SearchBackendLuceneSettings.DIRECTORY_PROVIDER )
ConfigurationProperty.forKey( LuceneBackendSettings.DIRECTORY_PROVIDER )
.asString()
.build();

private static final ConfigurationProperty<Path> ROOT_DIRECTORY =
ConfigurationProperty.forKey( SearchBackendLuceneSettings.ROOT_DIRECTORY )
ConfigurationProperty.forKey( LuceneBackendSettings.ROOT_DIRECTORY )
.as( Path.class, Paths::get )
.withDefault( () -> Paths.get( "." ) )
.build();

private static final ConfigurationProperty<MultiTenancyStrategyConfiguration> MULTI_TENANCY_STRATEGY =
ConfigurationProperty.forKey( SearchBackendLuceneSettings.MULTI_TENANCY_STRATEGY )
ConfigurationProperty.forKey( LuceneBackendSettings.MULTI_TENANCY_STRATEGY )
.as( MultiTenancyStrategyConfiguration.class, MultiTenancyStrategyConfiguration::fromExternalRepresentation )
.withDefault( SearchBackendLuceneSettings.Defaults.MULTI_TENANCY_STRATEGY )
.withDefault( LuceneBackendSettings.Defaults.MULTI_TENANCY_STRATEGY )
.build();

private static final OptionalConfigurationProperty<BeanReference<? extends LuceneAnalysisConfigurer>> ANALYSIS_CONFIGURER =
ConfigurationProperty.forKey( SearchBackendLuceneSettings.ANALYSIS_CONFIGURER )
ConfigurationProperty.forKey( LuceneBackendSettings.ANALYSIS_CONFIGURER )
.asBeanReference( LuceneAnalysisConfigurer.class )
.build();

Expand Down Expand Up @@ -111,7 +111,7 @@ private Version getLuceneVersion(EventContext backendContext, ConfigurationPrope
}
}
else {
Version latestVersion = SearchBackendLuceneSettings.Defaults.LUCENE_VERSION;
Version latestVersion = LuceneBackendSettings.Defaults.LUCENE_VERSION;
log.recommendConfiguringLuceneVersion(
LUCENE_VERSION.resolveOrRaw( propertySource ),
latestVersion,
Expand Down
Expand Up @@ -12,8 +12,8 @@
import java.util.List;
import javax.persistence.EntityManagerFactory;

import org.hibernate.search.backend.elasticsearch.cfg.SearchBackendElasticsearchSettings;
import org.hibernate.search.backend.lucene.cfg.SearchBackendLuceneSettings;
import org.hibernate.search.backend.elasticsearch.cfg.ElasticsearchBackendSettings;
import org.hibernate.search.backend.lucene.cfg.LuceneBackendSettings;
import org.hibernate.search.mapper.orm.Search;
import org.hibernate.search.mapper.orm.jpa.FullTextEntityManager;
import org.hibernate.search.mapper.orm.jpa.FullTextQuery;
Expand Down Expand Up @@ -53,7 +53,7 @@ public OrmSetupHelper.SetupContext startSetup(OrmSetupHelper setupHelper) {
return setupHelper.withBackend( "lucene", BACKEND_NAME )
.withBackendProperty(
BACKEND_NAME,
SearchBackendLuceneSettings.ANALYSIS_CONFIGURER,
LuceneBackendSettings.ANALYSIS_CONFIGURER,
new LuceneSimpleMappingAnalysisConfigurer()
);
}
Expand All @@ -68,7 +68,7 @@ public OrmSetupHelper.SetupContext startSetup(OrmSetupHelper setupHelper) {
return setupHelper.withBackend( "elasticsearch", "backendName" )
.withBackendProperty(
BACKEND_NAME,
SearchBackendElasticsearchSettings.ANALYSIS_CONFIGURER,
ElasticsearchBackendSettings.ANALYSIS_CONFIGURER,
new ElasticsearchSimpleMappingAnalysisConfigurer()
);
}
Expand Down
Expand Up @@ -7,7 +7,7 @@
package org.hibernate.search.engine.backend.spi;

import org.hibernate.search.engine.cfg.ConfigurationPropertySource;
import org.hibernate.search.engine.cfg.SearchBackendCommonSettings;
import org.hibernate.search.engine.cfg.BackendSettings;

/**
* @author Yoann Rodiere
Expand All @@ -20,8 +20,8 @@ public interface BackendFactory {
* @param propertySource A configuration property source, appropriately masked so that the backend
* doesn't need to care about Hibernate Search prefixes (hibernate.search.*, etc.). All the properties
* can be accessed at the root.
* <strong>CAUTION:</strong> the property keys listed in {@link SearchBackendCommonSettings},
* in particular {@value SearchBackendCommonSettings#TYPE} and {@value SearchBackendCommonSettings#INDEX_DEFAULTS},
* <strong>CAUTION:</strong> the property keys listed in {@link BackendSettings},
* in particular {@value BackendSettings#TYPE} and {@value BackendSettings#INDEX_DEFAULTS},
* are reserved for use by the engine.
* @return A backend.
*/
Expand Down
Expand Up @@ -10,7 +10,7 @@
import org.hibernate.search.engine.backend.document.DocumentElement;
import org.hibernate.search.engine.backend.index.spi.IndexManagerBuilder;
import org.hibernate.search.engine.cfg.ConfigurationPropertySource;
import org.hibernate.search.engine.cfg.SearchIndexCommonSettings;
import org.hibernate.search.engine.cfg.IndexSettings;

/**
* @author Yoann Rodiere
Expand All @@ -31,8 +31,8 @@ public interface BackendImplementor<D extends DocumentElement> extends AutoClose
* @param propertySource A configuration property source, appropriately masked so that the backend
* doesn't need to care about Hibernate Search prefixes (hibernate.search.*, etc.). All the properties
* can be accessed at the root.
* <strong>CAUTION:</strong> the property keys listed in {@link SearchIndexCommonSettings},
* in particular {@value SearchIndexCommonSettings#BACKEND},
* <strong>CAUTION:</strong> the property keys listed in {@link IndexSettings},
* in particular {@value IndexSettings#BACKEND},
* are reserved for use by the engine.
* @return A builder for index managers targeting this backend.
*/
Expand Down
Expand Up @@ -9,9 +9,9 @@
/**
* Configuration properties common to all Hibernate Search backends regardless of the underlying technology.
*/
public final class SearchBackendCommonSettings {
public final class BackendSettings {

private SearchBackendCommonSettings() {
private BackendSettings() {
}

/**
Expand Down
Expand Up @@ -16,9 +16,9 @@
/**
* Configuration properties for the Hibernate Search engine.
*/
public final class SearchEngineSettings {
public final class EngineSettings {

private SearchEngineSettings() {
private EngineSettings() {
}

/**
Expand Down

0 comments on commit 344a805

Please sign in to comment.