/*
 * Copyright 2022 Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags.
 *
 * 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 org.keycloak.operator.controllers;

import io.fabric8.kubernetes.api.model.apps.StatefulSet;
import io.javaoperatorsdk.operator.processing.event.source.EventSource;

import org.keycloak.operator.crds.v2alpha1.deployment.Keycloak;

import java.util.List;

/**
 * Provides a mechanism to track secrets
 *
 * @author Vaclav Muzikar <vmuzikar@redhat.com>
 */
public interface WatchedSecrets {
    public static final String WATCHED_SECRETS_LABEL_VALUE = "watched-secret";

    /**
     * @param deployment mutable resource being reconciled, it will be updated with annotations
     */
    void annotateDeployment(List<String> desiredWatchedSecretsNames, Keycloak keycloakCR, StatefulSet deployment);

    EventSource getWatchedSecretsEventSource();

    void addLabelsToWatchedSecrets(StatefulSet deployment);

}