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.accept;
018
019import java.util.List;
020
021import org.springframework.http.MediaType;
022import org.springframework.web.HttpMediaTypeNotAcceptableException;
023import org.springframework.web.context.request.NativeWebRequest;
024
025/**
026 * A strategy for resolving the requested media types for a request.
027 *
028 * @author Rossen Stoyanchev
029 * @since 3.2
030 */
031public interface ContentNegotiationStrategy {
032
033        /**
034         * Resolve the given request to a list of media types. The returned list is
035         * ordered by specificity first and by quality parameter second.
036         * @param webRequest the current request
037         * @return the requested media types or an empty list (never {@code null})
038         * @throws HttpMediaTypeNotAcceptableException if the requested media
039         * types cannot be parsed
040         */
041        List<MediaType> resolveMediaTypes(NativeWebRequest webRequest)
042                        throws HttpMediaTypeNotAcceptableException;
043
044}