WALKey (Apache HBase 1.1.7 API)

java.lang.Object
- org.apache.hadoop.hbase.wal.WALKey

All Implemented Interfaces:

Comparable<WALKey>, SequenceId

Direct Known Subclasses:

HLogKey
```
@InterfaceAudience.LimitedPrivate(value="Replication")
public class WALKey
extends Object
implements SequenceId, Comparable<WALKey>
```
A Key for an entry in the change log. The log intermingles edits to many tables and rows, so each log entry identifies the appropriate table and row. Within a table and row, they're also sorted.
Some Transactional edits (START, COMMIT, ABORT) will not have an associated row. Note that protected members marked @InterfaceAudience.Private are only protected to support the legacy HLogKey class, which is in a different package.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static class WALKey.Version

Nested Classes
Modifier and Type	Class and Description
`protected static class`	`WALKey.Version`

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<UUID>`	`clusterIds`
`protected CompressionContext`	`compressionContext`
`protected byte[]`	`encodedRegionName`
`static org.apache.commons.logging.Log`	`LOG`
`protected long`	`logSeqNum`
`static long`	`NO_SEQUENCE_ID` Used to represent when a particular wal key doesn't know/care about the sequence ordering.
`protected TableName`	`tablename`
`protected static WALKey.Version`	`VERSION`
`protected long`	`writeTime`

Constructor Summary

Constructors
Constructor and Description
`WALKey()`
`WALKey(byte[] encodedRegionName, TableName tablename)`
`WALKey(byte[] encodedRegionName, TableName tablename, long now)`
`WALKey(byte[] encodedRegionName, TableName tablename, long now, List<UUID> clusterIds, long nonceGroup, long nonce)` Create the log key for writing to somewhere.
`WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, List<UUID> clusterIds, long nonceGroup, long nonce)` Create the log key for writing to somewhere.
`WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long nonceGroup, long nonce)` Create the log key for writing to somewhere.
`WALKey(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, UUID clusterId)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addClusterId(UUID clusterId)` Marks that the cluster with the given clusterId has consumed the change
`int`	`compareTo(WALKey o)`
`boolean`	`equals(Object obj)`
`WALProtos.WALKey.Builder`	`getBuilder(WALCellCodec.ByteStringCompressor compressor)`
`List<UUID>`	`getClusterIds()`
`byte[]`	`getEncodedRegionName()`
`long`	`getLogSeqNum()`
`long`	`getNonce()`
`long`	`getNonceGroup()`
`UUID`	`getOriginatingClusterId()`
`long`	`getOrigLogSeqNum()` Return a positive long if current WALKey is created from a replay edit
`NavigableMap<byte[],Integer>`	`getScopes()`
`long`	`getSequenceId()`
`long`	`getSequenceId(long maxWaitForSeqId)` Wait for sequence number to be assigned & return the assigned value.
`TableName`	`getTablename()`
`long`	`getWriteTime()`
`int`	`hashCode()`
`protected void`	`init(byte[] encodedRegionName, TableName tablename, long logSeqNum, long now, List<UUID> clusterIds, long nonceGroup, long nonce)`
`void`	`readFieldsFromPb(WALProtos.WALKey walKey, WALCellCodec.ByteStringUncompressor uncompressor)`
`void`	`readOlderScopes(NavigableMap<byte[],Integer> scopes)`
`void`	`setCompressionContext(CompressionContext compressionContext)`
`void`	`setLogSeqNum(long sequence)` Allow that the log sequence id to be set post-construction and release all waiters on assigned sequence number.
`void`	`setOrigLogSeqNum(long seqId)` Used to set original seq Id for WALKey during wal replay
`void`	`setScopes(NavigableMap<byte[],Integer> scopes)`
`String`	`toString()`
`Map<String,Object>`	`toStringMap()` Produces a string map for this key.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LOG
```
public static final org.apache.commons.logging.Log LOG
```
  - VERSION
```
@InterfaceAudience.Private
protected static final WALKey.Version VERSION
```
  - NO_SEQUENCE_ID
```
public static final long NO_SEQUENCE_ID
```
    Used to represent when a particular wal key doesn't know/care about the sequence ordering.
    
    See Also:
    Constant Field Values
  - encodedRegionName
```
@InterfaceAudience.Private
protected byte[] encodedRegionName
```
  - tablename
```
@InterfaceAudience.Private
protected TableName tablename
```
  - logSeqNum
```
@InterfaceAudience.Private
protected long logSeqNum
```
  - writeTime
```
@InterfaceAudience.Private
protected long writeTime
```
  - clusterIds
```
@InterfaceAudience.Private
protected List<UUID> clusterIds
```
  - compressionContext
```
@InterfaceAudience.Private
protected CompressionContext compressionContext
```
- Constructor Detail
  - WALKey
```
public WALKey()
```
  - WALKey
```
public WALKey(byte[] encodedRegionName,
      TableName tablename,
      long logSeqNum,
      long now,
      UUID clusterId)
```
  - WALKey
```
public WALKey(byte[] encodedRegionName,
      TableName tablename)
```
  - WALKey
```
public WALKey(byte[] encodedRegionName,
      TableName tablename,
      long now)
```
  - WALKey
```
public WALKey(byte[] encodedRegionName,
      TableName tablename,
      long logSeqNum,
      long now,
      List<UUID> clusterIds,
      long nonceGroup,
      long nonce)
