001/*
002 * SPDX-License-Identifier: Apache-2.0
003 *
004 * Copyright 2024-2026 The Enola <https://enola.dev> Authors
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 *     https://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package dev.enola.common.io.resource.cache;
019
020import dev.enola.common.io.iri.URIs;
021import dev.enola.common.io.resource.Resource;
022import dev.enola.common.io.resource.ResourceProvider;
023
024import org.jspecify.annotations.Nullable;
025
026import java.net.URI;
027
028/**
029 * OptionalCachingResourceProvider is a {@link AlwaysCachingResourceProvider} variant which only
030 * caches resources if the request URI contains a ?cache=forever query.
031 */
032public class OptionalCachingResourceProvider extends AlwaysCachingResourceProvider {
033
034    public static final String CACHE = "cache";
035
036    public OptionalCachingResourceProvider(ResourceProvider delegate) {
037        super(delegate);
038    }
039
040    @Override
041    public @Nullable Resource getResource(URI uri) {
042        if (URIs.hasQueryParameter(uri, CACHE)) return super.getResource(uri);
043        else return delegate.getResource(uri);
044    }
045}