jakarta.faces.view.facelets.ResourceResolver Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jakarta.faces Show documentation

EE4J Compatible Implementation for Jakarta Faces API

There is a newer version: 4.1.1

/*
 * Copyright (c) 1997, 2020 Oracle and/or its affiliates. All rights reserved.
 * Copyright 2005-2007 The Apache Software Foundation
 *
 * 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 jakarta.faces.view.facelets;

import java.net.URL;

/**
 * 
 * Deprecated as of Jakarta Server Faces 2.2. The same functionality is more correctly
 * provided by {@link jakarta.faces.application.ResourceHandler}. Provide a hook to decorate or override the way
 * that Facelets loads template files. A default implementation must be provided that satisfies the requirements for
 * loading templates as in Pre-Jakarta Server Faces 2.0 Facelets.
 * 
 *
 * 
 *
 * 
 * If a <context-param> with the param name equal to the value of
 * {@link #FACELETS_RESOURCE_RESOLVER_PARAM_NAME} exists, the runtime must interpret its value as a fully qualified
 * classname of a java class that extends ResourceResolver and has a zero argument public constructor or a
 * one argument public constructor where the type of the argument is ResourceResolver. If this param is set
 * and its value does not conform to those requirements, the runtime must log a message and continue. If it does conform
 * to these requirements and has a one-argument constructor, the default ResourceResolver must be passed to
 * the constructor. If it has a zero argument constructor it is invoked directly. In either case, the new
 * ResourceResolver replaces the old one.
 * 
 *
 * 
 *
 */

@Deprecated
public abstract class ResourceResolver {

    public static final String FACELETS_RESOURCE_RESOLVER_PARAM_NAME = "jakarta.faces.FACELETS_RESOURCE_RESOLVER";

    /**
     * 
     * Returns the URL of a Facelet template file. Called by the Facelets Runtime to load a template file
     * referred to in a Facelets page.
     * 
     *
     * @param path the internal path to the template resource.
     * @return the resolved URL.
     */
    abstract public URL resolveUrl(String path);
}