jetbrains.exodus.crypto

Class StreamCipherProvider

java.lang.Object

jetbrains.exodus.crypto.StreamCipherProvider

public abstract class StreamCipherProvider
extends java.lang.Object

Service provider interface for creation instances of StreamCipher. Id of the cipher defines stream cipher type (algorithm). Id can be an arbitrary string, but it's recommended to use the fully qualified name of the StreamCipherProvider implementation for easier and more transparent configuration using EnvironmentConfig.

Constructor Summary

Constructors

Constructor and Description
StreamCipherProvider()

Method Summary

Modifier and Type	Method and Description
abstract @NotNull java.lang.String	getId() Id of the cipher defines stream cipher type (algorithm).
static @Nullable StreamCipherProvider	getProvider(@NotNull java.lang.String id) Gets a StreamCipherProvider implementation by specified id.
abstract @NotNull StreamCipher	newCipher() Creates new instance of stream cipher.

Methods inherited from class java.lang.Object

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

Constructor Detail

StreamCipherProvider

public StreamCipherProvider()

Method Detail

getId

@NotNull
public abstract @NotNull java.lang.String getId()

Id of the cipher defines stream cipher type (algorithm). Id is an arbitrary string, but it's recommended to use a fully qualified name of the StreamCipherProvider implementation for easier and more transparent configuration using EnvironmentConfig.

Returns:

stream cipher id

newCipher

@NotNull
public abstract @NotNull StreamCipher newCipher()

Creates new instance of stream cipher. Use StreamCipher.init(byte[], long) to initialize encryption/decryption. Use StreamCipher.crypt(byte) to encrypt/decrypt bytes.

Returns:

new instance of stream cipher

getProvider

@Nullable
public static @Nullable StreamCipherProvider getProvider(@NotNull
                                                                    @NotNull java.lang.String id)

Gets a StreamCipherProvider implementation by specified id.

Parameters:

id - id of StreamCipherProvider

Returns:

StreamCipherProvider implementation of null if the service could not be loaded