org.hibernate.search.engine.common.spi.SearchIntegration Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of hibernate-search-engine Show documentation

Hibernate Search engine, always required

There is a newer version: 8.0.0.Alpha1

Show newest version

/*
 * SPDX-License-Identifier: Apache-2.0
 * Copyright Red Hat Inc. and Hibernate Authors
 */
package org.hibernate.search.engine.common.spi;

import java.util.Optional;

import org.hibernate.search.engine.backend.Backend;
import org.hibernate.search.engine.backend.index.IndexManager;
import org.hibernate.search.engine.common.impl.SearchIntegrationBuilder;
import org.hibernate.search.engine.mapper.mapping.building.spi.MappingInitiator;
import org.hibernate.search.engine.mapper.mapping.building.spi.MappingKey;
import org.hibernate.search.engine.mapper.mapping.building.spi.MappingPartialBuildState;

public interface SearchIntegration extends AutoCloseable {

	Backend backend();

	Backend backend(String backendName);

	IndexManager indexManager(String indexManagerName);

	Builder restartBuilder(SearchIntegrationEnvironment environment);

	@Override
	void close();

	static Builder builder(SearchIntegrationEnvironment environment) {
		return new SearchIntegrationBuilder( environment, Optional.empty() );
	}

	interface Builder {

		 Builder addMappingInitiator(
				MappingKey mappingKey, MappingInitiator initiator);

		SearchIntegrationPartialBuildState prepareBuild();

	}

	interface Handle {

		/**
		 * @return The {@link SearchIntegration}, if available.
		 * @throws org.hibernate.search.util.common.SearchException If the {@link SearchIntegration} hasn't been completely started yet.
		 */
		SearchIntegration getOrFail();

		/**
		 * @return The {@link SearchIntegration}, if available, or {@code null}.
		 */
		SearchIntegration getOrNull();

	}
}