/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.hadoop.ozone.om;

import java.util.List;
import org.apache.hadoop.ozone.om.helpers.S3SecretValue;

/**
 * Cache layer of S3 secrets.
 */
public interface S3SecretCache {
  /**
   * Put secret value to cache.
   * @param id secret value identifier.
   * @param secretValue secret value.
   */
  void put(String id, S3SecretValue secretValue);

  /**
   * Invalidate secret value with provided secret identifier.
   * @param id secret identifier.
   */
  void invalidate(String id);

  /**
   * Clears the cache, removing all entries, this is called when the
   * doubleBuffer is flushed to the DB.
   */
  void clearCache(List<Long> transactionIds);

  /**
   * Get value from cache.
   * @param id cache secrect identifier.
   * @return Secret value or {@code null} if value doesn't exist.
   */
  S3SecretValue get(String id);
}