```
    Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.
    Used by log splitting and snapshots.
    
    Parameters:
    encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().
    tablename - - name of table
    logSeqNum - - log sequence number
    now - Time at which this edit was written.
    clusterIds - the clusters that have consumed the change(used in Replication)
  - WALKey
```
public WALKey(byte[] encodedRegionName,
      TableName tablename,
      long now,
      List<UUID> clusterIds,
      long nonceGroup,
      long nonce)
```
    Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.
    
    Parameters:
    encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().
    tablename -
    now - Time at which this edit was written.
    clusterIds - the clusters that have consumed the change(used in Replication)
    nonceGroup -
    nonce -
  - WALKey
```
public WALKey(byte[] encodedRegionName,
      TableName tablename,
      long logSeqNum,
      long nonceGroup,
      long nonce)
```
    Create the log key for writing to somewhere. We maintain the tablename mainly for debugging purposes. A regionName is always a sub-table object.
    
    Parameters:
    encodedRegionName - Encoded name of the region as returned by HRegionInfo#getEncodedNameAsBytes().
    tablename -
    logSeqNum -
    nonceGroup -
    nonce -
- Method Detail
  - init
```
@InterfaceAudience.Private
protected void init(byte[] encodedRegionName,
                                  TableName tablename,
                                  long logSeqNum,
                                  long now,
                                  List<UUID> clusterIds,
                                  long nonceGroup,
                                  long nonce)
```
  - setCompressionContext
```
public void setCompressionContext(CompressionContext compressionContext)
```
    Parameters:
    compressionContext - Compression context to use
  - getEncodedRegionName
```
public byte[] getEncodedRegionName()
```
    Returns:
    encoded region name
  - getTablename
```
public TableName getTablename()
```
    Returns:
    table name
  - getLogSeqNum
```
public long getLogSeqNum()
```
    Returns:
    log sequence number
  - setLogSeqNum
```
@InterfaceAudience.Private
public void setLogSeqNum(long sequence)
```
    Allow that the log sequence id to be set post-construction and release all waiters on assigned sequence number. Only public for FSWALEntry
    
    Parameters:
    sequence -
  - setOrigLogSeqNum
```
public void setOrigLogSeqNum(long seqId)
```
    Used to set original seq Id for WALKey during wal replay
    
    Parameters:
    seqId -
  - getOrigLogSeqNum
```
public long getOrigLogSeqNum()
```
    Return a positive long if current WALKey is created from a replay edit
    
    Returns:
    original sequence number of the WALEdit
  - getSequenceId
```
public long getSequenceId()
                   throws IOException
```
    Specified by:
    
    getSequenceId in interface SequenceId
    
    Throws:
    
    IOException
  - getSequenceId
```
public long getSequenceId(long maxWaitForSeqId)
                   throws IOException
```
    Wait for sequence number to be assigned & return the assigned value.
    
    Parameters:
    maxWaitForSeqId - maximum time to wait in milliseconds for sequenceid
    
    Returns:
    long the new assigned sequence number
    
    Throws:
    
    InterruptedException
    
    IOException
  - getWriteTime
```
public long getWriteTime()
```
    Returns:
    the write time
  - getScopes
```
public NavigableMap<byte[],Integer> getScopes()
```
  - getNonceGroup
```
public long getNonceGroup()
```
    Returns:
    The nonce group
  - getNonce
```
public long getNonce()
```
    Returns:
    The nonce
  - setScopes
```
public void setScopes(NavigableMap<byte[],Integer> scopes)
```
  - readOlderScopes
```
public void readOlderScopes(NavigableMap<byte[],Integer> scopes)
```
  - addClusterId
```
public void addClusterId(UUID clusterId)
```
    Marks that the cluster with the given clusterId has consumed the change
  - getClusterIds
```
public List<UUID> getClusterIds()
```
    Returns:
    the set of cluster Ids that have consumed the change
  - getOriginatingClusterId
```
public UUID getOriginatingClusterId()
```
    Returns:
    the cluster id on which the change has originated. It there is no such cluster, it returns DEFAULT_CLUSTER_ID (cases where replication is not enabled)
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - toStringMap
```
public Map<String,Object> toStringMap()
```
    Produces a string map for this key. Useful for programmatic use and manipulation of the data stored in an WALKey, for example, printing as JSON.
    
    Returns:
    a Map containing data from this key
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - compareTo
```
public int compareTo(WALKey o)
```
    Specified by:
    
    compareTo in interface Comparable<WALKey>
  - getBuilder
```
public WALProtos.WALKey.Builder getBuilder(WALCellCodec.ByteStringCompressor compressor)
                                    throws IOException
```
    Throws:
    
    IOException
  - readFieldsFromPb
```
public void readFieldsFromPb(WALProtos.WALKey walKey,
                    WALCellCodec.ByteStringUncompressor uncompressor)
                      throws IOException
```
    Throws:
    
    IOException

Class WALKey

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LOG

VERSION

NO_SEQUENCE_ID

encodedRegionName

tablename

logSeqNum

writeTime

clusterIds

compressionContext

Constructor Detail

WALKey

WALKey

WALKey

WALKey

WALKey

WALKey

WALKey

Method Detail

init

setCompressionContext

getEncodedRegionName

getTablename

getLogSeqNum

setLogSeqNum

setOrigLogSeqNum

getOrigLogSeqNum

getSequenceId

getSequenceId

getWriteTime

getScopes

getNonceGroup

getNonce

setScopes

readOlderScopes

addClusterId

getClusterIds

getOriginatingClusterId

toString

toStringMap

equals

hashCode

compareTo

getBuilder

readFieldsFromPb