io.jsonwebtoken

Interface Identifiable

All Known Subinterfaces:

AeadAlgorithm, AsymmetricJwk<K>, Claims, CompressionAlgorithm, CompressionCodec, Curve, DigestAlgorithm<R,V>, EcPrivateJwk, EcPublicJwk, HashAlgorithm, Jwk<K>, KeyAlgorithm<E,D>, KeyOperation, MacAlgorithm, OctetPrivateJwk<K,L>, OctetPublicJwk<K>, PrivateJwk<K,L,M>, PublicJwk<K>, RsaPrivateJwk, RsaPublicJwk, SecretJwk, SecretKeyAlgorithm, SecureDigestAlgorithm<S,V>, SignatureAlgorithm

public interface Identifiable

An object that may be uniquely identified by an id relative to other instances of the same type.

The following table indicates how various JWT or JWK getId() values are used.

JWA Identifiable Concepts

JJWT Type	How getId() is Used
Claims	JWT's jti (JWT ID) claim.
Jwk	JWK's kid (Key ID) parameter value.
Curve	JWK's crv (Curve) parameter value.
CompressionAlgorithm	JWE protected header's zip (Compression Algorithm) parameter value.
HashAlgorithm	Within a JwkThumbprint's URI value.
MacAlgorithm	JWS protected header's alg (Algorithm) parameter value.
SignatureAlgorithm	JWS protected header's alg (Algorithm) parameter value.
KeyAlgorithm	JWE protected header's alg (Key Management Algorithm) parameter value.
AeadAlgorithm	JWE protected header's enc (Encryption Algorithm) parameter value.

Since:

0.12.0

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Returns the unique string identifier of the associated object.

Method Detail

getId

String getId()

Returns the unique string identifier of the associated object.

Returns:

the unique string identifier of the associated object.