com.google.crypto.tink.internal

Class ProtoKeySerialization

java.lang.Object

com.google.crypto.tink.internal.ProtoKeySerialization

All Implemented Interfaces:

Serialization

@Immutable
public final class ProtoKeySerialization
extends Object
implements Serialization

* Represents a Key object serialized with binary protobuf Serialization.

ProtoKeySerialization objects fully describe a Key object, but tailored for protocol buffer serialization.

Method Summary

Modifier and Type	Method and Description
static ProtoKeySerialization	create(String typeUrl, com.google.protobuf.ByteString value, KeyData.KeyMaterialType keyMaterialType, OutputPrefixType outputPrefixType, Integer idRequirement)
Integer	getIdRequirementOrNull() The id requirement of this key.
KeyData.KeyMaterialType	getKeyMaterialType() The contents of the field key_material_type in the message com.google.crypto.tink.proto.KeyData.
Bytes	getObjectIdentifier() The object identifier.
OutputPrefixType	getOutputPrefixType() The contents of the field output_prefix_type in the message com.google.crypto.tink.proto.Keyset.Key.
String	getTypeUrl() The typeUrl.
com.google.protobuf.ByteString	getValue() The contents of the field value in the message com.google.crypto.tink.proto.KeyData.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static ProtoKeySerialization create(String typeUrl,
                                           com.google.protobuf.ByteString value,
                                           KeyData.KeyMaterialType keyMaterialType,
                                           OutputPrefixType outputPrefixType,
                                           @Nullable
                                           Integer idRequirement)
                                    throws GeneralSecurityException

Throws:

GeneralSecurityException

getValue

public com.google.protobuf.ByteString getValue()

The contents of the field value in the message com.google.crypto.tink.proto.KeyData.

getKeyMaterialType

public KeyData.KeyMaterialType getKeyMaterialType()

The contents of the field key_material_type in the message com.google.crypto.tink.proto.KeyData.

getOutputPrefixType

public OutputPrefixType getOutputPrefixType()

The contents of the field output_prefix_type in the message com.google.crypto.tink.proto.Keyset.Key.

getIdRequirementOrNull

@Nullable
public Integer getIdRequirementOrNull()

The id requirement of this key. Guaranteed to be null if getOutputPrefixType == RAW, otherwise non-null, and equal to the ID this key has to have.

getObjectIdentifier

public Bytes getObjectIdentifier()

The object identifier.

This is the UTF8 encoding of the result of "getTypeUrl".

Specified by:

getObjectIdentifier in interface Serialization

getTypeUrl

public String getTypeUrl()

The typeUrl.