com.github.jknack.handlebars.io.ServletContextTemplateLoader Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of aem-sdk-api Show documentation

The Adobe Experience Manager SDK

There is a newer version: 2024.11.18751.20241128T090041Z-241100

/**
 * Copyright (c) 2012-2015 Edgar Espina
 *
 * This file is part of Handlebars.java.
 *
 * 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 com.github.jknack.handlebars.io;

import static org.apache.commons.lang3.Validate.notNull;
import java.io.IOException;
import java.net.URL;
import javax.servlet.ServletContext;

/**
 *  Load templates from the {@link ServletContext}.
 *
 *  @author edgar.espina
 *  @since 0.1.0
 *
 * @deprecated com.github.jknack.handlebars.io package is deprecated and marked for removal in subsequent releases which will involve removal of the handlebars dependency in AEM.
 */
@Deprecated(since = "2024-07-10")
public class ServletContextTemplateLoader extends URLTemplateLoader {

    /**
     * The servlet context. Required.
     */
    private final ServletContext servletContext;

    /**
     * Creates a new {@link ServletContextTemplateLoader}.
     *
     * @param servletContext The servlet context. Required.
     * @param prefix The prefix that gets prepended to view names when building a
     *        URI.
     * @param suffix The suffix that gets appended to view names when building a
     *        URI. Required.
     */
    public ServletContextTemplateLoader(final ServletContext servletContext, final String prefix, final String suffix) {
        this.servletContext = notNull(servletContext, "The servlet context is required.");
        setPrefix(prefix);
        setSuffix(suffix);
    }

    /**
     * Creates a new {@link ServletContextTemplateLoader}.
     *
     * @param servletContext The servlet context. Required.
     * @param prefix The prefix that gets prepended to view names when building a
     *        URI.
     */
    public ServletContextTemplateLoader(final ServletContext servletContext, final String prefix) {
        this(servletContext, prefix, DEFAULT_SUFFIX);
    }

    /**
     * Creates a new {@link ServletContextTemplateLoader}.
     *
     * @param servletContext The servlet context. Required.
     */
    public ServletContextTemplateLoader(final ServletContext servletContext) {
        this(servletContext, "/", DEFAULT_SUFFIX);
    }

    @Override
    protected URL getResource(final String location) throws IOException {
        return servletContext.getResource(location);
    }
}