org.apache.james.mailbox.hbase

Class HBaseUtils

java.lang.Object

org.apache.james.mailbox.hbase.HBaseUtils

public class HBaseUtils
extends Object

HBase utility classes for mailbox and message manipulation.

Author:

ieugen

Constructor Summary

Constructors

Constructor and Description
HBaseUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	customMessageRowKey(UUID mailboxUid, long value) Utility to build row keys from mailboxUID and a value.
static org.apache.hadoop.hbase.client.Delete	flagsToDelete(Message<UUID> message, javax.mail.Flags flags)
static org.apache.hadoop.hbase.client.Put	flagsToPut(Message<UUID> message, javax.mail.Flags flags) Utility method to transform message flags into a put opperation.
static String	flagsToString(javax.mail.Flags flags) Returns a String composed of all flags in the parameter.
static Mailbox<UUID>	mailboxFromResult(org.apache.hadoop.hbase.client.Result result) Creates a Mailbox object from a HBase Result object.
static byte[]	mailboxRowKey(UUID uuid) This returns the row key needed for HBase.
static Message<UUID>	messageMetaFromResult(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.hbase.client.Result result) Creates a HBaseMessage from a Result object.
static byte[]	messageRowKey(Message<UUID> message) Create a row key for a message in a mailbox.
static byte[]	messageRowKey(UUID mailboxUid, long uid) Utility method to build row keys from mailbox UUID and message uid.
static org.apache.hadoop.hbase.client.Put	metadataToPut(Message<UUID> message) Transforms only the metadata into a Put object.
static org.apache.hadoop.hbase.client.Put	toPut(HBaseMailbox mailbox) Transforms the mailbox into a Put operation.
static org.apache.hadoop.hbase.client.Put	toPut(Subscription subscription) Creates a Put object from this subscription object
static UUID	UUIDFromRowKey(byte[] rowkey) Returns a UUID from the a byte array.

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseUtils

public HBaseUtils()

Method Detail

mailboxFromResult

public static Mailbox<UUID> mailboxFromResult(org.apache.hadoop.hbase.client.Result result)

Creates a Mailbox object from a HBase Result object.

Parameters:

result - a result of a HBase Get operation

Returns:

a Mailbox object

mailboxRowKey

public static byte[] mailboxRowKey(UUID uuid)

This returns the row key needed for HBase. Having the method here ensure we have a consistent way to generate the rowkey. Convenience method for generating a rowKey when you don't have a mailbox object.

Parameters:

uuid -

Returns:

rowkey byte array that can be used with HBase API

UUIDFromRowKey

public static UUID UUIDFromRowKey(byte[] rowkey)

Returns a UUID from the a byte array.

Parameters:

rowkey -

Returns:

UUID calculated from the byte array

toPut

public static org.apache.hadoop.hbase.client.Put toPut(HBaseMailbox mailbox)

Transforms the mailbox into a Put operation.

Returns:

a Put object

metadataToPut

public static org.apache.hadoop.hbase.client.Put metadataToPut(Message<UUID> message)

Transforms only the metadata into a Put object. The rest of the message will be transfered using multiple Puts if size requires it.

Parameters:

message -

Returns:

a put that contains all metadata information.

messageRowKey

public static byte[] messageRowKey(Message<UUID> message)

Create a row key for a message in a mailbox. The current row key is mailboxID followed by messageID. Both values are fixed length so no separator is needed. Downside: we will be storing the same message multiple times, one time for each recipient.

Parameters:

message - message to get row key from

Returns:

rowkey byte array that can be used with HBase API

messageRowKey

public static byte[] messageRowKey(UUID mailboxUid,
                   long uid)

Utility method to build row keys from mailbox UUID and message uid. The message uid's are stored in reverse order by substracting the uid value from Long.MAX_VALUE.

Parameters:

mailboxUid - mailbox UUID

uid - message uid

Returns:

rowkey byte array that can be used with HBase API

customMessageRowKey

public static byte[] customMessageRowKey(UUID mailboxUid,
                         long value)

Utility to build row keys from mailboxUID and a value. The value is added to the key without any other operations.

Parameters:

mailboxUid - mailbox UUID

value -

Returns:

rowkey byte array that can be used with HBase API

messageMetaFromResult

public static Message<UUID> messageMetaFromResult(org.apache.hadoop.conf.Configuration conf,
                                  org.apache.hadoop.hbase.client.Result result)

Creates a HBaseMessage from a Result object. This method retrieves all information except for body and header related bytes. The message content will be loaded on demand through a specialised InputStream called ChunkInputStream. IMPORTANT: the method expects a single version of each cell. Use setMaxVersions(1).

Parameters:

conf - configuration object for HBase cluster

result - the result object containing message data

Returns:

a HBaseMessage instance with message metadata.

toPut

public static org.apache.hadoop.hbase.client.Put toPut(Subscription subscription)

Creates a Put object from this subscription object

Returns:

Put object suitable for HBase persistence

flagsToPut

public static org.apache.hadoop.hbase.client.Put flagsToPut(Message<UUID> message,
                                            javax.mail.Flags flags)

Utility method to transform message flags into a put opperation.

Parameters:

message -

flags -

Returns:

a put object with

flagsToDelete

public static org.apache.hadoop.hbase.client.Delete flagsToDelete(Message<UUID> message,
                                                  javax.mail.Flags flags)

flagsToString

public static String flagsToString(javax.mail.Flags flags)

Returns a String composed of all flags in the parameter.

Parameters:

flags -

Returns:

a string representation of all flags