Package org.apache.hadoop.crypto.key

Class KeyProvider.Metadata

java.lang.Object

org.apache.hadoop.crypto.key.KeyProvider.Metadata

Direct Known Subclasses:

KMSClientProvider.KMSMetadata

Enclosing class:

KeyProvider

public static class KeyProvider.Metadata
extends java.lang.Object

Key metadata that is associated with the key.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Metadata(byte[] bytes)	Deserialize a new metadata object from a set of bytes.
protected	Metadata(java.lang.String cipher, int bitLength, java.lang.String description, java.util.Map<java.lang.String,java.lang.String> attributes, java.util.Date created, int versions)

Method Summary

Modifier and Type	Method	Description
protected int	addVersion()
java.lang.String	getAlgorithm()	Get the algorithm from the cipher.
java.util.Map<java.lang.String,java.lang.String>	getAttributes()
int	getBitLength()
java.lang.String	getCipher()
java.util.Date	getCreated()
java.lang.String	getDescription()
int	getVersions()
protected byte[]	serialize()	Serialize the metadata to a set of bytes.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Metadata

protected Metadata(java.lang.String cipher,
                   int bitLength,
                   java.lang.String description,
                   java.util.Map<java.lang.String,java.lang.String> attributes,
                   java.util.Date created,
                   int versions)

Metadata

protected Metadata(byte[] bytes)
            throws java.io.IOException

Deserialize a new metadata object from a set of bytes.

Parameters:

bytes - the serialized metadata

Throws:

java.io.IOException - raised on errors performing I/O.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDescription

public java.lang.String getDescription()

getCreated

public java.util.Date getCreated()

getCipher

public java.lang.String getCipher()

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

getAlgorithm

public java.lang.String getAlgorithm()

Get the algorithm from the cipher.

Returns:

the algorithm name

getBitLength

public int getBitLength()

getVersions

public int getVersions()

addVersion

protected int addVersion()

serialize

protected byte[] serialize()
                    throws java.io.IOException

Serialize the metadata to a set of bytes.

Returns:

the serialized bytes

Throws:

java.io.IOException - raised on errors performing I/O.