001/*
002 * Copyright 2002-2016 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.web.reactive.result.view.freemarker;
018
019import freemarker.template.Configuration;
020
021/**
022 * Interface to be implemented by objects that configure and manage a
023 * FreeMarker Configuration object in a web environment. Detected and
024 * used by {@link FreeMarkerView}.
025 *
026 * @author Rossen Stoyanchev
027 * @since 5.0
028 */
029public interface FreeMarkerConfig {
030
031        /**
032         * Return the FreeMarker Configuration object for the current
033         * web application context.
034         * <p>A FreeMarker Configuration object may be used to set FreeMarker
035         * properties and shared objects, and allows to retrieve templates.
036         * @return the FreeMarker Configuration
037         */
038        Configuration getConfiguration();
039
040}