io.lettuce.core.codec

Class CipherCodec.KeyDescriptor

java.lang.Object

io.lettuce.core.codec.CipherCodec.KeyDescriptor

Enclosing class:

CipherCodec

public static class CipherCodec.KeyDescriptor
extends Object

Descriptor to determine which crypto key to use. Allows versioning and usage of named keys. Key names must not contain dollar $ or plus + characters as these characters are used within the message format to encode key name and key version.

Method Summary

Modifier and Type	Method and Description
static CipherCodec.KeyDescriptor	create(String name) Create a named CipherCodec.KeyDescriptor without version.
static CipherCodec.KeyDescriptor	create(String name, int version) Create a named and versioned CipherCodec.KeyDescriptor.
static CipherCodec.KeyDescriptor	create(String name, int version, Charset charset) Create a named and versioned CipherCodec.KeyDescriptor using Charset to encode name to its binary representation.
String	getName() Returns the key name by decoding name bytes using the default charset.
String	getName(Charset charset) Returns the key name by decoding name bytes using the given Charset.
int	getVersion()
static CipherCodec.KeyDescriptor	unnamed() Returns the default CipherCodec.KeyDescriptor that has no specified name.

Methods inherited from class java.lang.Object

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

Method Detail

unnamed

public static CipherCodec.KeyDescriptor unnamed()

Returns the default CipherCodec.KeyDescriptor that has no specified name.

Returns:

the default CipherCodec.KeyDescriptor.

create

public static CipherCodec.KeyDescriptor create(String name)

Create a named CipherCodec.KeyDescriptor without version. Version defaults to zero.

Parameters:

name - the key name. Must not contain plus or dollar character.

Returns:

the CipherCodec.KeyDescriptor for name.

create

public static CipherCodec.KeyDescriptor create(String name,
                                               int version)

Create a named and versioned CipherCodec.KeyDescriptor.

Parameters:

name - the key name. Must not contain plus or dollar character.

version - the key version.

Returns:

the CipherCodec.KeyDescriptor for name.

create

public static CipherCodec.KeyDescriptor create(String name,
                                               int version,
                                               Charset charset)

Create a named and versioned CipherCodec.KeyDescriptor using Charset to encode name to its binary representation.

Parameters:

name - the key name. Must not contain plus or dollar character.

version - the key version.

charset - must not be null.

Returns:

the CipherCodec.KeyDescriptor for name.

getVersion

public int getVersion()

getName

public String getName()

Returns the key name by decoding name bytes using the default charset.

Returns:

the key name.

getName

public String getName(Charset charset)

Returns the key name by decoding name bytes using the given Charset.

Parameters:

charset - the Charset to use to decode the key name, must not be null.

Returns:

the key name.