/*
 * Copyright 2025 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.models.sessions.infinispan.expiration;

/**
 * Lifecycle methods for the user and client session expiration task.
 * <p>
 * The task must remove the expired sessions from the database. The {@link #start()} is invoked when Keycloak starts
 * and, respectively, {@link #stop()} when Keycloak is shutdown.
 */
public interface ExpirationTask {

    /**
     * Starts the expiration task.
     * <p>
     * This method is only invoked when Keycloak starts, and the implementation is responsible to schedule future
     * invocation, to prevent the database growing.
     */
    void start();

    /**
     * Stops the expiration task.
     */
    void stop();

}
