de.arbeitsagentur.opdt.keycloak.common.ExpirationUtils Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2024 IT-Systemhaus der Bundesagentur fuer Arbeit
 *
 *  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 de.arbeitsagentur.opdt.keycloak.common;

import org.keycloak.common.util.Time;

public class ExpirationUtils {

  /**
   * Checks whether the {@code entity} is expired
   *
   * @param entity to check
   * @param allowInfiniteValues sets how null values are interpreted, if true entity with expiration
   *     equal to {@code null} is interpreted as never expiring entity, if false entities with
   *     {@code null} expiration are interpreted as expired entities
   * @return true if the {@code entity} is expired (expiration time is in the past or now), false
   *     otherwise
   */
  public static boolean isExpired(ExpirableEntity entity, boolean allowInfiniteValues) {
    Long expiration = entity.getExpiration();
    if (!allowInfiniteValues && expiration == null) return false;
    return expiration != null && expiration <= Time.currentTimeMillis();
  }

  public static boolean isNotExpired(Object entity) {
    return !isExpired((ExpirableEntity) entity, true);
  }
}