public static class CipherCodec.KeyDescriptor extends Object
$
or plus +
characters as these characters are used within the message format to encode key name
and key version.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. |
public static CipherCodec.KeyDescriptor unnamed()
CipherCodec.KeyDescriptor
that has no specified name.CipherCodec.KeyDescriptor
.public static CipherCodec.KeyDescriptor create(String name)
CipherCodec.KeyDescriptor
without version. Version defaults to zero.name
- the key name. Must not contain plus or dollar character.CipherCodec.KeyDescriptor
for name
.public static CipherCodec.KeyDescriptor create(String name, int version)
CipherCodec.KeyDescriptor
.name
- the key name. Must not contain plus or dollar character.version
- the key version.CipherCodec.KeyDescriptor
for name
.public static CipherCodec.KeyDescriptor create(String name, int version, Charset charset)
CipherCodec.KeyDescriptor
using Charset
to encode name
to its binary
representation.name
- the key name. Must not contain plus or dollar character.version
- the key version.charset
- must not be null
.CipherCodec.KeyDescriptor
for name
.public int getVersion()
public String getName()
name
by decoding name bytes using the default charset
.Copyright © 2022 lettuce.io. All rights reserved.