org.apache.cayenne.crypto.transformer.bytes

Class Header

java.lang.Object

org.apache.cayenne.crypto.transformer.bytes.Header

public class Header
extends Object

Represents a header with metadata about the encrypted data. A header is prependend to each encrypted value, and itself is not encrypted. Header format is the following:

• byte 0..2: "magic" number identifying the format as Cayenne-crypto encrypted sequence.
• byte 3: header length N, i.e. how many bytes the header contains, including magic number and the length indicator. N can be 0..127.
• byte 4: a bit String representing various flags, such as compression.
• byte 5..N: UTF8-encoded symbolic name of the encryption key.

Since:

4.0

Method Summary

Methods

Modifier and Type	Method and Description
static Header	create(byte[] data, int offset)
static Header	create(String keyName, boolean compessed)
byte	getFlags()
String	getKeyName()
boolean	isCompressed()
static byte	setCompressed(byte bits, boolean compressed)
int	size()
void	store(byte[] output, int outputOffset, byte flags) Saves the header bytes in the provided buffer at specified offset.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Header create(String keyName,
            boolean compessed)

create

public static Header create(byte[] data,
            int offset)

setCompressed

public static byte setCompressed(byte bits,
                 boolean compressed)

size

public int size()

isCompressed

public boolean isCompressed()

getFlags

public byte getFlags()

store

public void store(byte[] output,
         int outputOffset,
         byte flags)

Saves the header bytes in the provided buffer at specified offset.

getKeyName

public String getKeyName()