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