water.parser

Class DecryptionTool

java.lang.Object

water.Iced<T>

water.Keyed<DecryptionTool>

water.parser.DecryptionTool

All Implemented Interfaces:

java.io.Externalizable, java.io.Serializable, java.lang.Cloneable, Freezable<DecryptionTool>

Direct Known Subclasses:

GenericDecryptionTool, NullDecryptionTool

public abstract class DecryptionTool
extends Keyed<DecryptionTool>

Base class for implementations of the Decryption Tool Decryption Tool is applied to the raw data loaded from source files and decrypts them on-the-fly.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DecryptionTool.DecryptionSetup Blueprint of the Decryption Tool

Field Summary

Fields inherited from class water.Keyed

_key

Method Summary

Methods

Modifier and Type	Method and Description
abstract byte[]	decryptFirstBytes(byte[] bits) Decrypts the beginning of the file and returns its clear-text binary representation.
abstract java.io.InputStream	decryptInputStream(java.io.InputStream is) Wraps the source InputStream into deciphering input stream
static DecryptionTool	get(Key<DecryptionTool> key) Retrieves a Decryption Tool from DKV using a given key.
boolean	isTransparent()
static DecryptionTool	make(DecryptionTool.DecryptionSetup ds) Instantiates a Decryption Tool using a given Decryption Setup and installs it in DKV.

Methods inherited from class water.Keyed

checksum_impl, checksum, makeSchema, readAll_impl, readAll, remove_impl, remove, remove, remove, remove, writeAll_impl, writeAll

Methods inherited from class water.Iced

asBytes, clone, copyOver, frozenType, read, readExternal, readJSON, reloadFromBytes, toJsonString, write, writeExternal, writeJSON

Methods inherited from class java.lang.Object

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

Method Detail

decryptFirstBytes

public abstract byte[] decryptFirstBytes(byte[] bits)

Decrypts the beginning of the file and returns its clear-text binary representation.

Parameters:

bits - the first chunk of data of the datafile. The input byte array can contain zero-bytes padding (eg. case of DEFLATE compression in Zip files, the decompressed data can be smaller than the source chunk). The implementation of the method should discard the padding (all zero bytes at the end of the array).

Returns:

Decrypted binary data or the input byte array if Tool is not compatible with this input.

decryptInputStream

public abstract java.io.InputStream decryptInputStream(java.io.InputStream is)

Wraps the source InputStream into deciphering input stream

Parameters:

is - InputStream created by ByteVec (H2O-specific behavior is expected!)

Returns:

InputStream of decrypted data

isTransparent

public boolean isTransparent()

get

public static DecryptionTool get(Key<DecryptionTool> key)

Retrieves a Decryption Tool from DKV using a given key.

Parameters:

key - a valid DKV key or null

Returns:

instance of Decryption Tool for a valid key, Null Decryption tool for a null key

make

public static DecryptionTool make(DecryptionTool.DecryptionSetup ds)

Instantiates a Decryption Tool using a given Decryption Setup and installs it in DKV.

Parameters:

ds - decryption setup

Returns:

instance of a Decryption Tool