org.apache.lucene.replicator.nrt

Class PrimaryNode

java.lang.Object

org.apache.lucene.replicator.nrt.PrimaryNode

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public abstract class PrimaryNode
extends java.lang.Object

Node that holds an IndexWriter, indexing documents into its local index.

Field Summary

Fields

Modifier and Type	Field and Description
protected Directory	dir
static long	globalStartNS Startup time of original test, carefully propogated to all nodes to produce consistent "seconds since start time" in messages
protected int	id Compact ordinal for this node
protected java.util.Map<java.lang.String,FileMetaData>	lastFileMetaData File metadata for last sync that succeeded; we use this as a cache
static long	localStartNS When this node was started
protected ReferenceManager<IndexSearcher>	mgr
static java.lang.String	PRIMARY_GEN_KEY Key to store the primary gen in the commit data, which increments every time we promote a new primary, so replicas can detect when the primary they were talking to is changed
protected long	primaryGen
protected java.io.PrintStream	printStream For debug logging
protected SearcherFactory	searcherFactory
static java.lang.String	VERSION_KEY Key to store the version in the commit data, which increments every time we open a new NRT reader

Constructor Summary

Constructors

Constructor and Description
PrimaryNode(IndexWriter writer, int id, long primaryGen, long forcePrimaryVersion, SearcherFactory searcherFactory, java.io.PrintStream printStream)

Method Summary

Modifier and Type	Method and Description
static java.lang.String	bytesToString(long bytes)
void	close()
void	commit()
boolean	flushAndRefresh() Flush all index operations to disk and opens a new near-real-time reader.
CopyState	getCopyState() IncRef the current CopyState and return it
long	getCopyStateVersion()
long	getCurrentSearchingVersion()
long	getLastCommitVersion()
boolean	isClosed()
protected void	message(java.lang.String message)
java.lang.String	name()
static void	nodeMessage(java.io.PrintStream printStream, int id, java.lang.String message)
static void	nodeMessage(java.io.PrintStream printStream, java.lang.String message)
protected abstract void	preCopyMergedSegmentFiles(SegmentCommitInfo info, java.util.Map<java.lang.String,FileMetaData> files) Called when a merge has finished, but before IW switches to the merged segment
FileMetaData	readLocalFileMetaData(java.lang.String fileName) Opens the specified file, reads its identifying information, including file length, full index header (includes the unique segment ID) and the full footer (includes checksum), and returns the resulting FileMetaData.
void	releaseCopyState(CopyState copyState) Called once replica is done (or failed) copying an NRT point
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

primaryGen

protected final long primaryGen

PRIMARY_GEN_KEY

public static java.lang.String PRIMARY_GEN_KEY

Key to store the primary gen in the commit data, which increments every time we promote a new primary, so replicas can detect when the primary they were talking to is changed

VERSION_KEY

public static java.lang.String VERSION_KEY

Key to store the version in the commit data, which increments every time we open a new NRT reader

id

protected final int id

Compact ordinal for this node

dir

protected final Directory dir

searcherFactory

protected final SearcherFactory searcherFactory

mgr

protected ReferenceManager<IndexSearcher> mgr

globalStartNS

public static long globalStartNS

Startup time of original test, carefully propogated to all nodes to produce consistent "seconds since start time" in messages

localStartNS

public static final long localStartNS

When this node was started

printStream

protected final java.io.PrintStream printStream

For debug logging

lastFileMetaData

protected volatile java.util.Map<java.lang.String,FileMetaData> lastFileMetaData

File metadata for last sync that succeeded; we use this as a cache

Constructor Detail

PrimaryNode

public PrimaryNode(IndexWriter writer,
                   int id,
                   long primaryGen,
                   long forcePrimaryVersion,
                   SearcherFactory searcherFactory,
                   java.io.PrintStream printStream)
            throws java.io.IOException

Throws:

java.io.IOException

Method Detail

flushAndRefresh

public boolean flushAndRefresh()
                        throws java.io.IOException

Flush all index operations to disk and opens a new near-real-time reader. new NRT point, to make the changes visible to searching. Returns true if there were changes.

Throws:

java.io.IOException

getCopyStateVersion

public long getCopyStateVersion()

getLastCommitVersion

public long getLastCommitVersion()

commit

public void commit()
            throws java.io.IOException

Throws:

java.io.IOException

getCopyState

public CopyState getCopyState()
                       throws java.io.IOException

IncRef the current CopyState and return it

Throws:

java.io.IOException

releaseCopyState

public void releaseCopyState(CopyState copyState)
                      throws java.io.IOException

Called once replica is done (or failed) copying an NRT point

Throws:

java.io.IOException

isClosed

public boolean isClosed()

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

preCopyMergedSegmentFiles

protected abstract void preCopyMergedSegmentFiles(SegmentCommitInfo info,
                                                  java.util.Map<java.lang.String,FileMetaData> files)
                                           throws java.io.IOException

Called when a merge has finished, but before IW switches to the merged segment

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

nodeMessage

public static void nodeMessage(java.io.PrintStream printStream,
                               java.lang.String message)

nodeMessage

public static void nodeMessage(java.io.PrintStream printStream,
                               int id,
                               java.lang.String message)

message

protected void message(java.lang.String message)

name

public java.lang.String name()

getCurrentSearchingVersion

public long getCurrentSearchingVersion()
                                throws java.io.IOException

Throws:

java.io.IOException

bytesToString

public static java.lang.String bytesToString(long bytes)

readLocalFileMetaData

public FileMetaData readLocalFileMetaData(java.lang.String fileName)
                                   throws java.io.IOException

Opens the specified file, reads its identifying information, including file length, full index header (includes the unique segment ID) and the full footer (includes checksum), and returns the resulting FileMetaData.

This returns null, logging a message, if there are any problems (the file does not exist, is corrupt, truncated, etc.).

Throws:

java.io.IOException