001/* 002 * Copyright 2012-2018 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 * http://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.boot.autoconfigure.h2; 018 019import org.h2.server.web.WebServlet; 020 021import org.springframework.boot.autoconfigure.EnableAutoConfiguration; 022import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; 023import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; 024import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; 025import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication.Type; 026import org.springframework.boot.context.properties.EnableConfigurationProperties; 027import org.springframework.boot.web.servlet.ServletRegistrationBean; 028import org.springframework.context.annotation.Bean; 029import org.springframework.context.annotation.Configuration; 030 031/** 032 * {@link EnableAutoConfiguration Auto-configuration} for H2's web console. 033 * 034 * @author Andy Wilkinson 035 * @author Marten Deinum 036 * @author Stephane Nicoll 037 * @since 1.3.0 038 */ 039@Configuration 040@ConditionalOnWebApplication(type = Type.SERVLET) 041@ConditionalOnClass(WebServlet.class) 042@ConditionalOnProperty(prefix = "spring.h2.console", name = "enabled", havingValue = "true", matchIfMissing = false) 043@EnableConfigurationProperties(H2ConsoleProperties.class) 044public class H2ConsoleAutoConfiguration { 045 046 private final H2ConsoleProperties properties; 047 048 public H2ConsoleAutoConfiguration(H2ConsoleProperties properties) { 049 this.properties = properties; 050 } 051 052 @Bean 053 public ServletRegistrationBean<WebServlet> h2Console() { 054 String path = this.properties.getPath(); 055 String urlMapping = path + (path.endsWith("/") ? "*" : "/*"); 056 ServletRegistrationBean<WebServlet> registration = new ServletRegistrationBean<>( 057 new WebServlet(), urlMapping); 058 H2ConsoleProperties.Settings settings = this.properties.getSettings(); 059 if (settings.isTrace()) { 060 registration.addInitParameter("trace", ""); 061 } 062 if (settings.isWebAllowOthers()) { 063 registration.addInitParameter("webAllowOthers", ""); 064 } 065 return registration; 066 } 067 068}