001/*
002 * nimbus-jose-jwt
003 *
004 * Copyright 2012-2016, Connect2id Ltd and contributors.
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use
007 * this file except in compliance with the License. You may obtain a copy of the
008 * License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software distributed
013 * under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
014 * CONDITIONS OF ANY KIND, either express or implied. See the License for the
015 * specific language governing permissions and limitations under the License.
016 */
017
018package com.nimbusds.jose.jwk.source;
019
020
021import com.nimbusds.jose.jwk.JWKSet;
022
023
024/**
025 * JSON Web Key (JWK) set cache.
026 *
027 * @author Vladimir Dzhuvinov
028 * @author Sarvesh Sharma
029 * @version 2020-03-11
030 */
031public interface JWKSetCache {
032        
033        
034        /**
035         * Puts the specified JWK set into the cache or clears the cache.
036         *
037         * @param jwkSet The JWK set to cache, {@code null} to clear the cache.
038         */
039        void put(final JWKSet jwkSet);
040        
041        
042        /**
043         * Gets the cached JWK set.
044         *
045         * @return The cached JWK set, {@code null} if none or expired.
046         */
047        JWKSet get();
048
049
050        /**
051         * Returns {@code true} if the cached JWK set requires a refresh. This
052         * should typically occur some time before the cache has expired, to
053         * allow for transient retrieval exceptions before expiration.
054         *
055         * @return {@code true} if the cached JWK set requires a refresh.
056         */
057        boolean requiresRefresh();
058}