ome.smuggler.core.io.crypto

Class CryptoKeyFactory

java.lang.Object

ome.smuggler.core.io.crypto.CryptoKeyFactory

public class CryptoKeyFactory
extends java.lang.Object

Factory methods for security Keys.

Constructor Summary

Constructors

Constructor and Description
CryptoKeyFactory()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	exportKey(java.security.Key key) Serialises a key into a string using Base64 encoding.
static void	exportKey(java.security.Key key, java.io.OutputStream out) Serialises a key into a given stream using Base64 encoding.
static java.lang.String	exportNewKey(CryptoAlgoSpec algo) Generates a new key and serialises it using Base64 encoding.
static java.security.Key	generateKey(CryptoAlgoSpec algo) Generates a security Key for the given algorithm.
static java.security.Key	importKey(java.io.InputStream in) De-serialises a key from a given Base64-encoded stream.
static java.security.Key	importKey(java.lang.String encodedKey) De-serialises a key from a given Base64-encoded string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CryptoKeyFactory

public CryptoKeyFactory()

Method Detail

generateKey

public static java.security.Key generateKey(CryptoAlgoSpec algo)

Generates a security Key for the given algorithm.

Parameters:

algo - the algorithm to use.

Returns:

the key.

Throws:

java.lang.NullPointerException - if the argument is null.

exportKey

public static void exportKey(java.security.Key key,
                             java.io.OutputStream out)

Serialises a key into a given stream using Base64 encoding.

Parameters:

key - the key to serialise.

out - the destination stream to write the data to.

Throws:

java.lang.NullPointerException - if any argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an error occurs while writing to the stream.

See Also:

importKey(InputStream)

exportKey

public static java.lang.String exportKey(java.security.Key key)

Serialises a key into a string using Base64 encoding. This method simply calls exportKey, capturing the output in a string.

Parameters:

key - the key to serialise.

Returns:

the serialised and Base64-encoded key.

Throws:

java.lang.NullPointerException - if the argument is null.

importKey

public static java.security.Key importKey(java.io.InputStream in)

De-serialises a key from a given Base64-encoded stream.

Parameters:

in - contains the key object as serialised by the export method.

Returns:

the key object read from the stream.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an error occurs while reading from the stream.
ClassNotFoundException if an error occurs while instantiating the key object.

See Also:

exportKey(Key, OutputStream)

importKey

public static java.security.Key importKey(java.lang.String encodedKey)

De-serialises a key from a given Base64-encoded string.

Parameters:

encodedKey - contains the key object as serialised by the export method.

Returns:

the key object read from the stream.

Throws:

java.lang.NullPointerException - if the argument is null.

The following checked exceptions are rethrown as unchecked (i.e. the exception is masked as a runtime exception and thrown as is without wrapping it in a RuntimeException):
IOException if an error occurs while reading from the string.
ClassNotFoundException if an error occurs while instantiating the key object.

See Also:

exportKey(Key, OutputStream), exportNewKey(CryptoAlgoSpec)

exportNewKey

public static java.lang.String exportNewKey(CryptoAlgoSpec algo)

Generates a new key and serialises it using Base64 encoding. This method combines generateKey and exportKey, capturing the output in a string.

Parameters:

algo - the algorithm to use.

Returns:

the serialised and Base64-encoded key.

Throws:

java.lang.NullPointerException - if the argument is null.