Skip to content

Commit cb5ec45

Browse files
committed
HSEARCH-5464 More renames to address JQAssistant rules
1 parent fd48a1d commit cb5ec45

File tree

35 files changed

+143
-105
lines changed

35 files changed

+143
-105
lines changed

backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/logging/spi/ElasticsearchClientCommonLog.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77

88
import static org.jboss.logging.Logger.Level.TRACE;
99

10+
import org.hibernate.search.util.common.annotation.impl.SuppressJQAssistant;
1011
import org.hibernate.search.util.common.logging.impl.MessageConstants;
1112

1213
import org.jboss.logging.annotations.LogMessage;
@@ -22,6 +23,10 @@
2223
// Exceptions for legacy messages from Search 5 (engine module)
2324
@ValidIdRange(min = 35, max = 35),
2425
})
26+
@SuppressJQAssistant(
27+
reason = "Apache HTTP Client 5 uses a lot of classes/interfaces in the impl packages to create builders/instances etc. "
28+
+
29+
"So while it is bad to expose impl types ... in this case it's what Apache Client expects users to do?")
2530
public interface ElasticsearchClientCommonLog
2631
extends ElasticsearchRequestLog, ElasticsearchClientLog {
2732

backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/logging/spi/ElasticsearchClientConfigurationLog.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
import java.util.List;
1313

1414
import org.hibernate.search.util.common.SearchException;
15+
import org.hibernate.search.util.common.annotation.impl.SuppressJQAssistant;
1516
import org.hibernate.search.util.common.logging.CategorizedLogger;
1617
import org.hibernate.search.util.common.logging.impl.LoggerFactory;
1718
import org.hibernate.search.util.common.logging.impl.MessageConstants;
@@ -29,6 +30,10 @@
2930
"""
3031
)
3132
@MessageLogger(projectCode = MessageConstants.PROJECT_CODE)
33+
@SuppressJQAssistant(
34+
reason = "Apache HTTP Client 5 uses a lot of classes/interfaces in the impl packages to create builders/instances etc. "
35+
+
36+
"So while it is bad to expose impl types ... in this case it's what Apache Client expects users to do?")
3237
public interface ElasticsearchClientConfigurationLog {
3338
String CATEGORY_NAME = "org.hibernate.search.configuration.elasticsearch.client";
3439

backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/logging/spi/ElasticsearchClientLog.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import org.hibernate.search.util.common.AssertionFailure;
1919
import org.hibernate.search.util.common.SearchException;
2020
import org.hibernate.search.util.common.SearchTimeoutException;
21+
import org.hibernate.search.util.common.annotation.impl.SuppressJQAssistant;
2122
import org.hibernate.search.util.common.logging.CategorizedLogger;
2223
import org.hibernate.search.util.common.logging.impl.ClassFormatter;
2324
import org.hibernate.search.util.common.logging.impl.DurationInSecondsAndFractionsFormatter;
@@ -42,6 +43,10 @@
4243
"""
4344
)
4445
@MessageLogger(projectCode = MessageConstants.PROJECT_CODE)
46+
@SuppressJQAssistant(
47+
reason = "Apache HTTP Client 5 uses a lot of classes/interfaces in the impl packages to create builders/instances etc. "
48+
+
49+
"So while it is bad to expose impl types ... in this case it's what Apache Client expects users to do?")
4550
public interface ElasticsearchClientLog {
4651
String CATEGORY_NAME = "org.hibernate.search.elasticsearch.client";
4752

backend/elasticsearch-client/common/src/main/java/org/hibernate/search/backend/elasticsearch/client/common/logging/spi/ElasticsearchRequestLog.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
import java.lang.invoke.MethodHandles;
88
import java.util.Map;
99

10+
import org.hibernate.search.util.common.annotation.impl.SuppressJQAssistant;
1011
import org.hibernate.search.util.common.logging.CategorizedLogger;
1112
import org.hibernate.search.util.common.logging.impl.LoggerFactory;
1213
import org.hibernate.search.util.common.logging.impl.MessageConstants;
@@ -25,6 +26,10 @@
2526
"""
2627
)
2728
@MessageLogger(projectCode = MessageConstants.PROJECT_CODE)
29+
@SuppressJQAssistant(
30+
reason = "Apache HTTP Client 5 uses a lot of classes/interfaces in the impl packages to create builders/instances etc. "
31+
+
32+
"So while it is bad to expose impl types ... in this case it's what Apache Client expects users to do?")
2833
public interface ElasticsearchRequestLog extends BasicLogger {
2934
/**
3035
* This is the category of the Logger used to print out executed Elasticsearch requests,

backend/elasticsearch-client/elasticsearch-java-client/src/main/java/org/hibernate/search/backend/elasticsearch/client/java/ElasticsearchHttpClientConfigurationContext.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,17 @@
77

88
import org.hibernate.search.engine.cfg.ConfigurationPropertySource;
99
import org.hibernate.search.engine.environment.bean.BeanResolver;
10+
import org.hibernate.search.util.common.annotation.impl.SuppressJQAssistant;
1011

1112
import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder;
1213

1314

1415
/**
1516
* The context passed to {@link ElasticsearchHttpClientConfigurer}.
1617
*/
18+
@SuppressJQAssistant(
19+
reason = "Apache HTTP Client 5 uses a lot of classes/interfaces in the impl packages to create builders/instances etc. "
20+
+ "So while it is bad to expose impl types ... in this case it's what Apache Client expects users to do?")
1721
public interface ElasticsearchHttpClientConfigurationContext {
1822

1923
/**
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
*
1616
* @author Gunnar Morling
1717
*/
18-
public final class ElasticsearchBackendClientSettings {
18+
public final class ClientJavaElasticsearchBackendClientSettings {
1919

20-
private ElasticsearchBackendClientSettings() {
20+
private ClientJavaElasticsearchBackendClientSettings() {
2121
}
2222

2323
/**
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
/**
1010
* Configuration properties for the Elasticsearch backend that are considered SPI (and not API).
1111
*/
12-
public final class ElasticsearchBackendClientSpiSettings {
12+
public final class ClientJavaElasticsearchBackendClientSpiSettings {
1313

1414
/**
1515
* The prefix expected for the key of every Hibernate Search configuration property.
@@ -35,7 +35,7 @@ public final class ElasticsearchBackendClientSpiSettings {
3535
*/
3636
public static final String CLIENT_INSTANCE = "client.instance";
3737

38-
private ElasticsearchBackendClientSpiSettings() {
38+
private ClientJavaElasticsearchBackendClientSpiSettings() {
3939
}
4040

4141
/**
Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
import org.apache.hc.core5.http.impl.EnglishReasonPhraseCatalog;
4848
import org.apache.hc.core5.util.Timeout;
4949

50-
public class ElasticsearchClientImpl implements ElasticsearchClientImplementor {
50+
public class ClientJavaElasticsearchClient implements ElasticsearchClientImplementor {
5151

5252
private final BeanHolder<? extends Rest5Client> restClientHolder;
5353

@@ -56,20 +56,18 @@ public class ElasticsearchClientImpl implements ElasticsearchClientImplementor {
5656
private final SimpleScheduledExecutor timeoutExecutorService;
5757

5858
private final Optional<Integer> requestTimeoutMs;
59-
private final int connectionTimeoutMs;
6059

6160
private final Gson gson;
6261
private final JsonLogHelper jsonLogHelper;
6362

64-
ElasticsearchClientImpl(BeanHolder<? extends Rest5Client> restClientHolder, Sniffer sniffer,
63+
ClientJavaElasticsearchClient(BeanHolder<? extends Rest5Client> restClientHolder, Sniffer sniffer,
6564
SimpleScheduledExecutor timeoutExecutorService,
66-
Optional<Integer> requestTimeoutMs, int connectionTimeoutMs,
65+
Optional<Integer> requestTimeoutMs,
6766
Gson gson, JsonLogHelper jsonLogHelper) {
6867
this.restClientHolder = restClientHolder;
6968
this.sniffer = sniffer;
7069
this.timeoutExecutorService = timeoutExecutorService;
7170
this.requestTimeoutMs = requestTimeoutMs;
72-
this.connectionTimeoutMs = connectionTimeoutMs;
7371
this.gson = gson;
7472
this.jsonLogHelper = jsonLogHelper;
7573
}
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@
99
import org.hibernate.search.engine.environment.bean.spi.BeanConfigurationContext;
1010
import org.hibernate.search.engine.environment.bean.spi.BeanConfigurer;
1111

12-
public class ElasticsearchClientBeanConfigurer implements BeanConfigurer {
12+
public class ClientJavaElasticsearchClientBeanConfigurer implements BeanConfigurer {
1313
@Override
1414
public void configure(BeanConfigurationContext context) {
1515
context.define(
1616
ElasticsearchClientFactory.class, "elasticsearch-java",
17-
beanResolver -> BeanHolder.of( new ElasticsearchClientFactoryImpl() )
17+
beanResolver -> BeanHolder.of( new ClientJavaElasticsearchClientFactory() )
1818
);
1919
}
2020
}
Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515
import org.hibernate.search.backend.elasticsearch.client.common.spi.ElasticsearchClientFactory;
1616
import org.hibernate.search.backend.elasticsearch.client.common.spi.ElasticsearchClientImplementor;
1717
import org.hibernate.search.backend.elasticsearch.client.java.ElasticsearchHttpClientConfigurer;
18-
import org.hibernate.search.backend.elasticsearch.client.java.cfg.ElasticsearchBackendClientSettings;
19-
import org.hibernate.search.backend.elasticsearch.client.java.cfg.spi.ElasticsearchBackendClientSpiSettings;
18+
import org.hibernate.search.backend.elasticsearch.client.java.cfg.ClientJavaElasticsearchBackendClientSettings;
19+
import org.hibernate.search.backend.elasticsearch.client.java.cfg.spi.ClientJavaElasticsearchBackendClientSpiSettings;
2020
import org.hibernate.search.engine.cfg.ConfigurationPropertySource;
2121
import org.hibernate.search.engine.cfg.spi.ConfigurationProperty;
2222
import org.hibernate.search.engine.cfg.spi.OptionalConfigurationProperty;
@@ -51,10 +51,10 @@
5151
/**
5252
* @author Gunnar Morling
5353
*/
54-
public class ElasticsearchClientFactoryImpl implements ElasticsearchClientFactory {
54+
public class ClientJavaElasticsearchClientFactory implements ElasticsearchClientFactory {
5555

5656
private static final OptionalConfigurationProperty<BeanReference<? extends Rest5Client>> CLIENT_INSTANCE =
57-
ConfigurationProperty.forKey( ElasticsearchBackendClientSpiSettings.CLIENT_INSTANCE )
57+
ConfigurationProperty.forKey( ClientJavaElasticsearchBackendClientSpiSettings.CLIENT_INSTANCE )
5858
.asBeanReference( Rest5Client.class )
5959
.build();
6060

@@ -132,7 +132,7 @@ public class ElasticsearchClientFactoryImpl implements ElasticsearchClientFactor
132132

133133
private static final OptionalConfigurationProperty<
134134
BeanReference<? extends ElasticsearchHttpClientConfigurer>> CLIENT_CONFIGURER =
135-
ConfigurationProperty.forKey( ElasticsearchBackendClientSettings.CLIENT_CONFIGURER )
135+
ConfigurationProperty.forKey( ClientJavaElasticsearchBackendClientSettings.CLIENT_CONFIGURER )
136136
.asBeanReference( ElasticsearchHttpClientConfigurer.class )
137137
.build();
138138

@@ -147,7 +147,6 @@ public ElasticsearchClientImplementor create(BeanResolver beanResolver, Configur
147147
SimpleScheduledExecutor timeoutExecutorService,
148148
GsonProvider gsonProvider) {
149149
Optional<Integer> requestTimeoutMs = REQUEST_TIMEOUT.get( propertySource );
150-
int connectionTimeoutMs = CONNECTION_TIMEOUT.get( propertySource );
151150

152151
Optional<BeanHolder<? extends Rest5Client>> providedRestClientHolder = CLIENT_INSTANCE.getAndMap(
153152
propertySource, beanResolver::resolve );
@@ -166,9 +165,9 @@ public ElasticsearchClientImplementor create(BeanResolver beanResolver, Configur
166165
sniffer = createSniffer( propertySource, restClientHolder.get(), hosts );
167166
}
168167

169-
return new ElasticsearchClientImpl(
168+
return new ClientJavaElasticsearchClient(
170169
restClientHolder, sniffer, timeoutExecutorService,
171-
requestTimeoutMs, connectionTimeoutMs,
170+
requestTimeoutMs,
172171
gsonProvider.getGson(), gsonProvider.getLogHelper()
173172
);
174173
}
@@ -301,8 +300,8 @@ private HttpAsyncClientBuilder customizeHttpClientConfig(HttpAsyncClientBuilder
301300
builder.setKeepAliveStrategy( new CustomConnectionKeepAliveStrategy( maxKeepAlive.get() ) );
302301
}
303302

304-
ElasticsearchHttpClientConfigurationContextImpl clientConfigurationContext =
305-
new ElasticsearchHttpClientConfigurationContextImpl( beanResolver, propertySource, builder );
303+
ClientJavaElasticsearchHttpClientConfigurationContext clientConfigurationContext =
304+
new ClientJavaElasticsearchHttpClientConfigurationContext( beanResolver, propertySource, builder );
306305

307306
for ( ElasticsearchHttpClientConfigurer configurer : configurers ) {
308307
configurer.configure( clientConfigurationContext );

0 commit comments

Comments
 (0)