com.google.cloud.datalineage.producerclient.StandardApiEnablementCache Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of producerclient-java8 Show documentation

The library provides Synchronous and Asynchronous clients for interacting with Data Lineage API.

The newest version!

// Copyright 2024 Google LLC
//
// 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
//
// https://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 com.google.cloud.datalineage.producerclient;

import com.google.common.cache.Cache;
import com.google.common.cache.CacheBuilder;
import java.time.Clock;
import java.time.Duration;
import java.time.LocalDateTime;

/**
 * Cache used to indicate whether API is disabled for given project.
 *
 * Class lets specify default cache size, default duration of service disability and Clock.
 * Structure is thread-safe. There is no eviction guaranteed in case of cache overload.
 */
public class StandardApiEnablementCache implements ApiEnablementCache {
  private final Cache projectToLockEndTime;
  private final Duration defaultCacheDisabledStatusTime;
  private final Clock clock;

  StandardApiEnablementCache(ApiEnablementCacheOptions options) {
    defaultCacheDisabledStatusTime = options.getDefaultCacheDisabledStatusTime();
    clock = options.getClock();

    projectToLockEndTime = CacheBuilder.newBuilder().maximumSize(options.getCacheSize()).build();
  }

  /**
   * Defaults Duration to value specified by constructor.
   *
   * @see StandardApiEnablementCache#markServiceAsDisabled(String, Duration)
   */
  public synchronized void markServiceAsDisabled(String project) {
    markServiceAsDisabled(project, defaultCacheDisabledStatusTime);
  }

  /**
   * Sets service state for given project as disabled from current timestamp to current timestamp
   * increased by duration time.
   *
   * It is not guarantied that cache will indicate service state as disabled up to calculated
   * value. Specified entry may be deleted if cache is overloaded.
   */
  public synchronized void markServiceAsDisabled(String projectName, Duration offset) {
    projectToLockEndTime.put(projectName, LocalDateTime.now(clock).plus(offset));
  }

  /**
   * Indicates if service is disabled for given project.
   *
   * @return A boolean that indicates if service is disabled for given project
   */
  public synchronized boolean isServiceMarkedAsDisabled(String projectName) {
    LocalDateTime maybeTime = projectToLockEndTime.getIfPresent(projectName);
    if (maybeTime == null) {
      return false;
    }
    return !maybeTime.isBefore(LocalDateTime.now(clock));
  }
}