Package org.apache.cassandra.db.commitlog

Class CommitLogDescriptor

java.lang.Object

org.apache.cassandra.db.commitlog.CommitLogDescriptor

public class CommitLogDescriptor
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final ParameterizedClass	compression
static final int	current_version	Increment this number if there is a changes in the commit log disc layout or MessagingVersion changes.
final long	id
static final int	VERSION_30
static final int	VERSION_40
static final int	VERSION_50

Constructor Summary

Constructors

Constructor	Description
CommitLogDescriptor(int version, long id, ParameterizedClass compression, EncryptionContext encryptionContext)
CommitLogDescriptor(long id, ParameterizedClass compression, EncryptionContext encryptionContext)

Method Summary

Modifier and Type	Method	Description
String	cdcIndexFileName()
boolean	equals(Object that)
boolean	equals(CommitLogDescriptor that)
boolean	equalsIgnoringCompression(CommitLogDescriptor that)
String	fileName()
static CommitLogDescriptor	fromFileName(String name)
static CommitLogDescriptor	fromHeader(File file, EncryptionContext encryptionContext)
EncryptionContext	getEncryptionContext()
int	getMessagingVersion()
static long	idFromFileName(String name)
static File	inferCdcIndexFile(File cdcCommitLogSegment)	Infer the corresponding cdc index file using its cdc commitlog file
static boolean	isValid(String filename)
static CommitLogDescriptor	readHeader(DataInput input, EncryptionContext encryptionContext)
String	toString()
static void	writeHeader(ByteBuffer out, CommitLogDescriptor descriptor)
static void	writeHeader(ByteBuffer out, CommitLogDescriptor descriptor, Map<String,String> additionalHeaders)

Methods inherited from class java.lang.Object

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

Field Details

VERSION_30

public static final int VERSION_30

See Also:

• Constant Field Values

VERSION_40

public static final int VERSION_40

See Also:

• Constant Field Values

VERSION_50

public static final int VERSION_50

See Also:

• Constant Field Values

current_version

public static final int current_version

Increment this number if there is a changes in the commit log disc layout or MessagingVersion changes. Note: make sure to handle getMessagingVersion()

id

public final long id

compression

public final ParameterizedClass compression

Constructor Details

CommitLogDescriptor

public CommitLogDescriptor(int version,
 long id,
 ParameterizedClass compression,
 EncryptionContext encryptionContext)

CommitLogDescriptor

public CommitLogDescriptor(long id,
 ParameterizedClass compression,
 EncryptionContext encryptionContext)

Method Details

writeHeader

public static void writeHeader(ByteBuffer out,
 CommitLogDescriptor descriptor)

writeHeader

public static void writeHeader(ByteBuffer out,
 CommitLogDescriptor descriptor,
 Map<String,String> additionalHeaders)

Parameters:

additionalHeaders - Allow segments to pass custom header data

fromHeader

public static CommitLogDescriptor fromHeader(File file,
 EncryptionContext encryptionContext)

readHeader

public static CommitLogDescriptor readHeader(DataInput input,
 EncryptionContext encryptionContext)
                                      throws IOException

Throws:

IOException

fromFileName

public static CommitLogDescriptor fromFileName(String name)

idFromFileName

public static long idFromFileName(String name)

getMessagingVersion

public int getMessagingVersion()

fileName

public String fileName()

cdcIndexFileName

public String cdcIndexFileName()

inferCdcIndexFile

public static File inferCdcIndexFile(File cdcCommitLogSegment)

Infer the corresponding cdc index file using its cdc commitlog file

Parameters:

cdcCommitLogSegment -

Returns:

cdc index file or null if the cdc index file cannot be inferred.

isValid

public static boolean isValid(String filename)

Parameters:

filename - the filename to check

Returns:

true if filename could be a commit log based on it's filename

getEncryptionContext

public EncryptionContext getEncryptionContext()

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object that)

Overrides:

equals in class Object

equalsIgnoringCompression

public boolean equalsIgnoringCompression(CommitLogDescriptor that)

equals

public boolean equals(CommitLogDescriptor that)