org.hibernate.search.backend.lucene.lowlevel.directory.spi

Interface DirectoryCreationContext

public interface DirectoryCreationContext

Method Summary

Modifier and Type	Method and Description
org.hibernate.search.util.common.reporting.EventContext	getEventContext()
String	getIndexName()
Optional<String>	getShardId()
void	initializeIndexIfNeeded(Directory directory) Initialize the Lucene Directory if it isn't already.

Method Detail

getEventContext

org.hibernate.search.util.common.reporting.EventContext getEventContext()

Returns:

The event context to use for exceptions.

getIndexName

String getIndexName()

Returns:

The name of the index in Hibernate Search.

getShardId

Optional<String> getShardId()

Returns:

The identifier of the index shard, if relevant.

initializeIndexIfNeeded

void initializeIndexIfNeeded(Directory directory)
                      throws IOException

Initialize the Lucene Directory if it isn't already.

Parameters:

directory - the Directory to initialize

Throws:

IOException - If an IOException is thrown while initializing the index.

org.hibernate.search.util.common.SearchException - In case of lock acquisition timeouts, IOException, or if a corrupt index is found