001/*
002 * Copyright 2002-2017 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.servlet;
018
019import javax.servlet.http.HttpServletRequest;
020
021import org.springframework.lang.Nullable;
022
023/**
024 * Strategy interface for translating an incoming
025 * {@link javax.servlet.http.HttpServletRequest} into a
026 * logical view name when no view name is explicitly supplied.
027 *
028 * @author Rob Harrop
029 * @author Juergen Hoeller
030 * @since 2.0
031 */
032public interface RequestToViewNameTranslator {
033
034        /**
035         * Translate the given {@link HttpServletRequest} into a view name.
036         * @param request the incoming {@link HttpServletRequest} providing
037         * the context from which a view name is to be resolved
038         * @return the view name, or {@code null} if no default found
039         * @throws Exception if view name translation fails
040         */
041        @Nullable
042        String getViewName(HttpServletRequest request) throws Exception;
043
044}