DATAES-739 - Introduce nullable annotations for API validation.

Original PR: spring-projects#387

Author: sothawo

src/main/java/org/springframework/data/elasticsearch/ElasticsearchException.java

@@ -17,15 +17,18 @@
 
 import java.util.Map;
 
+import org.springframework.lang.Nullable;
+
 /**
  * ElasticsearchException
  *
  * @author Rizwan Idrees
  * @author Mohsin Husen
+ * @author Peter-Josef Meisch
  */
 public class ElasticsearchException extends RuntimeException {
 
-	private Map<String, String> failedDocuments;
+	@Nullable private Map<String, String> failedDocuments;
 
 	public ElasticsearchException(String message) {
 		super(message);
@@ -45,6 +48,7 @@ public ElasticsearchException(String message, Map<String, String> failedDocument
 		this.failedDocuments = failedDocuments;
 	}
 
+	@Nullable
 	public Map<String, String> getFailedDocuments() {
 		return failedDocuments;
 	}

src/main/java/org/springframework/data/elasticsearch/annotations/package-info.java

@@ -0,0 +1,3 @@
+@org.springframework.lang.NonNullApi
+@org.springframework.lang.NonNullFields
+package org.springframework.data.elasticsearch.annotations;

src/main/java/org/springframework/data/elasticsearch/client/ClientConfigurationBuilder.java

@@ -54,11 +54,11 @@ class ClientConfigurationBuilder
 	private @Nullable HostnameVerifier hostnameVerifier;
 	private Duration connectTimeout = Duration.ofSeconds(10);
 	private Duration soTimeout = Duration.ofSeconds(5);
-	private String username;
-	private String password;
-	private String pathPrefix;
-	private String proxy;
-	private Function<WebClient, WebClient> webClientConfigurer;
+	private @Nullable String username;
+	private @Nullable String password;
+	private @Nullable String pathPrefix;
+	private @Nullable String proxy;
+	private @Nullable Function<WebClient, WebClient> webClientConfigurer;
 
 	/*
 	 * (non-Javadoc)

src/main/java/org/springframework/data/elasticsearch/client/NodeClientFactoryBean.java

@@ -32,7 +32,9 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.FactoryBeanNotInitializedException;
 import org.springframework.beans.factory.InitializingBean;
+import org.springframework.lang.Nullable;
 import org.springframework.util.StringUtils;
 
 /**
@@ -48,12 +50,12 @@ public class NodeClientFactoryBean implements FactoryBean<Client>, InitializingB
 	private static final Logger logger = LoggerFactory.getLogger(NodeClientFactoryBean.class);
 	private boolean local;
 	private boolean enableHttp;
-	private String clusterName;
-	private Node node;
-	private NodeClient nodeClient;
-	private String pathData;
-	private String pathHome;
-	private String pathConfiguration;
+	private @Nullable String clusterName;
+	private @Nullable Node node;
+	private @Nullable NodeClient nodeClient;
+	private @Nullable String pathData;
+	private @Nullable String pathHome;
+	private @Nullable String pathConfiguration;
 
 	public static class TestNode extends Node {
 
@@ -82,6 +84,11 @@ public NodeClientFactoryBean(boolean local) {
 
 	@Override
 	public NodeClient getObject() {
+
+		if (nodeClient == null) {
+			throw new FactoryBeanNotInitializedException();
+		}
+
 		return nodeClient;
 	}
 

src/main/java/org/springframework/data/elasticsearch/client/RestClientFactoryBean.java

@@ -25,18 +25,21 @@
 import org.elasticsearch.client.RestHighLevelClient;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.FactoryBeanNotInitializedException;
 import org.springframework.beans.factory.InitializingBean;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
  * RestClientFactoryBean
  *
  * @author Don Wellington
+ * @author Peter-Josef Meisch
  */
 @Slf4j
 public class RestClientFactoryBean implements FactoryBean<RestHighLevelClient>, InitializingBean, DisposableBean {
 
-	private RestHighLevelClient client;
+	private @Nullable RestHighLevelClient client;
 	private String hosts = "http://localhost:9200";
 	static final String COMMA = ",";
 
@@ -59,6 +62,11 @@ public void afterPropertiesSet() throws Exception {
 
 	@Override
 	public RestHighLevelClient getObject() {
+
+		if (client == null) {
+			throw new FactoryBeanNotInitializedException();
+		}
+
 		return client;
 	}
 
@@ -75,6 +83,7 @@ public boolean isSingleton() {
 	protected void buildClient() throws Exception {
 
 		Assert.hasText(hosts, "[Assertion Failed] At least one host must be set.");
+
 		ArrayList<HttpHost> httpHosts = new ArrayList<>();
 		for (String host : hosts.split(COMMA)) {
 			URL hostUrl = new URL(host);

src/main/java/org/springframework/data/elasticsearch/client/TransportClientFactoryBean.java

@@ -24,7 +24,9 @@
 import org.slf4j.LoggerFactory;
 import org.springframework.beans.factory.DisposableBean;
 import org.springframework.beans.factory.FactoryBean;
+import org.springframework.beans.factory.FactoryBeanNotInitializedException;
 import org.springframework.beans.factory.InitializingBean;
+import org.springframework.lang.Nullable;
 
 /**
  * TransportClientFactoryBean
@@ -48,8 +50,8 @@ public class TransportClientFactoryBean implements FactoryBean<TransportClient>,
 	private Boolean clientIgnoreClusterName = Boolean.FALSE;
 	private String clientPingTimeout = "5s";
 	private String clientNodesSamplerInterval = "5s";
-	private TransportClient client;
-	private Properties properties;
+	private @Nullable TransportClient client;
+	private @Nullable Properties properties;
 
 	@Override
 	public void destroy() {
@@ -65,6 +67,10 @@ public void destroy() {
 
 	@Override
 	public TransportClient getObject() {
+
+		if (clientTransportSniff == null) {
+			throw new FactoryBeanNotInitializedException();
+		}
 		return client;
 	}
 

src/main/java/org/springframework/data/elasticsearch/client/package-info.java

@@ -0,0 +1,3 @@
+@org.springframework.lang.NonNullApi
+@org.springframework.lang.NonNullFields
+package org.springframework.data.elasticsearch.client;

src/main/java/org/springframework/data/elasticsearch/client/reactive/DefaultReactiveElasticsearchClient.java

@@ -865,8 +865,9 @@ private static class ScrollState {
 		private final Object lock = new Object();
 
 		private final List<String> pastIds = new ArrayList<>(1);
-		private String scrollId;
+		@Nullable private String scrollId;
 
+		@Nullable
 		String getScrollId() {
 			return scrollId;
 		}

src/main/java/org/springframework/data/elasticsearch/client/reactive/WebClientProvider.java

@@ -105,6 +105,7 @@ static WebClientProvider create(String scheme, @Nullable ClientHttpConnector con
 	 * @return the pathPrefix if set.
 	 * @since 4.0
 	 */
+	@Nullable
 	String getPathPrefix();
 
 	/**
@@ -133,7 +134,9 @@ static WebClientProvider create(String scheme, @Nullable ClientHttpConnector con
 	WebClientProvider withPathPrefix(String pathPrefix);
 
 	/**
-	 * Create a new instance of {@link WebClientProvider} calling the given {@link Function} to configure the {@link WebClient}.
+	 * Create a new instance of {@link WebClientProvider} calling the given {@link Function} to configure the
+	 * {@link WebClient}.
+	 * 
 	 * @param webClientConfigurer configuration function
 	 * @return new instance of {@link WebClientProvider}
 	 * @since 4.0

src/main/java/org/springframework/data/elasticsearch/client/reactive/package-info.java

@@ -1,6 +1,3 @@
-/**
- * Everything required for a Reactive Elasticsearch client.
- */
 @org.springframework.lang.NonNullApi
 @org.springframework.lang.NonNullFields
 package org.springframework.data.elasticsearch.client.reactive;

src/main/java/org/springframework/data/elasticsearch/client/util/package-info.java

@@ -0,0 +1,3 @@
+@org.springframework.lang.NonNullApi
+@org.springframework.lang.NonNullFields
+package org.springframework.data.elasticsearch.client.util;

src/main/java/org/springframework/data/elasticsearch/config/package-info.java

@@ -0,0 +1,3 @@
+@org.springframework.lang.NonNullApi
+@org.springframework.lang.NonNullFields
+package org.springframework.data.elasticsearch.config;

src/main/java/org/springframework/data/elasticsearch/core/AbstractElasticsearchTemplate.java

@@ -31,6 +31,7 @@
 import org.springframework.data.elasticsearch.core.query.NativeSearchQueryBuilder;
 import org.springframework.data.elasticsearch.core.query.Query;
 import org.springframework.data.util.CloseableIterator;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -41,9 +42,9 @@
  */
 public abstract class AbstractElasticsearchTemplate implements ElasticsearchOperations, ApplicationContextAware {
 
-	protected ElasticsearchConverter elasticsearchConverter;
-	protected RequestFactory requestFactory;
-	protected IndexOperations indexOperations;
+	protected @Nullable ElasticsearchConverter elasticsearchConverter;
+	protected @Nullable RequestFactory requestFactory;
+	protected @Nullable IndexOperations indexOperations;
 
 	// region Initialization
 	protected void initialize(ElasticsearchConverter elasticsearchConverter, IndexOperations indexOperations) {
@@ -74,6 +75,9 @@ public void setApplicationContext(ApplicationContext context) throws BeansExcept
 	// region getter/setter
 	@Override
 	public IndexOperations getIndexOperations() {
+
+		Assert.notNull("indexOperations are not initialized");
+
 		return indexOperations;
 	}
 	// endregion
@@ -159,13 +163,19 @@ public List<SearchHits<?>> multiSearch(List<? extends Query> queries, List<Class
 	// region Helper methods
 	@Override
 	public ElasticsearchConverter getElasticsearchConverter() {
+
+		Assert.notNull(elasticsearchConverter, "elasticsearchConverter is not initialized.");
+
 		return elasticsearchConverter;
 	}
 
 	/**
 	 * @since 4.0
 	 */
 	public RequestFactory getRequestFactory() {
+
+		Assert.notNull(requestFactory, "requestfactory not initialized");
+
 		return requestFactory;
 	}
 

src/main/java/org/springframework/data/elasticsearch/core/CriteriaFilterProcessor.java

@@ -34,6 +34,7 @@
 import org.springframework.data.geo.Distance;
 import org.springframework.data.geo.Metrics;
 import org.springframework.data.geo.Point;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -100,7 +101,9 @@ private List<QueryBuilder> createFilterFragmentForCriteria(Criteria chainedCrite
 		return filterList;
 	}
 
+	@Nullable
 	private QueryBuilder processCriteriaEntry(OperationKey key, Object value, String fieldName) {
+
 		if (value == null) {
 			return null;
 		}

src/main/java/org/springframework/data/elasticsearch/core/CriteriaQueryProcessor.java

@@ -30,6 +30,7 @@
 import org.elasticsearch.index.query.BoolQueryBuilder;
 import org.elasticsearch.index.query.QueryBuilder;
 import org.springframework.data.elasticsearch.core.query.Criteria;
+import org.springframework.lang.Nullable;
 import org.springframework.util.Assert;
 
 /**
@@ -46,8 +47,8 @@
 class CriteriaQueryProcessor {
 
 	QueryBuilder createQueryFromCriteria(Criteria criteria) {
-		if (criteria == null)
-			return null;
+
+		Assert.notNull(criteria, "criteria must not be null");
 
 		List<QueryBuilder> shouldQueryBuilderList = new LinkedList<>();
 		List<QueryBuilder> mustNotQueryBuilderList = new LinkedList<>();
@@ -109,6 +110,7 @@ QueryBuilder createQueryFromCriteria(Criteria criteria) {
 		return query;
 	}
 
+	@Nullable
 	private QueryBuilder createQueryFragmentForCriteria(Criteria chainedCriteria) {
 		if (chainedCriteria.getQueryCriteriaEntries().isEmpty())
 			return null;
@@ -135,6 +137,7 @@ private QueryBuilder createQueryFragmentForCriteria(Criteria chainedCriteria) {
 		return query;
 	}
 
+	@Nullable
 	private QueryBuilder processCriteriaEntry(Criteria.CriteriaEntry entry, String fieldName) {
 		OperationKey key = entry.getKey();
 		Object value = entry.getValue();

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchRestTemplate.java

@@ -93,10 +93,12 @@ public class ElasticsearchRestTemplate extends AbstractElasticsearchTemplate {
 
 	// region Initialization
 	public ElasticsearchRestTemplate(RestHighLevelClient client) {
+		this.client = client;
 		initialize(client, createElasticsearchConverter());
 	}
 
 	public ElasticsearchRestTemplate(RestHighLevelClient client, ElasticsearchConverter elasticsearchConverter) {
+		this.client = client;
 		initialize(client, elasticsearchConverter);
 	}
 
@@ -210,7 +212,7 @@ private void doBulkOperation(List<?> queries, BulkOptions bulkOptions, IndexCoor
 
 	// region SearchOperations
 	@Override
-	public long count(Query query, Class<?> clazz, IndexCoordinates index) {
+	public long count(Query query,@Nullable Class<?> clazz, IndexCoordinates index) {
 
 		Assert.notNull(query, "query must not be null");
 		Assert.notNull(index, "index must not be null");

src/main/java/org/springframework/data/elasticsearch/core/ElasticsearchTemplate.java

@@ -83,14 +83,16 @@ public class ElasticsearchTemplate extends AbstractElasticsearchTemplate {
 			.getLogger("org.springframework.data.elasticsearch.core.QUERY");
 
 	private Client client;
-	private String searchTimeout;
+	@Nullable private String searchTimeout;
 
 	// region Initialization
 	public ElasticsearchTemplate(Client client) {
+		this.client = client;
 		initialize(client, createElasticsearchConverter());
 	}
 
 	public ElasticsearchTemplate(Client client, ElasticsearchConverter elasticsearchConverter) {
+		this.client = client;
 		initialize(client, elasticsearchConverter);
 	}
 
@@ -102,6 +104,7 @@ private void initialize(Client client, ElasticsearchConverter elasticsearchConve
 	// endregion
 
 	// region getter/setter
+	@Nullable
 	public String getSearchTimeout() {
 		return searchTimeout;
 	}

src/main/java/org/springframework/data/elasticsearch/core/RequestFactory.java

@@ -867,6 +867,7 @@ private ElasticsearchPersistentEntity<?> getPersistentEntity(@Nullable Class<?>
 		return clazz != null ? elasticsearchConverter.getMappingContext().getPersistentEntity(clazz) : null;
 	}
 
+	@Nullable
 	private String getPersistentEntityId(Object entity) {
 
 		Object identifier = elasticsearchConverter.getMappingContext() //

src/main/java/org/springframework/data/elasticsearch/core/ResourceUtil.java

@@ -21,6 +21,7 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.springframework.core.io.ClassPathResource;
+import org.springframework.lang.Nullable;
 import org.springframework.util.StreamUtils;
 
 /**
@@ -40,6 +41,7 @@ public abstract class ResourceUtil {
 	 * @param url
 	 * @return
 	 */
+	@Nullable
 	public static String readFileFromClasspath(String url) {
 
 		ClassPathResource classPathResource = new ClassPathResource(url);