org.openmetadata.service.limits.AppLimits Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openmetadata-service Show documentation
There is a newer version: 1.6.2
package org.openmetadata.service.limits;

import javax.ws.rs.core.SecurityContext;
import lombok.Getter;
import lombok.extern.slf4j.Slf4j;
import org.openmetadata.schema.entity.app.App;
import org.openmetadata.schema.entity.app.AppExtension;
import org.openmetadata.service.exception.LimitsException;
import org.openmetadata.service.jdbi3.AppRepository;
import org.openmetadata.service.jdbi3.CollectionDAO;
import org.openmetadata.service.security.policyevaluator.OperationContext;
import org.openmetadata.service.security.policyevaluator.ResourceContextInterface;
import org.openmetadata.service.util.JsonUtils;
import org.openmetadata.service.util.ResultList;

@Slf4j
public abstract class AppLimits {

  private final CollectionDAO.AppExtensionTimeSeries dao;
  private final @Getter AppRepository repository;
  private @Getter App app;

  public AppLimits(CollectionDAO collectionDAO) {
    this.dao = collectionDAO.appExtensionTimeSeriesDao();
    this.repository = new AppRepository();
  }

  // This can only happen with runtime loaded apps with the private config
  public void init(App app) {
    this.app = app;
    try {
      parseAppLimits();
    } catch (Exception e) {
      LOG.error("Error parsing limits config file: {}", e.getMessage());
    }
  }

  public AppExtension getLatestLimit() {
    return repository.getLatestExtensionByName(
        this.app, AppExtension.class, AppExtension.ExtensionType.LIMITS);
  }

  public AppExtension getLatestLimit(long startTime) {
    return repository.getLatestExtensionAfterStartTimeByName(
        this.app, startTime, AppExtension.class, AppExtension.ExtensionType.LIMITS);
  }

  public ResultList listLimits(int limitParam, int offset) {
    return repository.listAppExtensionByName(
        this.app, limitParam, offset, AppExtension.class, AppExtension.ExtensionType.LIMITS);
  }

  public void insertLimit(AppExtension limitsExtension) {
    try {
      if (limitsExtension.getAppId() != getApp().getId()) {
        LOG.error(
            "App ID mismatch. You can't manage limits from another app: {} != {}",
            limitsExtension.getAppId(),
            getApp().getId());
        return;
      }
      // Ensure the passed extension is an updated limit
      limitsExtension.setTimestamp(System.currentTimeMillis());
      limitsExtension.setExtension(AppExtension.ExtensionType.LIMITS);
      this.dao.insert(
          JsonUtils.pojoToJson(limitsExtension), AppExtension.ExtensionType.LIMITS.toString());
    } catch (Exception e) {
      LOG.error("Error inserting app limits for {}: {}", this.getApp().getName(), e.getMessage());
    }
  }

  // Parse the app limits defined in the Private Configuration
  // Let each App parse and store however is needed
  public abstract void parseAppLimits() throws LimitsException;

  // Enforce limits for the app
  public abstract void enforceLimits(
      SecurityContext securityContext,
      ResourceContextInterface resourceContext,
      OperationContext operationContext);
}