Package io.confluent.kafka.schemaregistry.storage

Class OffsetCheckpoint

java.lang.Object

io.confluent.kafka.schemaregistry.storage.OffsetCheckpoint

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

OffsetCheckpointReadOnly

public class OffsetCheckpoint
extends Object
implements Closeable

This class saves out a map of topic/partition=>offsets to a file. The format of the file is UTF-8 text containing the following:

   <version>
   <n>
   <topic_name_1> <partition_1> <offset_1>
   .
   .
   .
   <topic_name_n> <partition_n> <offset_n>
 

The first line contains a number designating the format version (currently 0), the get line contains a number giving the total number of offsets. Each successive line gives a topic/partition/offset triple separated by spaces.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECKPOINT_FILE_NAME
protected final File	file
static final String	LOCK_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
OffsetCheckpoint(String checkpointDir, int version, String topic)

Method Summary

Modifier and Type	Method	Description
protected File	baseDir(String checkpointDir, String topic)
void	close()
void	delete()
Map<org.apache.kafka.common.TopicPartition,Long>	read()	Reads the offsets from the local checkpoint file, skipping any negative offsets it finds.
protected void	setUpLockFile(File baseDir)
String	toString()
void	write(Map<org.apache.kafka.common.TopicPartition,Long> offsets)	Write the given offsets to the checkpoint file.

Methods inherited from class java.lang.Object

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

Field Details

CHECKPOINT_FILE_NAME

public static final String CHECKPOINT_FILE_NAME

See Also:

• Constant Field Values

LOCK_FILE_NAME

public static final String LOCK_FILE_NAME

See Also:

• Constant Field Values

file

protected final File file

Constructor Details

OffsetCheckpoint

public OffsetCheckpoint(String checkpointDir,
 int version,
 String topic)
                 throws IOException

Throws:

IOException

Method Details

setUpLockFile

protected void setUpLockFile(File baseDir)
                      throws IOException

Throws:

IOException

baseDir

protected File baseDir(String checkpointDir,
 String topic)
                throws IOException

Throws:

IOException

write

public void write(Map<org.apache.kafka.common.TopicPartition,Long> offsets)
           throws IOException

Write the given offsets to the checkpoint file. All offsets should be non-negative.

Throws:

IOException - if any file operation fails with an IO exception

read

public Map<org.apache.kafka.common.TopicPartition,Long> read()
                                                      throws IOException

Reads the offsets from the local checkpoint file, skipping any negative offsets it finds.

Throws:

IOException - if any file operation fails with an IO exception

IllegalArgumentException - if the offset checkpoint version is unknown

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

delete

public void delete()
            throws IOException

Throws:

IOException - if there is any IO exception during delete

toString

public String toString()

Overrides:

toString in class Object