org.springframework.boot.autoconfigure.template.AbstractViewResolverProperties Maven / Gradle / Ivy
/*
* Copyright 2012-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.boot.autoconfigure.template;
import java.nio.charset.Charset;
import java.nio.charset.StandardCharsets;
import java.util.LinkedHashMap;
import java.util.Map;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.util.MimeType;
import org.springframework.web.servlet.ViewResolver;
/**
* Base class for {@link ConfigurationProperties} of a {@link ViewResolver}.
*
* @author Andy Wilkinson
* @author Stephane Nicoll
* @since 1.2.0
* @see AbstractTemplateViewResolverProperties
*/
public abstract class AbstractViewResolverProperties {
private static final MimeType DEFAULT_CONTENT_TYPE = MimeType.valueOf("text/html");
private static final Charset DEFAULT_CHARSET = StandardCharsets.UTF_8;
/**
* Whether to enable MVC view resolution for this technology.
*/
private boolean enabled = true;
/**
* Whether to enable template caching.
*/
private boolean cache;
/**
* Content-Type value.
*/
private MimeType contentType = DEFAULT_CONTENT_TYPE;
/**
* Template encoding.
*/
private Charset charset = DEFAULT_CHARSET;
/**
* White list of view names that can be resolved.
*/
private String[] viewNames;
/**
* Whether to check that the templates location exists.
*/
private boolean checkTemplateLocation = true;
public void setEnabled(boolean enabled) {
this.enabled = enabled;
}
public boolean isEnabled() {
return this.enabled;
}
public void setCheckTemplateLocation(boolean checkTemplateLocation) {
this.checkTemplateLocation = checkTemplateLocation;
}
public boolean isCheckTemplateLocation() {
return this.checkTemplateLocation;
}
public String[] getViewNames() {
return this.viewNames;
}
public void setViewNames(String[] viewNames) {
this.viewNames = viewNames;
}
public boolean isCache() {
return this.cache;
}
public void setCache(boolean cache) {
this.cache = cache;
}
public MimeType getContentType() {
if (this.contentType.getCharset() == null) {
Map parameters = new LinkedHashMap<>();
parameters.put("charset", this.charset.name());
parameters.putAll(this.contentType.getParameters());
return new MimeType(this.contentType, parameters);
}
return this.contentType;
}
public void setContentType(MimeType contentType) {
this.contentType = contentType;
}
public Charset getCharset() {
return this.charset;
}
public String getCharsetName() {
return (this.charset != null ? this.charset.name() : null);
}
public void setCharset(Charset charset) {
this.charset = charset;
}
}