TufMeta.java

/*
 * Copyright 2022 The Sigstore Authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package dev.sigstore.tuf.model;

import java.time.ZonedDateTime;
import org.immutables.gson.Gson;

/**
 * Generic Tuf Metadata interface for various TUF resources such as Roles, Snapshots, and Targets.
 */
public interface TufMeta {
  /** Returns the metadata type. In this case 'root', 'snapshot', or 'timestamp'. */
  @Gson.Named("_type")
  String getType();

  /** Date at which this data expires. */
  String getExpires();

  default ZonedDateTime getExpiresAsDate() {
    return ZonedDateTime.parse(getExpires());
  }

  /** Spec version of this type. */
  @Gson.Named("spec_version")
  String getSpecVersion();

  /** The version of this Resource. */
  int getVersion();
}