Interface PkiCredential.Metadata

Enclosing interface:
PkiCredential

public static interface PkiCredential.Metadata
Metadata associated with a PkiCredential.
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Property name for the expires-at metadata property.
    static final String
    Property name for the issued-at metadata property.
    static final String
    Property name for the key identifier metadata property.
  • Method Summary

    Modifier and Type
    Method
    Description
    default Instant
    The instant for when the key pair/credential "expires".
    default Instant
    The instant for when the key pair/credential was issued.
    default String
    An assigned, or calculated, key identifier for the credential.
    Gets a live map of the additional metadata properties.
  • Field Details

    • KEY_ID_PROPERTY

      static final String KEY_ID_PROPERTY
      Property name for the key identifier metadata property.
      See Also:
    • ISSUED_AT_PROPERTY

      static final String ISSUED_AT_PROPERTY
      Property name for the issued-at metadata property.
      See Also:
    • EXPIRES_AT_PROPERTY

      static final String EXPIRES_AT_PROPERTY
      Property name for the expires-at metadata property.
      See Also:
  • Method Details

    • getKeyId

      @Nullable default String getKeyId()
      An assigned, or calculated, key identifier for the credential.
      Returns:
      the credential key identifier, or null, if not assigned/calculated
    • getIssuedAt

      @Nullable default Instant getIssuedAt()
      The instant for when the key pair/credential was issued.

      If not explicitly assigned, implementations may use the notBefore property from the credential entity certificate.

      Returns:
      an instant for when the credential was issued/created, or null if this information is not available
    • getExpiresAt

      @Nullable default Instant getExpiresAt()
      The instant for when the key pair/credential "expires".

      If not explicitly assigned, implementations may use the notAfter property from the credential entity certificate.

      Returns:
      an instant for when the credential expires, or null if this information is not available
    • getProperties

      @Nonnull Map<String,Object> getProperties()
      Gets a live map of the additional metadata properties.
      Returns:
      a (possibly empty) map of additional metadata properties