org.springframework.web.accept.FixedContentNegotiationStrategy Maven / Gradle / Ivy
/*
* Copyright 2002-2017 the original author or authors.
*
* 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 org.springframework.web.accept;
import java.util.Collections;
import java.util.List;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.http.MediaType;
import org.springframework.util.Assert;
import org.springframework.web.context.request.NativeWebRequest;
/**
* A {@code ContentNegotiationStrategy} that returns a fixed content type.
*
* @author Rossen Stoyanchev
* @since 3.2
*/
public class FixedContentNegotiationStrategy implements ContentNegotiationStrategy {
private static final Log logger = LogFactory.getLog(FixedContentNegotiationStrategy.class);
private final List contentTypes;
/**
* Constructor with a single default {@code MediaType}.
*/
public FixedContentNegotiationStrategy(MediaType contentType) {
this(Collections.singletonList(contentType));
}
/**
* Constructor with an ordered List of default {@code MediaType}'s to return
* for use in applications that support a variety of content types.
* Consider appending {@link MediaType#ALL} at the end if destinations
* are present which do not support any of the other default media types.
* @since 5.0
*/
public FixedContentNegotiationStrategy(List contentTypes) {
Assert.notNull(contentTypes, "'contentTypes' must not be null");
this.contentTypes = Collections.unmodifiableList(contentTypes);
}
/**
* Return the configured list of media types.
*/
public List getContentTypes() {
return this.contentTypes;
}
@Override
public List resolveMediaTypes(NativeWebRequest request) {
if (logger.isDebugEnabled()) {
logger.debug("Requested media types: " + this.contentTypes);
}
return this.contentTypes;
}
}