    001// Copyright 2023 The Apache Software Foundation
    002//
    003// Licensed under the Apache License, Version 2.0 (the "License");
    004// you may not use this file except in compliance with the License.
    005// You may obtain a copy of the License at
    006//
    007// http://www.apache.org/licenses/LICENSE-2.0
    008//
    009// Unless required by applicable law or agreed to in writing, software
    010// distributed under the License is distributed on an "AS IS" BASIS,
    011// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    012// See the License for the specific language governing permissions and
    013// limitations under the License.
    014
    015package org.apache.tapestry5.services.pageload;
    016
    017import org.apache.tapestry5.ioc.annotations.UsesOrderedConfiguration;
    018
    019/**
    020 * A service which defines whether cache page instances should have soft references pointing to
    021 * it (the default) or strong, non-garbage-collectable ones. This service is a chain of command
    022 * of itself.
    023 *
    024 * @see ReferenceType
    025 * @since 5.8.3
    026 */
    027@UsesOrderedConfiguration(PageCachingReferenceTypeService.class)
    028public interface PageCachingReferenceTypeService
    029{
    030    /**
    031     * Defines which reference type should be used to cache instances of the given page.
    032     * Returning <code>null</code> means this implementation doesn't handle wit the given page.
    033     * @param canonicalPageName the name of the page.
    034     * @return a ReferenceType object or <code>null</code>
    035     */
    036    ReferenceType get(String canonicalPageName);
    037
    038}