HSEARCH-1727 Review API structure of SearchFactory: which methods sho…

…uld be exposed on API vs SPI vs hidden as implementation

backends/jgroups/src/test/java/org/hibernate/search/test/jgroups/common/InjectedChannelTest.java

@@ -8,9 +8,9 @@
 
 import org.hibernate.cfg.Configuration;
 import org.hibernate.search.cfg.Environment;
-import org.hibernate.search.engine.spi.SearchFactoryImplementor;
 import org.hibernate.search.backend.jgroups.impl.DispatchMessageSender;
 import org.hibernate.search.backend.jgroups.impl.MessageSenderService;
+import org.hibernate.search.spi.SearchFactoryIntegrator;
 import org.hibernate.search.util.configuration.impl.ConfigurationParseHelper;
 import org.jgroups.JChannel;
 import org.junit.Test;
@@ -29,7 +29,7 @@ public class InjectedChannelTest extends JGroupsCommonTest {
 
 	@Test
 	public void testInjectionHappened() throws Exception {
-		SearchFactoryImplementor searchFactory = getSearchFactory().unwrap( SearchFactoryImplementor.class );
+		SearchFactoryIntegrator searchFactory = getSearchFactory().unwrap( SearchFactoryIntegrator.class );
 		MessageSenderService sender = searchFactory.getServiceManager().requestService( MessageSenderService.class );
 		Assert.assertTrue( masterChannel.getAddress().equals( sender.getAddress() ) );
 	}

backends/jgroups/src/test/java/org/hibernate/search/test/jgroups/common/MuxChannelTest.java

@@ -10,9 +10,9 @@
 
 import org.hibernate.cfg.Configuration;
 import org.hibernate.search.cfg.Environment;
-import org.hibernate.search.engine.spi.SearchFactoryImplementor;
 import org.hibernate.search.backend.jgroups.impl.DispatchMessageSender;
 import org.hibernate.search.backend.jgroups.impl.MessageSenderService;
+import org.hibernate.search.spi.SearchFactoryIntegrator;
 import org.hibernate.search.util.configuration.impl.ConfigurationParseHelper;
 import org.jgroups.JChannel;
 import org.jgroups.blocks.mux.MuxUpHandler;
@@ -33,7 +33,7 @@ public abstract class MuxChannelTest extends JGroupsCommonTest {
 
 	@Test
 	public void testMuxDispatcher() throws Exception {
-		SearchFactoryImplementor searchFactory = getSearchFactory().unwrap( SearchFactoryImplementor.class );
+		SearchFactoryIntegrator searchFactory = getSearchFactory().unwrap( SearchFactoryIntegrator.class );
 		MessageSenderService sender = searchFactory.getServiceManager().requestService( MessageSenderService.class );
 		Assert.assertNotNull( sender );
 		String className = sender.getClass().getName();

engine/src/main/java/org/hibernate/search/engine/spi/SearchFactoryImplementor.java

@@ -83,13 +83,6 @@ public interface SearchFactoryImplementor extends SearchFactoryIntegrator {
 	 */
 	Properties getConfigurationProperties();
 
-	/**
-	 * Returns the service manager.
-	 *
-	 * @return Returns the service manager.
-	 */
-	ServiceManager getServiceManager();
-
 	/**
 	 * Returns the default {@code DatabaseRetrievalMethod}.
 	 *

engine/src/main/java/org/hibernate/search/spi/SearchFactoryIntegrator.java

@@ -10,6 +10,7 @@
 
 import org.apache.lucene.analysis.Analyzer;
 import org.hibernate.search.backend.spi.Worker;
+import org.hibernate.search.engine.service.spi.ServiceManager;
 import org.hibernate.search.engine.spi.EntityIndexBinding;
 import org.hibernate.search.exception.ErrorHandler;
 import org.hibernate.search.indexes.IndexReaderAccessor;
@@ -49,12 +50,6 @@ public interface SearchFactoryIntegrator {
 	 */
 	void addClasses(Class<?>... classes);
 
-	//TODO consider accepting SearchConfiguration or SearchMapping
-
-	Worker getWorker();
-
-	void close();
-
 	/**
 	 * Return an Hibernate Search query object.
 	 * This object uses fluent APIs to define the query executed.
@@ -78,10 +73,13 @@ public interface SearchFactoryIntegrator {
 	 */
 	ErrorHandler getErrorHandler();
 
+	/**
+	 * Useful if you need to create custom exception types to represent query timeouts.
+	 *
+	 * @return the configured TimeoutExceptionFactory
+	 */
 	TimeoutExceptionFactory getDefaultTimeoutExceptionFactory();
 
-	// Below are copied from SearchFactory:
-
 	/**
 	 * Optimize all indexes
 	 */
@@ -94,7 +92,6 @@ public interface SearchFactoryIntegrator {
 	 */
 	void optimize(Class entityType);
 
-
 	/**
 	 * Retrieve an analyzer instance by its definition name
 	 *
@@ -162,4 +159,21 @@ public interface SearchFactoryIntegrator {
 	 */
 	<T> T unwrap(Class<T> cls);
 
+	/**
+	 * Returns the service manager.
+	 *
+	 * @return Returns the service manager.
+	 */
+	ServiceManager getServiceManager();
+
+	/**
+	 * The Worker is the entry point to apply writes and updates to the indexes.
+	 */
+	Worker getWorker();
+
+	/**
+	 * Shuts down all workers and releases all resources.
+	 */
+	void close();
+
 }

orm/src/test/java/org/hibernate/search/test/backend/WorkQueueLengthConfiguredTest.java

@@ -9,9 +9,9 @@
 
 import org.hibernate.search.backend.impl.lucene.LuceneBackendQueueProcessor;
 import org.hibernate.search.engine.spi.EntityIndexBinding;
-import org.hibernate.search.engine.spi.SearchFactoryImplementor;
 import org.hibernate.search.indexes.impl.DirectoryBasedIndexManager;
 import org.hibernate.search.indexes.spi.IndexManager;
+import org.hibernate.search.spi.SearchFactoryIntegrator;
 import org.hibernate.search.test.SearchTestBase;
 import org.junit.Test;
 
@@ -32,7 +32,7 @@ protected Class<?>[] getAnnotatedClasses() {
 
 	@Test
 	public void testNothingTest() {
-		SearchFactoryImplementor searchFactory = getSearchFactory().unwrap( SearchFactoryImplementor.class );
+		SearchFactoryIntegrator searchFactory = getSearchFactory().unwrap( SearchFactoryIntegrator.class );
 		EntityIndexBinding indexBindingForEntity = searchFactory.getIndexBinding( Clock.class );
 		IndexManager[] indexManagers = indexBindingForEntity.getIndexManagers();
 		assertEquals( 1, indexManagers.length );