diff --git a/Spring-Boot/version/documents/1.5.7/guide.md b/Spring-Boot/version/documents/1.5.7/guide.md
index faf0c3c16c0e36e4784e91e510d29604c15a0eb0..6f1bd70afb92f1993be41813cc4da8aab3db360c 100644
--- a/Spring-Boot/version/documents/1.5.7/guide.md
+++ b/Spring-Boot/version/documents/1.5.7/guide.md
@@ -1,755 +1,210 @@
# Spring Boot Reference Guide
### [中文文档](README_CN.md)
+
## Authors
-> Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons
-### 1.5.7.BUILD-SNAPSHOT
-
-> Copyright © 2012-2017
-
-> Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
----------------------------------------------------------------------------------------------------------------------------
-### Table of Contents
-
-I. Spring Boot Documentation
-1. About the documentation
-2. Getting help
-3. First steps
-4. Working with Spring Boot
-5. Learning about Spring Boot features
-6. Moving to production
-7. Advanced topics
-II. Getting started
-8. Introducing Spring Boot
-9. System Requirements
-9.1. Servlet containers
-10. Installing Spring Boot
-10.1. Installation instructions for the Java developer
-10.1.1. Maven installation
-10.1.2. Gradle installation
-10.2. Installing the Spring Boot CLI
-10.2.1. Manual installation
-10.2.2. Installation with SDKMAN!
-10.2.3. OSX Homebrew installation
-10.2.4. MacPorts installation
-10.2.5. Command-line completion
-10.2.6. Quick start Spring CLI example
-10.3. Upgrading from an earlier version of Spring Boot
-11. Developing your first Spring Boot application
-11.1. Creating the POM
-11.2. Adding classpath dependencies
-11.3. Writing the code
-11.3.1. The @RestController and @RequestMapping annotations
-11.3.2. The @EnableAutoConfiguration annotation
-11.3.3. The “main” method
-11.4. Running the example
-11.5. Creating an executable jar
-12. What to read next
-III. Using Spring Boot
-13. Build systems
-13.1. Dependency management
-13.2. Maven
-13.2.1. Inheriting the starter parent
-13.2.2. Using Spring Boot without the parent POM
-13.2.3. Changing the Java version
-13.2.4. Using the Spring Boot Maven plugin
-13.3. Gradle
-13.4. Ant
-13.5. Starters
-14. Structuring your code
-14.1. Using the “default” package
-14.2. Locating the main application class
-15. Configuration classes
-15.1. Importing additional configuration classes
-15.2. Importing XML configuration
-16. Auto-configuration
-16.1. Gradually replacing auto-configuration
-16.2. Disabling specific auto-configuration
-17. Spring Beans and dependency injection
-18. Using the @SpringBootApplication annotation
-19. Running your application
-19.1. Running from an IDE
-19.2. Running as a packaged application
-19.3. Using the Maven plugin
-19.4. Using the Gradle plugin
-19.5. Hot swapping
-20. Developer tools
-20.1. Property defaults
-20.2. Automatic restart
-20.2.1. Excluding resources
-20.2.2. Watching additional paths
-20.2.3. Disabling restart
-20.2.4. Using a trigger file
-20.2.5. Customizing the restart classloader
-20.2.6. Known limitations
-20.3. LiveReload
-20.4. Global settings
-20.5. Remote applications
-20.5.1. Running the remote client application
-20.5.2. Remote update
-20.5.3. Remote debug tunnel
-21. Packaging your application for production
-22. What to read next
-IV. Spring Boot features
-23. SpringApplication
-23.1. Startup failure
-23.2. Customizing the Banner
-23.3. Customizing SpringApplication
-23.4. Fluent builder API
-23.5. Application events and listeners
-23.6. Web environment
-23.7. Accessing application arguments
-23.8. Using the ApplicationRunner or CommandLineRunner
-23.9. Application exit
-23.10. Admin features
-24. Externalized Configuration
-24.1. Configuring random values
-24.2. Accessing command line properties
-24.3. Application property files
-24.4. Profile-specific properties
-24.5. Placeholders in properties
-24.6. Using YAML instead of Properties
-24.6.1. Loading YAML
-24.6.2. Exposing YAML as properties in the Spring Environment
-24.6.3. Multi-profile YAML documents
-24.6.4. YAML shortcomings
-24.6.5. Merging YAML lists
-24.7. Type-safe Configuration Properties
-24.7.1. Third-party configuration
-24.7.2. Relaxed binding
-24.7.3. Properties conversion
-24.7.4. @ConfigurationProperties Validation
-24.7.5. @ConfigurationProperties vs. @Value
-25. Profiles
-25.1. Adding active profiles
-25.2. Programmatically setting profiles
-25.3. Profile-specific configuration files
-26. Logging
-26.1. Log format
-26.2. Console output
-26.2.1. Color-coded output
-26.3. File output
-26.4. Log Levels
-26.5. Custom log configuration
-26.6. Logback extensions
-26.6.1. Profile-specific configuration
-26.6.2. Environment properties
-27. Developing web applications
-27.1. The ‘Spring Web MVC framework’
-27.1.1. Spring MVC auto-configuration
-27.1.2. HttpMessageConverters
-27.1.3. Custom JSON Serializers and Deserializers
-27.1.4. MessageCodesResolver
-27.1.5. Static Content
-27.1.6. Custom Favicon
-27.1.7. ConfigurableWebBindingInitializer
-27.1.8. Template engines
-27.1.9. Error Handling
-Custom error pages
-Mapping error pages outside of Spring MVC
-Error Handling on WebSphere Application Server
-27.1.10. Spring HATEOAS
-27.1.11. CORS support
-27.2. JAX-RS and Jersey
-27.3. Embedded servlet container support
-27.3.1. Servlets, Filters, and listeners
-Registering Servlets, Filters, and listeners as Spring beans
-27.3.2. Servlet Context Initialization
-Scanning for Servlets, Filters, and listeners
-27.3.3. The EmbeddedWebApplicationContext
-27.3.4. Customizing embedded servlet containers
-Programmatic customization
-Customizing ConfigurableEmbeddedServletContainer directly
-27.3.5. JSP limitations
-28. Security
-28.1. OAuth2
-28.1.1. Authorization Server
-28.1.2. Resource Server
-28.2. Token Type in User Info
-28.3. Customizing the User Info RestTemplate
-28.3.1. Client
-28.3.2. Single Sign On
-28.4. Actuator Security
-29. Working with SQL databases
-29.1. Configure a DataSource
-29.1.1. Embedded Database Support
-29.1.2. Connection to a production database
-29.1.3. Connection to a JNDI DataSource
-29.2. Using JdbcTemplate
-29.3. JPA and ‘Spring Data’
-29.3.1. Entity Classes
-29.3.2. Spring Data JPA Repositories
-29.3.3. Creating and dropping JPA databases
-29.3.4. Open EntityManager in View
-29.4. Using H2’s web console
-29.4.1. Changing the H2 console’s path
-29.4.2. Securing the H2 console
-29.5. Using jOOQ
-29.5.1. Code Generation
-29.5.2. Using DSLContext
-29.5.3. Customizing jOOQ
-30. Working with NoSQL technologies
-30.1. Redis
-30.1.1. Connecting to Redis
-30.2. MongoDB
-30.2.1. Connecting to a MongoDB database
-30.2.2. MongoTemplate
-30.2.3. Spring Data MongoDB repositories
-30.2.4. Embedded Mongo
-30.3. Neo4j
-30.3.1. Connecting to a Neo4j database
-30.3.2. Using the embedded mode
-30.3.3. Neo4jSession
-30.3.4. Spring Data Neo4j repositories
-30.3.5. Repository example
-30.4. Gemfire
-30.5. Solr
-30.5.1. Connecting to Solr
-30.5.2. Spring Data Solr repositories
-30.6. Elasticsearch
-30.6.1. Connecting to Elasticsearch using Jest
-30.6.2. Connecting to Elasticsearch using Spring Data
-30.6.3. Spring Data Elasticsearch repositories
-30.7. Cassandra
-30.7.1. Connecting to Cassandra
-30.7.2. Spring Data Cassandra repositories
-30.8. Couchbase
-30.8.1. Connecting to Couchbase
-30.8.2. Spring Data Couchbase repositories
-30.9. LDAP
-30.9.1. Connecting to an LDAP server
-30.9.2. Spring Data LDAP repositories
-30.9.3. Embedded in-memory LDAP server
-31. Caching
-31.1. Supported cache providers
-31.1.1. Generic
-31.1.2. JCache (JSR-107)
-31.1.3. EhCache 2.x
-31.1.4. Hazelcast
-31.1.5. Infinispan
-31.1.6. Couchbase
-31.1.7. Redis
-31.1.8. Caffeine
-31.1.9. Guava (deprecated)
-31.1.10. Simple
-31.1.11. None
-32. Messaging
-32.1. JMS
-32.1.1. ActiveMQ support
-32.1.2. Artemis support
-32.1.3. Using a JNDI ConnectionFactory
-32.1.4. Sending a message
-32.1.5. Receiving a message
-32.2. AMQP
-32.2.1. RabbitMQ support
-32.2.2. Sending a message
-32.2.3. Receiving a message
-32.3. Apache Kafka Support
-32.3.1. Sending a Message
-32.3.2. Receiving a Message
-32.3.3. Additional Kafka Properties
-33. Calling REST services
-33.1. RestTemplate customization
-34. Validation
-35. Sending email
-36. Distributed Transactions with JTA
-36.1. Using an Atomikos transaction manager
-36.2. Using a Bitronix transaction manager
-36.3. Using a Narayana transaction manager
-36.4. Using a Java EE managed transaction manager
-36.5. Mixing XA and non-XA JMS connections
-36.6. Supporting an alternative embedded transaction manager
-37. Hazelcast
-38. Spring Integration
-39. Spring Session
-40. Monitoring and management over JMX
-41. Testing
-41.1. Test scope dependencies
-41.2. Testing Spring applications
-41.3. Testing Spring Boot applications
-41.3.1. Detecting test configuration
-41.3.2. Excluding test configuration
-41.3.3. Working with random ports
-41.3.4. Mocking and spying beans
-41.3.5. Auto-configured tests
-41.3.6. Auto-configured JSON tests
-41.3.7. Auto-configured Spring MVC tests
-41.3.8. Auto-configured Data JPA tests
-41.3.9. Auto-configured JDBC tests
-41.3.10. Auto-configured Data MongoDB tests
-41.3.11. Auto-configured REST clients
-41.3.12. Auto-configured Spring REST Docs tests
-41.3.13. Using Spock to test Spring Boot applications
-41.4. Test utilities
-41.4.1. ConfigFileApplicationContextInitializer
-41.4.2. EnvironmentTestUtils
-41.4.3. OutputCapture
-41.4.4. TestRestTemplate
-42. WebSockets
-43. Web Services
-44. Creating your own auto-configuration
-44.1. Understanding auto-configured beans
-44.2. Locating auto-configuration candidates
-44.3. Condition annotations
-44.3.1. Class conditions
-44.3.2. Bean conditions
-44.3.3. Property conditions
-44.3.4. Resource conditions
-44.3.5. Web application conditions
-44.3.6. SpEL expression conditions
-44.4. Creating your own starter
-44.4.1. Naming
-44.4.2. Autoconfigure module
-44.4.3. Starter module
-45. What to read next
-V. Spring Boot Actuator: Production-ready features
-46. Enabling production-ready features
-47. Endpoints
-47.1. Customizing endpoints
-47.2. Hypermedia for actuator MVC endpoints
-47.3. CORS support
-47.4. Adding custom endpoints
-47.5. Health information
-47.6. Security with HealthIndicators
-47.6.1. Auto-configured HealthIndicators
-47.6.2. Writing custom HealthIndicators
-47.7. Application information
-47.7.1. Auto-configured InfoContributors
-47.7.2. Custom application info information
-47.7.3. Git commit information
-47.7.4. Build information
-47.7.5. Writing custom InfoContributors
-48. Monitoring and management over HTTP
-48.1. Accessing sensitive endpoints
-48.2. Customizing the management endpoint paths
-48.3. Customizing the management server port
-48.4. Configuring management-specific SSL
-48.5. Customizing the management server address
-48.6. Disabling HTTP endpoints
-48.7. HTTP health endpoint format and access restrictions
-49. Monitoring and management over JMX
-49.1. Customizing MBean names
-49.2. Disabling JMX endpoints
-49.3. Using Jolokia for JMX over HTTP
-49.3.1. Customizing Jolokia
-49.3.2. Disabling Jolokia
-50. Monitoring and management using a remote shell (deprecated)
-50.1. Connecting to the remote shell
-50.1.1. Remote shell credentials
-50.2. Extending the remote shell
-50.2.1. Remote shell commands
-50.2.2. Remote shell plugins
-51. Loggers
-51.1. Configure a Logger
-52. Metrics
-52.1. System metrics
-52.2. DataSource metrics
-52.3. Cache metrics
-52.4. Tomcat session metrics
-52.5. Recording your own metrics
-52.6. Adding your own public metrics
-52.7. Special features with Java 8
-52.8. Metric writers, exporters and aggregation
-52.8.1. Example: Export to Redis
-52.8.2. Example: Export to Open TSDB
-52.8.3. Example: Export to Statsd
-52.8.4. Example: Export to JMX
-52.9. Aggregating metrics from multiple sources
-52.10. Dropwizard Metrics
-52.11. Message channel integration
-53. Auditing
-54. Tracing
-54.1. Custom tracing
-55. Process monitoring
-55.1. Extend configuration
-55.2. Programmatically
-56. Cloud Foundry support
-56.1. Disabling extended Cloud Foundry actuator support
-56.2. Cloud Foundry self signed certificates
-56.3. Custom security configuration
-57. What to read next
-VI. Deploying Spring Boot applications
-58. Deploying to the cloud
-58.1. Cloud Foundry
-58.1.1. Binding to services
-58.2. Heroku
-58.3. OpenShift
-58.4. Amazon Web Services (AWS)
-58.4.1. AWS Elastic Beanstalk
-Using the Tomcat platform
-Using the Java SE platform
-Best practices
-58.4.2. Summary
-58.5. Boxfuse and Amazon Web Services
-58.6. Google Cloud
-59. Installing Spring Boot applications
-59.1. Supported operating systems
-59.2. Unix/Linux services
-59.2.1. Installation as an init.d service (System V)
-Securing an init.d service
-59.2.2. Installation as a systemd service
-59.2.3. Customizing the startup script
-Customizing script when it’s written
-Customizing script when it runs
-59.3. Microsoft Windows services
-60. What to read next
-VII. Spring Boot CLI
-61. Installing the CLI
-62. Using the CLI
-62.1. Running applications using the CLI
-62.1.1. Deduced “grab” dependencies
-62.1.2. Deduced “grab” coordinates
-62.1.3. Default import statements
-62.1.4. Automatic main method
-62.1.5. Custom dependency management
-62.2. Testing your code
-62.3. Applications with multiple source files
-62.4. Packaging your application
-62.5. Initialize a new project
-62.6. Using the embedded shell
-62.7. Adding extensions to the CLI
-63. Developing application with the Groovy beans DSL
-64. Configuring the CLI with settings.xml
-65. What to read next
-VIII. Build tool plugins
-66. Spring Boot Maven plugin
-66.1. Including the plugin
-66.2. Packaging executable jar and war files
-67. Spring Boot Gradle plugin
-67.1. Including the plugin
-67.2. Gradle dependency management
-67.3. Packaging executable jar and war files
-67.4. Running a project in-place
-67.5. Spring Boot plugin configuration
-67.6. Repackage configuration
-67.7. Repackage with custom Gradle configuration
-67.7.1. Configuration options
-67.7.2. Available layouts
-67.7.3. Using a custom layout
-67.8. Understanding how the Gradle plugin works
-67.9. Publishing artifacts to a Maven repository using Gradle
-67.9.1. Configuring Gradle to produce a pom that inherits dependency management
-67.9.2. Configuring Gradle to produce a pom that imports dependency management
-68. Spring Boot AntLib module
-68.1. Spring Boot Ant tasks
-68.1.1. spring-boot:exejar
-68.1.2. Examples
-68.2. spring-boot:findmainclass
-68.2.1. Examples
-69. Supporting other build systems
-69.1. Repackaging archives
-69.2. Nested libraries
-69.3. Finding a main class
-69.4. Example repackage implementation
-70. What to read next
-IX. ‘How-to’ guides
-71. Spring Boot application
-71.1. Create your own FailureAnalyzer
-71.2. Troubleshoot auto-configuration
-71.3. Customize the Environment or ApplicationContext before it starts
-71.4. Build an ApplicationContext hierarchy (adding a parent or root context)
-71.5. Create a non-web application
-72. Properties & configuration
-72.1. Automatically expand properties at build time
-72.1.1. Automatic property expansion using Maven
-72.1.2. Automatic property expansion using Gradle
-72.2. Externalize the configuration of SpringApplication
-72.3. Change the location of external properties of an application
-72.4. Use ‘short’ command line arguments
-72.5. Use YAML for external properties
-72.6. Set the active Spring profiles
-72.7. Change configuration depending on the environment
-72.8. Discover built-in options for external properties
-73. Embedded servlet containers
-73.1. Add a Servlet, Filter or Listener to an application
-73.1.1. Add a Servlet, Filter or Listener using a Spring bean
-Disable registration of a Servlet or Filter
-73.1.2. Add Servlets, Filters, and Listeners using classpath scanning
-73.2. Change the HTTP port
-73.3. Use a random unassigned HTTP port
-73.4. Discover the HTTP port at runtime
-73.5. Configure SSL
-73.6. Configure Access Logging
-73.7. Use behind a front-end proxy server
-73.7.1. Customize Tomcat’s proxy configuration
-73.8. Configure Tomcat
-73.9. Enable Multiple Connectors with Tomcat
-73.10. Use Tomcat’s LegacyCookieProcessor
-73.11. Use Jetty instead of Tomcat
-73.12. Configure Jetty
-73.13. Use Undertow instead of Tomcat
-73.14. Configure Undertow
-73.15. Enable Multiple Listeners with Undertow
-73.16. Use Tomcat 7.x or 8.0
-73.16.1. Use Tomcat 7.x or 8.0 with Maven
-73.16.2. Use Tomcat 7.x or 8.0 with Gradle
-73.17. Use Jetty 9.2
-73.17.1. Use Jetty 9.2 with Maven
-73.17.2. Use Jetty 9.2 with Gradle
-73.18. Use Jetty 8
-73.18.1. Use Jetty 8 with Maven
-73.18.2. Use Jetty 8 with Gradle
-73.19. Create WebSocket endpoints using @ServerEndpoint
-73.20. Enable HTTP response compression
-74. Spring MVC
-74.1. Write a JSON REST service
-74.2. Write an XML REST service
-74.3. Customize the Jackson ObjectMapper
-74.4. Customize the @ResponseBody rendering
-74.5. Handling Multipart File Uploads
-74.6. Switch off the Spring MVC DispatcherServlet
-74.7. Switch off the Default MVC configuration
-74.8. Customize ViewResolvers
-74.9. Use Thymeleaf 3
-75. HTTP clients
-75.1. Configure RestTemplate to use a proxy
-76. Logging
-76.1. Configure Logback for logging
-76.1.1. Configure logback for file only output
-76.2. Configure Log4j for logging
-76.2.1. Use YAML or JSON to configure Log4j 2
-77. Data Access
-77.1. Configure a custom DataSource
-77.2. Configure Two DataSources
-77.3. Use Spring Data repositories
-77.4. Separate @Entity definitions from Spring configuration
-77.5. Configure JPA properties
-77.6. Configure Hibernate Naming Strategy
-77.7. Use a custom EntityManagerFactory
-77.8. Use Two EntityManagers
-77.9. Use a traditional persistence.xml
-77.10. Use Spring Data JPA and Mongo repositories
-77.11. Expose Spring Data repositories as REST endpoint
-77.12. Configure a component that is used by JPA
-78. Database initialization
-78.1. Initialize a database using JPA
-78.2. Initialize a database using Hibernate
-78.3. Initialize a database using Spring JDBC
-78.4. Initialize a Spring Batch database
-78.5. Use a higher-level database migration tool
-78.5.1. Execute Flyway database migrations on startup
-78.5.2. Execute Liquibase database migrations on startup
-79. Messaging
-79.1. Disable transacted JMS session
-80. Batch applications
-80.1. Execute Spring Batch jobs on startup
-81. Actuator
-81.1. Change the HTTP port or address of the actuator endpoints
-81.2. Customize the ‘whitelabel’ error page
-81.3. Actuator and Jersey
-82. Security
-82.1. Switch off the Spring Boot security configuration
-82.2. Change the AuthenticationManager and add user accounts
-82.3. Enable HTTPS when running behind a proxy server
-83. Hot swapping
-83.1. Reload static content
-83.2. Reload templates without restarting the container
-83.2.1. Thymeleaf templates
-83.2.2. FreeMarker templates
-83.2.3. Groovy templates
-83.3. Fast application restarts
-83.4. Reload Java classes without restarting the container
-83.4.1. Configuring Spring Loaded for use with Maven
-83.4.2. Configuring Spring Loaded for use with Gradle and IntelliJ IDEA
-84. Build
-84.1. Generate build information
-84.2. Generate git information
-84.3. Customize dependency versions
-84.4. Create an executable JAR with Maven
-84.5. Use a Spring Boot application as a dependency
-84.6. Extract specific libraries when an executable jar runs
-84.7. Create a non-executable JAR with exclusions
-84.8. Remote debug a Spring Boot application started with Maven
-84.9. Remote debug a Spring Boot application started with Gradle
-84.10. Build an executable archive from Ant without using spring-boot-antlib
-84.11. How to use Java 6
-84.11.1. Embedded servlet container compatibility
-84.11.2. Jackson
-84.11.3. JTA API compatibility
-85. Traditional deployment
-85.1. Create a deployable war file
-85.2. Create a deployable war file for older servlet containers
-85.3. Convert an existing application to Spring Boot
-85.4. Deploying a WAR to WebLogic
-85.5. Deploying a WAR in an Old (Servlet 2.5) Container
-X. Appendices
-A. Common application properties
-B. Configuration meta-data
-B.1. Meta-data format
-B.1.1. Group Attributes
-B.1.2. Property Attributes
-B.1.3. Hint Attributes
-B.1.4. Repeated meta-data items
-B.2. Providing manual hints
-B.2.1. Value hint
-B.2.2. Value provider
-Any
-Class reference
-Handle As
-Logger name
-Spring bean reference
-Spring profile name
-B.3. Generating your own meta-data using the annotation processor
-B.3.1. Nested properties
-B.3.2. Adding additional meta-data
-C. Auto-configuration classes
-C.1. From the “spring-boot-autoconfigure” module
-C.2. From the “spring-boot-actuator” module
-D. Test auto-configuration annotations
-E. The executable jar format
-E.1. Nested JARs
-E.1.1. The executable jar file structure
-E.1.2. The executable war file structure
-E.2. Spring Boot’s “JarFile” class
-E.2.1. Compatibility with the standard Java “JarFile”
-E.3. Launching executable jars
-E.3.1. Launcher manifest
-E.3.2. Exploded archives
-E.4. PropertiesLauncher Features
-E.5. Executable jar restrictions
-E.5.1. Zip entry compression
-E.5.2. System ClassLoader
-E.6. Alternative single jar solutions
-F. Dependency versions
-Part I. Spring Boot Documentation
+
+Phillip Webb, Dave Syer, Josh Long, Stéphane Nicoll, Rob Winch, Andy Wilkinson, Marcel Overdijk, Christian Dupuis, Sébastien Deleuze, Michael Simons
+
+
+
+**1.5.7.BUILD-SNAPSHOT**
+
+
+
+Copyright © 2012-2017
+
+*Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this* *Copyright Notice, whether distributed in print or electronically.*
+
+------
+
+**Table of Contents**
+
+- [I. Spring Boot Documentation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-documentation)
+
+ [1. About the documentation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-documentation-about)[2. Getting help](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-documentation-getting-help)[3. First steps](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-documentation-first-steps)[4. Working with Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_working_with_spring_boot)[5. Learning about Spring Boot features](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_learning_about_spring_boot_features)[6. Moving to production](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_moving_to_production)[7. Advanced topics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_advanced_topics)
+
+- [II. Getting started](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started)
+
+ [8. Introducing Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-introducing-spring-boot)[9. System Requirements](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-system-requirements)[9.1. Servlet containers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_servlet_containers)[10. Installing Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-installing-spring-boot)[10.1. Installation instructions for the Java developer](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-installation-instructions-for-java)[10.1.1. Maven installation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-maven-installation)[10.1.2. Gradle installation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-gradle-installation)[10.2. Installing the Spring Boot CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-installing-the-cli)[10.2.1. Manual installation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-manual-cli-installation)[10.2.2. Installation with SDKMAN!](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-sdkman-cli-installation)[10.2.3. OSX Homebrew installation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-homebrew-cli-installation)[10.2.4. MacPorts installation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-macports-cli-installation)[10.2.5. Command-line completion](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-cli-command-line-completion)[10.2.6. Quick start Spring CLI example](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-cli-example)[10.3. Upgrading from an earlier version of Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-upgrading-from-an-earlier-version)[11. Developing your first Spring Boot application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application)[11.1. Creating the POM](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-pom)[11.2. Adding classpath dependencies](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-dependencies)[11.3. Writing the code](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-code)[11.3.1. The @RestController and @RequestMapping annotations](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-annotations)[11.3.2. The @EnableAutoConfiguration annotation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-auto-configuration)[11.3.3. The “main” method](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-main-method)[11.4. Running the example](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-run)[11.5. Creating an executable jar](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-executable-jar)[12. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-whats-next)
+
+- [III. Using Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot)
+
+ [13. Build systems](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-build-systems)[13.1. Dependency management](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-dependency-management)[13.2. Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven)[13.2.1. Inheriting the starter parent](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-parent-pom)[13.2.2. Using Spring Boot without the parent POM](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-without-a-parent)[13.2.3. Changing the Java version](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-java-version)[13.2.4. Using the Spring Boot Maven plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-plugin)[13.3. Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-gradle)[13.4. Ant](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-ant)[13.5. Starters](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-starter)[14. Structuring your code](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-structuring-your-code)[14.1. Using the “default” package](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-using-the-default-package)[14.2. Locating the main application class](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-locating-the-main-class)[15. Configuration classes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-configuration-classes)[15.1. Importing additional configuration classes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-importing-configuration)[15.2. Importing XML configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-importing-xml-configuration)[16. Auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration)[16.1. Gradually replacing auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-replacing-auto-configuration)[16.2. Disabling specific auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-disabling-specific-auto-configuration)[17. Spring Beans and dependency injection](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-spring-beans-and-dependency-injection)[18. Using the @SpringBootApplication annotation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-using-springbootapplication-annotation)[19. Running your application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-your-application)[19.1. Running from an IDE](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-from-an-ide)[19.2. Running as a packaged application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-as-a-packaged-application)[19.3. Using the Maven plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-with-the-maven-plugin)[19.4. Using the Gradle plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-with-the-gradle-plugin)[19.5. Hot swapping](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-hot-swapping)[20. Developer tools](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools)[20.1. Property defaults](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-property-defaults)[20.2. Automatic restart](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart)[20.2.1. Excluding resources](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-exclude)[20.2.2. Watching additional paths](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-additional-paths)[20.2.3. Disabling restart](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-disable)[20.2.4. Using a trigger file](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-triggerfile)[20.2.5. Customizing the restart classloader](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-customizing-classload)[20.2.6. Known limitations](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-known-restart-limitations)[20.3. LiveReload](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-livereload)[20.4. Global settings](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-globalsettings)[20.5. Remote applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-remote)[20.5.1. Running the remote client application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_running_the_remote_client_application)[20.5.2. Remote update](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-remote-update)[20.5.3. Remote debug tunnel](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-remote-debugtunnel)[21. Packaging your application for production](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-packaging-for-production)[22. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-whats-next)
+
+- [IV. Spring Boot features](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features)
+
+ [23. SpringApplication](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-application)[23.1. Startup failure](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_startup_failure)[23.2. Customizing the Banner](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-banner)[23.3. Customizing SpringApplication](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-customizing-spring-application)[23.4. Fluent builder API](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-fluent-builder-api)[23.5. Application events and listeners](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-application-events-and-listeners)[23.6. Web environment](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-web-environment)[23.7. Accessing application arguments](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-application-arguments)[23.8. Using the ApplicationRunner or CommandLineRunner](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-command-line-runner)[23.9. Application exit](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-application-exit)[23.10. Admin features](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-application-admin)[24. Externalized Configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config)[24.1. Configuring random values](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-random-values)[24.2. Accessing command line properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-command-line-args)[24.3. Application property files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-application-property-files)[24.4. Profile-specific properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-profile-specific-properties)[24.5. Placeholders in properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-placeholders-in-properties)[24.6. Using YAML instead of Properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-yaml)[24.6.1. Loading YAML](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-loading-yaml)[24.6.2. Exposing YAML as properties in the Spring Environment](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-exposing-yaml-to-spring)[24.6.3. Multi-profile YAML documents](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-multi-profile-yaml)[24.6.4. YAML shortcomings](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-yaml-shortcomings)[24.6.5. Merging YAML lists](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-complex-type-merge)[24.7. Type-safe Configuration Properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-typesafe-configuration-properties)[24.7.1. Third-party configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-3rd-party-configuration)[24.7.2. Relaxed binding](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-relaxed-binding)[24.7.3. Properties conversion](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-conversion)[24.7.4. @ConfigurationProperties Validation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-validation)[24.7.5. @ConfigurationProperties vs. @Value](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-vs-value)[25. Profiles](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-profiles)[25.1. Adding active profiles](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-adding-active-profiles)[25.2. Programmatically setting profiles](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-programmatically-setting-profiles)[25.3. Profile-specific configuration files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-profile-specific-configuration)[26. Logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging)[26.1. Log format](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging-format)[26.2. Console output](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging-console-output)[26.2.1. Color-coded output](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging-color-coded-output)[26.3. File output](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging-file-output)[26.4. Log Levels](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-log-levels)[26.5. Custom log configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-log-configuration)[26.6. Logback extensions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logback-extensions)[26.6.1. Profile-specific configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_profile_specific_configuration)[26.6.2. Environment properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_environment_properties)[27. Developing web applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-developing-web-applications)[27.1. The ‘Spring Web MVC framework’](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc)[27.1.1. Spring MVC auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-auto-configuration)[27.1.2. HttpMessageConverters](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-message-converters)[27.1.3. Custom JSON Serializers and Deserializers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-json-components)[27.1.4. MessageCodesResolver](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-message-codes)[27.1.5. Static Content](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-static-content)[27.1.6. Custom Favicon](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-favicon)[27.1.7. ConfigurableWebBindingInitializer](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-web-binding-initializer)[27.1.8. Template engines](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-template-engines)[27.1.9. Error Handling](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling)[Custom error pages](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling-custom-error-pages)[Mapping error pages outside of Spring MVC](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling-mapping-error-pages-without-mvc)[Error Handling on WebSphere Application Server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling-websphere)[27.1.10. Spring HATEOAS](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-hateoas)[27.1.11. CORS support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-cors)[27.2. JAX-RS and Jersey](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jersey)[27.3. Embedded servlet container support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container)[27.3.1. Servlets, Filters, and listeners](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container-servlets-filters-listeners)[Registering Servlets, Filters, and listeners as Spring beans](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container-servlets-filters-listeners-beans)[27.3.2. Servlet Context Initialization](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container-context-initializer)[Scanning for Servlets, Filters, and listeners](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container-servlets-filters-listeners-scanning)[27.3.3. The EmbeddedWebApplicationContext](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container-application-context)[27.3.4. Customizing embedded servlet containers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-customizing-embedded-containers)[Programmatic customization](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-programmatic-embedded-container-customization)[Customizing ConfigurableEmbeddedServletContainer directly](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-customizing-configurableembeddedservletcontainerfactory-directly)[27.3.5. JSP limitations](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jsp-limitations)[28. Security](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security)[28.1. OAuth2](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-oauth2)[28.1.1. Authorization Server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-oauth2-authorization-server)[28.1.2. Resource Server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-oauth2-resource-server)[28.2. Token Type in User Info](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-oauth2-token-type)[28.3. Customizing the User Info RestTemplate](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-custom-user-info)[28.3.1. Client](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-custom-user-info-client)[28.3.2. Single Sign On](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-oauth2-single-sign-on)[28.4. Actuator Security](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-security-actuator)[29. Working with SQL databases](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-sql)[29.1. Configure a DataSource](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-configure-datasource)[29.1.1. Embedded Database Support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-database-support)[29.1.2. Connection to a production database](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connect-to-production-database)[29.1.3. Connection to a JNDI DataSource](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-a-jndi-datasource)[29.2. Using JdbcTemplate](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-using-jdbc-template)[29.3. JPA and ‘Spring Data’](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jpa-and-spring-data)[29.3.1. Entity Classes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-entity-classes)[29.3.2. Spring Data JPA Repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-jpa-repositories)[29.3.3. Creating and dropping JPA databases](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-creating-and-dropping-jpa-databases)[29.3.4. Open EntityManager in View](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jpa-in-web-environment)[29.4. Using H2’s web console](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-sql-h2-console)[29.4.1. Changing the H2 console’s path](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-sql-h2-console-custom-path)[29.4.2. Securing the H2 console](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-sql-h2-console-securing)[29.5. Using jOOQ](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jooq)[29.5.1. Code Generation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_code_generation)[29.5.2. Using DSLContext](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_using_dslcontext)[29.5.3. Customizing jOOQ](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_customizing_jooq)[30. Working with NoSQL technologies](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-nosql)[30.1. Redis](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-redis)[30.1.1. Connecting to Redis](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-redis)[30.2. MongoDB](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-mongodb)[30.2.1. Connecting to a MongoDB database](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-mongodb)[30.2.2. MongoTemplate](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-mongo-template)[30.2.3. Spring Data MongoDB repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-mongo-repositories)[30.2.4. Embedded Mongo](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-mongo-embedded)[30.3. Neo4j](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-neo4j)[30.3.1. Connecting to a Neo4j database](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-neo4j)[30.3.2. Using the embedded mode](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-neo4j-embedded)[30.3.3. Neo4jSession](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-neo4j-ogm-session)[30.3.4. Spring Data Neo4j repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-neo4j-repositories)[30.3.5. Repository example](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_repository_example)[30.4. Gemfire](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-gemfire)[30.5. Solr](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-solr)[30.5.1. Connecting to Solr](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-solr)[30.5.2. Spring Data Solr repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-solr-repositories)[30.6. Elasticsearch](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-elasticsearch)[30.6.1. Connecting to Elasticsearch using Jest](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-elasticsearch-jest)[30.6.2. Connecting to Elasticsearch using Spring Data](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-elasticsearch-spring-data)[30.6.3. Spring Data Elasticsearch repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-elasticsearch-repositories)[30.7. Cassandra](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-cassandra)[30.7.1. Connecting to Cassandra](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-cassandra)[30.7.2. Spring Data Cassandra repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-cassandra-repositories)[30.8. Couchbase](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-couchbase)[30.8.1. Connecting to Couchbase](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-connecting-to-couchbase)[30.8.2. Spring Data Couchbase repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-data-couchbase-repositories)[30.9. LDAP](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-ldap)[30.9.1. Connecting to an LDAP server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-ldap-connecting)[30.9.2. Spring Data LDAP repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-ldap-spring-data-repositories)[30.9.3. Embedded in-memory LDAP server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-ldap-embedded)[31. Caching](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching)[31.1. Supported cache providers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_supported_cache_providers)[31.1.1. Generic](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-generic)[31.1.2. JCache (JSR-107)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-jcache)[31.1.3. EhCache 2.x](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-ehcache2)[31.1.4. Hazelcast](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-hazelcast)[31.1.5. Infinispan](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-infinispan)[31.1.6. Couchbase](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-couchbase)[31.1.7. Redis](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-redis)[31.1.8. Caffeine](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-caffeine)[31.1.9. Guava (deprecated)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-guava)[31.1.10. Simple](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-simple)[31.1.11. None](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-none)[32. Messaging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-messaging)[32.1. JMS](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jms)[32.1.1. ActiveMQ support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-activemq)[32.1.2. Artemis support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-artemis)[32.1.3. Using a JNDI ConnectionFactory](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jms-jndi)[32.1.4. Sending a message](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-using-jms-sending)[32.1.5. Receiving a message](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-using-jms-receiving)[32.2. AMQP](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-amqp)[32.2.1. RabbitMQ support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-rabbitmq)[32.2.2. Sending a message](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-using-amqp-sending)[32.2.3. Receiving a message](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-using-amqp-receiving)[32.3. Apache Kafka Support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-kafka)[32.3.1. Sending a Message](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-kafka-sending-a-message)[32.3.2. Receiving a Message](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-kafka-receiving-a-message)[32.3.3. Additional Kafka Properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-kafka-extra-props)[33. Calling REST services](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-restclient)[33.1. RestTemplate customization](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-restclient-customization)[34. Validation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-validation)[35. Sending email](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-email)[36. Distributed Transactions with JTA](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta)[36.1. Using an Atomikos transaction manager](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta-atomikos)[36.2. Using a Bitronix transaction manager](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta-bitronix)[36.3. Using a Narayana transaction manager](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta-narayana)[36.4. Using a Java EE managed transaction manager](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta-javaee)[36.5. Mixing XA and non-XA JMS connections](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta-mixed-jms)[36.6. Supporting an alternative embedded transaction manager](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jta-supporting-alternative-embedded)[37. Hazelcast](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-hazelcast)[38. Spring Integration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-integration)[39. Spring Session](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-session)[40. Monitoring and management over JMX](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jmx)[41. Testing](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing)[41.1. Test scope dependencies](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-test-scope-dependencies)[41.2. Testing Spring applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-applications)[41.3. Testing Spring Boot applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications)[41.3.1. Detecting test configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-detecting-config)[41.3.2. Excluding test configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-excluding-config)[41.3.3. Working with random ports](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-working-with-random-ports)[41.3.4. Mocking and spying beans](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-mocking-beans)[41.3.5. Auto-configured tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-tests)[41.3.6. Auto-configured JSON tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-json-tests)[41.3.7. Auto-configured Spring MVC tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-mvc-tests)[41.3.8. Auto-configured Data JPA tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-jpa-test)[41.3.9. Auto-configured JDBC tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-jdbc-test)[41.3.10. Auto-configured Data MongoDB tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-mongo-test)[41.3.11. Auto-configured REST clients](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-client)[41.3.12. Auto-configured Spring REST Docs tests](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-testing-autoconfigured-rest-docs)[41.3.13. Using Spock to test Spring Boot applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications-with-spock)[41.4. Test utilities](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-test-utilities)[41.4.1. ConfigFileApplicationContextInitializer](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-configfileapplicationcontextinitializer-test-utility)[41.4.2. EnvironmentTestUtils](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-environment-test-utilities)[41.4.3. OutputCapture](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-output-capture-test-utility)[41.4.4. TestRestTemplate](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-rest-templates-test-utility)[42. WebSockets](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-websockets)[43. Web Services](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-webservices)[44. Creating your own auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-developing-auto-configuration)[44.1. Understanding auto-configured beans](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-understanding-auto-configured-beans)[44.2. Locating auto-configuration candidates](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-locating-auto-configuration-candidates)[44.3. Condition annotations](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-condition-annotations)[44.3.1. Class conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-class-conditions)[44.3.2. Bean conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-bean-conditions)[44.3.3. Property conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-property-conditions)[44.3.4. Resource conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-resource-conditions)[44.3.5. Web application conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-web-application-conditions)[44.3.6. SpEL expression conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spel-conditions)[44.4. Creating your own starter](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-starter)[44.4.1. Naming](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-starter-naming)[44.4.2. Autoconfigure module](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-starter-module-autoconfigure)[44.4.3. Starter module](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-starter-module-starter)[45. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-whats-next)
+
+- [V. Spring Boot Actuator: Production-ready features](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready)
+
+ [46. Enabling production-ready features](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-enabling)[47. Endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-endpoints)[47.1. Customizing endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-endpoints)[47.2. Hypermedia for actuator MVC endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-endpoint-hypermedia)[47.3. CORS support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-endpoint-cors)[47.4. Adding custom endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-endpoints-programmatically)[47.5. Health information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-health)[47.6. Security with HealthIndicators](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_security_with_healthindicators)[47.6.1. Auto-configured HealthIndicators](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_auto_configured_healthindicators)[47.6.2. Writing custom HealthIndicators](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_writing_custom_healthindicators)[47.7. Application information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-application-info)[47.7.1. Auto-configured InfoContributors](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-application-info-autoconfigure)[47.7.2. Custom application info information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-application-info-env)[47.7.3. Git commit information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-application-info-git)[47.7.4. Build information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-application-info-build)[47.7.5. Writing custom InfoContributors](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-application-info-custom)[48. Monitoring and management over HTTP](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-monitoring)[48.1. Accessing sensitive endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-sensitive-endpoints)[48.2. Customizing the management endpoint paths](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-management-server-context-path)[48.3. Customizing the management server port](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-management-server-port)[48.4. Configuring management-specific SSL](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-management-specific-ssl)[48.5. Customizing the management server address](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-management-server-address)[48.6. Disabling HTTP endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-disabling-http-endpoints)[48.7. HTTP health endpoint format and access restrictions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-health-access-restrictions)[49. Monitoring and management over JMX](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-jmx)[49.1. Customizing MBean names](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-custom-mbean-names)[49.2. Disabling JMX endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-disable-jmx-endpoints)[49.3. Using Jolokia for JMX over HTTP](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-jolokia)[49.3.1. Customizing Jolokia](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-jolokia)[49.3.2. Disabling Jolokia](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-disabling-jolokia)[50. Monitoring and management using a remote shell (deprecated)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-remote-shell)[50.1. Connecting to the remote shell](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-connecting-to-the-remote-shell)[50.1.1. Remote shell credentials](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-remote-shell-credentials)[50.2. Extending the remote shell](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-extending-the-remote-shell)[50.2.1. Remote shell commands](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-remote-commands)[50.2.2. Remote shell plugins](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-remote-shell-plugins)[51. Loggers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-loggers)[51.1. Configure a Logger](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-logger-configuration)[52. Metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metrics)[52.1. System metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-system-metrics)[52.2. DataSource metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-datasource-metrics)[52.3. Cache metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-datasource-cache)[52.4. Tomcat session metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-session-metrics)[52.5. Recording your own metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-recording-metrics)[52.6. Adding your own public metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-public-metrics)[52.7. Special features with Java 8](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-repositories)[52.8. Metric writers, exporters and aggregation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-writers)[52.8.1. Example: Export to Redis](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-writers-export-to-redis)[52.8.2. Example: Export to Open TSDB](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-writers-export-to-open-tsdb)[52.8.3. Example: Export to Statsd](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-writers-export-to-statsd)[52.8.4. Example: Export to JMX](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-writers-export-to-jmx)[52.9. Aggregating metrics from multiple sources](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metric-aggregation)[52.10. Dropwizard Metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-dropwizard-metrics)[52.11. Message channel integration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metrics-message-channel-integration)[53. Auditing](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-auditing)[54. Tracing](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-tracing)[54.1. Custom tracing](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-custom-tracing)[55. Process monitoring](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-process-monitoring)[55.1. Extend configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-process-monitoring-configuration)[55.2. Programmatically](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-process-monitoring-programmatically)[56. Cloud Foundry support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-cloudfoundry)[56.1. Disabling extended Cloud Foundry actuator support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-cloudfoundry-disable)[56.2. Cloud Foundry self signed certificates](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-cloudfoundry-ssl)[56.3. Custom security configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-cloudfoundry-custom-security)[57. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-whats-next)
+
+- [VI. Deploying Spring Boot applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment)
+
+ [58. Deploying to the cloud](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment)[58.1. Cloud Foundry](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-cloud-foundry)[58.1.1. Binding to services](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-cloud-foundry-services)[58.2. Heroku](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-heroku)[58.3. OpenShift](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-openshift)[58.4. Amazon Web Services (AWS)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-aws)[58.4.1. AWS Elastic Beanstalk](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_aws_elastic_beanstalk)[Using the Tomcat platform](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_using_the_tomcat_platform)[Using the Java SE platform](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_using_the_java_se_platform)[Best practices](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_best_practices)[58.4.2. Summary](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_summary)[58.5. Boxfuse and Amazon Web Services](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-boxfuse)[58.6. Google Cloud](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment-gae)[59. Installing Spring Boot applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-install)[59.1. Supported operating systems](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-install-supported-operating-systems)[59.2. Unix/Linux services](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-service)[59.2.1. Installation as an init.d service (System V)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-initd-service)[Securing an init.d service](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-initd-service-securing)[59.2.2. Installation as a systemd service](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-systemd-service)[59.2.3. Customizing the startup script](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-script-customization)[Customizing script when it’s written](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-script-customization-when-it-written)[Customizing script when it runs](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-script-customization-when-it-runs)[59.3. Microsoft Windows services](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-windows)[60. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-whats-next)
+
+- [VII. Spring Boot CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli)
+
+ [61. Installing the CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-installation)[62. Using the CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-using-the-cli)[62.1. Running applications using the CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-run)[62.1.1. Deduced “grab” dependencies](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-deduced-grab-annotations)[62.1.2. Deduced “grab” coordinates](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-default-grab-deduced-coordinates)[62.1.3. Default import statements](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-default-import-statements)[62.1.4. Automatic main method](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-automatic-main-method)[62.1.5. Custom dependency management](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-default-grab-deduced-coordinates-custom-dependency-management)[62.2. Testing your code](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-testing)[62.3. Applications with multiple source files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-multiple-source-files)[62.4. Packaging your application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-jar)[62.5. Initialize a new project](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-init)[62.6. Using the embedded shell](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-shell)[62.7. Adding extensions to the CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-install-uninstall)[63. Developing application with the Groovy beans DSL](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-groovy-beans-dsl)[64. Configuring the CLI with settings.xml](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-maven-settings)[65. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli-whats-next)
+
+- [VIII. Build tool plugins](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins)
+
+ [66. Spring Boot Maven plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-maven-plugin)[66.1. Including the plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-include-maven-plugin)[66.2. Packaging executable jar and war files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-maven-packaging)[67. Spring Boot Gradle plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-plugin)[67.1. Including the plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-including-the-gradle-plugin)[67.2. Gradle dependency management](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-dependency-management)[67.3. Packaging executable jar and war files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-packaging)[67.4. Running a project in-place](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-running-applications)[67.5. Spring Boot plugin configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-global-configuration)[67.6. Repackage configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-repackage-configuration)[67.7. Repackage with custom Gradle configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-repackage-custom-configuration)[67.7.1. Configuration options](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-configuration-options)[67.7.2. Available layouts](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-configuration-layouts)[67.7.3. Using a custom layout](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-configuration-custom-repackager)[67.8. Understanding how the Gradle plugin works](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-understanding-the-gradle-plugin)[67.9. Publishing artifacts to a Maven repository using Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-publishing-artifacts-to-a-maven-repository)[67.9.1. Configuring Gradle to produce a pom that inherits dependency management](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-publishing-artifacts-to-a-maven-repository-inherit)[67.9.2. Configuring Gradle to produce a pom that imports dependency management](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-publishing-artifacts-to-a-maven-repository-import)[68. Spring Boot AntLib module](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-antlib)[68.1. Spring Boot Ant tasks](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_spring_boot_ant_tasks)[68.1.1. spring-boot:exejar](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_spring_boot_exejar)[68.1.2. Examples](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_examples)[68.2. spring-boot:findmainclass](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_spring_boot_findmainclass)[68.2.1. Examples](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_examples_2)[69. Supporting other build systems](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-other-build-systems)[69.1. Repackaging archives](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-repackaging-archives)[69.2. Nested libraries](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-nested-libraries)[69.3. Finding a main class](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-find-a-main-class)[69.4. Example repackage implementation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-repackage-implementation)[70. What to read next](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-whats-next)
+
+- [IX. ‘How-to’ guides](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto)
+
+ [71. Spring Boot application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-spring-boot-application)[71.1. Create your own FailureAnalyzer](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-failure-analyzer)[71.2. Troubleshoot auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-troubleshoot-auto-configuration)[71.3. Customize the Environment or ApplicationContext before it starts](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-the-environment-or-application-context)[71.4. Build an ApplicationContext hierarchy (adding a parent or root context)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-build-an-application-context-hierarchy)[71.5. Create a non-web application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-a-non-web-application)[72. Properties & configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-properties-and-configuration)[72.1. Automatically expand properties at build time](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-automatic-expansion)[72.1.1. Automatic property expansion using Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-automatic-expansion-maven)[72.1.2. Automatic property expansion using Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-automatic-expansion-gradle)[72.2. Externalize the configuration of SpringApplication](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-externalize-configuration)[72.3. Change the location of external properties of an application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-change-the-location-of-external-properties)[72.4. Use ‘short’ command line arguments](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-short-command-line-arguments)[72.5. Use YAML for external properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-yaml-for-external-properties)[72.6. Set the active Spring profiles](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-set-active-spring-profiles)[72.7. Change configuration depending on the environment](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-change-configuration-depending-on-the-environment)[72.8. Discover built-in options for external properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-discover-build-in-options-for-external-properties)[73. Embedded servlet containers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-embedded-servlet-containers)[73.1. Add a Servlet, Filter or Listener to an application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-add-a-servlet-filter-or-listener)[73.1.1. Add a Servlet, Filter or Listener using a Spring bean](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-add-a-servlet-filter-or-listener-as-spring-bean)[Disable registration of a Servlet or Filter](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-disable-registration-of-a-servlet-or-filter)[73.1.2. Add Servlets, Filters, and Listeners using classpath scanning](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-add-a-servlet-filter-or-listener-using-scanning)[73.2. Change the HTTP port](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-change-the-http-port)[73.3. Use a random unassigned HTTP port](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-user-a-random-unassigned-http-port)[73.4. Discover the HTTP port at runtime](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-discover-the-http-port-at-runtime)[73.5. Configure SSL](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-ssl)[73.6. Configure Access Logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-accesslogs)[73.7. Use behind a front-end proxy server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-tomcat-behind-a-proxy-server)[73.7.1. Customize Tomcat’s proxy configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-tomcat-behind-a-proxy-server)[73.8. Configure Tomcat](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-tomcat)[73.9. Enable Multiple Connectors with Tomcat](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-enable-multiple-connectors-in-tomcat)[73.10. Use Tomcat’s LegacyCookieProcessor](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-tomcat-legacycookieprocessor)[73.11. Use Jetty instead of Tomcat](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-instead-of-tomcat)[73.12. Configure Jetty](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-jetty)[73.13. Use Undertow instead of Tomcat](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-undertow-instead-of-tomcat)[73.14. Configure Undertow](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-undertow)[73.15. Enable Multiple Listeners with Undertow](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-enable-multiple-listeners-in-undertow)[73.16. Use Tomcat 7.x or 8.0](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-tomcat-7)[73.16.1. Use Tomcat 7.x or 8.0 with Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-tomcat-7-maven)[73.16.2. Use Tomcat 7.x or 8.0 with Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_use_tomcat_7_x_or_8_0_with_gradle)[73.17. Use Jetty 9.2](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-9.2)[73.17.1. Use Jetty 9.2 with Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-9.2-maven)[73.17.2. Use Jetty 9.2 with Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-9.2-gradle)[73.18. Use Jetty 8](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-8)[73.18.1. Use Jetty 8 with Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-8-maven)[73.18.2. Use Jetty 8 with Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-8-gradle)[73.19. Create WebSocket endpoints using @ServerEndpoint](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-websocket-endpoints-using-serverendpoint)[73.20. Enable HTTP response compression](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#how-to-enable-http-response-compression)[74. Spring MVC](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-spring-mvc)[74.1. Write a JSON REST service](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-write-a-json-rest-service)[74.2. Write an XML REST service](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-write-an-xml-rest-service)[74.3. Customize the Jackson ObjectMapper](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-the-jackson-objectmapper)[74.4. Customize the @ResponseBody rendering](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-the-responsebody-rendering)[74.5. Handling Multipart File Uploads](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-multipart-file-upload-configuration)[74.6. Switch off the Spring MVC DispatcherServlet](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-switch-off-the-spring-mvc-dispatcherservlet)[74.7. Switch off the Default MVC configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-switch-off-default-mvc-configuration)[74.8. Customize ViewResolvers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-view-resolvers)[74.9. Use Thymeleaf 3](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-thymeleaf-3)[75. HTTP clients](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-http-clients)[75.1. Configure RestTemplate to use a proxy](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-http-clients-proxy-configuration)[76. Logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-logging)[76.1. Configure Logback for logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-logback-for-logging)[76.1.1. Configure logback for file only output](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-logback-for-logging-fileonly)[76.2. Configure Log4j for logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-log4j-for-logging)[76.2.1. Use YAML or JSON to configure Log4j 2](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-log4j-for-logging-yaml-or-json-config)[77. Data Access](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-data-access)[77.1. Configure a custom DataSource](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-a-datasource)[77.2. Configure Two DataSources](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-two-datasources)[77.3. Use Spring Data repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-spring-data-repositories)[77.4. Separate @Entity definitions from Spring configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-separate-entity-definitions-from-spring-configuration)[77.5. Configure JPA properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-jpa-properties)[77.6. Configure Hibernate Naming Strategy](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-hibernate-naming-strategy)[77.7. Use a custom EntityManagerFactory](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-custom-entity-manager)[77.8. Use Two EntityManagers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-two-entity-managers)[77.9. Use a traditional persistence.xml](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-traditional-persistence-xml)[77.10. Use Spring Data JPA and Mongo repositories](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-spring-data-jpa--and-mongo-repositories)[77.11. Expose Spring Data repositories as REST endpoint](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-exposing-spring-data-repositories-rest-endpoint)[77.12. Configure a component that is used by JPA](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-a-component-that-is-used-by-JPA)[78. Database initialization](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-database-initialization)[78.1. Initialize a database using JPA](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-initialize-a-database-using-jpa)[78.2. Initialize a database using Hibernate](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-initialize-a-database-using-hibernate)[78.3. Initialize a database using Spring JDBC](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-initialize-a-database-using-spring-jdbc)[78.4. Initialize a Spring Batch database](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-initialize-a-spring-batch-database)[78.5. Use a higher-level database migration tool](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-a-higher-level-database-migration-tool)[78.5.1. Execute Flyway database migrations on startup](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-execute-flyway-database-migrations-on-startup)[78.5.2. Execute Liquibase database migrations on startup](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-execute-liquibase-database-migrations-on-startup)[79. Messaging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-messaging)[79.1. Disable transacted JMS session](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-jms-disable-transaction)[80. Batch applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-batch-applications)[80.1. Execute Spring Batch jobs on startup](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-execute-spring-batch-jobs-on-startup)[81. Actuator](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-actuator)[81.1. Change the HTTP port or address of the actuator endpoints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-change-the-http-port-or-address-of-the-actuator-endpoints)[81.2. Customize the ‘whitelabel’ error page](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-the-whitelabel-error-page)[81.3. Actuator and Jersey](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-actuator-with-jersey)[82. Security](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-security)[82.1. Switch off the Spring Boot security configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-switch-off-spring-boot-security-configuration)[82.2. Change the AuthenticationManager and add user accounts](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-change-the-authenticationmanager-and-add-user-accounts)[82.3. Enable HTTPS when running behind a proxy server](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-enable-https)[83. Hot swapping](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-hotswapping)[83.1. Reload static content](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-static-content)[83.2. Reload templates without restarting the container](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-thymeleaf-template-content)[83.2.1. Thymeleaf templates](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-thymeleaf-content)[83.2.2. FreeMarker templates](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-freemarker-content)[83.2.3. Groovy templates](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-groovy-template-content)[83.3. Fast application restarts](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-fast-restart)[83.4. Reload Java classes without restarting the container](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-java-classes-without-restarting)[83.4.1. Configuring Spring Loaded for use with Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-springloaded-maven)[83.4.2. Configuring Spring Loaded for use with Gradle and IntelliJ IDEA](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-reload-springloaded-gradle-and-intellij-idea)[84. Build](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-build)[84.1. Generate build information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-build-info)[84.2. Generate git information](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-git-info)[84.3. Customize dependency versions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-customize-dependency-versions)[84.4. Create an executable JAR with Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-an-executable-jar-with-maven)[84.5. Use a Spring Boot application as a dependency](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-an-additional-executable-jar)[84.6. Extract specific libraries when an executable jar runs](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-extract-specific-libraries-when-an-executable-jar-runs)[84.7. Create a non-executable JAR with exclusions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-a-nonexecutable-jar)[84.8. Remote debug a Spring Boot application started with Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-remote-debug-maven-run)[84.9. Remote debug a Spring Boot application started with Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-remote-debug-gradle-run)[84.10. Build an executable archive from Ant without using spring-boot-antlib](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-build-an-executable-archive-with-ant)[84.11. How to use Java 6](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-java-6)[84.11.1. Embedded servlet container compatibility](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-java-6-embedded-container)[84.11.2. Jackson](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-java-6-jackson)[84.11.3. JTA API compatibility](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#how-to-use-java-6-jta-api)[85. Traditional deployment](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-traditional-deployment)[85.1. Create a deployable war file](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-a-deployable-war-file)[85.2. Create a deployable war file for older servlet containers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-a-deployable-war-file-for-older-containers)[85.3. Convert an existing application to Spring Boot](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-convert-an-existing-application-to-spring-boot)[85.4. Deploying a WAR to WebLogic](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-weblogic)[85.5. Deploying a WAR in an Old (Servlet 2.5) Container](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-servlet-2-5)
+
+- [X. Appendices](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#appendix)
+
+ [A. Common application properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#common-application-properties)[B. Configuration meta-data](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata)[B.1. Meta-data format](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-format)[B.1.1. Group Attributes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-group-attributes)[B.1.2. Property Attributes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-property-attributes)[B.1.3. Hint Attributes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-hints-attributes)[B.1.4. Repeated meta-data items](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-repeated-items)[B.2. Providing manual hints](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-providing-manual-hints)[B.2.1. Value hint](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_value_hint)[B.2.2. Value provider](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_value_provider)[Any](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_any)[Class reference](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_class_reference)[Handle As](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_handle_as)[Logger name](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_logger_name)[Spring bean reference](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_spring_bean_reference)[Spring profile name](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#_spring_profile_name)[B.3. Generating your own meta-data using the annotation processor](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-annotation-processor)[B.3.1. Nested properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-nested-properties)[B.3.2. Adding additional meta-data](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-additional-metadata)[C. Auto-configuration classes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#auto-configuration-classes)[C.1. From the “spring-boot-autoconfigure” module](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#auto-configuration-classes-from-autoconfigure-module)[C.2. From the “spring-boot-actuator” module](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#auto-configuration-classes-from-actuator)[D. Test auto-configuration annotations](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#test-auto-configuration)[E. The executable jar format](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar)[E.1. Nested JARs](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-nested-jars)[E.1.1. The executable jar file structure](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-jar-file-structure)[E.1.2. The executable war file structure](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-war-file-structure)[E.2. Spring Boot’s “JarFile” class](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-jarfile)[E.2.1. Compatibility with the standard Java “JarFile”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-jarfile-compatibility)[E.3. Launching executable jars](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-launching)[E.3.1. Launcher manifest](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-launcher-manifest)[E.3.2. Exploded archives](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-exploded-archives)[E.4. PropertiesLauncher Features](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-property-launcher-features)[E.5. Executable jar restrictions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-restrictions)[E.5.1. Zip entry compression](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-zip-entry-compression)[E.5.2. System ClassLoader](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-system-classloader)[E.6. Alternative single jar solutions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-alternatives)[F. Dependency versions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#appendix-dependency-versions)
+
+# Part I. Spring Boot Documentation
+
+
+
This section provides a brief overview of Spring Boot reference documentation. Think of it as map for the rest of the document. You can read this reference guide in a linear fashion, or you can skip sections if something doesn’t interest you.
-1. About the documentation
-The Spring Boot reference guide is available as html, pdf and epub documents. The latest copy is available at docs.spring.io/spring-boot/docs/current/reference.
+## 1. About the documentation
+
+The Spring Boot reference guide is available as [html](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/html), [pdf](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/pdf/spring-boot-reference.pdf) and [epub](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/epub/spring-boot-reference.epub) documents. The latest copy is available at [docs.spring.io/spring-boot/docs/current/reference](https://docs.spring.io/spring-boot/docs/current/reference).
Copies of this document may be made for your own use and for distribution to others, provided that you do not charge any fee for such copies and further provided that each copy contains this Copyright Notice, whether distributed in print or electronically.
-2. Getting help
+## 2. Getting help
+
Having trouble with Spring Boot, We’d like to help!
-Try the How-to’s — they provide solutions to the most common questions.
-Learn the Spring basics — Spring Boot builds on many other Spring projects, check the spring.io web-site for a wealth of reference documentation. If you are just starting out with Spring, try one of the guides.
-Ask a question - we monitor stackoverflow.com for questions tagged with spring-boot.
-Report bugs with Spring Boot at github.com/spring-projects/spring-boot/issues.
-[Note]
-All of Spring Boot is open source, including the documentation! If you find problems with the docs; or if you just want to improve them, please get involved.
-
-3. First steps
-If you’re just getting started with Spring Boot, or 'Spring' in general, this is the place to start!
-
-From scratch: Overview | Requirements | Installation
-Tutorial: Part 1 | Part 2
-Running your example: Part 1 | Part 2
-4. Working with Spring Boot
-Ready to actually start using Spring Boot? We’ve got you covered.
-
-Build systems: Maven | Gradle | Ant | Starters
-Best practices: Code Structure | @Configuration | @EnableAutoConfiguration | Beans and Dependency Injection
-Running your code IDE | Packaged | Maven | Gradle
-Packaging your app: Production jars
-Spring Boot CLI: Using the CLI
-5. Learning about Spring Boot features
-Need more details about Spring Boot’s core features? This is for you!
-
-Core Features: SpringApplication | External Configuration | Profiles | Logging
-Web Applications: MVC | Embedded Containers
-Working with data: SQL | NO-SQL
-Messaging: Overview | JMS
-Testing: Overview | Boot Applications | Utils
-Extending: Auto-configuration | @Conditions
-6. Moving to production
-When you’re ready to push your Spring Boot application to production, we’ve got some tricks that you might like!
-
-Management endpoints: Overview | Customization
-Connection options: HTTP | JMX | SSH
-Monitoring: Metrics | Auditing | Tracing | Process
-7. Advanced topics
-Lastly, we have a few topics for the more advanced user.
+- Try the [How-to’s](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto) — they provide solutions to the most common questions.
+- Learn the Spring basics — Spring Boot builds on many other Spring projects, check the [spring.io](https://spring.io/) web-site for a wealth of reference documentation. If you are just starting out with Spring, try one of the [guides](https://spring.io/guides).
+- Ask a question - we monitor [stackoverflow.com](https://stackoverflow.com/) for questions tagged with [`spring-boot`](https://stackoverflow.com/tags/spring-boot).
+- Report bugs with Spring Boot at [github.com/spring-projects/spring-boot/issues](https://github.com/spring-projects/spring-boot/issues).
-Deploy Spring Boot Applications: Cloud Deployment | OS Service
-Build tool plugins: Maven | Gradle
-Appendix: Application Properties | Auto-configuration classes | Executable Jars
-Part II. Getting started
-If you’re just getting started with Spring Boot, or 'Spring' in general, this is the section for you! Here we answer the basic “what?”, “how?” and “why?” questions. You’ll find a gentle introduction to Spring Boot along with installation instructions. We’ll then build our first Spring Boot application, discussing some core principles as we go.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| All of Spring Boot is open source, including the documentation! If you find problems with the docs; or if you just want to improve them, please [get involved](https://github.com/spring-projects/spring-boot/tree/1.5.x). |
-8. Introducing Spring Boot
-Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can “just run”. We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration.
+## 3. First steps
-You can use Spring Boot to create Java applications that can be started using java -jar or more traditional war deployments. We also provide a command line tool that runs “spring scripts”.
+If you’re just getting started with Spring Boot, or 'Spring' in general, [this is the place to start!](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started)
-Our primary goals are:
+- **From scratch:** [Overview](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-introducing-spring-boot) | [Requirements](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-system-requirements) | [Installation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-installing-spring-boot)
+- **Tutorial:** [Part 1](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application) | [Part 2](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-code)
+- **Running your example:** [Part 1](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-run) | [Part 2](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-executable-jar)
-Provide a radically faster and widely accessible getting started experience for all Spring development.
-Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults.
-Provide a range of non-functional features that are common to large classes of projects (e.g. embedded servers, security, metrics, health checks, externalized configuration).
-Absolutely no code generation and no requirement for XML configuration.
-9. System Requirements
-By default, Spring Boot 1.5.7.BUILD-SNAPSHOT requires Java 7 and Spring Framework 4.3.11.RELEASE or above. You can use Spring Boot with Java 6 with some additional configuration. See Section 84.11, “How to use Java 6” for more details. Explicit build support is provided for Maven (3.2+), and Gradle 2 (2.9 or later) and 3.
+## 4. Working with Spring Boot
-[Tip]
-Although you can use Spring Boot with Java 6 or 7, we generally recommend Java 8 if at all possible.
+Ready to actually start using Spring Boot? [We’ve got you covered](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot).
-9.1 Servlet containers
-The following embedded servlet containers are supported out of the box:
+- **Build systems:** [Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven) | [Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-gradle) | [Ant](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-ant) | [Starters](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-starter)
+- **Best practices:** [Code Structure](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-structuring-your-code) | [@Configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-configuration-classes) | [@EnableAutoConfiguration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-auto-configuration) | [Beans and Dependency Injection](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-spring-beans-and-dependency-injection)
+- **Running your code** [IDE](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-from-an-ide) | [Packaged](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-as-a-packaged-application) | [Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-with-the-maven-plugin) | [Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-running-with-the-gradle-plugin)
+- **Packaging your app:** [Production jars](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-packaging-for-production)
+- **Spring Boot CLI:** [Using the CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cli)
+
+## 5. Learning about Spring Boot features
+
+Need more details about Spring Boot’s core features? [This is for you](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features)!
+
+- **Core Features:** [SpringApplication](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-application) | [External Configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config) | [Profiles](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-profiles) | [Logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging)
+- **Web Applications:** [MVC](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc) | [Embedded Containers](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-embedded-container)
+- **Working with data:** [SQL](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-sql) | [NO-SQL](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-nosql)
+- **Messaging:** [Overview](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-messaging) | [JMS](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jms)
+- **Testing:** [Overview](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing) | [Boot Applications](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-testing-spring-boot-applications) | [Utils](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-test-utilities)
+- **Extending:** [Auto-configuration](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-developing-auto-configuration) | [@Conditions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-condition-annotations)
+
+## 6. Moving to production
+
+When you’re ready to push your Spring Boot application to production, we’ve got [some tricks that you might like](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready)!
+
+- **Management endpoints:** [Overview](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-endpoints) | [Customization](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-customizing-endpoints)
+- **Connection options:** [HTTP](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-monitoring) | [JMX](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-jmx) | [SSH](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-remote-shell)
+- **Monitoring:** [Metrics](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-metrics) | [Auditing](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-auditing) | [Tracing](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-tracing) | [Process](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready-process-monitoring)
-Name Servlet Version Java Version
-Tomcat 8
+## 7. Advanced topics
-3.1
+Lastly, we have a few topics for the more advanced user.
-Java 7+
+- **Deploy Spring Boot Applications:** [Cloud Deployment](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#cloud-deployment) | [OS Service](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-service)
+- **Build tool plugins:** [Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-maven-plugin) | [Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-plugin)
+- **Appendix:** [Application Properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#common-application-properties) | [Auto-configuration classes](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#auto-configuration-classes) | [Executable Jars](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar)
-Tomcat 7
+# Part II. Getting started
-3.0
-Java 6+
-Jetty 9.3
+If you’re just getting started with Spring Boot, or 'Spring' in general, this is the section for you! Here we answer the basic “what?”, “how?” and “why?” questions. You’ll find a gentle introduction to Spring Boot along with installation instructions. We’ll then build our first Spring Boot application, discussing some core principles as we go.
-3.1
+## 8. Introducing Spring Boot
-Java 8+
+Spring Boot makes it easy to create stand-alone, production-grade Spring based Applications that you can “just run”. We take an opinionated view of the Spring platform and third-party libraries so you can get started with minimum fuss. Most Spring Boot applications need very little Spring configuration.
-Jetty 9.2
+You can use Spring Boot to create Java applications that can be started using `java -jar` or more traditional war deployments. We also provide a command line tool that runs “spring scripts”.
-3.1
+Our primary goals are:
-Java 7+
+- Provide a radically faster and widely accessible getting started experience for all Spring development.
+- Be opinionated out of the box, but get out of the way quickly as requirements start to diverge from the defaults.
+- Provide a range of non-functional features that are common to large classes of projects (e.g. embedded servers, security, metrics, health checks, externalized configuration).
+- Absolutely no code generation and no requirement for XML configuration.
-Jetty 8
+## 9. System Requirements
-3.0
+By default, Spring Boot 1.5.7.BUILD-SNAPSHOT requires [Java 7](https://www.java.com/) and Spring Framework 4.3.11.RELEASE or above. You can use Spring Boot with Java 6 with some additional configuration. See [Section 84.11, “How to use Java 6”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-java-6) for more details. Explicit build support is provided for Maven (3.2+), and Gradle 2 (2.9 or later) and 3.
-Java 6+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Although you can use Spring Boot with Java 6 or 7, we generally recommend Java 8 if at all possible. |
-Undertow 1.3
+## 9.1 Servlet containers
-3.1
+The following embedded servlet containers are supported out of the box:
-Java 7+
+| Name | Servlet Version | Java Version |
+| ------------ | --------------- | ------------ |
+| Tomcat 8 | 3.1 | Java 7+ |
+| Tomcat 7 | 3.0 | Java 6+ |
+| Jetty 9.3 | 3.1 | Java 8+ |
+| Jetty 9.2 | 3.1 | Java 7+ |
+| Jetty 8 | 3.0 | Java 6+ |
+| Undertow 1.3 | 3.1 | Java 7+ |
You can also deploy Spring Boot applications to any Servlet 3.0+ compatible container.
-10. Installing Spring Boot
-Spring Boot can be used with “classic” Java development tools or installed as a command line tool. Regardless, you will need Java SDK v1.6 or higher. You should check your current Java installation before you begin:
+## 10. Installing Spring Boot
+
+Spring Boot can be used with “classic” Java development tools or installed as a command line tool. Regardless, you will need [Java SDK v1.6](https://www.java.com/) or higher. You should check your current Java installation before you begin:
+```
$ java -version
-If you are new to Java development, or if you just want to experiment with Spring Boot you might want to try the Spring Boot CLI first, otherwise, read on for “classic” installation instructions.
+```
+
+If you are new to Java development, or if you just want to experiment with Spring Boot you might want to try the [Spring Boot CLI](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-installing-the-cli) first, otherwise, read on for “classic” installation instructions.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Although Spring Boot is compatible with Java 1.6, if possible, you should consider using the latest version of Java. |
-[Tip]
-Although Spring Boot is compatible with Java 1.6, if possible, you should consider using the latest version of Java.
+## 10.1 Installation instructions for the Java developer
-10.1 Installation instructions for the Java developer
-You can use Spring Boot in the same way as any standard Java library. Simply include the appropriate spring-boot-*.jar files on your classpath. Spring Boot does not require any special tools integration, so you can use any IDE or text editor; and there is nothing special about a Spring Boot application, so you can run and debug as you would any other Java program.
+You can use Spring Boot in the same way as any standard Java library. Simply include the appropriate `spring-boot-*.jar` files on your classpath. Spring Boot does not require any special tools integration, so you can use any IDE or text editor; and there is nothing special about a Spring Boot application, so you can run and debug as you would any other Java program.
-Although you could just copy Spring Boot jars, we generally recommend that you use a build tool that supports dependency management (such as Maven or Gradle).
+Although you *could* just copy Spring Boot jars, we generally recommend that you use a build tool that supports dependency management (such as Maven or Gradle).
-10.1.1 Maven installation
-Spring Boot is compatible with Apache Maven 3.2 or above. If you don’t already have Maven installed you can follow the instructions at maven.apache.org.
+### 10.1.1 Maven installation
-[Tip]
-On many operating systems Maven can be installed via a package manager. If you’re an OSX Homebrew user try brew install maven. Ubuntu users can run sudo apt-get install maven.
+Spring Boot is compatible with Apache Maven 3.2 or above. If you don’t already have Maven installed you can follow the instructions at [maven.apache.org](https://maven.apache.org/).
-Spring Boot dependencies use the org.springframework.boot groupId. Typically your Maven POM file will inherit from the spring-boot-starter-parent project and declare dependencies to one or more “Starters”. Spring Boot also provides an optional Maven plugin to create executable jars.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| On many operating systems Maven can be installed via a package manager. If you’re an OSX Homebrew user try `brew install maven`. Ubuntu users can run `sudo apt-get install maven`. |
-Here is a typical pom.xml file:
+Spring Boot dependencies use the `org.springframework.boot` `groupId`. Typically your Maven POM file will inherit from the `spring-boot-starter-parent`project and declare dependencies to one or more [“Starters”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-starter). Spring Boot also provides an optional [Maven plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-maven-plugin) to create executable jars.
+Here is a typical `pom.xml` file:
+
+```
@@ -808,20 +263,25 @@ Here is a typical pom.xml file:
-[Tip]
-The spring-boot-starter-parent is a great way to use Spring Boot, but it might not be suitable all of the time. Sometimes you may need to inherit from a different parent POM, or you might just not like our default settings. See Section 13.2.2, “Using Spring Boot without the parent POM” for an alternative solution that uses an import scope.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `spring-boot-starter-parent` is a great way to use Spring Boot, but it might not be suitable all of the time. Sometimes you may need to inherit from a different parent POM, or you might just not like our default settings. See [Section 13.2.2, “Using Spring Boot without the parent POM”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-without-a-parent) for an alternative solution that uses an `import` scope. |
-10.1.2 Gradle installation
-Spring Boot is compatible with Gradle 2 (2.9 or later) and Gradle 3. If you don’t already have Gradle installed you can follow the instructions at www.gradle.org/.
+### 10.1.2 Gradle installation
-Spring Boot dependencies can be declared using the org.springframework.boot group. Typically your project will declare dependencies to one or more “Starters”. Spring Boot provides a useful Gradle plugin that can be used to simplify dependency declarations and to create executable jars.
+Spring Boot is compatible with Gradle 2 (2.9 or later) and Gradle 3. If you don’t already have Gradle installed you can follow the instructions at [www.gradle.org/](http://www.gradle.org/).
-Gradle Wrapper
+Spring Boot dependencies can be declared using the `org.springframework.boot` `group`. Typically your project will declare dependencies to one or more[“Starters”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-starter). Spring Boot provides a useful [Gradle plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-plugin) that can be used to simplify dependency declarations and to create executable jars.
-The Gradle Wrapper provides a nice way of “obtaining” Gradle when you need to build a project. It’s a small script and library that you commit alongside your code to bootstrap the build process. See docs.gradle.org/2.14.1/userguide/gradle_wrapper.html for details.
+**Gradle Wrapper**
-Here is a typical build.gradle file:
+The Gradle Wrapper provides a nice way of “obtaining” Gradle when you need to build a project. It’s a small script and library that you commit alongside your code to bootstrap the build process. See [docs.gradle.org/2.14.1/userguide/gradle_wrapper.html](https://docs.gradle.org/2.14.1/userguide/gradle_wrapper.html) for details.
+Here is a typical `build.gradle` file:
+
+```
buildscript {
repositories {
jcenter()
@@ -851,36 +311,49 @@ dependencies {
compile("org.springframework.boot:spring-boot-starter-web")
testCompile("org.springframework.boot:spring-boot-starter-test")
}
-10.2 Installing the Spring Boot CLI
-The Spring Boot CLI is a command line tool that can be used if you want to quickly prototype with Spring. It allows you to run Groovy scripts, which means that you have a familiar Java-like syntax, without so much boilerplate code.
+```
+
+## 10.2 Installing the Spring Boot CLI
+
+The Spring Boot CLI is a command line tool that can be used if you want to quickly prototype with Spring. It allows you to run [Groovy](http://groovy.codehaus.org/) scripts, which means that you have a familiar Java-like syntax, without so much boilerplate code.
You don’t need to use the CLI to work with Spring Boot but it’s definitely the quickest way to get a Spring application off the ground.
-10.2.1 Manual installation
+### 10.2.1 Manual installation
+
You can download the Spring CLI distribution from the Spring software repository:
-spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin.zip
-spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin.tar.gz
-Cutting edge snapshot distributions are also available.
+- [spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin.zip](https://repo.spring.io/snapshot/org/springframework/boot/spring-boot-cli/1.5.7.BUILD-SNAPSHOT/spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin.zip)
+- [spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin.tar.gz](https://repo.spring.io/snapshot/org/springframework/boot/spring-boot-cli/1.5.7.BUILD-SNAPSHOT/spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin.tar.gz)
+
+Cutting edge [snapshot distributions](https://repo.spring.io/snapshot/org/springframework/boot/spring-boot-cli/) are also available.
+
+Once downloaded, follow the [INSTALL.txt](https://raw.github.com/spring-projects/spring-boot/1.5.x/spring-boot-cli/src/main/content/INSTALL.txt) instructions from the unpacked archive. In summary: there is a `spring` script (`spring.bat` for Windows) in a `bin/`directory in the `.zip` file, or alternatively you can use `java -jar` with the `.jar` file (the script helps you to be sure that the classpath is set correctly).
-Once downloaded, follow the INSTALL.txt instructions from the unpacked archive. In summary: there is a spring script (spring.bat for Windows) in a bin/ directory in the .zip file, or alternatively you can use java -jar with the .jar file (the script helps you to be sure that the classpath is set correctly).
+### 10.2.2 Installation with SDKMAN!
-10.2.2 Installation with SDKMAN!
-SDKMAN! (The Software Development Kit Manager) can be used for managing multiple versions of various binary SDKs, including Groovy and the Spring Boot CLI. Get SDKMAN! from sdkman.io and install Spring Boot with
+SDKMAN! (The Software Development Kit Manager) can be used for managing multiple versions of various binary SDKs, including Groovy and the Spring Boot CLI. Get SDKMAN! from [sdkman.io](http://sdkman.io/) and install Spring Boot with
+```
$ sdk install springboot
$ spring --version
Spring Boot v1.5.7.BUILD-SNAPSHOT
+```
+
If you are developing features for the CLI and want easy access to the version you just built, follow these extra instructions.
+```
$ sdk install springboot dev /path/to/spring-boot/spring-boot-cli/target/spring-boot-cli-1.5.7.BUILD-SNAPSHOT-bin/spring-1.5.7.BUILD-SNAPSHOT/
$ sdk default springboot dev
$ spring --version
Spring CLI v1.5.7.BUILD-SNAPSHOT
-This will install a local instance of spring called the dev instance. It points at your target build location, so every time you rebuild Spring Boot, spring will be up-to-date.
+```
+
+This will install a local instance of `spring` called the `dev` instance. It points at your target build location, so every time you rebuild Spring Boot, `spring` will be up-to-date.
You can see it by doing this:
+```
$ sdk ls springboot
================================================================================
@@ -894,32 +367,51 @@ Available Springboot Versions
* - installed
> - currently in use
================================================================================
-10.2.3 OSX Homebrew installation
-If you are on a Mac and using Homebrew, all you need to do to install the Spring Boot CLI is:
+```
+
+### 10.2.3 OSX Homebrew installation
+
+If you are on a Mac and using [Homebrew](https://brew.sh/), all you need to do to install the Spring Boot CLI is:
+```
$ brew tap pivotal/tap
$ brew install springboot
-Homebrew will install spring to /usr/local/bin.
+```
-[Note]
-If you don’t see the formula, your installation of brew might be out-of-date. Just execute brew update and try again.
+Homebrew will install `spring` to `/usr/local/bin`.
-10.2.4 MacPorts installation
-If you are on a Mac and using MacPorts, all you need to do to install the Spring Boot CLI is:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you don’t see the formula, your installation of brew might be out-of-date. Just execute `brew update` and try again. |
+### 10.2.4 MacPorts installation
+
+If you are on a Mac and using [MacPorts](https://www.macports.org/), all you need to do to install the Spring Boot CLI is:
+
+```
$ sudo port install spring-boot-cli
-10.2.5 Command-line completion
-Spring Boot CLI ships with scripts that provide command completion for BASH and zsh shells. You can source the script (also named spring) in any shell, or put it in your personal or system-wide bash completion initialization. On a Debian system the system-wide scripts are in /shell-completion/bash and all scripts in that directory are executed when a new shell starts. To run the script manually, e.g. if you have installed using SDKMAN!
+```
+
+### 10.2.5 Command-line completion
+
+Spring Boot CLI ships with scripts that provide command completion for [BASH](https://en.wikipedia.org/wiki/Bash_(Unix_shell)) and [zsh](https://en.wikipedia.org/wiki/Zsh) shells. You can `source` the script (also named `spring`) in any shell, or put it in your personal or system-wide bash completion initialization. On a Debian system the system-wide scripts are in `/shell-completion/bash` and all scripts in that directory are executed when a new shell starts. To run the script manually, e.g. if you have installed using SDKMAN!
+```
$ . ~/.sdkman/candidates/springboot/current/shell-completion/bash/spring
$ spring
grab help jar run test version
-[Note]
-If you install Spring Boot CLI using Homebrew or MacPorts, the command-line completion scripts are automatically registered with your shell.
-10.2.6 Quick start Spring CLI example
-Here’s a really simple web application that you can use to test your installation. Create a file called app.groovy:
+```
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you install Spring Boot CLI using Homebrew or MacPorts, the command-line completion scripts are automatically registered with your shell. |
+
+### 10.2.6 Quick start Spring CLI example
+
+Here’s a really simple web application that you can use to test your installation. Create a file called `app.groovy`:
+
+```
@RestController
class ThisWillActuallyRun {
@@ -929,30 +421,44 @@ class ThisWillActuallyRun {
}
}
+
+```
+
Then simply run it from a shell:
+```
$ spring run app.groovy
-[Note]
-It will take some time when you first run the application as dependencies are downloaded. Subsequent runs will be much quicker.
-Open localhost:8080 in your favorite web browser and you should see the following output:
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| It will take some time when you first run the application as dependencies are downloaded. Subsequent runs will be much quicker. |
+Open [localhost:8080](http://localhost:8080/) in your favorite web browser and you should see the following output:
+
+```
Hello World!
-10.3 Upgrading from an earlier version of Spring Boot
-If you are upgrading from an earlier release of Spring Boot check the “release notes” hosted on the project wiki. You’ll find upgrade instructions along with a list of “new and noteworthy” features for each release.
-To upgrade an existing CLI installation use the appropriate package manager command (for example brew upgrade) or, if you manually installed the CLI, follow the standard instructions remembering to update your PATH environment variable to remove any older references.
+```
-11. Developing your first Spring Boot application
-Let’s develop a simple “Hello World!” web application in Java that highlights some of Spring Boot’s key features. We’ll use Maven to build this project since most IDEs support it.
+## 10.3 Upgrading from an earlier version of Spring Boot
-[Tip]
-The spring.io web site contains many “Getting Started” guides that use Spring Boot. If you’re looking to solve a specific problem; check there first.
+If you are upgrading from an earlier release of Spring Boot check the “release notes” hosted on the [project wiki](https://github.com/spring-projects/spring-boot/wiki). You’ll find upgrade instructions along with a list of “new and noteworthy” features for each release.
-You can shortcut the steps below by going to start.spring.io and choosing the web starter from the dependencies searcher. This will automatically generate a new project structure so that you can start coding right away. Check the documentation for more details.
+To upgrade an existing CLI installation use the appropriate package manager command (for example `brew upgrade`) or, if you manually installed the CLI, follow the[standard instructions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-manual-cli-installation) remembering to update your `PATH` environment variable to remove any older references.
+
+## 11. Developing your first Spring Boot application
+
+Let’s develop a simple “Hello World!” web application in Java that highlights some of Spring Boot’s key features. We’ll use Maven to build this project since most IDEs support it.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The [spring.io](https://spring.io/) web site contains many “Getting Started” guides that use Spring Boot. If you’re looking to solve a specific problem; check there first.You can shortcut the steps below by going to [start.spring.io](https://start.spring.io/) and choosing the `web` starter from the dependencies searcher. This will automatically generate a new project structure so that you can [start coding right away](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#getting-started-first-application-code). Check the [documentation for more details](https://github.com/spring-io/initializr). |
Before we begin, open a terminal to check that you have valid versions of Java and Maven installed.
+```
$ java -version
java version "1.7.0_51"
Java(TM) SE Runtime Environment (build 1.7.0_51-b13)
@@ -961,12 +467,18 @@ $ mvn -v
Apache Maven 3.2.3 (33f8c3e1027c3ddde99d3cdebad2656a31e8fdf4; 2014-08-11T13:58:10-07:00)
Maven home: /Users/user/tools/apache-maven-3.1.1
Java version: 1.7.0_51, vendor: Oracle Corporation
-[Note]
-This sample needs to be created in its own folder. Subsequent instructions assume that you have created a suitable folder and that it is your “current directory”.
-11.1 Creating the POM
-We need to start by creating a Maven pom.xml file. The pom.xml is the recipe that will be used to build your project. Open your favorite text editor and add the following:
+```
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| This sample needs to be created in its own folder. Subsequent instructions assume that you have created a suitable folder and that it is your “current directory”. |
+
+## 11.1 Creating the POM
+
+We need to start by creating a Maven `pom.xml` file. The `pom.xml` is the recipe that will be used to build your project. Open your favorite text editor and add the following:
+
+```
@@ -1007,32 +519,47 @@ We need to start by creating a Maven pom.xml file. The pom.xml is the recipe tha
-This should give you a working build, you can test it out by running mvn package (you can ignore the “jar will be empty - no content was marked for inclusion!” warning for now).
-[Note]
-At this point you could import the project into an IDE (most modern Java IDE’s include built-in support for Maven). For simplicity, we will continue to use a plain text editor for this example.
+```
+
+This should give you a working build, you can test it out by running `mvn package` (you can ignore the “jar will be empty - no content was marked for inclusion!” warning for now).
-11.2 Adding classpath dependencies
-Spring Boot provides a number of “Starters” that make easy to add jars to your classpath. Our sample application has already used spring-boot-starter-parent in the parent section of the POM. The spring-boot-starter-parent is a special starter that provides useful Maven defaults. It also provides a dependency-management section so that you can omit version tags for “blessed” dependencies.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| At this point you could import the project into an IDE (most modern Java IDE’s include built-in support for Maven). For simplicity, we will continue to use a plain text editor for this example. |
-Other “Starters” simply provide dependencies that you are likely to need when developing a specific type of application. Since we are developing a web application, we will add a spring-boot-starter-web dependency — but before that, let’s look at what we currently have.
+## 11.2 Adding classpath dependencies
+Spring Boot provides a number of “Starters” that make easy to add jars to your classpath. Our sample application has already used `spring-boot-starter-parent`in the `parent` section of the POM. The `spring-boot-starter-parent` is a special starter that provides useful Maven defaults. It also provides a[`dependency-management`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-dependency-management) section so that you can omit `version` tags for “blessed” dependencies.
+
+Other “Starters” simply provide dependencies that you are likely to need when developing a specific type of application. Since we are developing a web application, we will add a `spring-boot-starter-web` dependency — but before that, let’s look at what we currently have.
+
+```
$ mvn dependency:tree
[INFO] com.example:myproject:jar:0.0.1-SNAPSHOT
-The mvn dependency:tree command prints a tree representation of your project dependencies. You can see that spring-boot-starter-parent provides no dependencies by itself. Let’s edit our pom.xml and add the spring-boot-starter-web dependency just below the parent section:
+```
+
+The `mvn dependency:tree` command prints a tree representation of your project dependencies. You can see that `spring-boot-starter-parent` provides no dependencies by itself. Let’s edit our `pom.xml` and add the `spring-boot-starter-web` dependency just below the `parent` section:
+
+```
org.springframework.boot
spring-boot-starter-web
-If you run mvn dependency:tree again, you will see that there are now a number of additional dependencies, including the Tomcat web server and Spring Boot itself.
-11.3 Writing the code
-To finish our application we need to create a single Java file. Maven will compile sources from src/main/java by default so you need to create that folder structure, then add a file named src/main/java/Example.java:
+```
+If you run `mvn dependency:tree` again, you will see that there are now a number of additional dependencies, including the Tomcat web server and Spring Boot itself.
+
+## 11.3 Writing the code
+
+To finish our application we need to create a single Java file. Maven will compile sources from `src/main/java` by default so you need to create that folder structure, then add a file named `src/main/java/Example.java`:
+
+```
import org.springframework.boot.*;
import org.springframework.boot.autoconfigure.*;
import org.springframework.stereotype.*;
@@ -1052,29 +579,38 @@ public class Example {
}
}
+
+```
+
Although there isn’t much code here, quite a lot is going on. Let’s step through the important parts.
-11.3.1 The @RestController and @RequestMapping annotations
-The first annotation on our Example class is @RestController. This is known as a stereotype annotation. It provides hints for people reading the code, and for Spring, that the class plays a specific role. In this case, our class is a web @Controller so Spring will consider it when handling incoming web requests.
+### 11.3.1 The @RestController and @RequestMapping annotations
+
+The first annotation on our `Example` class is `@RestController`. This is known as a *stereotype* annotation. It provides hints for people reading the code, and for Spring, that the class plays a specific role. In this case, our class is a web `@Controller` so Spring will consider it when handling incoming web requests.
-The @RequestMapping annotation provides “routing” information. It is telling Spring that any HTTP request with the path “/” should be mapped to the home method. The @RestController annotation tells Spring to render the resulting string directly back to the caller.
+The `@RequestMapping` annotation provides “routing” information. It is telling Spring that any HTTP request with the path “/” should be mapped to the `home` method. The `@RestController` annotation tells Spring to render the resulting string directly back to the caller.
-[Tip]
-The @RestController and @RequestMapping annotations are Spring MVC annotations (they are not specific to Spring Boot). See the MVC section in the Spring Reference Documentation for more details.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `@RestController` and `@RequestMapping` annotations are Spring MVC annotations (they are not specific to Spring Boot). See the [MVC section](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle#mvc)in the Spring Reference Documentation for more details. |
-11.3.2 The @EnableAutoConfiguration annotation
-The second class-level annotation is @EnableAutoConfiguration. This annotation tells Spring Boot to “guess” how you will want to configure Spring, based on the jar dependencies that you have added. Since spring-boot-starter-web added Tomcat and Spring MVC, the auto-configuration will assume that you are developing a web application and setup Spring accordingly.
+### 11.3.2 The @EnableAutoConfiguration annotation
-Starters and Auto-Configuration
+The second class-level annotation is `@EnableAutoConfiguration`. This annotation tells Spring Boot to “guess” how you will want to configure Spring, based on the jar dependencies that you have added. Since `spring-boot-starter-web` added Tomcat and Spring MVC, the auto-configuration will assume that you are developing a web application and setup Spring accordingly.
+
+**Starters and Auto-Configuration**
Auto-configuration is designed to work well with “Starters”, but the two concepts are not directly tied. You are free to pick-and-choose jar dependencies outside of the starters and Spring Boot will still do its best to auto-configure your application.
-11.3.3 The “main” method
-The final part of our application is the main method. This is just a standard method that follows the Java convention for an application entry point. Our main method delegates to Spring Boot’s SpringApplication class by calling run. SpringApplication will bootstrap our application, starting Spring which will in turn start the auto-configured Tomcat web server. We need to pass Example.class as an argument to the run method to tell SpringApplication which is the primary Spring component. The args array is also passed through to expose any command-line arguments.
+### 11.3.3 The “main” method
+
+The final part of our application is the `main` method. This is just a standard method that follows the Java convention for an application entry point. Our main method delegates to Spring Boot’s `SpringApplication` class by calling `run`. `SpringApplication` will bootstrap our application, starting Spring which will in turn start the auto-configured Tomcat web server. We need to pass `Example.class` as an argument to the `run` method to tell `SpringApplication` which is the primary Spring component. The `args` array is also passed through to expose any command-line arguments.
-11.4 Running the example
-At this point our application should work. Since we have used the spring-boot-starter-parent POM we have a useful run goal that we can use to start the application. Type mvn spring-boot:run from the root project directory to start the application:
+## 11.4 Running the example
+At this point our application should work. Since we have used the `spring-boot-starter-parent` POM we have a useful `run` goal that we can use to start the application. Type `mvn spring-boot:run` from the root project directory to start the application:
+
+```
$ mvn spring-boot:run
. ____ _ __ _ _
@@ -1088,24 +624,33 @@ $ mvn spring-boot:run
....... . . . (log output here)
....... . . .
........ Started Example in 2.222 seconds (JVM running for 6.514)
-If you open a web browser to localhost:8080 you should see the following output:
+```
+
+If you open a web browser to [localhost:8080](http://localhost:8080/) you should see the following output:
+
+```
Hello World!
-To gracefully exit the application hit ctrl-c.
-11.5 Creating an executable jar
+```
+
+To gracefully exit the application hit `ctrl-c`.
+
+## 11.5 Creating an executable jar
+
Let’s finish our example by creating a completely self-contained executable jar file that we could run in production. Executable jars (sometimes called “fat jars”) are archives containing your compiled classes along with all of the jar dependencies that your code needs to run.
-Executable jars and Java
+**Executable jars and Java**
Java does not provide any standard way to load nested jar files (i.e. jar files that are themselves contained within a jar). This can be problematic if you are looking to distribute a self-contained application.
To solve this problem, many developers use “uber” jars. An uber jar simply packages all classes, from all jars, into a single archive. The problem with this approach is that it becomes hard to see which libraries you are actually using in your application. It can also be problematic if the same filename is used (but with different content) in multiple jars.
-Spring Boot takes a different approach and allows you to actually nest jars directly.
+Spring Boot takes a [different approach](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar) and allows you to actually nest jars directly.
-To create an executable jar we need to add the spring-boot-maven-plugin to our pom.xml. Insert the following lines just below the dependencies section:
+To create an executable jar we need to add the `spring-boot-maven-plugin` to our `pom.xml`. Insert the following lines just below the `dependencies` section:
+```
@@ -1114,11 +659,16 @@ To create an executable jar we need to add the spring-boot-maven-plugin to our p
-[Note]
-The spring-boot-starter-parent POM includes configuration to bind the repackage goal. If you are not using the parent POM you will need to declare this configuration yourself. See the plugin documentation for details.
-Save your pom.xml and run mvn package from the command line:
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The `spring-boot-starter-parent` POM includes `` configuration to bind the `repackage` goal. If you are not using the parent POM you will need to declare this configuration yourself. See the [plugin documentation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/usage.html) for details. |
+
+Save your `pom.xml` and run `mvn package` from the command line:
+```
$ mvn package
[INFO] Scanning for projects...
@@ -1134,13 +684,21 @@ $ mvn package
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
-If you look in the target directory you should see myproject-0.0.1-SNAPSHOT.jar. The file should be around 10 MB in size. If you want to peek inside, you can use jar tvf:
+```
+
+If you look in the `target` directory you should see `myproject-0.0.1-SNAPSHOT.jar`. The file should be around 10 MB in size. If you want to peek inside, you can use `jar tvf`:
+
+```
$ jar tvf target/myproject-0.0.1-SNAPSHOT.jar
-You should also see a much smaller file named myproject-0.0.1-SNAPSHOT.jar.original in the target directory. This is the original jar file that Maven created before it was repackaged by Spring Boot.
-To run that application, use the java -jar command:
+```
+
+You should also see a much smaller file named `myproject-0.0.1-SNAPSHOT.jar.original` in the `target` directory. This is the original jar file that Maven created before it was repackaged by Spring Boot.
+
+To run that application, use the `java -jar` command:
+```
$ java -jar target/myproject-0.0.1-SNAPSHOT.jar
. ____ _ __ _ _
@@ -1154,70 +712,96 @@ $ java -jar target/myproject-0.0.1-SNAPSHOT.jar
....... . . . (log output here)
....... . . .
........ Started Example in 2.536 seconds (JVM running for 2.864)
-As before, to gracefully exit the application hit ctrl-c.
-12. What to read next
-Hopefully this section has provided you with some of the Spring Boot basics, and got you on your way to writing your own applications. If you’re a task-oriented type of developer you might want to jump over to spring.io and check out some of the getting started guides that solve specific “How do I do that with Spring” problems; we also have Spring Boot-specific How-to reference documentation.
+```
+
+As before, to gracefully exit the application hit `ctrl-c`.
+
+## 12. What to read next
+
+Hopefully this section has provided you with some of the Spring Boot basics, and got you on your way to writing your own applications. If you’re a task-oriented type of developer you might want to jump over to [spring.io](https://spring.io/) and check out some of the [getting started](https://spring.io/guides/) guides that solve specific “How do I do that with Spring” problems; we also have Spring Boot-specific *How-to* reference documentation.
+
+The [Spring Boot repository](https://github.com/spring-projects/spring-boot) has also a [bunch of samples](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples) you can run. The samples are independent of the rest of the code (that is you don’t need to build the rest to run or use the samples).
+
+Otherwise, the next logical step is to read *Part III, “Using Spring Boot”*. If you’re really impatient, you could also jump ahead and read about *Spring Boot features*.
+
+# Part III. Using Spring Boot
-The Spring Boot repository has also a bunch of samples you can run. The samples are independent of the rest of the code (that is you don’t need to build the rest to run or use the samples).
-Otherwise, the next logical step is to read Part III, “Using Spring Boot”. If you’re really impatient, you could also jump ahead and read about Spring Boot features.
-Part III. Using Spring Boot
This section goes into more detail about how you should use Spring Boot. It covers topics such as build systems, auto-configuration and how to run your applications. We also cover some Spring Boot best practices. Although there is nothing particularly special about Spring Boot (it is just another library that you can consume), there are a few recommendations that, when followed, will make your development process just a little easier.
-If you’re just starting out with Spring Boot, you should probably read the Getting Started guide before diving into this section.
+If you’re just starting out with Spring Boot, you should probably read the *Getting Started* guide before diving into this section.
+
+## 13. Build systems
+
+It is strongly recommended that you choose a build system that supports [*dependency management*](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-dependency-management), and one that can consume artifacts published to the “Maven Central” repository. We would recommend that you choose Maven or Gradle. It is possible to get Spring Boot to work with other build systems (Ant for example), but they will not be particularly well supported.
-13. Build systems
-It is strongly recommended that you choose a build system that supports dependency management, and one that can consume artifacts published to the “Maven Central” repository. We would recommend that you choose Maven or Gradle. It is possible to get Spring Boot to work with other build systems (Ant for example), but they will not be particularly well supported.
+## 13.1 Dependency management
-13.1 Dependency management
Each release of Spring Boot provides a curated list of dependencies it supports. In practice, you do not need to provide a version for any of these dependencies in your build configuration as Spring Boot is managing that for you. When you upgrade Spring Boot itself, these dependencies will be upgraded as well in a consistent way.
-[Note]
-You can still specify a version and override Spring Boot’s recommendations if you feel that’s necessary.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can still specify a version and override Spring Boot’s recommendations if you feel that’s necessary. |
-The curated list contains all the spring modules that you can use with Spring Boot as well as a refined list of third party libraries. The list is available as a standard Bills of Materials (spring-boot-dependencies) and additional dedicated support for Maven and Gradle are available as well.
+The curated list contains all the spring modules that you can use with Spring Boot as well as a refined list of third party libraries. The list is available as a standard [Bills of Materials (`spring-boot-dependencies`)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-without-a-parent) and additional dedicated support for [Maven](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-maven-parent-pom) and [Gradle](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-dependency-management) are available as well.
-[Warning]
-Each release of Spring Boot is associated with a base version of the Spring Framework so we highly recommend you to not specify its version on your own.
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| Each release of Spring Boot is associated with a base version of the Spring Framework so we **highly** recommend you to not specify its version on your own. |
-13.2 Maven
-Maven users can inherit from the spring-boot-starter-parent project to obtain sensible defaults. The parent project provides the following features:
+## 13.2 Maven
-Java 1.6 as the default compiler level.
-UTF-8 source encoding.
-A Dependency Management section, allowing you to omit tags for common dependencies, inherited from the spring-boot-dependencies POM.
-Sensible resource filtering.
-Sensible plugin configuration (exec plugin, surefire, Git commit ID, shade).
-Sensible resource filtering for application.properties and application.yml including profile-specific files (e.g. application-foo.properties and application-foo.yml)
-On the last point: since the default config files accept Spring style placeholders (${…}) the Maven filtering is changed to use @..@ placeholders (you can override that with a Maven property resource.delimiter).
+Maven users can inherit from the `spring-boot-starter-parent` project to obtain sensible defaults. The parent project provides the following features:
-13.2.1 Inheriting the starter parent
-To configure your project to inherit from the spring-boot-starter-parent simply set the parent:
+- Java 1.6 as the default compiler level.
+- UTF-8 source encoding.
+- A [Dependency Management section](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-dependency-management), allowing you to omit `` tags for common dependencies, inherited from the `spring-boot-dependencies` POM.
+- Sensible [resource filtering](https://maven.apache.org/plugins/maven-resources-plugin/examples/filter.html).
+- Sensible plugin configuration ([exec plugin](http://www.mojohaus.org/exec-maven-plugin/), [surefire](https://maven.apache.org/surefire/maven-surefire-plugin/), [Git commit ID](https://github.com/ktoso/maven-git-commit-id-plugin), [shade](https://maven.apache.org/plugins/maven-shade-plugin/)).
+- Sensible resource filtering for `application.properties` and `application.yml` including profile-specific files (e.g. `application-foo.properties` and `application-foo.yml`)
+On the last point: since the default config files accept Spring style placeholders (`${…}`) the Maven filtering is changed to use `@..@` placeholders (you can override that with a Maven property `resource.delimiter`).
+
+### 13.2.1 Inheriting the starter parent
+
+To configure your project to inherit from the `spring-boot-starter-parent` simply set the `parent`:
+
+```
org.springframework.boot
spring-boot-starter-parent
1.5.7.BUILD-SNAPSHOT
-[Note]
-You should only need to specify the Spring Boot version number on this dependency. If you import additional starters, you can safely omit the version number.
-With that setup, you can also override individual dependencies by overriding a property in your own project. For instance, to upgrade to another Spring Data release train you’d add the following to your pom.xml.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You should only need to specify the Spring Boot version number on this dependency. If you import additional starters, you can safely omit the version number. |
+With that setup, you can also override individual dependencies by overriding a property in your own project. For instance, to upgrade to another Spring Data release train you’d add the following to your `pom.xml`.
+
+```
Fowler-SR2
-[Tip]
-Check the spring-boot-dependencies pom for a list of supported properties.
-13.2.2 Using Spring Boot without the parent POM
-Not everyone likes inheriting from the spring-boot-starter-parent POM. You may have your own corporate standard parent that you need to use, or you may just prefer to explicitly declare all your Maven configuration.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Check the [`spring-boot-dependencies` pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-dependencies/pom.xml) for a list of supported properties. |
+
+### 13.2.2 Using Spring Boot without the parent POM
+
+Not everyone likes inheriting from the `spring-boot-starter-parent` POM. You may have your own corporate standard parent that you need to use, or you may just prefer to explicitly declare all your Maven configuration.
-If you don’t want to use the spring-boot-starter-parent, you can still keep the benefit of the dependency management (but not the plugin management) by using a scope=import dependency:
+If you don’t want to use the `spring-boot-starter-parent`, you can still keep the benefit of the dependency management (but not the plugin management) by using a `scope=import` dependency:
+```
@@ -1230,8 +814,12 @@ If you don’t want to use the spring-boot-starter-parent, you can still keep th
-That setup does not allow you to override individual dependencies using a property as explained above. To achieve the same result, you’d need to add an entry in the dependencyManagement of your project before the spring-boot-dependencies entry. For instance, to upgrade to another Spring Data release train you’d add the following to your pom.xml.
+```
+
+That setup does not allow you to override individual dependencies using a property as explained above. To achieve the same result, you’d need to add an entry in the`dependencyManagement` of your project **before** the `spring-boot-dependencies` entry. For instance, to upgrade to another Spring Data release train you’d add the following to your `pom.xml`.
+
+```
@@ -1251,18 +839,29 @@ That setup does not allow you to override individual dependencies using a proper
-[Note]
-In the example above, we specify a BOM but any dependency type can be overridden that way.
-13.2.3 Changing the Java version
-The spring-boot-starter-parent chooses fairly conservative Java compatibility. If you want to follow our recommendation and use a later Java version you can add a java.version property:
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| In the example above, we specify a *BOM* but any dependency type can be overridden that way. |
+
+### 13.2.3 Changing the Java version
+The `spring-boot-starter-parent` chooses fairly conservative Java compatibility. If you want to follow our recommendation and use a later Java version you can add a `java.version` property:
+
+```
1.8
-13.2.4 Using the Spring Boot Maven plugin
-Spring Boot includes a Maven plugin that can package the project as an executable jar. Add the plugin to your section if you want to use it:
+```
+
+### 13.2.4 Using the Spring Boot Maven plugin
+
+Spring Boot includes a [Maven plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-maven-plugin) that can package the project as an executable jar. Add the plugin to your `` section if you want to use it:
+
+```
@@ -1271,12 +870,18 @@ Spring Boot includes a Maven plugin that can package the project as an executabl
-[Note]
-If you use the Spring Boot starter parent pom, you only need to add the plugin, there is no need for to configure it unless you want to change the settings defined in the parent.
-13.3 Gradle
-Gradle users can directly import ‘starters’ in their dependencies section. Unlike Maven, there is no “super parent” to import to share some configuration.
+```
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you use the Spring Boot starter parent pom, you only need to add the plugin, there is no need for to configure it unless you want to change the settings defined in the parent. |
+
+## 13.3 Gradle
+
+Gradle users can directly import ‘starters’ in their `dependencies` section. Unlike Maven, there is no “super parent” to import to share some configuration.
+
+```
repositories {
maven { url "http://repo.spring.io/snapshot" }
maven { url "http://repo.spring.io/milestone" }
@@ -1285,8 +890,12 @@ repositories {
dependencies {
compile("org.springframework.boot:spring-boot-starter-web:1.5.7.BUILD-SNAPSHOT")
}
-The spring-boot-gradle-plugin is also available and provides tasks to create executable jars and run projects from source. It also provides dependency management that, among other capabilities, allows you to omit the version number for any dependencies that are managed by Spring Boot:
+```
+
+The [`spring-boot-gradle-plugin`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-plugin) is also available and provides tasks to create executable jars and run projects from source. It also provides [dependency management](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-dependency-management) that, among other capabilities, allows you to omit the version number for any dependencies that are managed by Spring Boot:
+
+```
buildscript {
repositories {
jcenter()
@@ -1311,11 +920,16 @@ dependencies {
compile("org.springframework.boot:spring-boot-starter-web")
testCompile("org.springframework.boot:spring-boot-starter-test")
}
-13.4 Ant
-It is possible to build a Spring Boot project using Apache Ant+Ivy. The spring-boot-antlib “AntLib” module is also available to help Ant create executable jars.
-To declare dependencies a typical ivy.xml file will look something like this:
+```
+
+## 13.4 Ant
+
+It is possible to build a Spring Boot project using Apache Ant+Ivy. The `spring-boot-antlib` “AntLib” module is also available to help Ant create executable jars.
+
+To declare dependencies a typical `ivy.xml` file will look something like this:
+```
@@ -1327,8 +941,12 @@ To declare dependencies a typical ivy.xml file will look something like this:
rev="${spring-boot.version}" conf="compile" />
-A typical build.xml will look like this:
+```
+
+A typical `build.xml` will look like this:
+
+```
-[Tip]
-See the Section 84.10, “Build an executable archive from Ant without using spring-boot-antlib” “How-to” if you don’t want to use the spring-boot-antlib module.
-13.5 Starters
-Starters are a set of convenient dependency descriptors that you can include in your application. You get a one-stop-shop for all the Spring and related technology that you need, without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, just include the spring-boot-starter-data-jpa dependency in your project, and you are good to go.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| See the *Section 84.10, “Build an executable archive from Ant without using spring-boot-antlib”* “How-to” if you don’t want to use the `spring-boot-antlib` module. |
+
+## 13.5 Starters
+
+Starters are a set of convenient dependency descriptors that you can include in your application. You get a one-stop-shop for all the Spring and related technology that you need, without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, just include the `spring-boot-starter-data-jpa` dependency in your project, and you are good to go.
The starters contain a lot of the dependencies that you need to get a project up and running quickly and with a consistent, supported set of managed transitive dependencies.
-What’s in a name
+**What’s in a name**
+
+All **official** starters follow a similar naming pattern; `spring-boot-starter-*`, where `*` is a particular type of application. This naming structure is intended to help when you need to find a starter. The Maven integration in many IDEs allow you to search dependencies by name. For example, with the appropriate Eclipse or STS plugin installed, you can simply hit `ctrl-space` in the POM editor and type “spring-boot-starter” for a complete list.
+
+As explained in the [Creating your own starter](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-starter) section, third party starters should not start with `spring-boot` as it is reserved for official Spring Boot artifacts. A third-party starter for `acme` will be typically named `acme-spring-boot-starter`.
+
+The following application starters are provided by Spring Boot under the `org.springframework.boot` group:
+
+
+
+**Table 13.1. Spring Boot application starters**
+
+| Name | Description | Pom |
+| ---------------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `spring-boot-starter` | Core starter, including auto-configuration support, logging and YAML | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter/pom.xml) |
+| `spring-boot-starter-activemq` | Starter for JMS messaging using Apache ActiveMQ | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-activemq/pom.xml) |
+| `spring-boot-starter-amqp` | Starter for using Spring AMQP and Rabbit MQ | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-amqp/pom.xml) |
+| `spring-boot-starter-aop` | Starter for aspect-oriented programming with Spring AOP and AspectJ | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-aop/pom.xml) |
+| `spring-boot-starter-artemis` | Starter for JMS messaging using Apache Artemis | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-artemis/pom.xml) |
+| `spring-boot-starter-batch` | Starter for using Spring Batch | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-batch/pom.xml) |
+| `spring-boot-starter-cache` | Starter for using Spring Framework’s caching support | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-cache/pom.xml) |
+| `spring-boot-starter-cloud-connectors` | Starter for using Spring Cloud Connectors which simplifies connecting to services in cloud platforms like Cloud Foundry and Heroku | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-cloud-connectors/pom.xml) |
+| `spring-boot-starter-data-cassandra` | Starter for using Cassandra distributed database and Spring Data Cassandra | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-cassandra/pom.xml) |
+| `spring-boot-starter-data-couchbase` | Starter for using Couchbase document-oriented database and Spring Data Couchbase | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-couchbase/pom.xml) |
+| `spring-boot-starter-data-elasticsearch` | Starter for using Elasticsearch search and analytics engine and Spring Data Elasticsearch | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-elasticsearch/pom.xml) |
+| `spring-boot-starter-data-gemfire` | Starter for using GemFire distributed data store and Spring Data GemFire | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-gemfire/pom.xml) |
+| `spring-boot-starter-data-jpa` | Starter for using Spring Data JPA with Hibernate | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-jpa/pom.xml) |
+| `spring-boot-starter-data-ldap` | Starter for using Spring Data LDAP | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-ldap/pom.xml) |
+| `spring-boot-starter-data-mongodb` | Starter for using MongoDB document-oriented database and Spring Data MongoDB | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-mongodb/pom.xml) |
+| `spring-boot-starter-data-neo4j` | Starter for using Neo4j graph database and Spring Data Neo4j | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-neo4j/pom.xml) |
+| `spring-boot-starter-data-redis` | Starter for using Redis key-value data store with Spring Data Redis and the Jedis client | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-redis/pom.xml) |
+| `spring-boot-starter-data-rest` | Starter for exposing Spring Data repositories over REST using Spring Data REST | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-rest/pom.xml) |
+| `spring-boot-starter-data-solr` | Starter for using the Apache Solr search platform with Spring Data Solr | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-data-solr/pom.xml) |
+| `spring-boot-starter-freemarker` | Starter for building MVC web applications using FreeMarker views | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-freemarker/pom.xml) |
+| `spring-boot-starter-groovy-templates` | Starter for building MVC web applications using Groovy Templates views | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-groovy-templates/pom.xml) |
+| `spring-boot-starter-hateoas` | Starter for building hypermedia-based RESTful web application with Spring MVC and Spring HATEOAS | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-hateoas/pom.xml) |
+| `spring-boot-starter-integration` | Starter for using Spring Integration | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-integration/pom.xml) |
+| `spring-boot-starter-jdbc` | Starter for using JDBC with the Tomcat JDBC connection pool | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jdbc/pom.xml) |
+| `spring-boot-starter-jersey` | Starter for building RESTful web applications using JAX-RS and Jersey. An alternative to [`spring-boot-starter-web`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-web) | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jersey/pom.xml) |
+| `spring-boot-starter-jooq` | Starter for using jOOQ to access SQL databases. An alternative to [`spring-boot-starter-data-jpa`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-data-jpa) or [`spring-boot-starter-jdbc`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-jdbc) | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jooq/pom.xml) |
+| `spring-boot-starter-jta-atomikos` | Starter for JTA transactions using Atomikos | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jta-atomikos/pom.xml) |
+| `spring-boot-starter-jta-bitronix` | Starter for JTA transactions using Bitronix | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jta-bitronix/pom.xml) |
+| `spring-boot-starter-jta-narayana` | Spring Boot Narayana JTA Starter | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jta-narayana/pom.xml) |
+| `spring-boot-starter-mail` | Starter for using Java Mail and Spring Framework’s email sending support | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-mail/pom.xml) |
+| `spring-boot-starter-mobile` | Starter for building web applications using Spring Mobile | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-mobile/pom.xml) |
+| `spring-boot-starter-mustache` | Starter for building MVC web applications using Mustache views | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-mustache/pom.xml) |
+| `spring-boot-starter-security` | Starter for using Spring Security | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-security/pom.xml) |
+| `spring-boot-starter-social-facebook` | Starter for using Spring Social Facebook | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-social-facebook/pom.xml) |
+| `spring-boot-starter-social-linkedin` | Stater for using Spring Social LinkedIn | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-social-linkedin/pom.xml) |
+| `spring-boot-starter-social-twitter` | Starter for using Spring Social Twitter | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-social-twitter/pom.xml) |
+| `spring-boot-starter-test` | Starter for testing Spring Boot applications with libraries including JUnit, Hamcrest and Mockito | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-test/pom.xml) |
+| `spring-boot-starter-thymeleaf` | Starter for building MVC web applications using Thymeleaf views | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-thymeleaf/pom.xml) |
+| `spring-boot-starter-validation` | Starter for using Java Bean Validation with Hibernate Validator | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-validation/pom.xml) |
+| `spring-boot-starter-web` | Starter for building web, including RESTful, applications using Spring MVC. Uses Tomcat as the default embedded container | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-web/pom.xml) |
+| `spring-boot-starter-web-services` | Starter for using Spring Web Services | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-web-services/pom.xml) |
+| `spring-boot-starter-websocket` | Starter for building WebSocket applications using Spring Framework’s WebSocket support | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-websocket/pom.xml) |
+
+In addition to the application starters, the following starters can be used to add *production ready* features:
+
+
+
+**Table 13.2. Spring Boot production starters**
+
+| Name | Description | Pom |
+| ---------------------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `spring-boot-starter-actuator` | Starter for using Spring Boot’s Actuator which provides production ready features to help you monitor and manage your application | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-actuator/pom.xml) |
+| `spring-boot-starter-remote-shell` | Starter for using the CRaSH remote shell to monitor and manage your application over SSH. Deprecated since 1.5 | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-remote-shell/pom.xml) |
-All official starters follow a similar naming pattern; spring-boot-starter-*, where * is a particular type of application. This naming structure is intended to help when you need to find a starter. The Maven integration in many IDEs allow you to search dependencies by name. For example, with the appropriate Eclipse or STS plugin installed, you can simply hit ctrl-space in the POM editor and type “spring-boot-starter” for a complete list.
+Finally, Spring Boot also includes some starters that can be used if you want to exclude or swap specific technical facets:
-As explained in the Creating your own starter section, third party starters should not start with spring-boot as it is reserved for official Spring Boot artifacts. A third-party starter for acme will be typically named acme-spring-boot-starter.
-The following application starters are provided by Spring Boot under the org.springframework.boot group:
-Table 13.1. Spring Boot application starters
+**Table 13.3. Spring Boot technical starters**
-Name Description Pom
-spring-boot-starter
+| Name | Description | Pom |
+| ------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `spring-boot-starter-jetty` | Starter for using Jetty as the embedded servlet container. An alternative to [`spring-boot-starter-tomcat`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-tomcat) | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-jetty/pom.xml) |
+| `spring-boot-starter-log4j2` | Starter for using Log4j2 for logging. An alternative to [`spring-boot-starter-logging`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-logging) | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-log4j2/pom.xml) |
+| `spring-boot-starter-logging` | Starter for logging using Logback. Default logging starter | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-logging/pom.xml) |
+| `spring-boot-starter-tomcat` | Starter for using Tomcat as the embedded servlet container. Default servlet container starter used by [`spring-boot-starter-web`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-web) | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-tomcat/pom.xml) |
+| `spring-boot-starter-undertow` | Starter for using Undertow as the embedded servlet container. An alternative to [`spring-boot-starter-tomcat`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#spring-boot-starter-tomcat) | [Pom](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-starters/spring-boot-starter-undertow/pom.xml) |
-Core starter, including auto-configuration support, logging and YAML
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For a list of additional community contributed starters, see the [README file](https://github.com/spring-projects/spring-boot/tree/master/spring-boot-starters/README.adoc) in the `spring-boot-starters` module on GitHub. |
-Pom
+## 14. Structuring your code
-spring-boot-starter-activemq
+Spring Boot does not require any specific code layout to work, however, there are some best practices that help.
-Starter for JMS messaging using Apache ActiveMQ
+## 14.1 Using the “default” package
-Pom
+When a class doesn’t include a `package` declaration it is considered to be in the “default package”. The use of the “default package” is generally discouraged, and should be avoided. It can cause particular problems for Spring Boot applications that use `@ComponentScan`, `@EntityScan` or `@SpringBootApplication`annotations, since every class from every jar, will be read.
-spring-boot-starter-amqp
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| We recommend that you follow Java’s recommended package naming conventions and use a reversed domain name (for example, `com.example.project`). |
-Starter for using Spring AMQP and Rabbit MQ
+## 14.2 Locating the main application class
-Pom
+We generally recommend that you locate your main application class in a root package above other classes. The `@EnableAutoConfiguration` annotation is often placed on your main class, and it implicitly defines a base “search package” for certain items. For example, if you are writing a JPA application, the package of the`@EnableAutoConfiguration` annotated class will be used to search for `@Entity` items.
-spring-boot-starter-aop
+Using a root package also allows the `@ComponentScan` annotation to be used without needing to specify a `basePackage` attribute. You can also use the`@SpringBootApplication` annotation if your main class is in the root package.
-Starter for aspect-oriented programming with Spring AOP and AspectJ
+Here is a typical layout:
-Pom
+```
+com
+ +- example
+ +- myproject
+ +- Application.java
+ |
+ +- domain
+ | +- Customer.java
+ | +- CustomerRepository.java
+ |
+ +- service
+ | +- CustomerService.java
+ |
+ +- web
+ +- CustomerController.java
-spring-boot-starter-artemis
+```
-Starter for JMS messaging using Apache Artemis
+The `Application.java` file would declare the `main` method, along with the basic `@Configuration`.
-Pom
+```
+package com.example.myproject;
-spring-boot-starter-batch
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.Configuration;
-Starter for using Spring Batch
+@Configuration
+@EnableAutoConfiguration
+@ComponentScan
+public class Application {
-Pom
+ public static void main(String[] args) {
+ SpringApplication.run(Application.class, args);
+ }
-spring-boot-starter-cache
+}
-Starter for using Spring Framework’s caching support
+```
-Pom
+## 15. Configuration classes
-spring-boot-starter-cloud-connectors
+Spring Boot favors Java-based configuration. Although it is possible to call `SpringApplication.run()` with an XML source, we generally recommend that your primary source is a `@Configuration` class. Usually the class that defines the `main` method is also a good candidate as the primary `@Configuration`.
-Starter for using Spring Cloud Connectors which simplifies connecting to services in cloud platforms like Cloud Foundry and Heroku
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Many Spring configuration examples have been published on the Internet that use XML configuration. Always try to use the equivalent Java-based configuration if possible. Searching for `Enable*` annotations can be a good starting point. |
-Pom
+## 15.1 Importing additional configuration classes
-spring-boot-starter-data-cassandra
+You don’t need to put all your `@Configuration` into a single class. The `@Import` annotation can be used to import additional configuration classes. Alternatively, you can use `@ComponentScan` to automatically pick up all Spring components, including `@Configuration` classes.
-Starter for using Cassandra distributed database and Spring Data Cassandra
+## 15.2 Importing XML configuration
-Pom
+If you absolutely must use XML based configuration, we recommend that you still start with a `@Configuration` class. You can then use an additional `@ImportResource` annotation to load XML configuration files.
-spring-boot-starter-data-couchbase
+## 16. Auto-configuration
-Starter for using Couchbase document-oriented database and Spring Data Couchbase
+Spring Boot auto-configuration attempts to automatically configure your Spring application based on the jar dependencies that you have added. For example, If `HSQLDB`is on your classpath, and you have not manually configured any database connection beans, then we will auto-configure an in-memory database.
-Pom
+You need to opt-in to auto-configuration by adding the `@EnableAutoConfiguration` or `@SpringBootApplication` annotations to one of your `@Configuration` classes.
-spring-boot-starter-data-elasticsearch
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You should only ever add one `@EnableAutoConfiguration` annotation. We generally recommend that you add it to your primary `@Configuration`class. |
-Starter for using Elasticsearch search and analytics engine and Spring Data Elasticsearch
+## 16.1 Gradually replacing auto-configuration
-Pom
+Auto-configuration is noninvasive, at any point you can start to define your own configuration to replace specific parts of the auto-configuration. For example, if you add your own `DataSource` bean, the default embedded database support will back away.
-spring-boot-starter-data-gemfire
+If you need to find out what auto-configuration is currently being applied, and why, start your application with the `--debug` switch. This will enable debug logs for a selection of core loggers and log an auto-configuration report to the console.
-Starter for using GemFire distributed data store and Spring Data GemFire
+## 16.2 Disabling specific auto-configuration
-Pom
+If you find that specific auto-configure classes are being applied that you don’t want, you can use the exclude attribute of `@EnableAutoConfiguration` to disable them.
-spring-boot-starter-data-jpa
+```
+import org.springframework.boot.autoconfigure.*;
+import org.springframework.boot.autoconfigure.jdbc.*;
+import org.springframework.context.annotation.*;
-Starter for using Spring Data JPA with Hibernate
+@Configuration
+@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
+public class MyConfiguration {
+}
-Pom
+```
-spring-boot-starter-data-ldap
+If the class is not on the classpath, you can use the `excludeName` attribute of the annotation and specify the fully qualified name instead. Finally, you can also control the list of auto-configuration classes to exclude via the `spring.autoconfigure.exclude` property.
-Starter for using Spring Data LDAP
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You can define exclusions both at the annotation level and using the property. |
-Pom
+## 17. Spring Beans and dependency injection
-spring-boot-starter-data-mongodb
+You are free to use any of the standard Spring Framework techniques to define your beans and their injected dependencies. For simplicity, we often find that using `@ComponentScan` to find your beans, in combination with `@Autowired` constructor injection works well.
-Starter for using MongoDB document-oriented database and Spring Data MongoDB
+If you structure your code as suggested above (locating your application class in a root package), you can add `@ComponentScan` without any arguments. All of your application components (`@Component`, `@Service`, `@Repository`, `@Controller` etc.) will be automatically registered as Spring Beans.
-Pom
+Here is an example `@Service` Bean that uses constructor injection to obtain a required `RiskAssessor` bean.
-spring-boot-starter-data-neo4j
+```
+package com.example.service;
-Starter for using Neo4j graph database and Spring Data Neo4j
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Service;
-Pom
+@Service
+public class DatabaseAccountService implements AccountService {
-spring-boot-starter-data-redis
+ private final RiskAssessor riskAssessor;
-Starter for using Redis key-value data store with Spring Data Redis and the Jedis client
+ @Autowired
+ public DatabaseAccountService(RiskAssessor riskAssessor) {
+ this.riskAssessor = riskAssessor;
+ }
-Pom
+ // ...
-spring-boot-starter-data-rest
+}
-Starter for exposing Spring Data repositories over REST using Spring Data REST
+```
-Pom
+And if a bean has one constructor, you can omit the `@Autowired`.
-spring-boot-starter-data-solr
+```
+@Service
+public class DatabaseAccountService implements AccountService {
-Starter for using the Apache Solr search platform with Spring Data Solr
+ private final RiskAssessor riskAssessor;
-Pom
+ public DatabaseAccountService(RiskAssessor riskAssessor) {
+ this.riskAssessor = riskAssessor;
+ }
-spring-boot-starter-freemarker
+ // ...
-Starter for building MVC web applications using FreeMarker views
+}
-Pom
+```
-spring-boot-starter-groovy-templates
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Notice how using constructor injection allows the `riskAssessor` field to be marked as `final`, indicating that it cannot be subsequently changed. |
-Starter for building MVC web applications using Groovy Templates views
+## 18. Using the @SpringBootApplication annotation
-Pom
+Many Spring Boot developers always have their main class annotated with `@Configuration`, `@EnableAutoConfiguration` and `@ComponentScan`. Since these annotations are so frequently used together (especially if you follow the [best practices](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-structuring-your-code) above), Spring Boot provides a convenient `@SpringBootApplication`alternative.
-spring-boot-starter-hateoas
+The `@SpringBootApplication` annotation is equivalent to using `@Configuration`, `@EnableAutoConfiguration` and `@ComponentScan` with their default attributes:
-Starter for building hypermedia-based RESTful web application with Spring MVC and Spring HATEOAS
+```
+package com.example.myproject;
-Pom
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
-spring-boot-starter-integration
+@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
+public class Application {
-Starter for using Spring Integration
+ public static void main(String[] args) {
+ SpringApplication.run(Application.class, args);
+ }
-Pom
+}
-spring-boot-starter-jdbc
+```
-Starter for using JDBC with the Tomcat JDBC connection pool
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| `@SpringBootApplication` also provides aliases to customize the attributes of `@EnableAutoConfiguration` and `@ComponentScan`. |
-Pom
+## 19. Running your application
-spring-boot-starter-jersey
+One of the biggest advantages of packaging your application as jar and using an embedded HTTP server is that you can run your application as you would any other. Debugging Spring Boot applications is also easy; you don’t need any special IDE plugins or extensions.
-Starter for building RESTful web applications using JAX-RS and Jersey. An alternative to spring-boot-starter-web
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| This section only covers jar based packaging, If you choose to package your application as a war file you should refer to your server and IDE documentation. |
-Pom
+## 19.1 Running from an IDE
-spring-boot-starter-jooq
+You can run a Spring Boot application from your IDE as a simple Java application, however, first you will need to import your project. Import steps will vary depending on your IDE and build system. Most IDEs can import Maven projects directly, for example Eclipse users can select `Import…` → `Existing Maven Projects` from the `File` menu.
-Starter for using jOOQ to access SQL databases. An alternative to spring-boot-starter-data-jpa or spring-boot-starter-jdbc
+If you can’t directly import your project into your IDE, you may be able to generate IDE metadata using a build plugin. Maven includes plugins for [Eclipse](https://maven.apache.org/plugins/maven-eclipse-plugin/) and [IDEA](https://maven.apache.org/plugins/maven-idea-plugin/); Gradle offers plugins for [various IDEs](https://docs.gradle.org/2.14.1/userguide/userguide.html).
-Pom
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you accidentally run a web application twice you will see a “Port already in use” error. STS users can use the `Relaunch` button rather than `Run` to ensure that any existing instance is closed. |
-spring-boot-starter-jta-atomikos
+## 19.2 Running as a packaged application
-Starter for JTA transactions using Atomikos
+If you use the Spring Boot Maven or Gradle plugins to create an executable jar you can run your application using `java -jar`. For example:
-Pom
+```
+$ java -jar target/myproject-0.0.1-SNAPSHOT.jar
-spring-boot-starter-jta-bitronix
+```
-Starter for JTA transactions using Bitronix
+It is also possible to run a packaged application with remote debugging support enabled. This allows you to attach a debugger to your packaged application:
-Pom
+```
+$ java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n \
+ -jar target/myproject-0.0.1-SNAPSHOT.jar
-spring-boot-starter-jta-narayana
+```
-Spring Boot Narayana JTA Starter
+## 19.3 Using the Maven plugin
-Pom
+The Spring Boot Maven plugin includes a `run` goal which can be used to quickly compile and run your application. Applications run in an exploded form just like in your IDE.
-spring-boot-starter-mail
+```
+$ mvn spring-boot:run
-Starter for using Java Mail and Spring Framework’s email sending support
+```
-Pom
+You might also want to use the useful operating system environment variable:
-spring-boot-starter-mobile
+```
+$ export MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128M
-Starter for building web applications using Spring Mobile
+```
-Pom
+## 19.4 Using the Gradle plugin
-spring-boot-starter-mustache
+The Spring Boot Gradle plugin also includes a `bootRun` task which can be used to run your application in an exploded form. The `bootRun` task is added whenever you import the `spring-boot-gradle-plugin`:
-Starter for building MVC web applications using Mustache views
+```
+$ gradle bootRun
-Pom
+```
-spring-boot-starter-security
+You might also want to use this useful operating system environment variable:
-Starter for using Spring Security
+```
+$ export JAVA_OPTS=-Xmx1024m -XX:MaxPermSize=128M
-Pom
+```
-spring-boot-starter-social-facebook
+## 19.5 Hot swapping
-Starter for using Spring Social Facebook
+Since Spring Boot applications are just plain Java applications, JVM hot-swapping should work out of the box. JVM hot swapping is somewhat limited with the bytecode that it can replace, for a more complete solution [JRebel](http://zeroturnaround.com/software/jrebel/) or the [Spring Loaded](https://github.com/spring-projects/spring-loaded) project can be used. The `spring-boot-devtools` module also includes support for quick application restarts.
-Pom
+See the [Chapter 20, *Developer tools*](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools) section below and the [Hot swapping “How-to”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-hotswapping) for details.
-spring-boot-starter-social-linkedin
+## 20. Developer tools
-Stater for using Spring Social LinkedIn
+Spring Boot includes an additional set of tools that can make the application development experience a little more pleasant. The `spring-boot-devtools` module can be included in any project to provide additional development-time features. To include devtools support, simply add the module dependency to your build:
-Pom
+**Maven.**
-spring-boot-starter-social-twitter
+```
+
+
+ org.springframework.boot
+ spring-boot-devtools
+ true
+
+
-Starter for using Spring Social Twitter
+```
-Pom
-spring-boot-starter-test
-Starter for testing Spring Boot applications with libraries including JUnit, Hamcrest and Mockito
+**Gradle.**
-Pom
+```
+dependencies {
+ compile("org.springframework.boot:spring-boot-devtools")
+}
-spring-boot-starter-thymeleaf
+```
-Starter for building MVC web applications using Thymeleaf views
-Pom
-spring-boot-starter-validation
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Developer tools are automatically disabled when running a fully packaged application. If your application is launched using `java -jar` or if it’s started using a special classloader, then it is considered a “production application”. Flagging the dependency as optional is a best practice that prevents devtools from being transitively applied to other modules using your project. Gradle does not support `optional` dependencies out-of-the-box so you may want to have a look to the [`propdeps-plugin`](https://github.com/spring-projects/gradle-plugins/tree/master/propdeps-plugin) in the meantime. |
-Starter for using Java Bean Validation with Hibernate Validator
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| repackaged archives do not contain devtools by default. If you want to use [certain remote devtools feature](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-remote), you’ll need to disable the `excludeDevtools`build property to include it. The property is supported with both the Maven and Gradle plugins. |
-Pom
+## 20.1 Property defaults
-spring-boot-starter-web
+Several of the libraries supported by Spring Boot use caches to improve performance. For example, [template engines](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-spring-mvc-template-engines) will cache compiled templates to avoid repeatedly parsing template files. Also, Spring MVC can add HTTP caching headers to responses when serving static resources.
-Starter for building web, including RESTful, applications using Spring MVC. Uses Tomcat as the default embedded container
+Whilst caching is very beneficial in production, it can be counter productive during development, preventing you from seeing the changes you just made in your application. For this reason, spring-boot-devtools will disable those caching options by default.
-Pom
+Cache options are usually configured by settings in your `application.properties` file. For example, Thymeleaf offers the `spring.thymeleaf.cache` property. Rather than needing to set these properties manually, the `spring-boot-devtools` module will automatically apply sensible development-time configuration.
-spring-boot-starter-web-services
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For a complete list of the properties that are applied see [DevToolsPropertyDefaultsPostProcessor](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-devtools/src/main/java/org/springframework/boot/devtools/env/DevToolsPropertyDefaultsPostProcessor.java). |
-Starter for using Spring Web Services
+## 20.2 Automatic restart
-Pom
+Applications that use `spring-boot-devtools` will automatically restart whenever files on the classpath change. This can be a useful feature when working in an IDE as it gives a very fast feedback loop for code changes. By default, any entry on the classpath that points to a folder will be monitored for changes. Note that certain resources such as static assets and view templates [do not need to restart the application](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-exclude).
-spring-boot-starter-websocket
+**Triggering a restart**
-Starter for building WebSocket applications using Spring Framework’s WebSocket support
+As DevTools monitors classpath resources, the only way to trigger a restart is to update the classpath. The way in which you cause the classpath to be updated depends on the IDE that you are using. In Eclipse, saving a modified file will cause the classpath to be updated and trigger a restart. In IntelliJ IDEA, building the project (`Build -> Make Project`) will have the same effect.
-Pom
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can also start your application via the supported build plugins (i.e. Maven and Gradle) as long as forking is enabled since DevTools need an isolated application classloader to operate properly. Gradle and Maven do that by default when they detect DevTools on the classpath. |
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Automatic restart works very well when used with LiveReload. [See below](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-livereload) for details. If you use JRebel automatic restarts will be disabled in favor of dynamic class reloading. Other devtools features (such as LiveReload and property overrides) can still be used. |
-In addition to the application starters, the following starters can be used to add production ready features:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| DevTools relies on the application context’s shutdown hook to close it during a restart. It will not work correctly if you have disabled the shutdown hook (`SpringApplication.setRegisterShutdownHook(false)`). |
-Table 13.2. Spring Boot production starters
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| When deciding if an entry on the classpath should trigger a restart when it changes, DevTools automatically ignores projects named `spring-boot`, `spring-boot-devtools`, `spring-boot-autoconfigure`, `spring-boot-actuator`, and `spring-boot-starter`. |
-Name Description Pom
-spring-boot-starter-actuator
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| DevTools needs to customize the `ResourceLoader` used by the `ApplicationContext`: if your application provides one already, it is going to be wrapped. Direct override of the `getResource` method on the `ApplicationContext` is not supported. |
-Starter for using Spring Boot’s Actuator which provides production ready features to help you monitor and manage your application
-Pom
-spring-boot-starter-remote-shell
+**Restart vs Reload**
-Starter for using the CRaSH remote shell to monitor and manage your application over SSH. Deprecated since 1.5
+The restart technology provided by Spring Boot works by using two classloaders. Classes that don’t change (for example, those from third-party jars) are loaded into a *base* classloader. Classes that you’re actively developing are loaded into a *restart* classloader. When the application is restarted, the *restart* classloader is thrown away and a new one is created. This approach means that application restarts are typically much faster than “cold starts” since the *base* classloader is already available and populated.
-Pom
+If you find that restarts aren’t quick enough for your applications, or you encounter classloading issues, you could consider reloading technologies such as [JRebel](http://zeroturnaround.com/software/jrebel/)from ZeroTurnaround. These work by rewriting classes as they are loaded to make them more amenable to reloading. [Spring Loaded](https://github.com/spring-projects/spring-loaded) provides another option, however it doesn’t support as many frameworks and it isn’t commercially supported.
+### 20.2.1 Excluding resources
-Finally, Spring Boot also includes some starters that can be used if you want to exclude or swap specific technical facets:
+Certain resources don’t necessarily need to trigger a restart when they are changed. For example, Thymeleaf templates can just be edited in-place. By default changing resources in `/META-INF/maven`, `/META-INF/resources`, `/resources`, `/static`, `/public` or `/templates` will not trigger a restart but will trigger a [live reload](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-livereload). If you want to customize these exclusions you can use the `spring.devtools.restart.exclude` property. For example, to exclude only `/static` and `/public` you would set the following:
-Table 13.3. Spring Boot technical starters
+```
+spring.devtools.restart.exclude=static/**,public/**
-Name Description Pom
-spring-boot-starter-jetty
+```
-Starter for using Jetty as the embedded servlet container. An alternative to spring-boot-starter-tomcat
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| if you want to keep those defaults and *add* additional exclusions, use the `spring.devtools.restart.additional-exclude` property instead. |
-Pom
+### 20.2.2 Watching additional paths
-spring-boot-starter-log4j2
+You may want your application to be restarted or reloaded when you make changes to files that are not on the classpath. To do so, use the`spring.devtools.restart.additional-paths` property to configure additional paths to watch for changes. You can use the `spring.devtools.restart.exclude` property [described above](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-exclude) to control whether changes beneath the additional paths will trigger a full restart or just a [live reload](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-livereload).
-Starter for using Log4j2 for logging. An alternative to spring-boot-starter-logging
+### 20.2.3 Disabling restart
-Pom
+If you don’t want to use the restart feature you can disable it using the `spring.devtools.restart.enabled` property. In most cases you can set this in your`application.properties` (this will still initialize the restart classloader but it won’t watch for file changes).
-spring-boot-starter-logging
+If you need to *completely* disable restart support, for example, because it doesn’t work with a specific library, you need to set a `System` property before calling`SpringApplication.run(…)`. For example:
-Starter for logging using Logback. Default logging starter
+```
+public static void main(String[] args) {
+ System.setProperty("spring.devtools.restart.enabled", "false");
+ SpringApplication.run(MyApp.class, args);
+}
-Pom
+```
-spring-boot-starter-tomcat
+### 20.2.4 Using a trigger file
-Starter for using Tomcat as the embedded servlet container. Default servlet container starter used by spring-boot-starter-web
+If you work with an IDE that continuously compiles changed files, you might prefer to trigger restarts only at specific times. To do this you can use a “trigger file”, which is a special file that must be modified when you want to actually trigger a restart check. Changing the file only triggers the check and the restart will only occur if Devtools has detected it has to do something. The trigger file could be updated manually, or via an IDE plugin.
-Pom
+To use a trigger file use the `spring.devtools.restart.trigger-file` property.
-spring-boot-starter-undertow
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You might want to set `spring.devtools.restart.trigger-file` as a [global setting](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-globalsettings) so that all your projects behave in the same way. |
-Starter for using Undertow as the embedded servlet container. An alternative to spring-boot-starter-tomcat
+### 20.2.5 Customizing the restart classloader
-Pom
+As described in the [Restart vs Reload](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-spring-boot-restart-vs-reload) section above, restart functionality is implemented by using two classloaders. For most applications this approach works well, however, sometimes it can cause classloading issues.
+By default, any open project in your IDE will be loaded using the “restart” classloader, and any regular `.jar` file will be loaded using the “base” classloader. If you work on a multi-module project, and not each module is imported into your IDE, you may need to customize things. To do this you can create a `META-INF/spring-devtools.properties` file.
-[Tip]
-For a list of additional community contributed starters, see the README file in the spring-boot-starters module on GitHub.
+The `spring-devtools.properties` file can contain `restart.exclude.` and `restart.include.` prefixed properties. The `include` elements are items that should be pulled up into the “restart” classloader, and the `exclude` elements are items that should be pushed down into the “base” classloader. The value of the property is a regex pattern that will be applied to the classpath.
-14. Structuring your code
-Spring Boot does not require any specific code layout to work, however, there are some best practices that help.
+For example:
-14.1 Using the “default” package
-When a class doesn’t include a package declaration it is considered to be in the “default package”. The use of the “default package” is generally discouraged, and should be avoided. It can cause particular problems for Spring Boot applications that use @ComponentScan, @EntityScan or @SpringBootApplication annotations, since every class from every jar, will be read.
+```
+restart.exclude.companycommonlibs=/mycorp-common-[\\w-]+\.jar
+restart.include.projectcommon=/mycorp-myproj-[\\w-]+\.jar
-[Tip]
-We recommend that you follow Java’s recommended package naming conventions and use a reversed domain name (for example, com.example.project).
+```
-14.2 Locating the main application class
-We generally recommend that you locate your main application class in a root package above other classes. The @EnableAutoConfiguration annotation is often placed on your main class, and it implicitly defines a base “search package” for certain items. For example, if you are writing a JPA application, the package of the @EnableAutoConfiguration annotated class will be used to search for @Entity items.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| All property keys must be unique. As long as a property starts with `restart.include.` or `restart.exclude.` it will be considered. |
-Using a root package also allows the @ComponentScan annotation to be used without needing to specify a basePackage attribute. You can also use the @SpringBootApplication annotation if your main class is in the root package.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| All `META-INF/spring-devtools.properties` from the classpath will be loaded. You can package files inside your project, or in the libraries that the project consumes. |
-Here is a typical layout:
+### 20.2.6 Known limitations
-com
- +- example
- +- myproject
- +- Application.java
- |
- +- domain
- | +- Customer.java
- | +- CustomerRepository.java
- |
- +- service
- | +- CustomerService.java
- |
- +- web
- +- CustomerController.java
-The Application.java file would declare the main method, along with the basic @Configuration.
-
-package com.example.myproject;
-
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
-import org.springframework.context.annotation.ComponentScan;
-import org.springframework.context.annotation.Configuration;
-
-@Configuration
-@EnableAutoConfiguration
-@ComponentScan
-public class Application {
-
- public static void main(String[] args) {
- SpringApplication.run(Application.class, args);
- }
-
-}
-15. Configuration classes
-Spring Boot favors Java-based configuration. Although it is possible to call SpringApplication.run() with an XML source, we generally recommend that your primary source is a @Configuration class. Usually the class that defines the main method is also a good candidate as the primary @Configuration.
-
-[Tip]
-Many Spring configuration examples have been published on the Internet that use XML configuration. Always try to use the equivalent Java-based configuration if possible. Searching for Enable* annotations can be a good starting point.
-
-15.1 Importing additional configuration classes
-You don’t need to put all your @Configuration into a single class. The @Import annotation can be used to import additional configuration classes. Alternatively, you can use @ComponentScan to automatically pick up all Spring components, including @Configuration classes.
-
-15.2 Importing XML configuration
-If you absolutely must use XML based configuration, we recommend that you still start with a @Configuration class. You can then use an additional @ImportResource annotation to load XML configuration files.
-
-16. Auto-configuration
-Spring Boot auto-configuration attempts to automatically configure your Spring application based on the jar dependencies that you have added. For example, If HSQLDB is on your classpath, and you have not manually configured any database connection beans, then we will auto-configure an in-memory database.
-
-You need to opt-in to auto-configuration by adding the @EnableAutoConfiguration or @SpringBootApplication annotations to one of your @Configuration classes.
-
-[Tip]
-You should only ever add one @EnableAutoConfiguration annotation. We generally recommend that you add it to your primary @Configuration class.
-
-16.1 Gradually replacing auto-configuration
-Auto-configuration is noninvasive, at any point you can start to define your own configuration to replace specific parts of the auto-configuration. For example, if you add your own DataSource bean, the default embedded database support will back away.
-
-If you need to find out what auto-configuration is currently being applied, and why, start your application with the --debug switch. This will enable debug logs for a selection of core loggers and log an auto-configuration report to the console.
-
-16.2 Disabling specific auto-configuration
-If you find that specific auto-configure classes are being applied that you don’t want, you can use the exclude attribute of @EnableAutoConfiguration to disable them.
-
-import org.springframework.boot.autoconfigure.*;
-import org.springframework.boot.autoconfigure.jdbc.*;
-import org.springframework.context.annotation.*;
-
-@Configuration
-@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
-public class MyConfiguration {
-}
-If the class is not on the classpath, you can use the excludeName attribute of the annotation and specify the fully qualified name instead. Finally, you can also control the list of auto-configuration classes to exclude via the spring.autoconfigure.exclude property.
-
-[Tip]
-You can define exclusions both at the annotation level and using the property.
-
-17. Spring Beans and dependency injection
-You are free to use any of the standard Spring Framework techniques to define your beans and their injected dependencies. For simplicity, we often find that using @ComponentScan to find your beans, in combination with @Autowired constructor injection works well.
-
-If you structure your code as suggested above (locating your application class in a root package), you can add @ComponentScan without any arguments. All of your application components (@Component, @Service, @Repository, @Controller etc.) will be automatically registered as Spring Beans.
-
-Here is an example @Service Bean that uses constructor injection to obtain a required RiskAssessor bean.
-
-package com.example.service;
-
-import org.springframework.beans.factory.annotation.Autowired;
-import org.springframework.stereotype.Service;
-
-@Service
-public class DatabaseAccountService implements AccountService {
-
- private final RiskAssessor riskAssessor;
-
- @Autowired
- public DatabaseAccountService(RiskAssessor riskAssessor) {
- this.riskAssessor = riskAssessor;
- }
-
- // ...
-
-}
-And if a bean has one constructor, you can omit the @Autowired.
-
-@Service
-public class DatabaseAccountService implements AccountService {
-
- private final RiskAssessor riskAssessor;
-
- public DatabaseAccountService(RiskAssessor riskAssessor) {
- this.riskAssessor = riskAssessor;
- }
-
- // ...
-
-}
-[Tip]
-Notice how using constructor injection allows the riskAssessor field to be marked as final, indicating that it cannot be subsequently changed.
-
-18. Using the @SpringBootApplication annotation
-Many Spring Boot developers always have their main class annotated with @Configuration, @EnableAutoConfiguration and @ComponentScan. Since these annotations are so frequently used together (especially if you follow the best practices above), Spring Boot provides a convenient @SpringBootApplication alternative.
-
-The @SpringBootApplication annotation is equivalent to using @Configuration, @EnableAutoConfiguration and @ComponentScan with their default attributes:
-
-package com.example.myproject;
-
-import org.springframework.boot.SpringApplication;
-import org.springframework.boot.autoconfigure.SpringBootApplication;
-
-@SpringBootApplication // same as @Configuration @EnableAutoConfiguration @ComponentScan
-public class Application {
-
- public static void main(String[] args) {
- SpringApplication.run(Application.class, args);
- }
-
-}
-[Note]
-@SpringBootApplication also provides aliases to customize the attributes of @EnableAutoConfiguration and @ComponentScan.
-
-19. Running your application
-One of the biggest advantages of packaging your application as jar and using an embedded HTTP server is that you can run your application as you would any other. Debugging Spring Boot applications is also easy; you don’t need any special IDE plugins or extensions.
-
-[Note]
-This section only covers jar based packaging, If you choose to package your application as a war file you should refer to your server and IDE documentation.
-
-19.1 Running from an IDE
-You can run a Spring Boot application from your IDE as a simple Java application, however, first you will need to import your project. Import steps will vary depending on your IDE and build system. Most IDEs can import Maven projects directly, for example Eclipse users can select Import… → Existing Maven Projects from the File menu.
-
-If you can’t directly import your project into your IDE, you may be able to generate IDE metadata using a build plugin. Maven includes plugins for Eclipse and IDEA; Gradle offers plugins for various IDEs.
-
-[Tip]
-If you accidentally run a web application twice you will see a “Port already in use” error. STS users can use the Relaunch button rather than Run to ensure that any existing instance is closed.
-
-19.2 Running as a packaged application
-If you use the Spring Boot Maven or Gradle plugins to create an executable jar you can run your application using java -jar. For example:
-
-$ java -jar target/myproject-0.0.1-SNAPSHOT.jar
-It is also possible to run a packaged application with remote debugging support enabled. This allows you to attach a debugger to your packaged application:
-
-$ java -Xdebug -Xrunjdwp:server=y,transport=dt_socket,address=8000,suspend=n \
- -jar target/myproject-0.0.1-SNAPSHOT.jar
-19.3 Using the Maven plugin
-The Spring Boot Maven plugin includes a run goal which can be used to quickly compile and run your application. Applications run in an exploded form just like in your IDE.
-
-$ mvn spring-boot:run
-You might also want to use the useful operating system environment variable:
-
-$ export MAVEN_OPTS=-Xmx1024m -XX:MaxPermSize=128M
-19.4 Using the Gradle plugin
-The Spring Boot Gradle plugin also includes a bootRun task which can be used to run your application in an exploded form. The bootRun task is added whenever you import the spring-boot-gradle-plugin:
-
-$ gradle bootRun
-You might also want to use this useful operating system environment variable:
-
-$ export JAVA_OPTS=-Xmx1024m -XX:MaxPermSize=128M
-19.5 Hot swapping
-Since Spring Boot applications are just plain Java applications, JVM hot-swapping should work out of the box. JVM hot swapping is somewhat limited with the bytecode that it can replace, for a more complete solution JRebel or the Spring Loaded project can be used. The spring-boot-devtools module also includes support for quick application restarts.
-
-See the Chapter 20, Developer tools section below and the Hot swapping “How-to” for details.
-
-20. Developer tools
-Spring Boot includes an additional set of tools that can make the application development experience a little more pleasant. The spring-boot-devtools module can be included in any project to provide additional development-time features. To include devtools support, simply add the module dependency to your build:
-
-Maven.
-
-
-
- org.springframework.boot
- spring-boot-devtools
- true
-
-
-Gradle.
-
-dependencies {
- compile("org.springframework.boot:spring-boot-devtools")
-}
-[Note]
-Developer tools are automatically disabled when running a fully packaged application. If your application is launched using java -jar or if it’s started using a special classloader, then it is considered a “production application”. Flagging the dependency as optional is a best practice that prevents devtools from being transitively applied to other modules using your project. Gradle does not support optional dependencies out-of-the-box so you may want to have a look to the propdeps-plugin in the meantime.
-
-[Tip]
-repackaged archives do not contain devtools by default. If you want to use certain remote devtools feature, you’ll need to disable the excludeDevtools build property to include it. The property is supported with both the Maven and Gradle plugins.
-
-20.1 Property defaults
-Several of the libraries supported by Spring Boot use caches to improve performance. For example, template engines will cache compiled templates to avoid repeatedly parsing template files. Also, Spring MVC can add HTTP caching headers to responses when serving static resources.
-
-Whilst caching is very beneficial in production, it can be counter productive during development, preventing you from seeing the changes you just made in your application. For this reason, spring-boot-devtools will disable those caching options by default.
-
-Cache options are usually configured by settings in your application.properties file. For example, Thymeleaf offers the spring.thymeleaf.cache property. Rather than needing to set these properties manually, the spring-boot-devtools module will automatically apply sensible development-time configuration.
-
-[Tip]
-For a complete list of the properties that are applied see DevToolsPropertyDefaultsPostProcessor.
-
-20.2 Automatic restart
-Applications that use spring-boot-devtools will automatically restart whenever files on the classpath change. This can be a useful feature when working in an IDE as it gives a very fast feedback loop for code changes. By default, any entry on the classpath that points to a folder will be monitored for changes. Note that certain resources such as static assets and view templates do not need to restart the application.
-
-Triggering a restart
-
-As DevTools monitors classpath resources, the only way to trigger a restart is to update the classpath. The way in which you cause the classpath to be updated depends on the IDE that you are using. In Eclipse, saving a modified file will cause the classpath to be updated and trigger a restart. In IntelliJ IDEA, building the project (Build -> Make Project) will have the same effect.
-
-[Note]
-You can also start your application via the supported build plugins (i.e. Maven and Gradle) as long as forking is enabled since DevTools need an isolated application classloader to operate properly. Gradle and Maven do that by default when they detect DevTools on the classpath.
-
-[Tip]
-Automatic restart works very well when used with LiveReload. See below for details. If you use JRebel automatic restarts will be disabled in favor of dynamic class reloading. Other devtools features (such as LiveReload and property overrides) can still be used.
-
-[Note]
-DevTools relies on the application context’s shutdown hook to close it during a restart. It will not work correctly if you have disabled the shutdown hook ( SpringApplication.setRegisterShutdownHook(false)).
-
-[Note]
-When deciding if an entry on the classpath should trigger a restart when it changes, DevTools automatically ignores projects named spring-boot, spring-boot-devtools, spring-boot-autoconfigure, spring-boot-actuator, and spring-boot-starter.
-
-[Note]
-DevTools needs to customize the ResourceLoader used by the ApplicationContext: if your application provides one already, it is going to be wrapped. Direct override of the getResource method on the ApplicationContext is not supported.
-
-Restart vs Reload
-
-The restart technology provided by Spring Boot works by using two classloaders. Classes that don’t change (for example, those from third-party jars) are loaded into a base classloader. Classes that you’re actively developing are loaded into a restart classloader. When the application is restarted, the restart classloader is thrown away and a new one is created. This approach means that application restarts are typically much faster than “cold starts” since the base classloader is already available and populated.
-
-If you find that restarts aren’t quick enough for your applications, or you encounter classloading issues, you could consider reloading technologies such as JRebel from ZeroTurnaround. These work by rewriting classes as they are loaded to make them more amenable to reloading. Spring Loaded provides another option, however it doesn’t support as many frameworks and it isn’t commercially supported.
-
-20.2.1 Excluding resources
-Certain resources don’t necessarily need to trigger a restart when they are changed. For example, Thymeleaf templates can just be edited in-place. By default changing resources in /META-INF/maven, /META-INF/resources, /resources, /static, /public or /templates will not trigger a restart but will trigger a live reload. If you want to customize these exclusions you can use the spring.devtools.restart.exclude property. For example, to exclude only /static and /public you would set the following:
-
-spring.devtools.restart.exclude=static/**,public/**
-[Tip]
-if you want to keep those defaults and add additional exclusions, use the spring.devtools.restart.additional-exclude property instead.
-
-20.2.2 Watching additional paths
-You may want your application to be restarted or reloaded when you make changes to files that are not on the classpath. To do so, use the spring.devtools.restart.additional-paths property to configure additional paths to watch for changes. You can use the spring.devtools.restart.exclude property described above to control whether changes beneath the additional paths will trigger a full restart or just a live reload.
-
-20.2.3 Disabling restart
-If you don’t want to use the restart feature you can disable it using the spring.devtools.restart.enabled property. In most cases you can set this in your application.properties (this will still initialize the restart classloader but it won’t watch for file changes).
-
-If you need to completely disable restart support, for example, because it doesn’t work with a specific library, you need to set a System property before calling SpringApplication.run(…). For example:
-
-public static void main(String[] args) {
- System.setProperty("spring.devtools.restart.enabled", "false");
- SpringApplication.run(MyApp.class, args);
-}
-20.2.4 Using a trigger file
-If you work with an IDE that continuously compiles changed files, you might prefer to trigger restarts only at specific times. To do this you can use a “trigger file”, which is a special file that must be modified when you want to actually trigger a restart check. Changing the file only triggers the check and the restart will only occur if Devtools has detected it has to do something. The trigger file could be updated manually, or via an IDE plugin.
-
-To use a trigger file use the spring.devtools.restart.trigger-file property.
-
-[Tip]
-You might want to set spring.devtools.restart.trigger-file as a global setting so that all your projects behave in the same way.
+Restart functionality does not work well with objects that are deserialized using a standard `ObjectInputStream`. If you need to deserialize data, you may need to use Spring’s `ConfigurableObjectInputStream` in combination with `Thread.currentThread().getContextClassLoader()`.
-20.2.5 Customizing the restart classloader
-As described in the Restart vs Reload section above, restart functionality is implemented by using two classloaders. For most applications this approach works well, however, sometimes it can cause classloading issues.
+Unfortunately, several third-party libraries deserialize without considering the context classloader. If you find such a problem, you will need to request a fix with the original authors.
-By default, any open project in your IDE will be loaded using the “restart” classloader, and any regular .jar file will be loaded using the “base” classloader. If you work on a multi-module project, and not each module is imported into your IDE, you may need to customize things. To do this you can create a META-INF/spring-devtools.properties file.
+## 20.3 LiveReload
-The spring-devtools.properties file can contain restart.exclude. and restart.include. prefixed properties. The include elements are items that should be pulled up into the “restart” classloader, and the exclude elements are items that should be pushed down into the “base” classloader. The value of the property is a regex pattern that will be applied to the classpath.
+The `spring-boot-devtools` module includes an embedded LiveReload server that can be used to trigger a browser refresh when a resource is changed. LiveReload browser extensions are freely available for Chrome, Firefox and Safari from [livereload.com](http://livereload.com/extensions/).
-For example:
+If you don’t want to start the LiveReload server when your application runs you can set the `spring.devtools.livereload.enabled` property to `false`.
-restart.exclude.companycommonlibs=/mycorp-common-[\\w-]+\.jar
-restart.include.projectcommon=/mycorp-myproj-[\\w-]+\.jar
-[Note]
-All property keys must be unique. As long as a property starts with restart.include. or restart.exclude. it will be considered.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can only run one LiveReload server at a time. Before starting your application, ensure that no other LiveReload servers are running. If you start multiple applications from your IDE, only the first will have LiveReload support. |
-[Tip]
-All META-INF/spring-devtools.properties from the classpath will be loaded. You can package files inside your project, or in the libraries that the project consumes.
+## 20.4 Global settings
-20.2.6 Known limitations
-Restart functionality does not work well with objects that are deserialized using a standard ObjectInputStream. If you need to deserialize data, you may need to use Spring’s ConfigurableObjectInputStream in combination with Thread.currentThread().getContextClassLoader().
+You can configure global devtools settings by adding a file named `.spring-boot-devtools.properties` to your `$HOME` folder (note that the filename starts with “.”). Any properties added to this file will apply to *all* Spring Boot applications on your machine that use devtools. For example, to configure restart to always use a [trigger file](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-triggerfile), you would add the following:
-Unfortunately, several third-party libraries deserialize without considering the context classloader. If you find such a problem, you will need to request a fix with the original authors.
+**~/.spring-boot-devtools.properties.**
-20.3 LiveReload
-The spring-boot-devtools module includes an embedded LiveReload server that can be used to trigger a browser refresh when a resource is changed. LiveReload browser extensions are freely available for Chrome, Firefox and Safari from livereload.com.
+```
+spring.devtools.reload.trigger-file=.reloadtrigger
-If you don’t want to start the LiveReload server when your application runs you can set the spring.devtools.livereload.enabled property to false.
+```
-[Note]
-You can only run one LiveReload server at a time. Before starting your application, ensure that no other LiveReload servers are running. If you start multiple applications from your IDE, only the first will have LiveReload support.
-20.4 Global settings
-You can configure global devtools settings by adding a file named .spring-boot-devtools.properties to your $HOME folder (note that the filename starts with “.”). Any properties added to this file will apply to all Spring Boot applications on your machine that use devtools. For example, to configure restart to always use a trigger file, you would add the following:
-~/.spring-boot-devtools.properties.
+## 20.5 Remote applications
-spring.devtools.reload.trigger-file=.reloadtrigger
-20.5 Remote applications
-The Spring Boot developer tools are not just limited to local development. You can also use several features when running applications remotely. Remote support is opt-in, to enable it you need to make sure that devtools is included in the repackaged archive:
+The Spring Boot developer tools are not just limited to local development. You can also use several features when running applications remotely. Remote support is opt-in, to enable it you need to make sure that `devtools` is included in the repackaged archive:
+```
@@ -2023,26 +1542,37 @@ The Spring Boot developer tools are not just limited to local development. You c
-Then you need to set a spring.devtools.remote.secret property, for example:
+```
+
+Then you need to set a `spring.devtools.remote.secret` property, for example:
+
+```
spring.devtools.remote.secret=mysecret
-[Warning]
-Enabling spring-boot-devtools on a remote application is a security risk. You should never enable support on a production deployment.
-Remote devtools support is provided in two parts; there is a server side endpoint that accepts connections, and a client application that you run in your IDE. The server component is automatically enabled when the spring.devtools.remote.secret property is set. The client component must be launched manually.
+```
+
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| Enabling `spring-boot-devtools` on a remote application is a security risk. You should never enable support on a production deployment. |
+
+Remote devtools support is provided in two parts; there is a server side endpoint that accepts connections, and a client application that you run in your IDE. The server component is automatically enabled when the `spring.devtools.remote.secret` property is set. The client component must be launched manually.
+
+### 20.5.1 Running the remote client application
-20.5.1 Running the remote client application
-The remote client application is designed to be run from within your IDE. You need to run org.springframework.boot.devtools.RemoteSpringApplication using the same classpath as the remote project that you’re connecting to. The non-option argument passed to the application should be the remote URL that you are connecting to.
+The remote client application is designed to be run from within your IDE. You need to run `org.springframework.boot.devtools.RemoteSpringApplication`using the same classpath as the remote project that you’re connecting to. The *non-option* argument passed to the application should be the remote URL that you are connecting to.
-For example, if you are using Eclipse or STS, and you have a project named my-app that you’ve deployed to Cloud Foundry, you would do the following:
+For example, if you are using Eclipse or STS, and you have a project named `my-app` that you’ve deployed to Cloud Foundry, you would do the following:
+
+- Select `Run Configurations…` from the `Run` menu.
+- Create a new `Java Application` “launch configuration”.
+- Browse for the `my-app` project.
+- Use `org.springframework.boot.devtools.RemoteSpringApplication` as the main class.
+- Add `https://myapp.cfapps.io` to the `Program arguments` (or whatever your remote URL is).
-Select Run Configurations… from the Run menu.
-Create a new Java Application “launch configuration”.
-Browse for the my-app project.
-Use org.springframework.boot.devtools.RemoteSpringApplication as the main class.
-Add https://myapp.cfapps.io to the Program arguments (or whatever your remote URL is).
A running remote client will look like this:
+```
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ ___ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | | _ \___ _ __ ___| |_ ___ \ \ \ \
@@ -2056,59 +1586,86 @@ A running remote client will look like this:
2015-06-10 18:25:07.043 WARN 14938 --- [ main] o.s.b.d.r.c.RemoteClientConfiguration : The connection to http://localhost:8080 is insecure. You should use a URL starting with 'https://'.
2015-06-10 18:25:07.074 INFO 14938 --- [ main] o.s.b.d.a.OptionalLiveReloadServer : LiveReload server is running on port 35729
2015-06-10 18:25:07.130 INFO 14938 --- [ main] o.s.b.devtools.RemoteSpringApplication : Started RemoteSpringApplication in 0.74 seconds (JVM running for 1.105)
-[Note]
-Because the remote client is using the same classpath as the real application it can directly read application properties. This is how the spring.devtools.remote.secret property is read and passed to the server for authentication.
-[Tip]
-It’s always advisable to use https:// as the connection protocol so that traffic is encrypted and passwords cannot be intercepted.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Because the remote client is using the same classpath as the real application it can directly read application properties. This is how the `spring.devtools.remote.secret` property is read and passed to the server for authentication. |
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| It’s always advisable to use `https://` as the connection protocol so that traffic is encrypted and passwords cannot be intercepted. |
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you need to use a proxy to access the remote application, configure the `spring.devtools.remote.proxy.host` and `spring.devtools.remote.proxy.port` properties. |
-[Tip]
-If you need to use a proxy to access the remote application, configure the spring.devtools.remote.proxy.host and spring.devtools.remote.proxy.port properties.
+### 20.5.2 Remote update
-20.5.2 Remote update
-The remote client will monitor your application classpath for changes in the same way as the local restart. Any updated resource will be pushed to the remote application and (if required) trigger a restart. This can be quite helpful if you are iterating on a feature that uses a cloud service that you don’t have locally. Generally remote updates and restarts are much quicker than a full rebuild and deploy cycle.
+The remote client will monitor your application classpath for changes in the same way as the [local restart](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart). Any updated resource will be pushed to the remote application and *(if required)* trigger a restart. This can be quite helpful if you are iterating on a feature that uses a cloud service that you don’t have locally. Generally remote updates and restarts are much quicker than a full rebuild and deploy cycle.
-[Note]
-Files are only monitored when the remote client is running. If you change a file before starting the remote client, it won’t be pushed to the remote server.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Files are only monitored when the remote client is running. If you change a file before starting the remote client, it won’t be pushed to the remote server. |
+
+### 20.5.3 Remote debug tunnel
-20.5.3 Remote debug tunnel
Java remote debugging is useful when diagnosing issues on a remote application. Unfortunately, it’s not always possible to enable remote debugging when your application is deployed outside of your data center. Remote debugging can also be tricky to setup if you are using a container based technology such as Docker.
-To help work around these limitations, devtools supports tunneling of remote debug traffic over HTTP. The remote client provides a local server on port 8000 that you can attach a remote debugger to. Once a connection is established, debug traffic is sent over HTTP to the remote application. You can use the spring.devtools.remote.debug.local-port property if you want to use a different port.
+To help work around these limitations, devtools supports tunneling of remote debug traffic over HTTP. The remote client provides a local server on port `8000` that you can attach a remote debugger to. Once a connection is established, debug traffic is sent over HTTP to the remote application. You can use the `spring.devtools.remote.debug.local-port` property if you want to use a different port.
-You’ll need to ensure that your remote application is started with remote debugging enabled. Often this can be achieved by configuring JAVA_OPTS. For example, with Cloud Foundry you can add the following to your manifest.yml:
+You’ll need to ensure that your remote application is started with remote debugging enabled. Often this can be achieved by configuring `JAVA_OPTS`. For example, with Cloud Foundry you can add the following to your `manifest.yml`:
+```
---
env:
JAVA_OPTS: "-Xdebug -Xrunjdwp:server=y,transport=dt_socket,suspend=n"
-[Tip]
-Notice that you don’t need to pass an address=NNNN option to -Xrunjdwp. If omitted Java will simply pick a random free port.
-[Note]
-Debugging a remote service over the Internet can be slow and you might need to increase timeouts in your IDE. For example, in Eclipse you can select Java → Debug from Preferences… and change the Debugger timeout (ms) to a more suitable value (60000 works well in most situations).
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Notice that you don’t need to pass an `address=NNNN` option to `-Xrunjdwp`. If omitted Java will simply pick a random free port. |
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Debugging a remote service over the Internet can be slow and you might need to increase timeouts in your IDE. For example, in Eclipse you can select `Java` → `Debug` from `Preferences…` and change the `Debugger timeout (ms)` to a more suitable value (`60000` works well in most situations). |
+
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| When using the remote debug tunnel with IntelliJ IDEA, all breakpoints must be configured to suspend the thread rather than the VM. By default, breakpoints in IntelliJ IDEA suspend the entire VM rather than only suspending the thread that hit the breakpoint. This has the unwanted side-effect of suspending the thread that manages the remote debug tunnel, causing your debugging session to freeze. When using the remote debug tunnel with IntelliJ IDEA, all breakpoints should be configured to suspend the thread rather than the VM. Please see [IDEA-165769](https://youtrack.jetbrains.com/issue/IDEA-165769) for further details. |
-[Warning]
-When using the remote debug tunnel with IntelliJ IDEA, all breakpoints must be configured to suspend the thread rather than the VM. By default, breakpoints in IntelliJ IDEA suspend the entire VM rather than only suspending the thread that hit the breakpoint. This has the unwanted side-effect of suspending the thread that manages the remote debug tunnel, causing your debugging session to freeze. When using the remote debug tunnel with IntelliJ IDEA, all breakpoints should be configured to suspend the thread rather than the VM. Please see IDEA-165769 for further details.
+## 21. Packaging your application for production
-21. Packaging your application for production
Executable jars can be used for production deployment. As they are self-contained, they are also ideally suited for cloud-based deployment.
-For additional “production ready” features, such as health, auditing and metric REST or JMX end-points; consider adding spring-boot-actuator. See Part V, “Spring Boot Actuator: Production-ready features” for details.
+For additional “production ready” features, such as health, auditing and metric REST or JMX end-points; consider adding `spring-boot-actuator`. See *Part V, “Spring Boot Actuator: Production-ready features”* for details.
-22. What to read next
-You should now have good understanding of how you can use Spring Boot along with some best practices that you should follow. You can now go on to learn about specific Spring Boot features in depth, or you could skip ahead and read about the “production ready” aspects of Spring Boot.
+## 22. What to read next
-Part IV. Spring Boot features
-This section dives into the details of Spring Boot. Here you can learn about the key features that you will want to use and customize. If you haven’t already, you might want to read the Part II, “Getting started” and Part III, “Using Spring Boot” sections so that you have a good grounding of the basics.
+You should now have good understanding of how you can use Spring Boot along with some best practices that you should follow. You can now go on to learn about specific *Spring Boot features* in depth, or you could skip ahead and read about the “[production ready](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#production-ready)” aspects of Spring Boot.
-23. SpringApplication
-The SpringApplication class provides a convenient way to bootstrap a Spring application that will be started from a main() method. In many situations you can just delegate to the static SpringApplication.run method:
+# Part IV. Spring Boot features
+
+
+This section dives into the details of Spring Boot. Here you can learn about the key features that you will want to use and customize. If you haven’t already, you might want to read the *Part II, “Getting started”* and *Part III, “Using Spring Boot”* sections so that you have a good grounding of the basics.
+
+## 23. SpringApplication
+
+The `SpringApplication` class provides a convenient way to bootstrap a Spring application that will be started from a `main()` method. In many situations you can just delegate to the static `SpringApplication.run` method:
+
+```
public static void main(String[] args) {
SpringApplication.run(MySpringConfiguration.class, args);
}
+
+```
+
When your application starts you should see something similar to the following:
+```
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
@@ -2121,11 +1678,16 @@ When your application starts you should see something similar to the following:
2013-07-31 00:08:16.166 INFO 56603 --- [ main] ationConfigEmbeddedWebApplicationContext : Refreshing org.springframework.boot.context.embedded.AnnotationConfigEmbeddedWebApplicationContext@6e5a8246: startup date [Wed Jul 31 00:08:16 PDT 2013]; root of context hierarchy
2014-03-04 13:09:54.912 INFO 41370 --- [ main] .t.TomcatEmbeddedServletContainerFactory : Server initialized with port: 8080
2014-03-04 13:09:56.501 INFO 41370 --- [ main] o.s.b.s.app.SampleApplication : Started SampleApplication in 2.992 seconds (JVM running for 3.658)
-By default INFO logging messages will be shown, including some relevant startup details such as the user that launched the application.
-23.1 Startup failure
-If your application fails to start, registered FailureAnalyzers get a chance to provide a dedicated error message and a concrete action to fix the problem. For instance if you start a web application on port 8080 and that port is already in use, you should see something similar to the following:
+```
+
+By default `INFO` logging messages will be shown, including some relevant startup details such as the user that launched the application.
+## 23.1 Startup failure
+
+If your application fails to start, registered `FailureAnalyzers` get a chance to provide a dedicated error message and a concrete action to fix the problem. For instance if you start a web application on port `8080` and that port is already in use, you should see something similar to the following:
+
+```
***************************
APPLICATION FAILED TO START
***************************
@@ -2137,122 +1699,132 @@ Embedded servlet container failed to start. Port 8080 was already in use.
Action:
Identify and stop the process that's listening on port 8080 or configure this application to listen on another port.
-[Note]
-Spring Boot provides numerous FailureAnalyzer implementations and you can add your own very easily.
-
-If no failure analyzers are able to handle the exception, you can still display the full auto-configuration report to better understand what went wrong. To do so you need to enable the debug property or enable DEBUG logging for org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer.
-
-For instance, if you are running your application using java -jar you can enable the debug property as follows:
-$ java -jar myproject-0.0.1-SNAPSHOT.jar --debug
-23.2 Customizing the Banner
-The banner that is printed on start up can be changed by adding a banner.txt file to your classpath, or by setting banner.location to the location of such a file. If the file has an unusual encoding you can set banner.charset (default is UTF-8). In addition to a text file, you can also add a banner.gif, banner.jpg or banner.png image file to your classpath, or set a banner.image.location property. Images will be converted into an ASCII art representation and printed above any text banner.
-
-Inside your banner.txt file you can use any of the following placeholders:
+```
-Table 23.1. Banner variables
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Spring Boot provides numerous `FailureAnalyzer` implementations and you can [add your own](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-failure-analyzer) very easily. |
-Variable Description
-${application.version}
+If no failure analyzers are able to handle the exception, you can still display the full auto-configuration report to better understand what went wrong. To do so you need to[enable the `debug` property](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config) or [enable `DEBUG` logging](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-custom-log-levels) for`org.springframework.boot.autoconfigure.logging.AutoConfigurationReportLoggingInitializer`.
-The version number of your application as declared in MANIFEST.MF. For example Implementation-Version: 1.0 is printed as 1.0.
+For instance, if you are running your application using `java -jar` you can enable the `debug` property as follows:
-${application.formatted-version}
-
-The version number of your application as declared in MANIFEST.MF formatted for display (surrounded with brackets and prefixed with v). For example (v1.0).
+```
+$ java -jar myproject-0.0.1-SNAPSHOT.jar --debug
-${spring-boot.version}
+```
-The Spring Boot version that you are using. For example 1.5.7.BUILD-SNAPSHOT.
+## 23.2 Customizing the Banner
-${spring-boot.formatted-version}
+The banner that is printed on start up can be changed by adding a `banner.txt` file to your classpath, or by setting `banner.location` to the location of such a file. If the file has an unusual encoding you can set `banner.charset` (default is `UTF-8`). In addition to a text file, you can also add a `banner.gif`, `banner.jpg` or `banner.png` image file to your classpath, or set a `banner.image.location` property. Images will be converted into an ASCII art representation and printed above any text banner.
-The Spring Boot version that you are using formatted for display (surrounded with brackets and prefixed with v). For example (v1.5.7.BUILD-SNAPSHOT).
+Inside your `banner.txt` file you can use any of the following placeholders:
-${Ansi.NAME} (or ${AnsiColor.NAME}, ${AnsiBackground.NAME}, ${AnsiStyle.NAME})
-Where NAME is the name of an ANSI escape code. See AnsiPropertySource for details.
-${application.title}
+**Table 23.1. Banner variables**
-The title of your application as declared in MANIFEST.MF. For example Implementation-Title: MyApp is printed as MyApp.
+| Variable | Description |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| `${application.version}` | The version number of your application as declared in `MANIFEST.MF`. For example`Implementation-Version: 1.0` is printed as `1.0`. |
+| `${application.formatted-version}` | The version number of your application as declared in `MANIFEST.MF` formatted for display (surrounded with brackets and prefixed with `v`). For example `(v1.0)`. |
+| `${spring-boot.version}` | The Spring Boot version that you are using. For example `1.5.7.BUILD-SNAPSHOT`. |
+| `${spring-boot.formatted-version}` | The Spring Boot version that you are using formatted for display (surrounded with brackets and prefixed with `v`). For example `(v1.5.7.BUILD-SNAPSHOT)`. |
+| `${Ansi.NAME}` (or `${AnsiColor.NAME}`, `${AnsiBackground.NAME}`, `${AnsiStyle.NAME}`) | Where `NAME` is the name of an ANSI escape code. See [`AnsiPropertySource`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/ansi/AnsiPropertySource.java) for details. |
+| `${application.title}` | The title of your application as declared in `MANIFEST.MF`. For example`Implementation-Title: MyApp` is printed as `MyApp`. |
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `SpringApplication.setBanner(…)` method can be used if you want to generate a banner programmatically. Use the `org.springframework.boot.Banner` interface and implement your own `printBanner()` method. |
-[Tip]
-The SpringApplication.setBanner(…) method can be used if you want to generate a banner programmatically. Use the org.springframework.boot.Banner interface and implement your own printBanner() method.
+You can also use the `spring.main.banner-mode` property to determine if the banner has to be printed on `System.out` (`console`), using the configured logger (`log`) or not at all (`off`).
-You can also use the spring.main.banner-mode property to determine if the banner has to be printed on System.out (console), using the configured logger (log) or not at all (off).
+The printed banner will be registered as a singleton bean under the name `springBootBanner`.
-The printed banner will be registered as a singleton bean under the name springBootBanner.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| YAML maps `off` to `false` so make sure to add quotes if you want to disable the banner in your application.`spring: main: banner-mode: "off"` |
-[Note]
-YAML maps off to false so make sure to add quotes if you want to disable the banner in your application.
+## 23.3 Customizing SpringApplication
-spring:
- main:
- banner-mode: "off"
-23.3 Customizing SpringApplication
-If the SpringApplication defaults aren’t to your taste you can instead create a local instance and customize it. For example, to turn off the banner you would write:
+If the `SpringApplication` defaults aren’t to your taste you can instead create a local instance and customize it. For example, to turn off the banner you would write:
+```
public static void main(String[] args) {
SpringApplication app = new SpringApplication(MySpringConfiguration.class);
app.setBannerMode(Banner.Mode.OFF);
app.run(args);
}
-[Note]
-The constructor arguments passed to SpringApplication are configuration sources for spring beans. In most cases these will be references to @Configuration classes, but they could also be references to XML configuration or to packages that should be scanned.
-It is also possible to configure the SpringApplication using an application.properties file. See Chapter 24, Externalized Configuration for details.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The constructor arguments passed to `SpringApplication` are configuration sources for spring beans. In most cases these will be references to `@Configuration` classes, but they could also be references to XML configuration or to packages that should be scanned. |
+
+It is also possible to configure the `SpringApplication` using an `application.properties` file. See *Chapter 24, Externalized Configuration* for details.
+
+For a complete list of the configuration options, see the [`SpringApplication` Javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/SpringApplication.html).
-For a complete list of the configuration options, see the SpringApplication Javadoc.
+## 23.4 Fluent builder API
-23.4 Fluent builder API
-If you need to build an ApplicationContext hierarchy (multiple contexts with a parent/child relationship), or if you just prefer using a ‘fluent’ builder API, you can use the SpringApplicationBuilder.
+If you need to build an `ApplicationContext` hierarchy (multiple contexts with a parent/child relationship), or if you just prefer using a ‘fluent’ builder API, you can use the `SpringApplicationBuilder`.
-The SpringApplicationBuilder allows you to chain together multiple method calls, and includes parent and child methods that allow you to create a hierarchy.
+The `SpringApplicationBuilder` allows you to chain together multiple method calls, and includes `parent` and `child` methods that allow you to create a hierarchy.
For example:
+```
new SpringApplicationBuilder()
.sources(Parent.class)
.child(Application.class)
.bannerMode(Banner.Mode.OFF)
.run(args);
-[Note]
-There are some restrictions when creating an ApplicationContext hierarchy, e.g. Web components must be contained within the child context, and the same Environment will be used for both parent and child contexts. See the SpringApplicationBuilder Javadoc for full details.
-23.5 Application events and listeners
-In addition to the usual Spring Framework events, such as ContextRefreshedEvent, a SpringApplication sends some additional application events.
+```
-[Note]
-Some events are actually triggered before the ApplicationContext is created so you cannot register a listener on those as a @Bean. You can register them via the SpringApplication.addListeners(…) or SpringApplicationBuilder.listeners(…) methods.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| There are some restrictions when creating an `ApplicationContext` hierarchy, e.g. Web components **must** be contained within the child context, and the same `Environment` will be used for both parent and child contexts. See the [`SpringApplicationBuilder` Javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/builder/SpringApplicationBuilder.html) for full details. |
-If you want those listeners to be registered automatically regardless of the way the application is created you can add a META-INF/spring.factories file to your project and reference your listener(s) using the org.springframework.context.ApplicationListener key.
+## 23.5 Application events and listeners
+
+In addition to the usual Spring Framework events, such as [`ContextRefreshedEvent`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/javadoc-api/org/springframework/context/event/ContextRefreshedEvent.html), a `SpringApplication` sends some additional application events.
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Some events are actually triggered before the `ApplicationContext` is created so you cannot register a listener on those as a `@Bean`. You can register them via the `SpringApplication.addListeners(…)` or `SpringApplicationBuilder.listeners(…)` methods.If you want those listeners to be registered automatically regardless of the way the application is created you can add a `META-INF/spring.factories`file to your project and reference your listener(s) using the `org.springframework.context.ApplicationListener` key.`org.springframework.context.ApplicationListener=com.example.project.MyListener` |
-org.springframework.context.ApplicationListener=com.example.project.MyListener
Application events are sent in the following order, as your application runs:
-An ApplicationStartingEvent is sent at the start of a run, but before any processing except the registration of listeners and initializers.
-An ApplicationEnvironmentPreparedEvent is sent when the Environment to be used in the context is known, but before the context is created.
-An ApplicationPreparedEvent is sent just before the refresh is started, but after bean definitions have been loaded.
-An ApplicationReadyEvent is sent after the refresh and any related callbacks have been processed to indicate the application is ready to service requests.
-An ApplicationFailedEvent is sent if there is an exception on startup.
-[Tip]
-You often won’t need to use application events, but it can be handy to know that they exist. Internally, Spring Boot uses events to handle a variety of tasks.
+1. An `ApplicationStartingEvent` is sent at the start of a run, but before any processing except the registration of listeners and initializers.
+2. An `ApplicationEnvironmentPreparedEvent` is sent when the `Environment` to be used in the context is known, but before the context is created.
+3. An `ApplicationPreparedEvent` is sent just before the refresh is started, but after bean definitions have been loaded.
+4. An `ApplicationReadyEvent` is sent after the refresh and any related callbacks have been processed to indicate the application is ready to service requests.
+5. An `ApplicationFailedEvent` is sent if there is an exception on startup.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You often won’t need to use application events, but it can be handy to know that they exist. Internally, Spring Boot uses events to handle a variety of tasks. |
+
+## 23.6 Web environment
-23.6 Web environment
-A SpringApplication will attempt to create the right type of ApplicationContext on your behalf. By default, an AnnotationConfigApplicationContext or AnnotationConfigEmbeddedWebApplicationContext will be used, depending on whether you are developing a web application or not.
+A `SpringApplication` will attempt to create the right type of `ApplicationContext` on your behalf. By default, an `AnnotationConfigApplicationContext`or `AnnotationConfigEmbeddedWebApplicationContext` will be used, depending on whether you are developing a web application or not.
-The algorithm used to determine a ‘web environment’ is fairly simplistic (based on the presence of a few classes). You can use setWebEnvironment(boolean webEnvironment) if you need to override the default.
+The algorithm used to determine a ‘web environment’ is fairly simplistic (based on the presence of a few classes). You can use `setWebEnvironment(boolean webEnvironment)` if you need to override the default.
-It is also possible to take complete control of the ApplicationContext type that will be used by calling setApplicationContextClass(…).
+It is also possible to take complete control of the `ApplicationContext` type that will be used by calling `setApplicationContextClass(…)`.
-[Tip]
-It is often desirable to call setWebEnvironment(false) when using SpringApplication within a JUnit test.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| It is often desirable to call `setWebEnvironment(false)` when using `SpringApplication` within a JUnit test. |
-23.7 Accessing application arguments
-If you need to access the application arguments that were passed to SpringApplication.run(…) you can inject a org.springframework.boot.ApplicationArguments bean. The ApplicationArguments interface provides access to both the raw String[] arguments as well as parsed option and non-option arguments:
+## 23.7 Accessing application arguments
+If you need to access the application arguments that were passed to `SpringApplication.run(…)` you can inject a`org.springframework.boot.ApplicationArguments` bean. The `ApplicationArguments` interface provides access to both the raw `String[]` arguments as well as parsed `option` and `non-option` arguments:
+
+```
import org.springframework.boot.*
import org.springframework.beans.factory.annotation.*
import org.springframework.stereotype.*
@@ -2268,14 +1840,20 @@ public class MyBean {
}
}
-[Tip]
-Spring Boot will also register a CommandLinePropertySource with the Spring Environment. This allows you to also inject single application arguments using the @Value annotation.
-23.8 Using the ApplicationRunner or CommandLineRunner
-If you need to run some specific code once the SpringApplication has started, you can implement the ApplicationRunner or CommandLineRunner interfaces. Both interfaces work in the same way and offer a single run method which will be called just before SpringApplication.run(…) completes.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Spring Boot will also register a `CommandLinePropertySource` with the Spring `Environment`. This allows you to also inject single application arguments using the `@Value` annotation. |
+
+## 23.8 Using the ApplicationRunner or CommandLineRunner
+
+If you need to run some specific code once the `SpringApplication` has started, you can implement the `ApplicationRunner` or `CommandLineRunner`interfaces. Both interfaces work in the same way and offer a single `run` method which will be called just before `SpringApplication.run(…)` completes.
-The CommandLineRunner interfaces provides access to application arguments as a simple string array, whereas the ApplicationRunner uses the ApplicationArguments interface discussed above.
+The `CommandLineRunner` interfaces provides access to application arguments as a simple string array, whereas the `ApplicationRunner` uses the `ApplicationArguments` interface discussed above.
+```
import org.springframework.boot.*
import org.springframework.stereotype.*
@@ -2287,13 +1865,18 @@ public class MyBean implements CommandLineRunner {
}
}
-You can additionally implement the org.springframework.core.Ordered interface or use the org.springframework.core.annotation.Order annotation if several CommandLineRunner or ApplicationRunner beans are defined that must be called in a specific order.
-23.9 Application exit
-Each SpringApplication will register a shutdown hook with the JVM to ensure that the ApplicationContext is closed gracefully on exit. All the standard Spring lifecycle callbacks (such as the DisposableBean interface, or the @PreDestroy annotation) can be used.
+```
-In addition, beans may implement the org.springframework.boot.ExitCodeGenerator interface if they wish to return a specific exit code when SpringApplication.exit() is called. This exit code can then be passed to System.exit() to return it as a status code.
+You can additionally implement the `org.springframework.core.Ordered` interface or use the `org.springframework.core.annotation.Order` annotation if several `CommandLineRunner` or `ApplicationRunner` beans are defined that must be called in a specific order.
+## 23.9 Application exit
+
+Each `SpringApplication` will register a shutdown hook with the JVM to ensure that the `ApplicationContext` is closed gracefully on exit. All the standard Spring lifecycle callbacks (such as the `DisposableBean` interface, or the `@PreDestroy` annotation) can be used.
+
+In addition, beans may implement the `org.springframework.boot.ExitCodeGenerator` interface if they wish to return a specific exit code when `SpringApplication.exit()` is called. This exit code can then be passed to `System.exit()` to return it as a status code.
+
+```
@SpringBootApplication
public class ExitCodeApplication {
@@ -2313,41 +1896,50 @@ public class ExitCodeApplication {
}
}
-Also, the ExitCodeGenerator interface may be implemented by exceptions. When such an exception is encountered, Spring Boot will return the exit code provided by the implemented getExitCode() method.
-23.10 Admin features
-It is possible to enable admin-related features for the application by specifying the spring.application.admin.enabled property. This exposes the SpringApplicationAdminMXBean on the platform MBeanServer. You could use this feature to administer your Spring Boot application remotely. This could also be useful for any service wrapper implementation.
+```
+
+Also, the `ExitCodeGenerator` interface may be implemented by exceptions. When such an exception is encountered, Spring Boot will return the exit code provided by the implemented `getExitCode()` method.
-[Tip]
-If you want to know on which HTTP port the application is running, get the property with key local.server.port.
+## 23.10 Admin features
-[Note]
-Take care when enabling this feature as the MBean exposes a method to shutdown the application.
+It is possible to enable admin-related features for the application by specifying the `spring.application.admin.enabled` property. This exposes the[`SpringApplicationAdminMXBean`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/admin/SpringApplicationAdminMXBean.java) on the platform `MBeanServer`. You could use this feature to administer your Spring Boot application remotely. This could also be useful for any service wrapper implementation.
-24. Externalized Configuration
-Spring Boot allows you to externalize your configuration so you can work with the same application code in different environments. You can use properties files, YAML files, environment variables and command-line arguments to externalize configuration. Property values can be injected directly into your beans using the @Value annotation, accessed via Spring’s Environment abstraction or bound to structured objects via @ConfigurationProperties.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you want to know on which HTTP port the application is running, get the property with key `local.server.port`. |
-Spring Boot uses a very particular PropertySource order that is designed to allow sensible overriding of values. Properties are considered in the following order:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Take care when enabling this feature as the MBean exposes a method to shutdown the application. |
-Devtools global settings properties on your home directory (~/.spring-boot-devtools.properties when devtools is active).
-@TestPropertySource annotations on your tests.
-@SpringBootTest#properties annotation attribute on your tests.
-Command line arguments.
-Properties from SPRING_APPLICATION_JSON (inline JSON embedded in an environment variable or system property)
-ServletConfig init parameters.
-ServletContext init parameters.
-JNDI attributes from java:comp/env.
-Java System properties (System.getProperties()).
-OS environment variables.
-A RandomValuePropertySource that only has properties in random.*.
-Profile-specific application properties outside of your packaged jar (application-{profile}.properties and YAML variants)
-Profile-specific application properties packaged inside your jar (application-{profile}.properties and YAML variants)
-Application properties outside of your packaged jar (application.properties and YAML variants).
-Application properties packaged inside your jar (application.properties and YAML variants).
-@PropertySource annotations on your @Configuration classes.
-Default properties (specified using SpringApplication.setDefaultProperties).
-To provide a concrete example, suppose you develop a @Component that uses a name property:
+## 24. Externalized Configuration
+Spring Boot allows you to externalize your configuration so you can work with the same application code in different environments. You can use properties files, YAML files, environment variables and command-line arguments to externalize configuration. Property values can be injected directly into your beans using the `@Value`annotation, accessed via Spring’s `Environment` abstraction or [bound to structured objects](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-typesafe-configuration-properties) via `@ConfigurationProperties`.
+
+Spring Boot uses a very particular `PropertySource` order that is designed to allow sensible overriding of values. Properties are considered in the following order:
+
+1. [Devtools global settings properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-globalsettings) on your home directory (`~/.spring-boot-devtools.properties` when devtools is active).
+2. [`@TestPropertySource`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/javadoc-api/org/springframework/test/context/TestPropertySource.html) annotations on your tests.
+3. [`@SpringBootTest#properties`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/test/context/SpringBootTest.html) annotation attribute on your tests.
+4. Command line arguments.
+5. Properties from `SPRING_APPLICATION_JSON` (inline JSON embedded in an environment variable or system property)
+6. `ServletConfig` init parameters.
+7. `ServletContext` init parameters.
+8. JNDI attributes from `java:comp/env`.
+9. Java System properties (`System.getProperties()`).
+10. OS environment variables.
+11. A `RandomValuePropertySource` that only has properties in `random.*`.
+12. [Profile-specific application properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-profile-specific-properties) outside of your packaged jar (`application-{profile}.properties` and YAML variants)
+13. [Profile-specific application properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-profile-specific-properties) packaged inside your jar (`application-{profile}.properties` and YAML variants)
+14. Application properties outside of your packaged jar (`application.properties` and YAML variants).
+15. Application properties packaged inside your jar (`application.properties` and YAML variants).
+16. [`@PropertySource`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/javadoc-api/org/springframework/context/annotation/PropertySource.html) annotations on your `@Configuration` classes.
+17. Default properties (specified using `SpringApplication.setDefaultProperties`).
+
+To provide a concrete example, suppose you develop a `@Component` that uses a `name` property:
+
+```
import org.springframework.stereotype.*
import org.springframework.beans.factory.annotation.*
@@ -2360,110 +1952,139 @@ public class MyBean {
// ...
}
-On your application classpath (e.g. inside your jar) you can have an application.properties that provides a sensible default property value for name. When running in a new environment, an application.properties can be provided outside of your jar that overrides the name; and for one-off testing, you can launch with a specific command line switch (e.g. java -jar app.jar --name="Spring").
-[Tip]
-The SPRING_APPLICATION_JSON properties can be supplied on the command line with an environment variable. For example in a UN*X shell:
+```
-$ SPRING_APPLICATION_JSON='{"foo":{"bar":"spam"}}' java -jar myapp.jar
-In this example you will end up with foo.bar=spam in the Spring Environment. You can also supply the JSON as spring.application.json in a System variable:
+On your application classpath (e.g. inside your jar) you can have an `application.properties` that provides a sensible default property value for `name`. When running in a new environment, an `application.properties` can be provided outside of your jar that overrides the `name`; and for one-off testing, you can launch with a specific command line switch (e.g. `java -jar app.jar --name="Spring"`).
-$ java -Dspring.application.json='{"foo":"bar"}' -jar myapp.jar
-or command line argument:
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `SPRING_APPLICATION_JSON` properties can be supplied on the command line with an environment variable. For example in a UN*X shell:`$ SPRING_APPLICATION_JSON='{"foo":{"bar":"spam"}}' java -jar myapp.jar`In this example you will end up with `foo.bar=spam` in the Spring `Environment`. You can also supply the JSON as `spring.application.json` in a System variable:`$ java -Dspring.application.json='{"foo":"bar"}' -jar myapp.jar`or command line argument:`$ java -jar myapp.jar --spring.application.json='{"foo":"bar"}'`or as a JNDI variable `java:comp/env/spring.application.json`. |
-$ java -jar myapp.jar --spring.application.json='{"foo":"bar"}'
-or as a JNDI variable java:comp/env/spring.application.json.
+## 24.1 Configuring random values
-24.1 Configuring random values
-The RandomValuePropertySource is useful for injecting random values (e.g. into secrets or test cases). It can produce integers, longs, uuids or strings, e.g.
+The `RandomValuePropertySource` is useful for injecting random values (e.g. into secrets or test cases). It can produce integers, longs, uuids or strings, e.g.
+```
my.secret=${random.value}
my.number=${random.int}
my.bignumber=${random.long}
my.uuid=${random.uuid}
my.number.less.than.ten=${random.int(10)}
my.number.in.range=${random.int[1024,65536]}
-The random.int* syntax is OPEN value (,max) CLOSE where the OPEN,CLOSE are any character and value,max are integers. If max is provided then value is the minimum value and max is the maximum (exclusive).
-24.2 Accessing command line properties
-By default SpringApplication will convert any command line option arguments (starting with ‘--’, e.g. --server.port=9000) to a property and add it to the Spring Environment. As mentioned above, command line properties always take precedence over other property sources.
+```
+
+The `random.int*` syntax is `OPEN value (,max) CLOSE` where the `OPEN,CLOSE` are any character and `value,max` are integers. If `max` is provided then `value` is the minimum value and `max` is the maximum (exclusive).
+
+## 24.2 Accessing command line properties
+
+By default `SpringApplication` will convert any command line option arguments (starting with ‘--’, e.g. `--server.port=9000`) to a `property` and add it to the Spring `Environment`. As mentioned above, command line properties always take precedence over other property sources.
+
+If you don’t want command line properties to be added to the `Environment` you can disable them using `SpringApplication.setAddCommandLineProperties(false)`.
-If you don’t want command line properties to be added to the Environment you can disable them using SpringApplication.setAddCommandLineProperties(false).
+## 24.3 Application property files
-24.3 Application property files
-SpringApplication will load properties from application.properties files in the following locations and add them to the Spring Environment:
+`SpringApplication` will load properties from `application.properties` files in the following locations and add them to the Spring `Environment`:
+
+1. A `/config` subdirectory of the current directory.
+2. The current directory
+3. A classpath `/config` package
+4. The classpath root
-A /config subdirectory of the current directory.
-The current directory
-A classpath /config package
-The classpath root
The list is ordered by precedence (properties defined in locations higher in the list override those defined in lower locations).
-[Note]
-You can also use YAML ('.yml') files as an alternative to '.properties'.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can also [use YAML ('.yml') files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-yaml) as an alternative to '.properties'. |
-If you don’t like application.properties as the configuration file name you can switch to another by specifying a spring.config.name environment property. You can also refer to an explicit location using the spring.config.location environment property (comma-separated list of directory locations, or file paths).
+If you don’t like `application.properties` as the configuration file name you can switch to another by specifying a `spring.config.name` environment property. You can also refer to an explicit location using the `spring.config.location` environment property (comma-separated list of directory locations, or file paths).
+```
$ java -jar myproject.jar --spring.config.name=myproject
+
+```
+
or
+```
$ java -jar myproject.jar --spring.config.location=classpath:/default.properties,classpath:/override.properties
-[Warning]
-spring.config.name and spring.config.location are used very early to determine which files have to be loaded so they have to be defined as an environment property (typically OS env, system property or command line argument).
-If spring.config.location contains directories (as opposed to files) they should end in / (and will be appended with the names generated from spring.config.name before being loaded, including profile-specific file names). Files specified in spring.config.location are used as-is, with no support for profile-specific variants, and will be overridden by any profile-specific properties.
+```
+
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| `spring.config.name` and `spring.config.location` are used very early to determine which files have to be loaded so they have to be defined as an environment property (typically OS env, system property or command line argument). |
+
+If `spring.config.location` contains directories (as opposed to files) they should end in `/` (and will be appended with the names generated from `spring.config.name` before being loaded, including profile-specific file names). Files specified in `spring.config.location` are used as-is, with no support for profile-specific variants, and will be overridden by any profile-specific properties.
+
+Config locations are searched in reverse order. By default, the configured locations are `classpath:/,classpath:/config/,file:./,file:./config/`. The resulting search order is:
+
+1. `file:./config/`
+2. `file:./`
+3. `classpath:/config/`
+4. `classpath:/`
+
+When custom config locations are configured, they are used in addition to the default locations. Custom locations are searched before the default locations. For example, if custom locations `classpath:/custom-config/,file:./custom-config/` are configured, the search order becomes:
-Config locations are searched in reverse order. By default, the configured locations are classpath:/,classpath:/config/,file:./,file:./config/. The resulting search order is:
+1. `file:./custom-config/`
+2. `classpath:custom-config/`
+3. `file:./config/`
+4. `file:./`
+5. `classpath:/config/`
+6. `classpath:/`
-file:./config/
-file:./
-classpath:/config/
-classpath:/
-When custom config locations are configured, they are used in addition to the default locations. Custom locations are searched before the default locations. For example, if custom locations classpath:/custom-config/,file:./custom-config/ are configured, the search order becomes:
+This search ordering allows you to specify default values in one configuration file and then selectively override those values in another. You can provide default values for you application in `application.properties` (or whatever other basename you choose with `spring.config.name`) in one of the default locations. These default values can then be overriden at runtime with a different file located in one of the custom locations.
-file:./custom-config/
-classpath:custom-config/
-file:./config/
-file:./
-classpath:/config/
-classpath:/
-This search ordering allows you to specify default values in one configuration file and then selectively override those values in another. You can provide default values for you application in application.properties (or whatever other basename you choose with spring.config.name) in one of the default locations. These default values can then be overriden at runtime with a different file located in one of the custom locations.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you use environment variables rather than system properties, most operating systems disallow period-separated key names, but you can use underscores instead (e.g. `SPRING_CONFIG_NAME` instead of `spring.config.name`). |
-[Note]
-If you use environment variables rather than system properties, most operating systems disallow period-separated key names, but you can use underscores instead (e.g. SPRING_CONFIG_NAME instead of spring.config.name).
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you are running in a container then JNDI properties (in `java:comp/env`) or servlet context initialization parameters can be used instead of, or as well as, environment variables or system properties. |
-[Note]
-If you are running in a container then JNDI properties (in java:comp/env) or servlet context initialization parameters can be used instead of, or as well as, environment variables or system properties.
+## 24.4 Profile-specific properties
-24.4 Profile-specific properties
-In addition to application.properties files, profile-specific properties can also be defined using the naming convention application-{profile}.properties. The Environment has a set of default profiles (by default [default]) which are used if no active profiles are set (i.e. if no profiles are explicitly activated then properties from application-default.properties are loaded).
+In addition to `application.properties` files, profile-specific properties can also be defined using the naming convention `application-{profile}.properties`. The `Environment` has a set of default profiles (by default `[default]`) which are used if no active profiles are set (i.e. if no profiles are explicitly activated then properties from `application-default.properties` are loaded).
-Profile-specific properties are loaded from the same locations as standard application.properties, with profile-specific files always overriding the non-specific ones irrespective of whether the profile-specific files are inside or outside your packaged jar.
+Profile-specific properties are loaded from the same locations as standard `application.properties`, with profile-specific files always overriding the non-specific ones irrespective of whether the profile-specific files are inside or outside your packaged jar.
-If several profiles are specified, a last wins strategy applies. For example, profiles specified by the spring.profiles.active property are added after those configured via the SpringApplication API and therefore take precedence.
+If several profiles are specified, a last wins strategy applies. For example, profiles specified by the `spring.profiles.active` property are added after those configured via the `SpringApplication` API and therefore take precedence.
-[Note]
-If you have specified any files in spring.config.location, profile-specific variants of those files will not be considered. Use directories in spring.config.location if you also want to also use profile-specific properties.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you have specified any files in `spring.config.location`, profile-specific variants of those files will not be considered. Use directories in`spring.config.location` if you also want to also use profile-specific properties. |
-24.5 Placeholders in properties
-The values in application.properties are filtered through the existing Environment when they are used so you can refer back to previously defined values (e.g. from System properties).
+## 24.5 Placeholders in properties
+The values in `application.properties` are filtered through the existing `Environment` when they are used so you can refer back to previously defined values (e.g. from System properties).
+
+```
app.name=MyApp
app.description=${app.name} is a Spring Boot application
-[Tip]
-You can also use this technique to create ‘short’ variants of existing Spring Boot properties. See the Section 72.4, “Use ‘short’ command line arguments” how-to for details.
-24.6 Using YAML instead of Properties
-YAML is a superset of JSON, and as such is a very convenient format for specifying hierarchical configuration data. The SpringApplication class will automatically support YAML as an alternative to properties whenever you have the SnakeYAML library on your classpath.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You can also use this technique to create ‘short’ variants of existing Spring Boot properties. See the *Section 72.4, “Use ‘short’ command line arguments”*how-to for details. |
+
+## 24.6 Using YAML instead of Properties
+
+[YAML](http://yaml.org/) is a superset of JSON, and as such is a very convenient format for specifying hierarchical configuration data. The `SpringApplication` class will automatically support YAML as an alternative to properties whenever you have the [SnakeYAML](http://www.snakeyaml.org/) library on your classpath.
-[Note]
-If you use ‘Starters’ SnakeYAML will be automatically provided via spring-boot-starter.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you use ‘Starters’ SnakeYAML will be automatically provided via `spring-boot-starter`. |
-24.6.1 Loading YAML
-Spring Framework provides two convenient classes that can be used to load YAML documents. The YamlPropertiesFactoryBean will load YAML as Properties and the YamlMapFactoryBean will load YAML as a Map.
+### 24.6.1 Loading YAML
+
+Spring Framework provides two convenient classes that can be used to load YAML documents. The `YamlPropertiesFactoryBean` will load YAML as `Properties`and the `YamlMapFactoryBean` will load YAML as a `Map`.
For example, the following YAML document:
+```
environments:
dev:
url: http://dev.bar.com
@@ -2471,24 +2092,40 @@ environments:
prod:
url: http://foo.bar.com
name: My Cool App
+
+```
+
Would be transformed into these properties:
+```
environments.dev.url=http://dev.bar.com
environments.dev.name=Developer Setup
environments.prod.url=http://foo.bar.com
environments.prod.name=My Cool App
-YAML lists are represented as property keys with [index] dereferencers, for example this YAML:
+```
+
+YAML lists are represented as property keys with `[index]` dereferencers, for example this YAML:
+
+```
my:
servers:
- dev.bar.com
- foo.bar.com
+
+```
+
Would be transformed into these properties:
+```
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
-To bind to properties like that using the Spring DataBinder utilities (which is what @ConfigurationProperties does) you need to have a property in the target bean of type java.util.List (or Set) and you either need to provide a setter, or initialize it with a mutable value, e.g. this will bind to the properties above
+```
+
+To bind to properties like that using the Spring `DataBinder` utilities (which is what `@ConfigurationProperties` does) you need to have a property in the target bean of type `java.util.List` (or `Set`) and you either need to provide a setter, or initialize it with a mutable value, e.g. this will bind to the properties above
+
+```
@ConfigurationProperties(prefix="my")
public class Config {
@@ -2498,17 +2135,22 @@ public class Config {
return this.servers;
}
}
-[Note]
-Extra care is required when configuring lists that way as overriding will not work as you would expect. In the example above, when my.servers is redefined in several places, the individual elements are targeted for override, not the list. To make sure that a PropertySource with higher precedence can override the list, you need to define it as a single property:
-my:
- servers: dev.bar.com,foo.bar.com
-24.6.2 Exposing YAML as properties in the Spring Environment
-The YamlPropertySourceLoader class can be used to expose YAML as a PropertySource in the Spring Environment. This allows you to use the familiar @Value annotation with placeholders syntax to access YAML properties.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Extra care is required when configuring lists that way as overriding will not work as you would expect. In the example above, when `my.servers` is redefined in several places, the individual elements are targeted for override, not the list. To make sure that a `PropertySource` with higher precedence can override the list, you need to define it as a single property:`my: servers: dev.bar.com,foo.bar.com` |
+
+### 24.6.2 Exposing YAML as properties in the Spring Environment
-24.6.3 Multi-profile YAML documents
-You can specify multiple profile-specific YAML documents in a single file by using a spring.profiles key to indicate when the document applies. For example:
+The `YamlPropertySourceLoader` class can be used to expose YAML as a `PropertySource` in the Spring `Environment`. This allows you to use the familiar `@Value` annotation with placeholders syntax to access YAML properties.
+### 24.6.3 Multi-profile YAML documents
+
+You can specify multiple profile-specific YAML documents in a single file by using a `spring.profiles` key to indicate when the document applies. For example:
+
+```
server:
address: 192.168.1.100
---
@@ -2521,10 +2163,14 @@ spring:
profiles: production
server:
address: 192.168.1.120
-In the example above, the server.address property will be 127.0.0.1 if the development profile is active. If the development and production profiles are not enabled, then the value for the property will be 192.168.1.100.
-The default profiles are activated if none are explicitly active when the application context starts. So in this YAML we set a value for security.user.password that is only available in the "default" profile:
+```
+
+In the example above, the `server.address` property will be `127.0.0.1` if the `development` profile is active. If the `development` and `production` profiles are **not** enabled, then the value for the property will be `192.168.1.100`.
+
+The default profiles are activated if none are explicitly active when the application context starts. So in this YAML we set a value for `security.user.password` that is**only** available in the "default" profile:
+```
server:
port: 8000
---
@@ -2533,25 +2179,35 @@ spring:
security:
user:
password: weak
+
+```
+
whereas in this example, the password is always set because it isn’t attached to any profile, and it would have to be explicitly reset in all other profiles as necessary:
+```
server:
port: 8000
security:
user:
password: weak
-Spring profiles designated using the "spring.profiles" element may optionally be negated using the ! character. If both negated and non-negated profiles are specified for a single document, at least one non-negated profile must match and no negated profiles may match.
-24.6.4 YAML shortcomings
-YAML files can’t be loaded via the @PropertySource annotation. So in the case that you need to load values that way, you need to use a properties file.
+```
-24.6.5 Merging YAML lists
-As we have seen above, any YAML content is ultimately transformed to properties. That process may be counter intuitive when overriding “list” properties via a profile.
+Spring profiles designated using the "spring.profiles" element may optionally be negated using the `!` character. If both negated and non-negated profiles are specified for a single document, at least one non-negated profile must match and no negated profiles may match.
-For example, assume a MyPojo object with name and description attributes that are null by default. Let’s expose a list of MyPojo from FooProperties:
+### 24.6.4 YAML shortcomings
-@ConfigurationProperties("foo")
-public class FooProperties {
+YAML files can’t be loaded via the `@PropertySource` annotation. So in the case that you need to load values that way, you need to use a properties file.
+
+### 24.6.5 Merging YAML lists
+
+As [we have seen above](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-loading-yaml), any YAML content is ultimately transformed to properties. That process may be counter intuitive when overriding “list” properties via a profile.
+
+For example, assume a `MyPojo` object with `name` and `description` attributes that are `null` by default. Let’s expose a list of `MyPojo` from `FooProperties`:
+
+```
+@ConfigurationProperties("foo")
+public class FooProperties {
private final List list = new ArrayList<>();
@@ -2560,8 +2216,12 @@ public class FooProperties {
}
}
+
+```
+
Consider the following configuration:
+```
foo:
list:
- name: my name
@@ -2572,10 +2232,14 @@ spring:
foo:
list:
- name: my another name
-If the dev profile isn’t active, FooProperties.list will contain one MyPojo entry as defined above. If the dev profile is enabled however, the list will still only contain one entry (with name “my another name” and description null). This configuration will not add a second MyPojo instance to the list, and it won’t merge the items.
+
+```
+
+If the `dev` profile isn’t active, `FooProperties.list` will contain one `MyPojo` entry as defined above. If the `dev` profile is enabled however, the `list` will *still* only contain one entry (with name “my another name” and description `null`). This configuration *will not* add a second `MyPojo` instance to the list, and it won’t merge the items.
When a collection is specified in multiple profiles, the one with highest priority is used (and only that one):
+```
foo:
list:
- name: my name
@@ -2588,11 +2252,16 @@ spring:
foo:
list:
- name: my another name
-In the example above, considering that the dev profile is active, FooProperties.list will contain one MyPojo entry (with name “my another name” and description null).
-24.7 Type-safe Configuration Properties
-Using the @Value("${property}") annotation to inject configuration properties can sometimes be cumbersome, especially if you are working with multiple properties or your data is hierarchical in nature. Spring Boot provides an alternative method of working with properties that allows strongly typed beans to govern and validate the configuration of your application.
+```
+
+In the example above, considering that the `dev` profile is active, `FooProperties.list` will contain *one* `MyPojo` entry (with name “my another name” and description `null`).
+
+## 24.7 Type-safe Configuration Properties
+Using the `@Value("${property}")` annotation to inject configuration properties can sometimes be cumbersome, especially if you are working with multiple properties or your data is hierarchical in nature. Spring Boot provides an alternative method of working with properties that allows strongly typed beans to govern and validate the configuration of your application.
+
+```
package com.example;
import java.net.InetAddress;
@@ -2643,37 +2312,42 @@ public class FooProperties {
}
}
+
+```
+
The POJO above defines the following properties:
-foo.enabled, false by default
-foo.remote-address, with a type that can be coerced from String
-foo.security.username, with a nested "security" whose name is determined by the name of the property. In particular the return type is not used at all there and could have been SecurityProperties
-foo.security.password
-foo.security.roles, with a collection of String
-[Note]
-Getters and setters are usually mandatory, since binding is via standard Java Beans property descriptors, just like in Spring MVC. There are cases where a setter may be omitted:
+- `foo.enabled`, `false` by default
+- `foo.remote-address`, with a type that can be coerced from `String`
+- `foo.security.username`, with a nested "security" whose name is determined by the name of the property. In particular the return type is not used at all there and could have been `SecurityProperties`
+- `foo.security.password`
+- `foo.security.roles`, with a collection of `String`
-Maps, as long as they are initialized, need a getter but not necessarily a setter since they can be mutated by the binder.
-Collections and arrays can be either accessed via an index (typically with YAML) or using a single comma-separated value (properties). In the latter case, a setter is mandatory. We recommend to always add a setter for such types. If you initialize a collection, make sure it is not immutable (as in the example above)
-If nested POJO properties are initialized (like the Security field in the example above), a setter is not required. If you want the binder to create the instance on-the-fly using its default constructor, you will need a setter.
-Some people use Project Lombok to add getters and setters automatically. Make sure that Lombok doesn’t generate any particular constructor for such type as it will be used automatically by the container to instantiate the object.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Getters and setters are usually mandatory, since binding is via standard Java Beans property descriptors, just like in Spring MVC. There are cases where a setter may be omitted:Maps, as long as they are initialized, need a getter but not necessarily a setter since they can be mutated by the binder.Collections and arrays can be either accessed via an index (typically with YAML) or using a single comma-separated value (properties). In the latter case, a setter is mandatory. We recommend to always add a setter for such types. If you initialize a collection, make sure it is not immutable (as in the example above)If nested POJO properties are initialized (like the `Security` field in the example above), a setter is not required. If you want the binder to create the instance on-the-fly using its default constructor, you will need a setter.Some people use Project Lombok to add getters and setters automatically. Make sure that Lombok doesn’t generate any particular constructor for such type as it will be used automatically by the container to instantiate the object. |
-[Tip]
-See also the differences between @Value and @ConfigurationProperties.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| See also the [differences between `@Value` and `@ConfigurationProperties`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-vs-value). |
-You also need to list the properties classes to register in the @EnableConfigurationProperties annotation:
+You also need to list the properties classes to register in the `@EnableConfigurationProperties` annotation:
+```
@Configuration
@EnableConfigurationProperties(FooProperties.class)
public class MyConfiguration {
}
-[Note]
-When @ConfigurationProperties bean is registered that way, the bean will have a conventional name: -, where is the environment key prefix specified in the @ConfigurationProperties annotation and the fully qualified name of the bean. If the annotation does not provide any prefix, only the fully qualified name of the bean is used.
-The bean name in the example above will be foo-com.example.FooProperties.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| When `@ConfigurationProperties` bean is registered that way, the bean will have a conventional name: `-`, where `` is the environment key prefix specified in the `@ConfigurationProperties` annotation and `` the fully qualified name of the bean. If the annotation does not provide any prefix, only the fully qualified name of the bean is used.The bean name in the example above will be `foo-com.example.FooProperties`. |
-Even if the configuration above will create a regular bean for FooProperties, we recommend that @ConfigurationProperties only deal with the environment and in particular does not inject other beans from the context. Having said that, The @EnableConfigurationProperties annotation is also automatically applied to your project so that any existing bean annotated with @ConfigurationProperties will be configured from the Environment. You could shortcut MyConfiguration above by making sure FooProperties is a already a bean:
+Even if the configuration above will create a regular bean for `FooProperties`, we recommend that `@ConfigurationProperties` only deal with the environment and in particular does not inject other beans from the context. Having said that, The `@EnableConfigurationProperties` annotation is *also* automatically applied to your project so that any *existing* bean annotated with `@ConfigurationProperties` will be configured from the `Environment`. You could shortcut `MyConfiguration` above by making sure `FooProperties` is a already a bean:
+```
@Component
@ConfigurationProperties(prefix="foo")
public class FooProperties {
@@ -2681,8 +2355,12 @@ public class FooProperties {
// ... see above
}
-This style of configuration works particularly well with the SpringApplication external YAML configuration:
+```
+
+This style of configuration works particularly well with the `SpringApplication` external YAML configuration:
+
+```
# application.yml
foo:
@@ -2694,8 +2372,12 @@ foo:
- ADMIN
# additional configuration as required
-To work with @ConfigurationProperties beans you can just inject them in the same way as any other bean.
+```
+
+To work with `@ConfigurationProperties` beans you can just inject them in the same way as any other bean.
+
+```
@Service
public class MyService {
@@ -2715,26 +2397,37 @@ public class MyService {
}
}
-[Tip]
-Using @ConfigurationProperties also allows you to generate meta-data files that can be used by IDEs to offer auto-completion for your own keys, see the Appendix B, Configuration meta-data appendix for details.
-24.7.1 Third-party configuration
-As well as using @ConfigurationProperties to annotate a class, you can also use it on public @Bean methods. This can be particularly useful when you want to bind properties to third-party components that are outside of your control.
+```
-To configure a bean from the Environment properties, add @ConfigurationProperties to its bean registration:
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Using `@ConfigurationProperties` also allows you to generate meta-data files that can be used by IDEs to offer auto-completion for your own keys, see the [Appendix B, *Configuration meta-data*](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata) appendix for details. |
+### 24.7.1 Third-party configuration
+
+As well as using `@ConfigurationProperties` to annotate a class, you can also use it on public `@Bean` methods. This can be particularly useful when you want to bind properties to third-party components that are outside of your control.
+
+To configure a bean from the `Environment` properties, add `@ConfigurationProperties` to its bean registration:
+
+```
@ConfigurationProperties(prefix = "bar")
@Bean
public BarComponent barComponent() {
...
}
-Any property defined with the bar prefix will be mapped onto that BarComponent bean in a similar manner as the FooProperties example above.
-24.7.2 Relaxed binding
-Spring Boot uses some relaxed rules for binding Environment properties to @ConfigurationProperties beans, so there doesn’t need to be an exact match between the Environment property name and the bean property name. Common examples where this is useful include dashed separated (e.g. context-path binds to contextPath), and capitalized (e.g. PORT binds to port) environment properties.
+```
+
+Any property defined with the `bar` prefix will be mapped onto that `BarComponent` bean in a similar manner as the `FooProperties` example above.
-For example, given the following @ConfigurationProperties class:
+### 24.7.2 Relaxed binding
+Spring Boot uses some relaxed rules for binding `Environment` properties to `@ConfigurationProperties` beans, so there doesn’t need to be an exact match between the `Environment` property name and the bean property name. Common examples where this is useful include dashed separated (e.g. `context-path`binds to `contextPath`), and capitalized (e.g. `PORT` binds to `port`) environment properties.
+
+For example, given the following `@ConfigurationProperties` class:
+
+```
@ConfigurationProperties(prefix="person")
public class OwnerProperties {
@@ -2749,37 +2442,35 @@ public class OwnerProperties {
}
}
-The following properties names can all be used:
-
-Table 24.1. relaxed binding
-Property Note
-person.firstName
+```
-Standard camel case syntax.
-
-person.first-name
+The following properties names can all be used:
-Dashed notation, recommended for use in .properties and .yml files.
-person.first_name
-Underscore notation, alternative format for use in .properties and .yml files.
+**Table 24.1. relaxed binding**
-PERSON_FIRST_NAME
+| Property | Note |
+| ------------------- | ------------------------------------------------------------ |
+| `person.firstName` | Standard camel case syntax. |
+| `person.first-name` | Dashed notation, recommended for use in `.properties` and `.yml` files. |
+| `person.first_name` | Underscore notation, alternative format for use in `.properties` and `.yml` files. |
+| `PERSON_FIRST_NAME` | Upper case format. Recommended when using a system environment variables. |
-Upper case format. Recommended when using a system environment variables.
+### 24.7.3 Properties conversion
+Spring will attempt to coerce the external application properties to the right type when it binds to the `@ConfigurationProperties` beans. If you need custom type conversion you can provide a `ConversionService` bean (with bean id `conversionService`) or custom property editors (via a `CustomEditorConfigurer`bean) or custom `Converters` (with bean definitions annotated as `@ConfigurationPropertiesBinding`).
-24.7.3 Properties conversion
-Spring will attempt to coerce the external application properties to the right type when it binds to the @ConfigurationProperties beans. If you need custom type conversion you can provide a ConversionService bean (with bean id conversionService) or custom property editors (via a CustomEditorConfigurer bean) or custom Converters (with bean definitions annotated as @ConfigurationPropertiesBinding).
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| As this bean is requested very early during the application lifecycle, make sure to limit the dependencies that your `ConversionService` is using. Typically, any dependency that you require may not be fully initialized at creation time. You may want to rename your custom `ConversionService` if it’s not required for configuration keys coercion and only rely on custom converters qualified with `@ConfigurationPropertiesBinding`. |
-[Note]
-As this bean is requested very early during the application lifecycle, make sure to limit the dependencies that your ConversionService is using. Typically, any dependency that you require may not be fully initialized at creation time. You may want to rename your custom ConversionService if it’s not required for configuration keys coercion and only rely on custom converters qualified with @ConfigurationPropertiesBinding.
+### 24.7.4 @ConfigurationProperties Validation
-24.7.4 @ConfigurationProperties Validation
-Spring Boot will attempt to validate @ConfigurationProperties classes whenever they are annotated with Spring’s @Validated annotation. You can use JSR-303 javax.validation constraint annotations directly on your configuration class. Simply ensure that a compliant JSR-303 implementation is on your classpath, then add constraint annotations to your fields:
+Spring Boot will attempt to validate `@ConfigurationProperties` classes whenever they are annotated with Spring’s `@Validated` annotation. You can use JSR-303 `javax.validation` constraint annotations directly on your configuration class. Simply ensure that a compliant JSR-303 implementation is on your classpath, then add constraint annotations to your fields:
+```
@ConfigurationProperties(prefix="foo")
@Validated
public class FooProperties {
@@ -2790,8 +2481,12 @@ public class FooProperties {
// ... getters and setters
}
-In order to validate values of nested properties, you must annotate the associated field as @Valid to trigger its validation. For example, building upon the above FooProperties example:
+```
+
+In order to validate values of nested properties, you must annotate the associated field as `@Valid` to trigger its validation. For example, building upon the above`FooProperties` example:
+
+```
@ConfigurationProperties(prefix="connection")
@Validated
public class FooProperties {
@@ -2814,40 +2509,34 @@ public class FooProperties {
}
}
-You can also add a custom Spring Validator by creating a bean definition called configurationPropertiesValidator. The @Bean method should be declared static. The configuration properties validator is created very early in the application’s lifecycle and declaring the @Bean method as static allows the bean to be created without having to instantiate the @Configuration class. This avoids any problems that may be caused by early instantiation. There is a property validation sample so you can see how to set things up.
-[Tip]
-The spring-boot-actuator module includes an endpoint that exposes all @ConfigurationProperties beans. Simply point your web browser to /configprops or use the equivalent JMX endpoint. See the Production ready features. section for details.
+```
-24.7.5 @ConfigurationProperties vs. @Value
-@Value is a core container feature and it does not provide the same features as type-safe Configuration Properties. The table below summarizes the features that are supported by @ConfigurationProperties and @Value:
+You can also add a custom Spring `Validator` by creating a bean definition called `configurationPropertiesValidator`. The `@Bean` method should be declared `static`. The configuration properties validator is created very early in the application’s lifecycle and declaring the `@Bean` method as static allows the bean to be created without having to instantiate the `@Configuration` class. This avoids any problems that may be caused by early instantiation. There is a [property validation sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-property-validation) so you can see how to set things up.
-Feature @ConfigurationProperties @Value
-Relaxed binding
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `spring-boot-actuator` module includes an endpoint that exposes all `@ConfigurationProperties` beans. Simply point your web browser to `/configprops` or use the equivalent JMX endpoint. See the *Production ready features*. section for details. |
-Yes
+### 24.7.5 @ConfigurationProperties vs. @Value
-No
+`@Value` is a core container feature and it does not provide the same features as type-safe Configuration Properties. The table below summarizes the features that are supported by `@ConfigurationProperties` and `@Value`:
-Meta-data support
+| Feature | `@ConfigurationProperties` | `@Value` |
+| ------------------------------------------------------------ | -------------------------- | -------- |
+| [Relaxed binding](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-relaxed-binding) | Yes | No |
+| [Meta-data support](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata) | Yes | No |
+| `SpEL` evaluation | No | Yes |
-Yes
+If you define a set of configuration keys for your own components, we recommend you to group them in a POJO annotated with `@ConfigurationProperties`. Please also be aware that since `@Value` does not support relaxed binding, it isn’t a great candidate if you need to provide the value using environment variables.
-No
+Finally, while you can write a `SpEL` expression in `@Value`, such expressions are not processed from [Application property files](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-application-property-files).
-SpEL evaluation
+## 25. Profiles
-No
-
-Yes
-
-If you define a set of configuration keys for your own components, we recommend you to group them in a POJO annotated with @ConfigurationProperties. Please also be aware that since @Value does not support relaxed binding, it isn’t a great candidate if you need to provide the value using environment variables.
-
-Finally, while you can write a SpEL expression in @Value, such expressions are not processed from Application property files.
-
-25. Profiles
-Spring Profiles provide a way to segregate parts of your application configuration and make it only available in certain environments. Any @Component or @Configuration can be marked with @Profile to limit when it is loaded:
+Spring Profiles provide a way to segregate parts of your application configuration and make it only available in certain environments. Any `@Component` or `@Configuration` can be marked with `@Profile` to limit when it is loaded:
+```
@Configuration
@Profile("production")
public class ProductionConfiguration {
@@ -2855,18 +2544,27 @@ public class ProductionConfiguration {
// ...
}
-In the normal Spring way, you can use a spring.profiles.active Environment property to specify which profiles are active. You can specify the property in any of the usual ways, for example you could include it in your application.properties:
+```
+
+In the normal Spring way, you can use a `spring.profiles.active` `Environment` property to specify which profiles are active. You can specify the property in any of the usual ways, for example you could include it in your `application.properties`:
+
+```
spring.profiles.active=dev,hsqldb
-or specify on the command line using the switch --spring.profiles.active=dev,hsqldb.
-25.1 Adding active profiles
-The spring.profiles.active property follows the same ordering rules as other properties, the highest PropertySource will win. This means that you can specify active profiles in application.properties then replace them using the command line switch.
+```
+
+or specify on the command line using the switch `--spring.profiles.active=dev,hsqldb`.
+
+## 25.1 Adding active profiles
-Sometimes it is useful to have profile-specific properties that add to the active profiles rather than replace them. The spring.profiles.include property can be used to unconditionally add active profiles. The SpringApplication entry point also has a Java API for setting additional profiles (i.e. on top of those activated by the spring.profiles.active property): see the setAdditionalProfiles() method.
+The `spring.profiles.active` property follows the same ordering rules as other properties, the highest `PropertySource` will win. This means that you can specify active profiles in `application.properties` then **replace** them using the command line switch.
-For example, when an application with following properties is run using the switch --spring.profiles.active=prod the proddb and prodmq profiles will also be activated:
+Sometimes it is useful to have profile-specific properties that **add** to the active profiles rather than replace them. The `spring.profiles.include` property can be used to unconditionally add active profiles. The `SpringApplication` entry point also has a Java API for setting additional profiles (i.e. on top of those activated by the`spring.profiles.active` property): see the `setAdditionalProfiles()` method.
+For example, when an application with following properties is run using the switch `--spring.profiles.active=prod` the `proddb` and `prodmq` profiles will also be activated:
+
+```
---
my.property: fromyamlfile
---
@@ -2874,246 +2572,226 @@ spring.profiles: prod
spring.profiles.include:
- proddb
- prodmq
-[Note]
-Remember that the spring.profiles property can be defined in a YAML document to determine when this particular document is included in the configuration. See Section 72.7, “Change configuration depending on the environment” for more details.
-25.2 Programmatically setting profiles
-You can programmatically set active profiles by calling SpringApplication.setAdditionalProfiles(…) before your application runs. It is also possible to activate profiles using Spring’s ConfigurableEnvironment interface.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Remember that the `spring.profiles` property can be defined in a YAML document to determine when this particular document is included in the configuration. See [Section 72.7, “Change configuration depending on the environment”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-change-configuration-depending-on-the-environment) for more details. |
+
+## 25.2 Programmatically setting profiles
+
+You can programmatically set active profiles by calling `SpringApplication.setAdditionalProfiles(…)` before your application runs. It is also possible to activate profiles using Spring’s `ConfigurableEnvironment` interface.
-25.3 Profile-specific configuration files
-Profile-specific variants of both application.properties (or application.yml) and files referenced via @ConfigurationProperties are considered as files are loaded. See Section 24.4, “Profile-specific properties” for details.
+## 25.3 Profile-specific configuration files
-26. Logging
-Spring Boot uses Commons Logging for all internal logging, but leaves the underlying log implementation open. Default configurations are provided for Java Util Logging, Log4J2 and Logback. In each case loggers are pre-configured to use console output with optional file output also available.
+Profile-specific variants of both `application.properties` (or `application.yml`) and files referenced via `@ConfigurationProperties` are considered as files are loaded. See *Section 24.4, “Profile-specific properties”* for details.
+
+## 26. Logging
+
+Spring Boot uses [Commons Logging](https://commons.apache.org/logging) for all internal logging, but leaves the underlying log implementation open. Default configurations are provided for [Java Util Logging](https://docs.oracle.com/javase/7/docs/api/java/util/logging/package-summary.html),[Log4J2](https://logging.apache.org/log4j/2.x/) and [Logback](http://logback.qos.ch/). In each case loggers are pre-configured to use console output with optional file output also available.
By default, If you use the ‘Starters’, Logback will be used for logging. Appropriate Logback routing is also included to ensure that dependent libraries that use Java Util Logging, Commons Logging, Log4J or SLF4J will all work correctly.
-[Tip]
-There are a lot of logging frameworks available for Java. Don’t worry if the above list seems confusing. Generally you won’t need to change your logging dependencies and the Spring Boot defaults will work just fine.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| There are a lot of logging frameworks available for Java. Don’t worry if the above list seems confusing. Generally you won’t need to change your logging dependencies and the Spring Boot defaults will work just fine. |
+
+## 26.1 Log format
-26.1 Log format
The default log output from Spring Boot looks like this:
+```
2014-03-05 10:57:51.112 INFO 45469 --- [ main] org.apache.catalina.core.StandardEngine : Starting Servlet Engine: Apache Tomcat/7.0.52
2014-03-05 10:57:51.253 INFO 45469 --- [ost-startStop-1] o.a.c.c.C.[Tomcat].[localhost].[/] : Initializing Spring embedded WebApplicationContext
2014-03-05 10:57:51.253 INFO 45469 --- [ost-startStop-1] o.s.web.context.ContextLoader : Root WebApplicationContext: initialization completed in 1358 ms
2014-03-05 10:57:51.698 INFO 45469 --- [ost-startStop-1] o.s.b.c.e.ServletRegistrationBean : Mapping servlet: 'dispatcherServlet' to [/]
2014-03-05 10:57:51.702 INFO 45469 --- [ost-startStop-1] o.s.b.c.embedded.FilterRegistrationBean : Mapping filter: 'hiddenHttpMethodFilter' to: [/*]
-The following items are output:
-Date and Time — Millisecond precision and easily sortable.
-Log Level — ERROR, WARN, INFO, DEBUG or TRACE.
-Process ID.
-A --- separator to distinguish the start of actual log messages.
-Thread name — Enclosed in square brackets (may be truncated for console output).
-Logger name — This is usually the source class name (often abbreviated).
-The log message.
-[Note]
-Logback does not have a FATAL level (it is mapped to ERROR)
+```
-26.2 Console output
-The default log configuration will echo messages to the console as they are written. By default ERROR, WARN and INFO level messages are logged. You can also enable a “debug” mode by starting your application with a --debug flag.
-
-$ java -jar myapp.jar --debug
-[Note]
-you can also specify debug=true in your application.properties.
-
-When the debug mode is enabled, a selection of core loggers (embedded container, Hibernate and Spring Boot) are configured to output more information. Enabling the debug mode does not configure your application to log all messages with DEBUG level.
+The following items are output:
-Alternatively, you can enable a “trace” mode by starting your application with a --trace flag (or trace=true in your application.properties). This will enable trace logging for a selection of core loggers (embedded container, Hibernate schema generation and the whole Spring portfolio).
+- Date and Time — Millisecond precision and easily sortable.
+- Log Level — `ERROR`, `WARN`, `INFO`, `DEBUG` or `TRACE`.
+- Process ID.
+- A `---` separator to distinguish the start of actual log messages.
+- Thread name — Enclosed in square brackets (may be truncated for console output).
+- Logger name — This is usually the source class name (often abbreviated).
+- The log message.
-26.2.1 Color-coded output
-If your terminal supports ANSI, color output will be used to aid readability. You can set spring.output.ansi.enabled to a supported value to override the auto detection.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Logback does not have a `FATAL` level (it is mapped to `ERROR`) |
-Color coding is configured using the %clr conversion word. In its simplest form the converter will color the output according to the log level, for example:
+## 26.2 Console output
-%clr(%5p)
-The mapping of log level to a color is as follows:
+The default log configuration will echo messages to the console as they are written. By default `ERROR`, `WARN` and `INFO` level messages are logged. You can also enable a “debug” mode by starting your application with a `--debug` flag.
-Level Color
-FATAL
+```
+$ java -jar myapp.jar --debug
-Red
+```
-ERROR
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| you can also specify `debug=true` in your `application.properties`. |
-Red
+When the debug mode is enabled, a selection of core loggers (embedded container, Hibernate and Spring Boot) are configured to output more information. Enabling the debug mode does *not* configure your application to log all messages with `DEBUG` level.
-WARN
+Alternatively, you can enable a “trace” mode by starting your application with a `--trace` flag (or `trace=true` in your `application.properties`). This will enable trace logging for a selection of core loggers (embedded container, Hibernate schema generation and the whole Spring portfolio).
-Yellow
+### 26.2.1 Color-coded output
-INFO
+If your terminal supports ANSI, color output will be used to aid readability. You can set `spring.output.ansi.enabled` to a [supported value](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/ansi/AnsiOutput.Enabled.html) to override the auto detection.
-Green
+Color coding is configured using the `%clr` conversion word. In its simplest form the converter will color the output according to the log level, for example:
-DEBUG
+```
+%clr(%5p)
-Green
+```
-TRACE
+The mapping of log level to a color is as follows:
-Green
+| Level | Color |
+| ------- | ------ |
+| `FATAL` | Red |
+| `ERROR` | Red |
+| `WARN` | Yellow |
+| `INFO` | Green |
+| `DEBUG` | Green |
+| `TRACE` | Green |
Alternatively, you can specify the color or style that should be used by providing it as an option to the conversion. For example, to make the text yellow:
+```
%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){yellow}
-The following colors and styles are supported:
-
-blue
-cyan
-faint
-green
-magenta
-red
-yellow
-26.3 File output
-By default, Spring Boot will only log to the console and will not write log files. If you want to write log files in addition to the console output you need to set a logging.file or logging.path property (for example in your application.properties).
-
-The following table shows how the logging.* properties can be used together:
-Table 26.1. Logging properties
+```
-logging.file logging.path Example Description
-(none)
-
-(none)
-
-
-Console only logging.
+The following colors and styles are supported:
-Specific file
+- `blue`
+- `cyan`
+- `faint`
+- `green`
+- `magenta`
+- `red`
+- `yellow`
-(none)
+## 26.3 File output
-my.log
+By default, Spring Boot will only log to the console and will not write log files. If you want to write log files in addition to the console output you need to set a`logging.file` or `logging.path` property (for example in your `application.properties`).
-Writes to the specified log file. Names can be an exact location or relative to the current directory.
+The following table shows how the `logging.*` properties can be used together:
-(none)
-Specific directory
-/var/log
+**Table 26.1. Logging properties**
-Writes spring.log to the specified directory. Names can be an exact location or relative to the current directory.
+| `logging.file` | `logging.path` | Example | Description |
+| -------------- | ------------------ | ---------- | ------------------------------------------------------------ |
+| *(none)* | *(none)* | | Console only logging. |
+| Specific file | *(none)* | `my.log` | Writes to the specified log file. Names can be an exact location or relative to the current directory. |
+| *(none)* | Specific directory | `/var/log` | Writes `spring.log` to the specified directory. Names can be an exact location or relative to the current directory. |
+Log files will rotate when they reach 10 MB and as with console output, `ERROR`, `WARN` and `INFO` level messages are logged by default.
-Log files will rotate when they reach 10 MB and as with console output, ERROR, WARN and INFO level messages are logged by default.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The logging system is initialized early in the application lifecycle and as such logging properties will not be found in property files loaded via `@PropertySource` annotations. |
-[Note]
-The logging system is initialized early in the application lifecycle and as such logging properties will not be found in property files loaded via @PropertySource annotations.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Logging properties are independent of the actual logging infrastructure. As a result, specific configuration keys (such as `logback.configurationFile`for Logback) are not managed by spring Boot. |
-[Tip]
-Logging properties are independent of the actual logging infrastructure. As a result, specific configuration keys (such as logback.configurationFile for Logback) are not managed by spring Boot.
+## 26.4 Log Levels
-26.4 Log Levels
-All the supported logging systems can have the logger levels set in the Spring Environment (so for example in application.properties) using ‘logging.level.*=LEVEL’ where ‘LEVEL’ is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF. The root logger can be configured using logging.level.root. Example application.properties:
+All the supported logging systems can have the logger levels set in the Spring `Environment` (so for example in `application.properties`) using ‘logging.level.*=LEVEL’ where ‘LEVEL’ is one of TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF. The `root` logger can be configured using `logging.level.root`. Example `application.properties`:
+```
logging.level.root=WARN
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR
-[Note]
-By default Spring Boot remaps Thymeleaf INFO messages so that they are logged at DEBUG level. This helps to reduce noise in the standard log output. See LevelRemappingAppender for details of how you can apply remapping in your own configuration.
-
-26.5 Custom log configuration
-The various logging systems can be activated by including the appropriate libraries on the classpath, and further customized by providing a suitable configuration file in the root of the classpath, or in a location specified by the Spring Environment property logging.config.
-You can force Spring Boot to use a particular logging system using the org.springframework.boot.logging.LoggingSystem system property. The value should be the fully-qualified class name of a LoggingSystem implementation. You can also disable Spring Boot’s logging configuration entirely by using a value of none.
+```
-[Note]
-Since logging is initialized before the ApplicationContext is created, it isn’t possible to control logging from @PropertySources in Spring @Configuration files. System properties and the conventional Spring Boot external configuration files work just fine.)
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| By default Spring Boot remaps Thymeleaf `INFO` messages so that they are logged at `DEBUG` level. This helps to reduce noise in the standard log output. See [`LevelRemappingAppender`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/logging/logback/LevelRemappingAppender.java) for details of how you can apply remapping in your own configuration. |
-Depending on your logging system, the following files will be loaded:
-
-Logging System Customization
-Logback
-
-logback-spring.xml, logback-spring.groovy, logback.xml or logback.groovy
-
-Log4j2
-
-log4j2-spring.xml or log4j2.xml
-
-JDK (Java Util Logging)
-
-logging.properties
-
-[Note]
-When possible we recommend that you use the -spring variants for your logging configuration (for example logback-spring.xml rather than logback.xml). If you use standard configuration locations, Spring cannot completely control log initialization.
-
-[Warning]
-There are known classloading issues with Java Util Logging that cause problems when running from an ‘executable jar’. We recommend that you avoid it if at all possible.
-
-To help with the customization some other properties are transferred from the Spring Environment to System properties:
-
-Spring Environment System Property Comments
-logging.exception-conversion-word
-
-LOG_EXCEPTION_CONVERSION_WORD
-
-The conversion word that’s used when logging exceptions.
-
-logging.file
-
-LOG_FILE
-
-Used in default log configuration if defined.
+## 26.5 Custom log configuration
-logging.path
+The various logging systems can be activated by including the appropriate libraries on the classpath, and further customized by providing a suitable configuration file in the root of the classpath, or in a location specified by the Spring `Environment` property `logging.config`.
-LOG_PATH
+You can force Spring Boot to use a particular logging system using the `org.springframework.boot.logging.LoggingSystem` system property. The value should be the fully-qualified class name of a `LoggingSystem` implementation. You can also disable Spring Boot’s logging configuration entirely by using a value of `none`.
-Used in default log configuration if defined.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Since logging is initialized **before** the `ApplicationContext` is created, it isn’t possible to control logging from `@PropertySources` in Spring `@Configuration` files. System properties and the conventional Spring Boot external configuration files work just fine.) |
-logging.pattern.console
-
-CONSOLE_LOG_PATTERN
-
-The log pattern to use on the console (stdout). (Only supported with the default logback setup.)
+Depending on your logging system, the following files will be loaded:
-logging.pattern.file
+| Logging System | Customization |
+| ----------------------- | ------------------------------------------------------------ |
+| Logback | `logback-spring.xml`, `logback-spring.groovy`, `logback.xml` or `logback.groovy` |
+| Log4j2 | `log4j2-spring.xml` or `log4j2.xml` |
+| JDK (Java Util Logging) | `logging.properties` |
-FILE_LOG_PATTERN
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| When possible we recommend that you use the `-spring` variants for your logging configuration (for example `logback-spring.xml` rather than `logback.xml`). If you use standard configuration locations, Spring cannot completely control log initialization. |
-The log pattern to use in a file (if LOG_FILE enabled). (Only supported with the default logback setup.)
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| There are known classloading issues with Java Util Logging that cause problems when running from an ‘executable jar’. We recommend that you avoid it if at all possible. |
-logging.pattern.level
+To help with the customization some other properties are transferred from the Spring `Environment` to System properties:
-LOG_LEVEL_PATTERN
+| Spring Environment | System Property | Comments |
+| ----------------------------------- | ------------------------------- | ------------------------------------------------------------ |
+| `logging.exception-conversion-word` | `LOG_EXCEPTION_CONVERSION_WORD` | The conversion word that’s used when logging exceptions. |
+| `logging.file` | `LOG_FILE` | Used in default log configuration if defined. |
+| `logging.path` | `LOG_PATH` | Used in default log configuration if defined. |
+| `logging.pattern.console` | `CONSOLE_LOG_PATTERN` | The log pattern to use on the console (stdout). (Only supported with the default logback setup.) |
+| `logging.pattern.file` | `FILE_LOG_PATTERN` | The log pattern to use in a file (if LOG_FILE enabled). (Only supported with the default logback setup.) |
+| `logging.pattern.level` | `LOG_LEVEL_PATTERN` | The format to use to render the log level (default `%5p`). (Only supported with the default logback setup.) |
+| `PID` | `PID` | The current process ID (discovered if possible and when not already defined as an OS environment variable). |
-The format to use to render the log level (default %5p). (Only supported with the default logback setup.)
+All the logging systems supported can consult System properties when parsing their configuration files. See the default configurations in `spring-boot.jar` for examples.
-PID
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you want to use a placeholder in a logging property, you should use [Spring Boot’s syntax](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-placeholders-in-properties) and not the syntax of the underlying framework. Notably, if you’re using Logback, you should use `:` as the delimiter between a property name and its default value and not `:-`. |
-PID
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You can add MDC and other ad-hoc content to log lines by overriding only the `LOG_LEVEL_PATTERN` (or `logging.pattern.level` with Logback). For example, if you use `logging.pattern.level=user:%X{user} %5p` then the default log format will contain an MDC entry for "user" if it exists, e.g.`2015-09-30 12:30:04.031 user:juergen INFO 22174 --- [ nio-8080-exec-0] demo.Controller Handling authenticated request` |
-The current process ID (discovered if possible and when not already defined as an OS environment variable).
+## 26.6 Logback extensions
-All the logging systems supported can consult System properties when parsing their configuration files. See the default configurations in spring-boot.jar for examples.
+Spring Boot includes a number of extensions to Logback which can help with advanced configuration. You can use these extensions in your `logback-spring.xml`configuration file.
-[Tip]
-If you want to use a placeholder in a logging property, you should use Spring Boot’s syntax and not the syntax of the underlying framework. Notably, if you’re using Logback, you should use : as the delimiter between a property name and its default value and not :-.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You cannot use extensions in the standard `logback.xml` configuration file since it’s loaded too early. You need to either use `logback-spring.xml` or define a `logging.config` property. |
-[Tip]
-You can add MDC and other ad-hoc content to log lines by overriding only the LOG_LEVEL_PATTERN (or logging.pattern.level with Logback). For example, if you use logging.pattern.level=user:%X{user} %5p then the default log format will contain an MDC entry for "user" if it exists, e.g.
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| The extensions cannot be used with Logback’s [configuration scanning](http://logback.qos.ch/manual/configuration.html#autoScan). If you attempt to do so, making changes to the configuration file will result in an error similar to one of the following being logged: |
-2015-09-30 12:30:04.031 user:juergen INFO 22174 --- [ nio-8080-exec-0] demo.Controller
-Handling authenticated request
-26.6 Logback extensions
-Spring Boot includes a number of extensions to Logback which can help with advanced configuration. You can use these extensions in your logback-spring.xml configuration file.
+```
+ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]]
+ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]
-[Note]
-You cannot use extensions in the standard logback.xml configuration file since it’s loaded too early. You need to either use logback-spring.xml or define a logging.config property.
+```
-[Warning]
-The extensions cannot be used with Logback’s configuration scanning. If you attempt to do so, making changes to the configuration file will result in an error similar to one of the following being logged:
+### 26.6.1 Profile-specific configuration
-ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProperty], current ElementPath is [[configuration][springProperty]]
-ERROR in ch.qos.logback.core.joran.spi.Interpreter@4:71 - no applicable action for [springProfile], current ElementPath is [[configuration][springProfile]]
-26.6.1 Profile-specific configuration
-The tag allows you to optionally include or exclude sections of configuration based on the active Spring profiles. Profile sections are supported anywhere within the element. Use the name attribute to specify which profile accepts the configuration. Multiple profiles can be specified using a comma-separated list.
+The `` tag allows you to optionally include or exclude sections of configuration based on the active Spring profiles. Profile sections are supported anywhere within the `` element. Use the `name` attribute to specify which profile accepts the configuration. Multiple profiles can be specified using a comma-separated list.
+```
@@ -3125,28 +2803,40 @@ The tag allows you to optionally include or exclude sections of
-26.6.2 Environment properties
-The tag allows you to surface properties from the Spring Environment for use within Logback. This can be useful if you want to access values from your application.properties file in your logback configuration. The tag works in a similar way to Logback’s standard tag, but rather than specifying a direct value you specify the source of the property (from the Environment). You can use the scope attribute if you need to store the property somewhere other than in local scope. If you need a fallback value in case the property is not set in the Environment, you can use the defaultValue attribute.
+```
+
+### 26.6.2 Environment properties
+
+The `` tag allows you to surface properties from the Spring `Environment` for use within Logback. This can be useful if you want to access values from your `application.properties` file in your logback configuration. The tag works in a similar way to Logback’s standard `` tag, but rather than specifying a direct `value` you specify the `source` of the property (from the `Environment`). You can use the `scope` attribute if you need to store the property somewhere other than in `local` scope. If you need a fallback value in case the property is not set in the `Environment`, you can use the `defaultValue` attribute.
+
+```
${fluentHost}
...
-[Tip]
-The RelaxedPropertyResolver is used to access Environment properties. If specify the source in dashed notation (my-property-name) all the relaxed variations will be tried (myPropertyName, MY_PROPERTY_NAME etc).
-27. Developing web applications
-Spring Boot is well suited for web application development. You can easily create a self-contained HTTP server using embedded Tomcat, Jetty, or Undertow. Most web applications will use the spring-boot-starter-web module to get up and running quickly.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `RelaxedPropertyResolver` is used to access `Environment` properties. If specify the `source` in dashed notation (`my-property-name`) all the relaxed variations will be tried (`myPropertyName`, `MY_PROPERTY_NAME` etc). |
+
+## 27. Developing web applications
-If you haven’t yet developed a Spring Boot web application you can follow the "Hello World!" example in the Getting started section.
+Spring Boot is well suited for web application development. You can easily create a self-contained HTTP server using embedded Tomcat, Jetty, or Undertow. Most web applications will use the `spring-boot-starter-web` module to get up and running quickly.
-27.1 The ‘Spring Web MVC framework’
-The Spring Web MVC framework (often referred to as simply ‘Spring MVC’) is a rich ‘model view controller’ web framework. Spring MVC lets you create special @Controller or @RestController beans to handle incoming HTTP requests. Methods in your controller are mapped to HTTP using @RequestMapping annotations.
+If you haven’t yet developed a Spring Boot web application you can follow the "Hello World!" example in the *Getting started* section.
-Here is a typical example @RestController to serve JSON data:
+## 27.1 The ‘Spring Web MVC framework’
+The Spring Web MVC framework (often referred to as simply ‘Spring MVC’) is a rich ‘model view controller’ web framework. Spring MVC lets you create special `@Controller` or `@RestController` beans to handle incoming HTTP requests. Methods in your controller are mapped to HTTP using `@RequestMapping`annotations.
+
+Here is a typical example `@RestController` to serve JSON data:
+
+```
@RestController
@RequestMapping(value="/users")
public class MyRestController {
@@ -3167,30 +2857,37 @@ public class MyRestController {
}
}
-Spring MVC is part of the core Spring Framework and detailed information is available in the reference documentation. There are also several guides available at spring.io/guides that cover Spring MVC.
-27.1.1 Spring MVC auto-configuration
+```
+
+Spring MVC is part of the core Spring Framework and detailed information is available in the [reference documentation](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle#mvc). There are also several guides available at [spring.io/guides](https://spring.io/guides) that cover Spring MVC.
+
+### 27.1.1 Spring MVC auto-configuration
+
Spring Boot provides auto-configuration for Spring MVC that works well with most applications.
The auto-configuration adds the following features on top of Spring’s defaults:
-Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
-Support for serving static resources, including support for WebJars (see below).
-Automatic registration of Converter, GenericConverter, Formatter beans.
-Support for HttpMessageConverters (see below).
-Automatic registration of MessageCodesResolver (see below).
-Static index.html support.
-Custom Favicon support (see below).
-Automatic use of a ConfigurableWebBindingInitializer bean (see below).
-If you want to keep Spring Boot MVC features, and you just want to add additional MVC configuration (interceptors, formatters, view controllers etc.) you can add your own @Configuration class of type WebMvcConfigurerAdapter, but without @EnableWebMvc. If you wish to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter or ExceptionHandlerExceptionResolver you can declare a WebMvcRegistrationsAdapter instance providing such components.
+- Inclusion of `ContentNegotiatingViewResolver` and `BeanNameViewResolver` beans.
+- Support for serving static resources, including support for WebJars (see below).
+- Automatic registration of `Converter`, `GenericConverter`, `Formatter` beans.
+- Support for `HttpMessageConverters` (see below).
+- Automatic registration of `MessageCodesResolver` (see below).
+- Static `index.html` support.
+- Custom `Favicon` support (see below).
+- Automatic use of a `ConfigurableWebBindingInitializer` bean (see below).
+
+If you want to keep Spring Boot MVC features, and you just want to add additional [MVC configuration](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle#mvc) (interceptors, formatters, view controllers etc.) you can add your own `@Configuration` class of type `WebMvcConfigurerAdapter`, but **without** `@EnableWebMvc`. If you wish to provide custom instances of `RequestMappingHandlerMapping`, `RequestMappingHandlerAdapter` or `ExceptionHandlerExceptionResolver` you can declare a `WebMvcRegistrationsAdapter` instance providing such components.
-If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.
+If you want to take complete control of Spring MVC, you can add your own `@Configuration` annotated with `@EnableWebMvc`.
-27.1.2 HttpMessageConverters
-Spring MVC uses the HttpMessageConverter interface to convert HTTP requests and responses. Sensible defaults are included out of the box, for example Objects can be automatically converted to JSON (using the Jackson library) or XML (using the Jackson XML extension if available, else using JAXB). Strings are encoded using UTF-8 by default.
+### 27.1.2 HttpMessageConverters
-If you need to add or customize converters you can use Spring Boot’s HttpMessageConverters class:
+Spring MVC uses the `HttpMessageConverter` interface to convert HTTP requests and responses. Sensible defaults are included out of the box, for example Objects can be automatically converted to JSON (using the Jackson library) or XML (using the Jackson XML extension if available, else using JAXB). Strings are encoded using `UTF-8` by default.
+If you need to add or customize converters you can use Spring Boot’s `HttpMessageConverters` class:
+
+```
import org.springframework.boot.autoconfigure.web.HttpMessageConverters;
import org.springframework.context.annotation.*;
import org.springframework.http.converter.*;
@@ -3206,13 +2903,18 @@ public class MyConfiguration {
}
}
-Any HttpMessageConverter bean that is present in the context will be added to the list of converters. You can also override default converters that way.
-27.1.3 Custom JSON Serializers and Deserializers
-If you’re using Jackson to serialize and deserialize JSON data, you might want to write your own JsonSerializer and JsonDeserializer classes. Custom serializers are usually registered with Jackson via a Module, but Spring Boot provides an alternative @JsonComponent annotation which makes it easier to directly register Spring Beans.
+```
+
+Any `HttpMessageConverter` bean that is present in the context will be added to the list of converters. You can also override default converters that way.
-You can use @JsonComponent directly on JsonSerializer or JsonDeserializer implementations. You can also use it on classes that contains serializers/deserializers as inner-classes. For example:
+### 27.1.3 Custom JSON Serializers and Deserializers
+If you’re using Jackson to serialize and deserialize JSON data, you might want to write your own `JsonSerializer` and `JsonDeserializer` classes. Custom serializers are usually [registered with Jackson via a Module](http://wiki.fasterxml.com/JacksonHowToCustomDeserializers), but Spring Boot provides an alternative `@JsonComponent` annotation which makes it easier to directly register Spring Beans.
+
+You can use `@JsonComponent` directly on `JsonSerializer` or `JsonDeserializer` implementations. You can also use it on classes that contains serializers/deserializers as inner-classes. For example:
+
+```
import java.io.*;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
@@ -3230,87 +2932,117 @@ public class Example {
}
}
-All @JsonComponent beans in the ApplicationContext will be automatically registered with Jackson, and since @JsonComponent is meta-annotated with @Component, the usual component-scanning rules apply.
-Spring Boot also provides JsonObjectSerializer and JsonObjectDeserializer base classes which provide useful alternatives to the standard Jackson versions when serializing Objects. See the Javadoc for details.
+```
+
+All `@JsonComponent` beans in the `ApplicationContext` will be automatically registered with Jackson, and since `@JsonComponent` is meta-annotated with `@Component`, the usual component-scanning rules apply.
+
+Spring Boot also provides [`JsonObjectSerializer`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/jackson/JsonObjectSerializer.java) and [`JsonObjectDeserializer`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/jackson/JsonObjectDeserializer.java) base classes which provide useful alternatives to the standard Jackson versions when serializing Objects. See the Javadoc for details.
-27.1.4 MessageCodesResolver
-Spring MVC has a strategy for generating error codes for rendering error messages from binding errors: MessageCodesResolver. Spring Boot will create one for you if you set the spring.mvc.message-codes-resolver.format property PREFIX_ERROR_CODE or POSTFIX_ERROR_CODE (see the enumeration in DefaultMessageCodesResolver.Format).
+### 27.1.4 MessageCodesResolver
-27.1.5 Static Content
-By default Spring Boot will serve static content from a directory called /static (or /public or /resources or /META-INF/resources) in the classpath or from the root of the ServletContext. It uses the ResourceHttpRequestHandler from Spring MVC so you can modify that behavior by adding your own WebMvcConfigurerAdapter and overriding the addResourceHandlers method.
+Spring MVC has a strategy for generating error codes for rendering error messages from binding errors: `MessageCodesResolver`. Spring Boot will create one for you if you set the `spring.mvc.message-codes-resolver.format` property `PREFIX_ERROR_CODE` or `POSTFIX_ERROR_CODE` (see the enumeration in `DefaultMessageCodesResolver.Format`).
-In a stand-alone web application the default servlet from the container is also enabled, and acts as a fallback, serving content from the root of the ServletContext if Spring decides not to handle it. Most of the time this will not happen (unless you modify the default MVC configuration) because Spring will always be able to handle requests through the DispatcherServlet.
+### 27.1.5 Static Content
-By default, resources are mapped on /** but you can tune that via spring.mvc.static-path-pattern. For instance, relocating all resources to /resources/** can be achieved as follows:
+By default Spring Boot will serve static content from a directory called `/static` (or `/public` or `/resources` or `/META-INF/resources`) in the classpath or from the root of the `ServletContext`. It uses the `ResourceHttpRequestHandler` from Spring MVC so you can modify that behavior by adding your own `WebMvcConfigurerAdapter` and overriding the `addResourceHandlers` method.
+In a stand-alone web application the default servlet from the container is also enabled, and acts as a fallback, serving content from the root of the `ServletContext` if Spring decides not to handle it. Most of the time this will not happen (unless you modify the default MVC configuration) because Spring will always be able to handle requests through the `DispatcherServlet`.
+
+By default, resources are mapped on `/**` but you can tune that via `spring.mvc.static-path-pattern`. For instance, relocating all resources to `/resources/**` can be achieved as follows:
+
+```
spring.mvc.static-path-pattern=/resources/**
-You can also customize the static resource locations using spring.resources.static-locations (replacing the default values with a list of directory locations). If you do this the default welcome page detection will switch to your custom locations, so if there is an index.html in any of your locations on startup, it will be the home page of the application.
-In addition to the ‘standard’ static resource locations above, a special case is made for Webjars content. Any resources with a path in /webjars/** will be served from jar files if they are packaged in the Webjars format.
+```
+
+You can also customize the static resource locations using `spring.resources.static-locations` (replacing the default values with a list of directory locations). If you do this the default welcome page detection will switch to your custom locations, so if there is an `index.html` in any of your locations on startup, it will be the home page of the application.
+
+In addition to the ‘standard’ static resource locations above, a special case is made for [Webjars content](http://www.webjars.org/). Any resources with a path in `/webjars/**` will be served from jar files if they are packaged in the Webjars format.
-[Tip]
-Do not use the src/main/webapp directory if your application will be packaged as a jar. Although this directory is a common standard, it will only work with war packaging and it will be silently ignored by most build tools if you generate a jar.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Do not use the `src/main/webapp` directory if your application will be packaged as a jar. Although this directory is a common standard, it will **only** work with war packaging and it will be silently ignored by most build tools if you generate a jar. |
Spring Boot also supports advanced resource handling features provided by Spring MVC, allowing use cases such as cache busting static resources or using version agnostic URLs for Webjars.
-To use version agnostic URLs for Webjars, simply add the webjars-locator dependency. Then declare your Webjar, taking jQuery for example, as "/webjars/jquery/dist/jquery.min.js" which results in "/webjars/jquery/x.y.z/dist/jquery.min.js" where x.y.z is the Webjar version.
+To use version agnostic URLs for Webjars, simply add the `webjars-locator` dependency. Then declare your Webjar, taking jQuery for example, as `"/webjars/jquery/dist/jquery.min.js"` which results in `"/webjars/jquery/x.y.z/dist/jquery.min.js"` where `x.y.z` is the Webjar version.
-[Note]
-If you are using JBoss, you’ll need to declare the webjars-locator-jboss-vfs dependency instead of the webjars-locator; otherwise all Webjars resolve as a 404.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you are using JBoss, you’ll need to declare the `webjars-locator-jboss-vfs` dependency instead of the `webjars-locator`; otherwise all Webjars resolve as a `404`. |
-To use cache busting, the following configuration will configure a cache busting solution for all static resources, effectively adding a content hash in URLs, such as :
+To use cache busting, the following configuration will configure a cache busting solution for all static resources, effectively adding a content hash in URLs, such as``:
+```
spring.resources.chain.strategy.content.enabled=true
spring.resources.chain.strategy.content.paths=/**
-[Note]
-Links to resources are rewritten at runtime in template, thanks to a ResourceUrlEncodingFilter, auto-configured for Thymeleaf and FreeMarker. You should manually declare this filter when using JSPs. Other template engines aren’t automatically supported right now, but can be with custom template macros/helpers and the use of the ResourceUrlProvider.
+
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Links to resources are rewritten at runtime in template, thanks to a `ResourceUrlEncodingFilter`, auto-configured for Thymeleaf and FreeMarker. You should manually declare this filter when using JSPs. Other template engines aren’t automatically supported right now, but can be with custom template macros/helpers and the use of the [`ResourceUrlProvider`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/javadoc-api/org/springframework/web/servlet/resource/ResourceUrlProvider.html). |
When loading resources dynamically with, for example, a JavaScript module loader, renaming files is not an option. That’s why other strategies are also supported and can be combined. A "fixed" strategy will add a static version string in the URL, without changing the file name:
+```
spring.resources.chain.strategy.content.enabled=true
spring.resources.chain.strategy.content.paths=/**
spring.resources.chain.strategy.fixed.enabled=true
spring.resources.chain.strategy.fixed.paths=/js/lib/
spring.resources.chain.strategy.fixed.version=v12
-With this configuration, JavaScript modules located under "/js/lib/" will use a fixed versioning strategy "/v12/js/lib/mymodule.js" while other resources will still use the content one .
-See ResourceProperties for more of the supported options.
+```
+
+With this configuration, JavaScript modules located under `"/js/lib/"` will use a fixed versioning strategy `"/v12/js/lib/mymodule.js"` while other resources will still use the content one ``.
+
+See [`ResourceProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ResourceProperties.java) for more of the supported options.
-[Tip]
-This feature has been thoroughly described in a dedicated blog post and in Spring Framework’s reference documentation.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| This feature has been thoroughly described in a dedicated [blog post](https://spring.io/blog/2014/07/24/spring-framework-4-1-handling-static-web-resources) and in Spring Framework’s [reference documentation](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#mvc-config-static-resources). |
-27.1.6 Custom Favicon
-Spring Boot looks for a favicon.ico in the configured static content locations and the root of the classpath (in that order). If such file is present, it is automatically used as the favicon of the application.
+### 27.1.6 Custom Favicon
-27.1.7 ConfigurableWebBindingInitializer
-Spring MVC uses a WebBindingInitializer to initialize a WebDataBinder for a particular request. If you create your own ConfigurableWebBindingInitializer @Bean, Spring Boot will automatically configure Spring MVC to use it.
+Spring Boot looks for a `favicon.ico` in the configured static content locations and the root of the classpath (in that order). If such file is present, it is automatically used as the favicon of the application.
+
+### 27.1.7 ConfigurableWebBindingInitializer
+
+Spring MVC uses a `WebBindingInitializer` to initialize a `WebDataBinder` for a particular request. If you create your own `ConfigurableWebBindingInitializer` `@Bean`, Spring Boot will automatically configure Spring MVC to use it.
+
+### 27.1.8 Template engines
-27.1.8 Template engines
As well as REST web services, you can also use Spring MVC to serve dynamic HTML content. Spring MVC supports a variety of templating technologies including Thymeleaf, FreeMarker and JSPs. Many other templating engines also ship their own Spring MVC integrations.
Spring Boot includes auto-configuration support for the following templating engines:
-FreeMarker
-Groovy
-Thymeleaf
-Mustache
-[Tip]
-JSPs should be avoided if possible, there are several known limitations when using them with embedded servlet containers.
+- [FreeMarker](http://freemarker.org/docs/)
+- [Groovy](http://docs.groovy-lang.org/docs/next/html/documentation/template-engines.html#_the_markuptemplateengine)
+- [Thymeleaf](http://www.thymeleaf.org/)
+- [Mustache](https://mustache.github.io/)
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| JSPs should be avoided if possible, there are several [known limitations](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-jsp-limitations) when using them with embedded servlet containers. |
-When you’re using one of these templating engines with the default configuration, your templates will be picked up automatically from src/main/resources/templates.
+When you’re using one of these templating engines with the default configuration, your templates will be picked up automatically from `src/main/resources/templates`.
-[Tip]
-IntelliJ IDEA orders the classpath differently depending on how you run your application. Running your application in the IDE via its main method will result in a different ordering to when you run your application using Maven or Gradle or from its packaged jar. This can cause Spring Boot to fail to find the templates on the classpath. If you’re affected by this problem you can reorder the classpath in the IDE to place the module’s classes and resources first. Alternatively, you can configure the template prefix to search every templates directory on the classpath: classpath*:/templates/.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| IntelliJ IDEA orders the classpath differently depending on how you run your application. Running your application in the IDE via its main method will result in a different ordering to when you run your application using Maven or Gradle or from its packaged jar. This can cause Spring Boot to fail to find the templates on the classpath. If you’re affected by this problem you can reorder the classpath in the IDE to place the module’s classes and resources first. Alternatively, you can configure the template prefix to search every templates directory on the classpath: `classpath*:/templates/`. |
-27.1.9 Error Handling
-Spring Boot provides an /error mapping by default that handles all errors in a sensible way, and it is registered as a ‘global’ error page in the servlet container. For machine clients it will produce a JSON response with details of the error, the HTTP status and the exception message. For browser clients there is a ‘whitelabel’ error view that renders the same data in HTML format (to customize it just add a View that resolves to ‘error’). To replace the default behaviour completely you can implement ErrorController and register a bean definition of that type, or simply add a bean of type ErrorAttributes to use the existing mechanism but replace the contents.
+### 27.1.9 Error Handling
-[Tip]
-The BasicErrorController can be used as a base class for a custom ErrorController. This is particularly useful if you want to add a handler for a new content type (the default is to handle text/html specifically and provide a fallback for everything else). To do that just extend BasicErrorController and add a public method with a @RequestMapping that has a produces attribute, and create a bean of your new type.
+Spring Boot provides an `/error` mapping by default that handles all errors in a sensible way, and it is registered as a ‘global’ error page in the servlet container. For machine clients it will produce a JSON response with details of the error, the HTTP status and the exception message. For browser clients there is a ‘whitelabel’ error view that renders the same data in HTML format (to customize it just add a `View` that resolves to ‘error’). To replace the default behaviour completely you can implement`ErrorController` and register a bean definition of that type, or simply add a bean of type `ErrorAttributes` to use the existing mechanism but replace the contents.
-You can also define a @ControllerAdvice to customize the JSON document to return for a particular controller and/or exception type.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `BasicErrorController` can be used as a base class for a custom `ErrorController`. This is particularly useful if you want to add a handler for a new content type (the default is to handle `text/html` specifically and provide a fallback for everything else). To do that just extend `BasicErrorController` and add a public method with a `@RequestMapping` that has a `produces` attribute, and create a bean of your new type. |
+You can also define a `@ControllerAdvice` to customize the JSON document to return for a particular controller and/or exception type.
+
+```
@ControllerAdvice(basePackageClasses = FooController.class)
public class FooControllerAdvice extends ResponseEntityExceptionHandler {
@@ -3330,13 +3062,18 @@ public class FooControllerAdvice extends ResponseEntityExceptionHandler {
}
}
-In the example above, if YourException is thrown by a controller defined in the same package as FooController, a json representation of the CustomerErrorType POJO will be used instead of the ErrorAttributes representation.
-Custom error pages
-If you want to display a custom HTML error page for a given status code, you add a file to an /error folder. Error pages can either be static HTML (i.e. added under any of the static resource folders) or built using templates. The name of the file should be the exact status code or a series mask.
+```
+
+In the example above, if `YourException` is thrown by a controller defined in the same package as `FooController`, a json representation of the `CustomerErrorType` POJO will be used instead of the `ErrorAttributes` representation.
+
+#### Custom error pages
+
+If you want to display a custom HTML error page for a given status code, you add a file to an `/error` folder. Error pages can either be static HTML (i.e. added under any of the static resource folders) or built using templates. The name of the file should be the exact status code or a series mask.
-For example, to map 404 to a static HTML file, your folder structure would look like this:
+For example, to map `404` to a static HTML file, your folder structure would look like this:
+```
src/
+- main/
+- java/
@@ -3346,8 +3083,12 @@ src/
+- error/
| +- 404.html
+-
-To map all 5xx errors using a FreeMarker template, you’d have a structure like this:
+```
+
+To map all `5xx` errors using a FreeMarker template, you’d have a structure like this:
+
+```
src/
+- main/
+- java/
@@ -3357,8 +3098,12 @@ src/
+- error/
| +- 5xx.ftl
+-
-For more complex mappings you can also add beans that implement the ErrorViewResolver interface.
+```
+
+For more complex mappings you can also add beans that implement the `ErrorViewResolver` interface.
+
+```
public class MyErrorViewResolver implements ErrorViewResolver {
@Override
@@ -3369,11 +3114,16 @@ public class MyErrorViewResolver implements ErrorViewResolver {
}
}
-You can also use regular Spring MVC features like @ExceptionHandler methods and @ControllerAdvice. The ErrorController will then pick up any unhandled exceptions.
-Mapping error pages outside of Spring MVC
-For applications that aren’t using Spring MVC, you can use the ErrorPageRegistrar interface to directly register ErrorPages. This abstraction works directly with the underlying embedded servlet container and will work even if you don’t have a Spring MVC DispatcherServlet.
+```
+You can also use regular Spring MVC features like [`@ExceptionHandler` methods](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#mvc-exceptionhandlers) and [`@ControllerAdvice`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#mvc-ann-controller-advice). The `ErrorController` will then pick up any unhandled exceptions.
+
+#### Mapping error pages outside of Spring MVC
+
+For applications that aren’t using Spring MVC, you can use the `ErrorPageRegistrar` interface to directly register `ErrorPages`. This abstraction works directly with the underlying embedded servlet container and will work even if you don’t have a Spring MVC `DispatcherServlet`.
+
+```
@Bean
public ErrorPageRegistrar errorPageRegistrar(){
return new MyErrorPageRegistrar();
@@ -3389,8 +3139,12 @@ private static class MyErrorPageRegistrar implements ErrorPageRegistrar {
}
}
-N.B. if you register an ErrorPage with a path that will end up being handled by a Filter (e.g. as is common with some non-Spring web frameworks, like Jersey and Wicket), then the Filter has to be explicitly registered as an ERROR dispatcher, e.g.
+```
+
+N.B. if you register an `ErrorPage` with a path that will end up being handled by a `Filter` (e.g. as is common with some non-Spring web frameworks, like Jersey and Wicket), then the `Filter` has to be explicitly registered as an `ERROR` dispatcher, e.g.
+
+```
@Bean
public FilterRegistrationBean myFilter() {
FilterRegistrationBean registration = new FilterRegistrationBean();
@@ -3399,21 +3153,28 @@ public FilterRegistrationBean myFilter() {
registration.setDispatcherTypes(EnumSet.allOf(DispatcherType.class));
return registration;
}
-(the default FilterRegistrationBean does not include the ERROR dispatcher type).
-Error Handling on WebSphere Application Server
-When deployed to a servlet container, a Spring Boot uses its error page filter to forward a request with an error status to the appropriate error page. The request can only be forwarded to the correct error page if the response has not already been committed. By default, WebSphere Application Server 8.0 and later commits the response upon successful completion of a servlet’s service method. You should disable this behaviour by setting com.ibm.ws.webcontainer.invokeFlushAfterService to false
+```
+
+(the default `FilterRegistrationBean` does not include the `ERROR` dispatcher type).
+
+#### Error Handling on WebSphere Application Server
+
+When deployed to a servlet container, a Spring Boot uses its error page filter to forward a request with an error status to the appropriate error page. The request can only be forwarded to the correct error page if the response has not already been committed. By default, WebSphere Application Server 8.0 and later commits the response upon successful completion of a servlet’s service method. You should disable this behaviour by setting `com.ibm.ws.webcontainer.invokeFlushAfterService`to `false`
-27.1.10 Spring HATEOAS
-If you’re developing a RESTful API that makes use of hypermedia, Spring Boot provides auto-configuration for Spring HATEOAS that works well with most applications. The auto-configuration replaces the need to use @EnableHypermediaSupport and registers a number of beans to ease building hypermedia-based applications including a LinkDiscoverers (for client side support) and an ObjectMapper configured to correctly marshal responses into the desired representation. The ObjectMapper will be customized based on the spring.jackson.* properties or a Jackson2ObjectMapperBuilder bean if one exists.
+### 27.1.10 Spring HATEOAS
-You can take control of Spring HATEOAS’s configuration by using @EnableHypermediaSupport. Note that this will disable the ObjectMapper customization described above.
+If you’re developing a RESTful API that makes use of hypermedia, Spring Boot provides auto-configuration for Spring HATEOAS that works well with most applications. The auto-configuration replaces the need to use `@EnableHypermediaSupport` and registers a number of beans to ease building hypermedia-based applications including a `LinkDiscoverers` (for client side support) and an `ObjectMapper` configured to correctly marshal responses into the desired representation. The `ObjectMapper` will be customized based on the `spring.jackson.*` properties or a `Jackson2ObjectMapperBuilder` bean if one exists.
-27.1.11 CORS support
-Cross-origin resource sharing (CORS) is a W3C specification implemented by most browsers that allows you to specify in a flexible way what kind of cross domain requests are authorized, instead of using some less secure and less powerful approaches like IFRAME or JSONP.
+You can take control of Spring HATEOAS’s configuration by using `@EnableHypermediaSupport`. Note that this will disable the `ObjectMapper` customization described above.
-As of version 4.2, Spring MVC supports CORS out of the box. Using controller method CORS configuration with @CrossOrigin annotations in your Spring Boot application does not require any specific configuration. Global CORS configuration can be defined by registering a WebMvcConfigurer bean with a customized addCorsMappings(CorsRegistry) method:
+### 27.1.11 CORS support
+[Cross-origin resource sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) (CORS) is a [W3C specification](https://www.w3.org/TR/cors/) implemented by [most browsers](https://caniuse.com/#feat=cors) that allows you to specify in a flexible way what kind of cross domain requests are authorized, instead of using some less secure and less powerful approaches like IFRAME or JSONP.
+
+As of version 4.2, Spring MVC [supports CORS](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#cors) out of the box. Using [controller method CORS configuration](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#_controller_method_cors_configuration) with [`@CrossOrigin`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/javadoc-api/org/springframework/web/bind/annotation/CrossOrigin.html) annotations in your Spring Boot application does not require any specific configuration. [Global CORS configuration](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#_global_cors_configuration) can be defined by registering a `WebMvcConfigurer` bean with a customized `addCorsMappings(CorsRegistry)` method:
+
+```
@Configuration
public class MyConfiguration {
@@ -3427,11 +3188,16 @@ public class MyConfiguration {
};
}
}
-27.2 JAX-RS and Jersey
-If you prefer the JAX-RS programming model for REST endpoints you can use one of the available implementations instead of Spring MVC. Jersey 1.x and Apache CXF work quite well out of the box if you just register their Servlet or Filter as a @Bean in your application context. Jersey 2.x has some native Spring support so we also provide auto-configuration support for it in Spring Boot together with a starter.
-To get started with Jersey 2.x just include the spring-boot-starter-jersey as a dependency and then you need one @Bean of type ResourceConfig in which you register all the endpoints:
+```
+
+## 27.2 JAX-RS and Jersey
+
+If you prefer the JAX-RS programming model for REST endpoints you can use one of the available implementations instead of Spring MVC. Jersey 1.x and Apache CXF work quite well out of the box if you just register their `Servlet` or `Filter` as a `@Bean` in your application context. Jersey 2.x has some native Spring support so we also provide auto-configuration support for it in Spring Boot together with a starter.
+To get started with Jersey 2.x just include the `spring-boot-starter-jersey` as a dependency and then you need one `@Bean` of type `ResourceConfig` in which you register all the endpoints:
+
+```
@Component
public class JerseyConfig extends ResourceConfig {
@@ -3440,13 +3206,18 @@ public class JerseyConfig extends ResourceConfig {
}
}
-[Warning]
-Jersey’s support for scanning executable archives is rather limited. For example, it cannot scan for endpoints in a package found in WEB-INF/classes when running an executable war file. To avoid this limitation, the packages method should not be used and endpoints should be registered individually using the register method as shown above.
-You can also register an arbitrary number of beans implementing ResourceConfigCustomizer for more advanced customizations.
+```
+
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| Jersey’s support for scanning executable archives is rather limited. For example, it cannot scan for endpoints in a package found in `WEB-INF/classes`when running an executable war file. To avoid this limitation, the `packages` method should not be used and endpoints should be registered individually using the `register` method as shown above. |
-All the registered endpoints should be @Components with HTTP resource annotations (@GET etc.), e.g.
+You can also register an arbitrary number of beans implementing `ResourceConfigCustomizer` for more advanced customizations.
+All the registered endpoints should be `@Components` with HTTP resource annotations (`@GET` etc.), e.g.
+
+```
@Component
@Path("/hello")
public class Endpoint {
@@ -3457,63 +3228,80 @@ public class Endpoint {
}
}
-Since the Endpoint is a Spring @Component its lifecycle is managed by Spring and you can @Autowired dependencies and inject external configuration with @Value. The Jersey servlet will be registered and mapped to /* by default. You can change the mapping by adding @ApplicationPath to your ResourceConfig.
-By default Jersey will be set up as a Servlet in a @Bean of type ServletRegistrationBean named jerseyServletRegistration. By default, the servlet will be initialized lazily but you can customize it with spring.jersey.servlet.load-on-startup .You can disable or override that bean by creating one of your own with the same name. You can also use a Filter instead of a Servlet by setting spring.jersey.type=filter (in which case the @Bean to replace or override is jerseyFilterRegistration). The servlet has an @Order which you can set with spring.jersey.filter.order. Both the Servlet and the Filter registrations can be given init parameters using spring.jersey.init.* to specify a map of properties.
+```
+
+Since the `Endpoint` is a Spring `@Component` its lifecycle is managed by Spring and you can `@Autowired` dependencies and inject external configuration with `@Value`. The Jersey servlet will be registered and mapped to `/*` by default. You can change the mapping by adding `@ApplicationPath` to your `ResourceConfig`.
+
+By default Jersey will be set up as a Servlet in a `@Bean` of type `ServletRegistrationBean` named `jerseyServletRegistration`. By default, the servlet will be initialized lazily but you can customize it with `spring.jersey.servlet.load-on-startup` .You can disable or override that bean by creating one of your own with the same name. You can also use a Filter instead of a Servlet by setting `spring.jersey.type=filter` (in which case the `@Bean` to replace or override is`jerseyFilterRegistration`). The servlet has an `@Order` which you can set with `spring.jersey.filter.order`. Both the Servlet and the Filter registrations can be given init parameters using `spring.jersey.init.*` to specify a map of properties.
+
+There is a [Jersey sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-jersey) so you can see how to set things up. There is also a [Jersey 1.x sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-jersey1). Note that in the Jersey 1.x sample that the spring-boot maven plugin has been configured to unpack some Jersey jars so they can be scanned by the JAX-RS implementation (because the sample asks for them to be scanned in its `Filter` registration). You may need to do the same if any of your JAX-RS resources are packaged as nested jars.
+
+## 27.3 Embedded servlet container support
+
+Spring Boot includes support for embedded Tomcat, Jetty, and Undertow servers. Most developers will simply use the appropriate ‘Starter’ to obtain a fully configured instance. By default the embedded server will listen for HTTP requests on port `8080`.
-There is a Jersey sample so you can see how to set things up. There is also a Jersey 1.x sample. Note that in the Jersey 1.x sample that the spring-boot maven plugin has been configured to unpack some Jersey jars so they can be scanned by the JAX-RS implementation (because the sample asks for them to be scanned in its Filter registration). You may need to do the same if any of your JAX-RS resources are packaged as nested jars.
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| If you choose to use Tomcat on CentOS be aware that, by default, a temporary directory is used to store compiled JSPs, file uploads etc. This directory may be deleted by `tmpwatch` while your application is running leading to failures. To avoid this, you may want to customize your `tmpwatch` configuration so that `tomcat.*` directories are not deleted, or configure `server.tomcat.basedir` so that embedded Tomcat uses a different location. |
-27.3 Embedded servlet container support
-Spring Boot includes support for embedded Tomcat, Jetty, and Undertow servers. Most developers will simply use the appropriate ‘Starter’ to obtain a fully configured instance. By default the embedded server will listen for HTTP requests on port 8080.
+### 27.3.1 Servlets, Filters, and listeners
-[Warning]
-If you choose to use Tomcat on CentOS be aware that, by default, a temporary directory is used to store compiled JSPs, file uploads etc. This directory may be deleted by tmpwatch while your application is running leading to failures. To avoid this, you may want to customize your tmpwatch configuration so that tomcat.* directories are not deleted, or configure server.tomcat.basedir so that embedded Tomcat uses a different location.
+When using an embedded servlet container you can register Servlets, Filters and all the listeners from the Servlet spec (e.g. `HttpSessionListener`) either by using Spring beans or by scanning for Servlet components.
-27.3.1 Servlets, Filters, and listeners
-When using an embedded servlet container you can register Servlets, Filters and all the listeners from the Servlet spec (e.g. HttpSessionListener) either by using Spring beans or by scanning for Servlet components.
+#### Registering Servlets, Filters, and listeners as Spring beans
-Registering Servlets, Filters, and listeners as Spring beans
-Any Servlet, Filter or Servlet *Listener instance that is a Spring bean will be registered with the embedded container. This can be particularly convenient if you want to refer to a value from your application.properties during configuration.
+Any `Servlet`, `Filter` or Servlet `*Listener` instance that is a Spring bean will be registered with the embedded container. This can be particularly convenient if you want to refer to a value from your `application.properties` during configuration.
-By default, if the context contains only a single Servlet it will be mapped to /. In the case of multiple Servlet beans the bean name will be used as a path prefix. Filters will map to /*.
+By default, if the context contains only a single Servlet it will be mapped to `/`. In the case of multiple Servlet beans the bean name will be used as a path prefix. Filters will map to `/*`.
-If convention-based mapping is not flexible enough you can use the ServletRegistrationBean, FilterRegistrationBean and ServletListenerRegistrationBean classes for complete control.
+If convention-based mapping is not flexible enough you can use the `ServletRegistrationBean`, `FilterRegistrationBean` and `ServletListenerRegistrationBean` classes for complete control.
-27.3.2 Servlet Context Initialization
-Embedded servlet containers will not directly execute the Servlet 3.0+ javax.servlet.ServletContainerInitializer interface, or Spring’s org.springframework.web.WebApplicationInitializer interface. This is an intentional design decision intended to reduce the risk that 3rd party libraries designed to run inside a war will break Spring Boot applications.
+### 27.3.2 Servlet Context Initialization
-If you need to perform servlet context initialization in a Spring Boot application, you should register a bean that implements the org.springframework.boot.context.embedded.ServletContextInitializer interface. The single onStartup method provides access to the ServletContext, and can easily be used as an adapter to an existing WebApplicationInitializer if necessary.
+Embedded servlet containers will not directly execute the Servlet 3.0+ `javax.servlet.ServletContainerInitializer` interface, or Spring’s`org.springframework.web.WebApplicationInitializer` interface. This is an intentional design decision intended to reduce the risk that 3rd party libraries designed to run inside a war will break Spring Boot applications.
-Scanning for Servlets, Filters, and listeners
-When using an embedded container, automatic registration of @WebServlet, @WebFilter, and @WebListener annotated classes can be enabled using @ServletComponentScan.
+If you need to perform servlet context initialization in a Spring Boot application, you should register a bean that implements the`org.springframework.boot.context.embedded.ServletContextInitializer` interface. The single `onStartup` method provides access to the `ServletContext`, and can easily be used as an adapter to an existing `WebApplicationInitializer` if necessary.
-[Tip]
-@ServletComponentScan will have no effect in a standalone container, where the container’s built-in discovery mechanisms will be used instead.
+#### Scanning for Servlets, Filters, and listeners
-27.3.3 The EmbeddedWebApplicationContext
-Under the hood Spring Boot uses a new type of ApplicationContext for embedded servlet container support. The EmbeddedWebApplicationContext is a special type of WebApplicationContext that bootstraps itself by searching for a single EmbeddedServletContainerFactory bean. Usually a TomcatEmbeddedServletContainerFactory, JettyEmbeddedServletContainerFactory, or UndertowEmbeddedServletContainerFactory will have been auto-configured.
+When using an embedded container, automatic registration of `@WebServlet`, `@WebFilter`, and `@WebListener` annotated classes can be enabled using `@ServletComponentScan`.
-[Note]
-You usually won’t need to be aware of these implementation classes. Most applications will be auto-configured and the appropriate ApplicationContext and EmbeddedServletContainerFactory will be created on your behalf.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| `@ServletComponentScan` will have no effect in a standalone container, where the container’s built-in discovery mechanisms will be used instead. |
-27.3.4 Customizing embedded servlet containers
-Common servlet container settings can be configured using Spring Environment properties. Usually you would define the properties in your application.properties file.
+### 27.3.3 The EmbeddedWebApplicationContext
+
+Under the hood Spring Boot uses a new type of `ApplicationContext` for embedded servlet container support. The `EmbeddedWebApplicationContext` is a special type of `WebApplicationContext` that bootstraps itself by searching for a single `EmbeddedServletContainerFactory` bean. Usually a `TomcatEmbeddedServletContainerFactory`, `JettyEmbeddedServletContainerFactory`, or `UndertowEmbeddedServletContainerFactory` will have been auto-configured.
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You usually won’t need to be aware of these implementation classes. Most applications will be auto-configured and the appropriate `ApplicationContext` and `EmbeddedServletContainerFactory` will be created on your behalf. |
+
+### 27.3.4 Customizing embedded servlet containers
+
+Common servlet container settings can be configured using Spring `Environment` properties. Usually you would define the properties in your `application.properties` file.
Common server settings include:
-Network settings: listen port for incoming HTTP requests (server.port), interface address to bind to server.address, etc.
-Session settings: whether the session is persistent (server.session.persistence), session timeout (server.session.timeout), location of session data (server.session.store-dir) and session-cookie configuration (server.session.cookie.*).
-Error management: location of the error page (server.error.path), etc.
-SSL
-HTTP compression
-Spring Boot tries as much as possible to expose common settings but this is not always possible. For those cases, dedicated namespaces offer server-specific customizations (see server.tomcat and server.undertow). For instance, access logs can be configured with specific features of the embedded servlet container.
+- Network settings: listen port for incoming HTTP requests (`server.port`), interface address to bind to `server.address`, etc.
+- Session settings: whether the session is persistent (`server.session.persistence`), session timeout (`server.session.timeout`), location of session data (`server.session.store-dir`) and session-cookie configuration (`server.session.cookie.*`).
+- Error management: location of the error page (`server.error.path`), etc.
+- [SSL](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-ssl)
+- [HTTP compression](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#how-to-enable-http-response-compression)
-[Tip]
-See the ServerProperties class for a complete list.
+Spring Boot tries as much as possible to expose common settings but this is not always possible. For those cases, dedicated namespaces offer server-specific customizations (see `server.tomcat` and `server.undertow`). For instance, [access logs](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-accesslogs) can be configured with specific features of the embedded servlet container.
-Programmatic customization
-If you need to configure your embedded servlet container programmatically you can register a Spring bean that implements the EmbeddedServletContainerCustomizer interface. EmbeddedServletContainerCustomizer provides access to the ConfigurableEmbeddedServletContainer which includes numerous customization setter methods.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| See the [`ServerProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java) class for a complete list. |
+#### Programmatic customization
+
+If you need to configure your embedded servlet container programmatically you can register a Spring bean that implements the `EmbeddedServletContainerCustomizer` interface. `EmbeddedServletContainerCustomizer` provides access to the`ConfigurableEmbeddedServletContainer` which includes numerous customization setter methods.
+
+```
import org.springframework.boot.context.embedded.*;
import org.springframework.stereotype.Component;
@@ -3526,9 +3314,14 @@ public class CustomizationBean implements EmbeddedServletContainerCustomizer {
}
}
-Customizing ConfigurableEmbeddedServletContainer directly
-If the above customization techniques are too limited, you can register the TomcatEmbeddedServletContainerFactory, JettyEmbeddedServletContainerFactory or UndertowEmbeddedServletContainerFactory bean yourself.
+```
+
+#### Customizing ConfigurableEmbeddedServletContainer directly
+
+If the above customization techniques are too limited, you can register the `TomcatEmbeddedServletContainerFactory`, `JettyEmbeddedServletContainerFactory` or `UndertowEmbeddedServletContainerFactory` bean yourself.
+
+```
@Bean
public EmbeddedServletContainerFactory servletContainer() {
TomcatEmbeddedServletContainerFactory factory = new TomcatEmbeddedServletContainerFactory();
@@ -3537,115 +3330,149 @@ public EmbeddedServletContainerFactory servletContainer() {
factory.addErrorPages(new ErrorPage(HttpStatus.NOT_FOUND, "/notfound.html"));
return factory;
}
+
+```
+
Setters are provided for many configuration options. Several protected method ‘hooks’ are also provided should you need to do something more exotic. See the source code documentation for details.
-27.3.5 JSP limitations
+### 27.3.5 JSP limitations
+
When running a Spring Boot application that uses an embedded servlet container (and is packaged as an executable archive), there are some limitations in the JSP support.
-With Tomcat it should work if you use war packaging, i.e. an executable war will work, and will also be deployable to a standard container (not limited to, but including Tomcat). An executable jar will not work because of a hard coded file pattern in Tomcat.
-With Jetty it should work if you use war packaging, i.e. an executable war will work, and will also be deployable to any standard container.
-Undertow does not support JSPs.
-Creating a custom error.jsp page won’t override the default view for error handling, custom error pages should be used instead.
-There is a JSP sample so you can see how to set things up.
+- With Tomcat it should work if you use war packaging, i.e. an executable war will work, and will also be deployable to a standard container (not limited to, but including Tomcat). An executable jar will not work because of a hard coded file pattern in Tomcat.
+- With Jetty it should work if you use war packaging, i.e. an executable war will work, and will also be deployable to any standard container.
+- Undertow does not support JSPs.
+- Creating a custom `error.jsp` page won’t override the default view for [error handling](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling), [custom error pages](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling-custom-error-pages) should be used instead.
-28. Security
-If Spring Security is on the classpath then web applications will be secure by default with ‘basic’ authentication on all HTTP endpoints. To add method-level security to a web application you can also add @EnableGlobalMethodSecurity with your desired settings. Additional information can be found in the Spring Security Reference.
+There is a [JSP sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-web-jsp) so you can see how to set things up.
-The default AuthenticationManager has a single user (‘user’ username and random password, printed at INFO level when the application starts up)
+## 28. Security
+If Spring Security is on the classpath then web applications will be secure by default with ‘basic’ authentication on all HTTP endpoints. To add method-level security to a web application you can also add `@EnableGlobalMethodSecurity` with your desired settings. Additional information can be found in the [Spring Security Reference](https://docs.spring.io/spring-security/site/docs/4.2.3.RELEASE/reference/htmlsingle#jc-method).
+
+The default `AuthenticationManager` has a single user (‘user’ username and random password, printed at INFO level when the application starts up)
+
+```
Using default security password: 78fa095d-3f4c-48b1-ad50-e24c31d5cf35
-[Note]
-If you fine-tune your logging configuration, ensure that the org.springframework.boot.autoconfigure.security category is set to log INFO messages, otherwise the default password will not be printed.
-You can change the password by providing a security.user.password. This and other useful properties are externalized via SecurityProperties (properties prefix "security").
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you fine-tune your logging configuration, ensure that the `org.springframework.boot.autoconfigure.security` category is set to log `INFO`messages, otherwise the default password will not be printed. |
+
+You can change the password by providing a `security.user.password`. This and other useful properties are externalized via [`SecurityProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityProperties.java) (properties prefix "security").
-The default security configuration is implemented in SecurityAutoConfiguration and in the classes imported from there (SpringBootWebSecurityConfiguration for web security and AuthenticationManagerConfiguration for authentication configuration which is also relevant in non-web applications). To switch off the default web application security configuration completely you can add a bean with @EnableWebSecurity (this does not disable the authentication manager configuration or Actuator’s security). To customize it you normally use external properties and beans of type WebSecurityConfigurerAdapter (e.g. to add form-based login).
+The default security configuration is implemented in `SecurityAutoConfiguration` and in the classes imported from there (`SpringBootWebSecurityConfiguration` for web security and `AuthenticationManagerConfiguration` for authentication configuration which is also relevant in non-web applications). To switch off the default web application security configuration completely you can add a bean with `@EnableWebSecurity` (this does not disable the authentication manager configuration or Actuator’s security). To customize it you normally use external properties and beans of type`WebSecurityConfigurerAdapter` (e.g. to add form-based login).
-[Note]
-If you add @EnableWebSecurity and also disable Actuator security, you will get the default form-based login for the entire application unless you add a custom WebSecurityConfigurerAdapter.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you add `@EnableWebSecurity` and also disable Actuator security, you will get the default form-based login for the entire application unless you add a custom `WebSecurityConfigurerAdapter`. |
-To also switch off the authentication manager configuration you can add a bean of type AuthenticationManager, or else configure the global AuthenticationManager by autowiring an AuthenticationManagerBuilder into a method in one of your @Configuration classes. There are several secure applications in the Spring Boot samples to get you started with common use cases.
+To also switch off the authentication manager configuration you can add a bean of type `AuthenticationManager`, or else configure the global `AuthenticationManager` by autowiring an `AuthenticationManagerBuilder` into a method in one of your `@Configuration` classes. There are several secure applications in the [Spring Boot samples](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/) to get you started with common use cases.
The basic features you get out of the box in a web application are:
-An AuthenticationManager bean with in-memory store and a single user (see SecurityProperties.User for the properties of the user).
-Ignored (insecure) paths for common static resource locations (/css/**, /js/**, /images/**, /webjars/** and **/favicon.ico).
-HTTP Basic security for all other endpoints.
-Security events published to Spring’s ApplicationEventPublisher (successful and unsuccessful authentication and access denied).
-Common low-level features (HSTS, XSS, CSRF, caching) provided by Spring Security are on by default.
-All of the above can be switched on and off or modified using external properties (security.*). To override the access rules without changing any other auto-configured features add a @Bean of type WebSecurityConfigurerAdapter with @Order(SecurityProperties.ACCESS_OVERRIDE_ORDER) and configure it to meet your needs.
+- An `AuthenticationManager` bean with in-memory store and a single user (see `SecurityProperties.User` for the properties of the user).
+- Ignored (insecure) paths for common static resource locations (`/css/**`, `/js/**`, `/images/**`, `/webjars/**` and `**/favicon.ico`).
+- HTTP Basic security for all other endpoints.
+- Security events published to Spring’s `ApplicationEventPublisher` (successful and unsuccessful authentication and access denied).
+- Common low-level features (HSTS, XSS, CSRF, caching) provided by Spring Security are on by default.
-[Note]
-By default, a WebSecurityConfigurerAdapter will match any path. If you don’t want to completely override Spring Boot’s auto-configured access rules, your adapter must explicitly configure the paths that you do want to override.
+All of the above can be switched on and off or modified using external properties (`security.*`). To override the access rules without changing any other auto-configured features add a `@Bean` of type `WebSecurityConfigurerAdapter` with `@Order(SecurityProperties.ACCESS_OVERRIDE_ORDER)` and configure it to meet your needs.
-28.1 OAuth2
-If you have spring-security-oauth2 on your classpath you can take advantage of some auto-configuration to make it easy to set up Authorization or Resource Server. For full details, see the Spring Security OAuth 2 Developers Guide.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| By default, a `WebSecurityConfigurerAdapter` will match any path. If you don’t want to completely override Spring Boot’s auto-configured access rules, your adapter must explicitly configure the paths that you do want to override. |
-28.1.1 Authorization Server
-To create an Authorization Server and grant access tokens you need to use @EnableAuthorizationServer and provide security.oauth2.client.client-id and security.oauth2.client.client-secret] properties. The client will be registered for you in an in-memory repository.
+## 28.1 OAuth2
+
+If you have `spring-security-oauth2` on your classpath you can take advantage of some auto-configuration to make it easy to set up Authorization or Resource Server. For full details, see the [Spring Security OAuth 2 Developers Guide](https://projects.spring.io/spring-security-oauth/docs/oauth2.html).
+
+### 28.1.1 Authorization Server
+
+To create an Authorization Server and grant access tokens you need to use `@EnableAuthorizationServer` and provide `security.oauth2.client.client-id` and `security.oauth2.client.client-secret]` properties. The client will be registered for you in an in-memory repository.
Having done that you will be able to use the client credentials to create an access token, for example:
+```
$ curl client:secret@localhost:8080/oauth/token -d grant_type=password -d username=user -d password=pwd
-The basic auth credentials for the /token endpoint are the client-id and client-secret. The user credentials are the normal Spring Security user details (which default in Spring Boot to “user” and a random password).
-To switch off the auto-configuration and configure the Authorization Server features yourself just add a @Bean of type AuthorizationServerConfigurer.
+```
+
+The basic auth credentials for the `/token` endpoint are the `client-id` and `client-secret`. The user credentials are the normal Spring Security user details (which default in Spring Boot to “user” and a random password).
-28.1.2 Resource Server
-To use the access token you need a Resource Server (which can be the same as the Authorization Server). Creating a Resource Server is easy, just add @EnableResourceServer and provide some configuration to allow the server to decode access tokens. If your application is also an Authorization Server it already knows how to decode tokens, so there is nothing else to do. If your app is a standalone service then you need to give it some more configuration, one of the following options:
+To switch off the auto-configuration and configure the Authorization Server features yourself just add a `@Bean` of type `AuthorizationServerConfigurer`.
-security.oauth2.resource.user-info-uri to use the /me resource (e.g. https://uaa.run.pivotal.io/userinfo on Pivotal Web Services (PWS))
-security.oauth2.resource.token-info-uri to use the token decoding endpoint (e.g. https://uaa.run.pivotal.io/check_token on PWS).
-If you specify both the user-info-uri and the token-info-uri then you can set a flag to say that one is preferred over the other (prefer-token-info=true is the default).
+### 28.1.2 Resource Server
-Alternatively (instead of user-info-uri or token-info-uri) if the tokens are JWTs you can configure a security.oauth2.resource.jwt.key-value to decode them locally (where the key is a verification key). The verification key value is either a symmetric secret or PEM-encoded RSA public key. If you don’t have the key and it’s public you can provide a URI where it can be downloaded (as a JSON object with a “value” field) with security.oauth2.resource.jwt.key-uri. E.g. on PWS:
+To use the access token you need a Resource Server (which can be the same as the Authorization Server). Creating a Resource Server is easy, just add`@EnableResourceServer` and provide some configuration to allow the server to decode access tokens. If your application is also an Authorization Server it already knows how to decode tokens, so there is nothing else to do. If your app is a standalone service then you need to give it some more configuration, one of the following options:
+- `security.oauth2.resource.user-info-uri` to use the `/me` resource (e.g. `https://uaa.run.pivotal.io/userinfo` on Pivotal Web Services (PWS))
+- `security.oauth2.resource.token-info-uri` to use the token decoding endpoint (e.g. `https://uaa.run.pivotal.io/check_token` on PWS).
+
+If you specify both the `user-info-uri` and the `token-info-uri` then you can set a flag to say that one is preferred over the other (`prefer-token-info=true`is the default).
+
+Alternatively (instead of `user-info-uri` or `token-info-uri`) if the tokens are JWTs you can configure a `security.oauth2.resource.jwt.key-value` to decode them locally (where the key is a verification key). The verification key value is either a symmetric secret or PEM-encoded RSA public key. If you don’t have the key and it’s public you can provide a URI where it can be downloaded (as a JSON object with a “value” field) with `security.oauth2.resource.jwt.key-uri`. E.g. on PWS:
+
+```
$ curl https://uaa.run.pivotal.io/token_key
{"alg":"SHA256withRSA","value":"-----BEGIN PUBLIC KEY-----\nMIIBI...\n-----END PUBLIC KEY-----\n"}
-Additionally, if your authorization server has an endpoint that returns a set of JSON Web Keys(JWKs), you can configure security.oauth2.resource.jwk.key-set-uri. E.g. on PWS:
+```
+
+Additionally, if your authorization server has an endpoint that returns a set of JSON Web Keys(JWKs), you can configure `security.oauth2.resource.jwk.key-set-uri`. E.g. on PWS:
+
+```
$ curl https://uaa.run.pivotal.io/token_keys
{"keys":[{"kid":"key-1","alg":"RS256","value":"-----BEGIN PUBLIC KEY-----\nMIIBI...\n-----END PUBLIC KEY-----\n"]}
-[Note]
-Configuring both JWT and JWK properties will cause an error. Only one of security.oauth2.resource.jwt.key-uri (or security.oauth2.resource.jwt.key-value) and security.oauth2.resource.jwk.key-set-uri should be configured.
-[Warning]
-If you use the security.oauth2.resource.jwt.key-uri or `security.oauth2.resource.jwk.key-set-uri, ` the authorization server needs to be running when your application starts up. It will log a warning if it can’t find the key, and tell you what to do to fix it.
+```
-OAuth2 resources are protected by a filter chain with order security.oauth2.resource.filter-order and the default is after the filter protecting the actuator endpoints by default (so actuator endpoints will stay on HTTP Basic unless you change the order).
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Configuring both JWT and JWK properties will cause an error. Only one of `security.oauth2.resource.jwt.key-uri` (or `security.oauth2.resource.jwt.key-value`) and `security.oauth2.resource.jwk.key-set-uri` should be configured. |
-28.2 Token Type in User Info
-Google, and certain other 3rd party identity providers, are more strict about the token type name that is sent in the headers to the user info endpoint. The default is “Bearer” which suits most providers and matches the spec, but if you need to change it you can set security.oauth2.resource.token-type.
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| If you use the `security.oauth2.resource.jwt.key-uri` or `security.oauth2.resource.jwk.key-set-uri, ` the authorization server needs to be running when your application starts up. It will log a warning if it can’t find the key, and tell you what to do to fix it. |
-28.3 Customizing the User Info RestTemplate
-If you have a user-info-uri, the resource server features use an OAuth2RestTemplate internally to fetch user details for authentication. This is provided as a @Bean of type UserInfoRestTemplateFactory. The default should be fine for most providers, but occasionally you might need to add additional interceptors, or change the request authenticator (which is how the token gets attached to outgoing requests). To add a customization just create a bean of type UserInfoRestTemplateCustomizer - it has a single method that will be called after the bean is created but before it is initialized. The rest template that is being customized here is only used internally to carry out authentication. Alternatively, you could define your own UserInfoRestTemplateFactory @Bean to take full control.
+OAuth2 resources are protected by a filter chain with order `security.oauth2.resource.filter-order` and the default is after the filter protecting the actuator endpoints by default (so actuator endpoints will stay on HTTP Basic unless you change the order).
-[Tip]
-To set an RSA key value in YAML use the “pipe” continuation marker to split it over multiple lines (“|”) and remember to indent the key value (it’s a standard YAML language feature). Example:
+## 28.2 Token Type in User Info
-security:
- oauth2:
- resource:
- jwt:
- keyValue: |
- -----BEGIN PUBLIC KEY-----
- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC...
- -----END PUBLIC KEY-----
-28.3.1 Client
-To make your web-app into an OAuth2 client you can simply add @EnableOAuth2Client and Spring Boot will create a OAuth2ClientContext and OAuth2ProtectedResourceDetails that are necessary to create an OAuth2RestOperations. Spring Boot does not automatically create such bean but you can easily create your own:
+Google, and certain other 3rd party identity providers, are more strict about the token type name that is sent in the headers to the user info endpoint. The default is “Bearer” which suits most providers and matches the spec, but if you need to change it you can set `security.oauth2.resource.token-type`.
+
+## 28.3 Customizing the User Info RestTemplate
+
+If you have a `user-info-uri`, the resource server features use an `OAuth2RestTemplate` internally to fetch user details for authentication. This is provided as a `@Bean` of type `UserInfoRestTemplateFactory`. The default should be fine for most providers, but occasionally you might need to add additional interceptors, or change the request authenticator (which is how the token gets attached to outgoing requests). To add a customization just create a bean of type `UserInfoRestTemplateCustomizer` - it has a single method that will be called after the bean is created but before it is initialized. The rest template that is being customized here is *only* used internally to carry out authentication. Alternatively, you could define your own `UserInfoRestTemplateFactory` `@Bean` to take full control.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| To set an RSA key value in YAML use the “pipe” continuation marker to split it over multiple lines (“\|”) and remember to indent the key value (it’s a standard YAML language feature). Example:`security: oauth2: resource: jwt: keyValue: | -----BEGIN PUBLIC KEY----- MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKC... -----END PUBLIC KEY-----` |
+
+### 28.3.1 Client
+
+To make your web-app into an OAuth2 client you can simply add `@EnableOAuth2Client` and Spring Boot will create a `OAuth2ClientContext` and `OAuth2ProtectedResourceDetails` that are necessary to create an `OAuth2RestOperations`. Spring Boot does not automatically create such bean but you can easily create your own:
+```
@Bean
public OAuth2RestTemplate oauth2RestTemplate(OAuth2ClientContext oauth2ClientContext,
OAuth2ProtectedResourceDetails details) {
return new OAuth2RestTemplate(details, oauth2ClientContext);
}
-[Note]
-You may want to add a qualifier and review your configuration as more than one RestTemplate may be defined in your application.
-This configuration uses security.oauth2.client.* as credentials (the same as you might be using in the Authorization Server), but in addition it will need to know the authorization and token URIs in the Authorization Server. For example:
+```
-application.yml.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You may want to add a qualifier and review your configuration as more than one `RestTemplate` may be defined in your application. |
+This configuration uses `security.oauth2.client.*` as credentials (the same as you might be using in the Authorization Server), but in addition it will need to know the authorization and token URIs in the Authorization Server. For example:
+
+**application.yml.**
+
+```
security:
oauth2:
client:
@@ -3654,31 +3481,46 @@ security:
accessTokenUri: https://github.com/login/oauth/access_token
userAuthorizationUri: https://github.com/login/oauth/authorize
clientAuthenticationScheme: form
-An application with this configuration will redirect to Github for authorization when you attempt to use the OAuth2RestTemplate. If you are already signed into Github you won’t even notice that it has authenticated. These specific credentials will only work if your application is running on port 8080 (register your own client app in Github or other provider for more flexibility).
-To limit the scope that the client asks for when it obtains an access token you can set security.oauth2.client.scope (comma separated or an array in YAML). By default the scope is empty and it is up to Authorization Server to decide what the defaults should be, usually depending on the settings in the client registration that it holds.
+```
+
+
-[Note]
-There is also a setting for security.oauth2.client.client-authentication-scheme which defaults to “header” (but you might need to set it to “form” if, like Github for instance, your OAuth2 provider doesn’t like header authentication). In fact, the security.oauth2.client.* properties are bound to an instance of AuthorizationCodeResourceDetails so all its properties can be specified.
+An application with this configuration will redirect to Github for authorization when you attempt to use the `OAuth2RestTemplate`. If you are already signed into Github you won’t even notice that it has authenticated. These specific credentials will only work if your application is running on port 8080 (register your own client app in Github or other provider for more flexibility).
-[Tip]
-In a non-web application you can still create an OAuth2RestOperations and it is still wired into the security.oauth2.client.* configuration. In this case it is a “client credentials token grant” you will be asking for if you use it (and there is no need to use @EnableOAuth2Client or @EnableOAuth2Sso). To prevent that infrastructure to be defined, just remove the security.oauth2.client.client-id from your configuration (or make it the empty string).
+To limit the scope that the client asks for when it obtains an access token you can set `security.oauth2.client.scope` (comma separated or an array in YAML). By default the scope is empty and it is up to Authorization Server to decide what the defaults should be, usually depending on the settings in the client registration that it holds.
-28.3.2 Single Sign On
-An OAuth2 Client can be used to fetch user details from the provider (if such features are available) and then convert them into an Authentication token for Spring Security. The Resource Server above support this via the user-info-uri property This is the basis for a Single Sign On (SSO) protocol based on OAuth2, and Spring Boot makes it easy to participate by providing an annotation @EnableOAuth2Sso. The Github client above can protect all its resources and authenticate using the Github /user/ endpoint, by adding that annotation and declaring where to find the endpoint (in addition to the security.oauth2.client.* configuration already listed above):
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| There is also a setting for `security.oauth2.client.client-authentication-scheme` which defaults to “header” (but you might need to set it to “form” if, like Github for instance, your OAuth2 provider doesn’t like header authentication). In fact, the `security.oauth2.client.*` properties are bound to an instance of `AuthorizationCodeResourceDetails` so all its properties can be specified. |
-application.yml.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| In a non-web application you can still create an `OAuth2RestOperations` and it is still wired into the `security.oauth2.client.*` configuration. In this case it is a “client credentials token grant” you will be asking for if you use it (and there is no need to use `@EnableOAuth2Client` or `@EnableOAuth2Sso`). To prevent that infrastructure to be defined, just remove the `security.oauth2.client.client-id` from your configuration (or make it the empty string). |
+### 28.3.2 Single Sign On
+
+An OAuth2 Client can be used to fetch user details from the provider (if such features are available) and then convert them into an `Authentication` token for Spring Security. The Resource Server above support this via the `user-info-uri` property This is the basis for a Single Sign On (SSO) protocol based on OAuth2, and Spring Boot makes it easy to participate by providing an annotation `@EnableOAuth2Sso`. The Github client above can protect all its resources and authenticate using the Github `/user/` endpoint, by adding that annotation and declaring where to find the endpoint (in addition to the `security.oauth2.client.*` configuration already listed above):
+
+**application.yml.**
+
+```
security:
oauth2:
...
resource:
userInfoUri: https://api.github.com/user
preferTokenInfo: false
-Since all paths are secure by default, there is no “home” page that you can show to unauthenticated users and invite them to login (by visiting the /login path, or the path specified by security.oauth2.sso.login-path).
-To customize the access rules or paths to protect, so you can add a “home” page for instance, @EnableOAuth2Sso can be added to a WebSecurityConfigurerAdapter and the annotation will cause it to be decorated and enhanced with the necessary pieces to get the /login path working. For example, here we simply allow unauthenticated access to the home page at "/" and keep the default for everything else:
+```
+
+
+Since all paths are secure by default, there is no “home” page that you can show to unauthenticated users and invite them to login (by visiting the `/login` path, or the path specified by `security.oauth2.sso.login-path`).
+
+To customize the access rules or paths to protect, so you can add a “home” page for instance, `@EnableOAuth2Sso` can be added to a `WebSecurityConfigurerAdapter` and the annotation will cause it to be decorated and enhanced with the necessary pieces to get the `/login` path working. For example, here we simply allow unauthenticated access to the home page at "/" and keep the default for everything else:
+
+```
@Configuration
static class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
@@ -3693,36 +3535,48 @@ static class WebSecurityConfiguration extends WebSecurityConfigurerAdapter {
}
}
-28.4 Actuator Security
+
+```
+
+## 28.4 Actuator Security
+
If the Actuator is also in use, you will find:
-The management endpoints are secure even if the application endpoints are insecure.
-Security events are transformed into AuditEvent instances and published to the AuditEventRepository.
-The default user will have the ACTUATOR role as well as the USER role.
-The Actuator security features can be modified using external properties (management.security.*). To override the application access rules add a @Bean of type WebSecurityConfigurerAdapter and use @Order(SecurityProperties.ACCESS_OVERRIDE_ORDER) if you don’t want to override the actuator access rules, or @Order(ManagementServerProperties.ACCESS_OVERRIDE_ORDER) if you do want to override the actuator access rules.
+- The management endpoints are secure even if the application endpoints are insecure.
+- Security events are transformed into `AuditEvent` instances and published to the `AuditEventRepository`.
+- The default user will have the `ACTUATOR` role as well as the `USER` role.
+
+The Actuator security features can be modified using external properties (`management.security.*`). To override the application access rules add a `@Bean` of type `WebSecurityConfigurerAdapter` and use `@Order(SecurityProperties.ACCESS_OVERRIDE_ORDER)` if you *don’t* want to override the actuator access rules, or `@Order(ManagementServerProperties.ACCESS_OVERRIDE_ORDER)` if you *do* want to override the actuator access rules.
+
+## 29. Working with SQL databases
-29. Working with SQL databases
-The Spring Framework provides extensive support for working with SQL databases. From direct JDBC access using JdbcTemplate to complete ‘object relational mapping’ technologies such as Hibernate. Spring Data provides an additional level of functionality, creating Repository implementations directly from interfaces and using conventions to generate queries from your method names.
+The Spring Framework provides extensive support for working with SQL databases. From direct JDBC access using `JdbcTemplate` to complete ‘object relational mapping’ technologies such as Hibernate. Spring Data provides an additional level of functionality, creating `Repository` implementations directly from interfaces and using conventions to generate queries from your method names.
-29.1 Configure a DataSource
-Java’s javax.sql.DataSource interface provides a standard method of working with database connections. Traditionally a DataSource uses a URL along with some credentials to establish a database connection.
+## 29.1 Configure a DataSource
-[Tip]
-Check also the ‘How-to’ section for more advanced examples, typically to take full control over the configuration of the DataSource.
+Java’s `javax.sql.DataSource` interface provides a standard method of working with database connections. Traditionally a DataSource uses a `URL` along with some credentials to establish a database connection.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Check also [the ‘How-to’ section](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-configure-a-datasource) for more advanced examples, typically to take full control over the configuration of the DataSource. |
+
+### 29.1.1 Embedded Database Support
-29.1.1 Embedded Database Support
It’s often convenient to develop applications using an in-memory embedded database. Obviously, in-memory databases do not provide persistent storage; you will need to populate your database when your application starts and be prepared to throw away data when your application ends.
-[Tip]
-The ‘How-to’ section includes a section on how to initialize a database
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The ‘How-to’ section includes a *section on how to initialize a database* |
-Spring Boot can auto-configure embedded H2, HSQL and Derby databases. You don’t need to provide any connection URLs, simply include a build dependency to the embedded database that you want to use.
+Spring Boot can auto-configure embedded [H2](http://www.h2database.com/), [HSQL](http://hsqldb.org/) and [Derby](https://db.apache.org/derby/) databases. You don’t need to provide any connection URLs, simply include a build dependency to the embedded database that you want to use.
-[Note]
-If you are using this feature in your tests, you may notice that the same database is reused by your whole test suite regardless of the number of application contexts that you use. If you want to make sure that each context has a separate embedded database, you should set spring.datasource.generate-unique-name to true.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you are using this feature in your tests, you may notice that the same database is reused by your whole test suite regardless of the number of application contexts that you use. If you want to make sure that each context has a separate embedded database, you should set `spring.datasource.generate-unique-name` to `true`. |
For example, typical POM dependencies would be:
+```
org.springframework.boot
spring-boot-starter-data-jpa
@@ -3732,46 +3586,63 @@ For example, typical POM dependencies would be:
hsqldb
runtime
-[Note]
-You need a dependency on spring-jdbc for an embedded database to be auto-configured. In this example it’s pulled in transitively via spring-boot-starter-data-jpa.
-[Tip]
-If, for whatever reason, you do configure the connection URL for an embedded database, care should be taken to ensure that the database’s automatic shutdown is disabled. If you’re using H2 you should use DB_CLOSE_ON_EXIT=FALSE to do so. If you’re using HSQLDB, you should ensure that shutdown=true is not used. Disabling the database’s automatic shutdown allows Spring Boot to control when the database is closed, thereby ensuring that it happens once access to the database is no longer needed.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You need a dependency on `spring-jdbc` for an embedded database to be auto-configured. In this example it’s pulled in transitively via`spring-boot-starter-data-jpa`. |
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If, for whatever reason, you do configure the connection URL for an embedded database, care should be taken to ensure that the database’s automatic shutdown is disabled. If you’re using H2 you should use `DB_CLOSE_ON_EXIT=FALSE` to do so. If you’re using HSQLDB, you should ensure that `shutdown=true` is not used. Disabling the database’s automatic shutdown allows Spring Boot to control when the database is closed, thereby ensuring that it happens once access to the database is no longer needed. |
-29.1.2 Connection to a production database
-Production database connections can also be auto-configured using a pooling DataSource. Here’s the algorithm for choosing a specific implementation:
+### 29.1.2 Connection to a production database
-We prefer the Tomcat pooling DataSource for its performance and concurrency, so if that is available we always choose it.
-Otherwise, if HikariCP is available we will use it.
-If neither the Tomcat pooling datasource nor HikariCP are available and if Commons DBCP is available we will use it, but we don’t recommend it in production and its support is deprecated.
-Lastly, if Commons DBCP2 is available we will use it.
-If you use the spring-boot-starter-jdbc or spring-boot-starter-data-jpa ‘starters’ you will automatically get a dependency to tomcat-jdbc.
+Production database connections can also be auto-configured using a pooling `DataSource`. Here’s the algorithm for choosing a specific implementation:
-[Note]
-You can bypass that algorithm completely and specify the connection pool to use via the spring.datasource.type property. This is especially important if you are running your application in a Tomcat container as tomcat-jdbc is provided by default.
+- We prefer the Tomcat pooling `DataSource` for its performance and concurrency, so if that is available we always choose it.
+- Otherwise, if HikariCP is available we will use it.
+- If neither the Tomcat pooling datasource nor HikariCP are available and if Commons DBCP is available we will use it, but we don’t recommend it in production and its support is deprecated.
+- Lastly, if Commons DBCP2 is available we will use it.
-[Tip]
-Additional connection pools can always be configured manually. If you define your own DataSource bean, auto-configuration will not occur.
+If you use the `spring-boot-starter-jdbc` or `spring-boot-starter-data-jpa` ‘starters’ you will automatically get a dependency to `tomcat-jdbc`.
-DataSource configuration is controlled by external configuration properties in spring.datasource.*. For example, you might declare the following section in application.properties:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can bypass that algorithm completely and specify the connection pool to use via the `spring.datasource.type` property. This is especially important if you are running your application in a Tomcat container as `tomcat-jdbc` is provided by default. |
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Additional connection pools can always be configured manually. If you define your own `DataSource` bean, auto-configuration will not occur. |
+
+DataSource configuration is controlled by external configuration properties in `spring.datasource.*`. For example, you might declare the following section in`application.properties`:
+
+```
spring.datasource.url=jdbc:mysql://localhost/test
spring.datasource.username=dbuser
spring.datasource.password=dbpass
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
-[Note]
-You should at least specify the url using the spring.datasource.url property or Spring Boot will attempt to auto-configure an embedded database.
-[Tip]
-You often won’t need to specify the driver-class-name since Spring boot can deduce it for most databases from the url.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You should at least specify the url using the `spring.datasource.url` property or Spring Boot will attempt to auto-configure an embedded database. |
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You often won’t need to specify the `driver-class-name` since Spring boot can deduce it for most databases from the `url`. |
-[Note]
-For a pooling DataSource to be created we need to be able to verify that a valid Driver class is available, so we check for that before doing anything. I.e. if you set spring.datasource.driver-class-name=com.mysql.jdbc.Driver then that class has to be loadable.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| For a pooling `DataSource` to be created we need to be able to verify that a valid `Driver` class is available, so we check for that before doing anything. I.e. if you set `spring.datasource.driver-class-name=com.mysql.jdbc.Driver` then that class has to be loadable. |
-See DataSourceProperties for more of the supported options. These are the standard options that work regardless of the actual implementation. It is also possible to fine-tune implementation-specific settings using their respective prefix (spring.datasource.tomcat.*, spring.datasource.hikari.*, and spring.datasource.dbcp2.*). Refer to the documentation of the connection pool implementation you are using for more details.
+See [`DataSourceProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceProperties.java) for more of the supported options. These are the standard options that work regardless of the actual implementation. It is also possible to fine-tune implementation-specific settings using their respective prefix (`spring.datasource.tomcat.*`, `spring.datasource.hikari.*`, and `spring.datasource.dbcp2.*`). Refer to the documentation of the connection pool implementation you are using for more details.
-For instance, if you are using the Tomcat connection pool you could customize many additional settings:
+For instance, if you are using the [Tomcat connection pool](https://tomcat.apache.org/tomcat-8.0-doc/jdbc-pool.html#Common_Attributes) you could customize many additional settings:
+```
# Number of ms to wait before throwing an exception if no connection is available.
spring.datasource.tomcat.max-wait=10000
@@ -3780,15 +3651,25 @@ spring.datasource.tomcat.max-active=50
# Validate the connection before borrowing it from the pool.
spring.datasource.tomcat.test-on-borrow=true
-29.1.3 Connection to a JNDI DataSource
+
+```
+
+### 29.1.3 Connection to a JNDI DataSource
+
If you are deploying your Spring Boot application to an Application Server you might want to configure and manage your DataSource using your Application Servers built-in features and access it using JNDI.
-The spring.datasource.jndi-name property can be used as an alternative to the spring.datasource.url, spring.datasource.username and spring.datasource.password properties to access the DataSource from a specific JNDI location. For example, the following section in application.properties shows how you can access a JBoss AS defined DataSource:
+The `spring.datasource.jndi-name` property can be used as an alternative to the `spring.datasource.url`, `spring.datasource.username` and `spring.datasource.password` properties to access the `DataSource` from a specific JNDI location. For example, the following section in `application.properties` shows how you can access a JBoss AS defined `DataSource`:
+```
spring.datasource.jndi-name=java:jboss/datasources/customers
-29.2 Using JdbcTemplate
-Spring’s JdbcTemplate and NamedParameterJdbcTemplate classes are auto-configured and you can @Autowire them directly into your own beans:
+```
+
+## 29.2 Using JdbcTemplate
+
+Spring’s `JdbcTemplate` and `NamedParameterJdbcTemplate` classes are auto-configured and you can `@Autowire` them directly into your own beans:
+
+```
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;
@@ -3806,23 +3687,32 @@ public class MyBean {
// ...
}
-29.3 JPA and ‘Spring Data’
-The Java Persistence API is a standard technology that allows you to ‘map’ objects to relational databases. The spring-boot-starter-data-jpa POM provides a quick way to get started. It provides the following key dependencies:
-Hibernate — One of the most popular JPA implementations.
-Spring Data JPA — Makes it easy to implement JPA-based repositories.
-Spring ORMs — Core ORM support from the Spring Framework.
-[Tip]
-We won’t go into too many details of JPA or Spring Data here. You can follow the ‘Accessing Data with JPA’ guide from spring.io and read the Spring Data JPA and Hibernate reference documentation.
+```
+
+## 29.3 JPA and ‘Spring Data’
+
+The Java Persistence API is a standard technology that allows you to ‘map’ objects to relational databases. The `spring-boot-starter-data-jpa` POM provides a quick way to get started. It provides the following key dependencies:
-[Note]
-By default, Spring Boot uses Hibernate 5.0.x. However it’s also possible to use 4.3.x or 5.2.x if you wish. Please refer to the Hibernate 4 and Hibernate 5.2 samples to see how to do so.
+- Hibernate — One of the most popular JPA implementations.
+- Spring Data JPA — Makes it easy to implement JPA-based repositories.
+- Spring ORMs — Core ORM support from the Spring Framework.
-29.3.1 Entity Classes
-Traditionally, JPA ‘Entity’ classes are specified in a persistence.xml file. With Spring Boot this file is not necessary and instead ‘Entity Scanning’ is used. By default all packages below your main configuration class (the one annotated with @EnableAutoConfiguration or @SpringBootApplication) will be searched.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| We won’t go into too many details of JPA or Spring Data here. You can follow the [‘Accessing Data with JPA’](https://spring.io/guides/gs/accessing-data-jpa/) guide from [spring.io](https://spring.io/) and read the [Spring Data JPA](https://projects.spring.io/spring-data-jpa/) and [Hibernate](http://hibernate.org/orm/documentation/) reference documentation. |
-Any classes annotated with @Entity, @Embeddable or @MappedSuperclass will be considered. A typical entity class would look something like this:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| By default, Spring Boot uses Hibernate 5.0.x. However it’s also possible to use 4.3.x or 5.2.x if you wish. Please refer to the [Hibernate 4](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-hibernate4) and [Hibernate 5.2](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-hibernate52)samples to see how to do so. |
+### 29.3.1 Entity Classes
+
+Traditionally, JPA ‘Entity’ classes are specified in a `persistence.xml` file. With Spring Boot this file is not necessary and instead ‘Entity Scanning’ is used. By default all packages below your main configuration class (the one annotated with `@EnableAutoConfiguration` or `@SpringBootApplication`) will be searched.
+
+Any classes annotated with `@Entity`, `@Embeddable` or `@MappedSuperclass` will be considered. A typical entity class would look something like this:
+
+```
package com.example.myapp.domain;
import java.io.Serializable;
@@ -3864,18 +3754,24 @@ public class City implements Serializable {
// ... etc
}
-[Tip]
-You can customize entity scanning locations using the @EntityScan annotation. See the Section 77.4, “Separate @Entity definitions from Spring configuration” how-to.
-29.3.2 Spring Data JPA Repositories
-Spring Data JPA repositories are interfaces that you can define to access data. JPA queries are created automatically from your method names. For example, a CityRepository interface might declare a findAllByState(String state) method to find all cities in a given state.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You can customize entity scanning locations using the `@EntityScan` annotation. See the *Section 77.4, “Separate @Entity definitions from Spring configuration”* how-to. |
-For more complex queries you can annotate your method using Spring Data’s Query annotation.
+### 29.3.2 Spring Data JPA Repositories
-Spring Data repositories usually extend from the Repository or CrudRepository interfaces. If you are using auto-configuration, repositories will be searched from the package containing your main configuration class (the one annotated with @EnableAutoConfiguration or @SpringBootApplication) down.
+Spring Data JPA repositories are interfaces that you can define to access data. JPA queries are created automatically from your method names. For example, a `CityRepository` interface might declare a `findAllByState(String state)` method to find all cities in a given state.
+
+For more complex queries you can annotate your method using Spring Data’s [`Query`](https://docs.spring.io/spring-data/jpa/docs/current/api/org/springframework/data/jpa/repository/Query.html) annotation.
+
+Spring Data repositories usually extend from the [`Repository`](https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/Repository.html) or [`CrudRepository`](https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/CrudRepository.html) interfaces. If you are using auto-configuration, repositories will be searched from the package containing your main configuration class (the one annotated with `@EnableAutoConfiguration` or `@SpringBootApplication`) down.
Here is a typical Spring Data repository:
+```
package com.example.myapp.domain;
import org.springframework.data.domain.*;
@@ -3888,48 +3784,72 @@ public interface CityRepository extends Repository {
City findByNameAndCountryAllIgnoringCase(String name, String country);
}
-[Tip]
-We have barely scratched the surface of Spring Data JPA. For complete details check their reference documentation.
-29.3.3 Creating and dropping JPA databases
-By default, JPA databases will be automatically created only if you use an embedded database (H2, HSQL or Derby). You can explicitly configure JPA settings using spring.jpa.* properties. For example, to create and drop tables you can add the following to your application.properties.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| We have barely scratched the surface of Spring Data JPA. For complete details check their [reference documentation](https://projects.spring.io/spring-data-jpa/). |
+
+### 29.3.3 Creating and dropping JPA databases
+By default, JPA databases will be automatically created **only** if you use an embedded database (H2, HSQL or Derby). You can explicitly configure JPA settings using`spring.jpa.*` properties. For example, to create and drop tables you can add the following to your `application.properties`.
+
+```
spring.jpa.hibernate.ddl-auto=create-drop
-[Note]
-Hibernate’s own internal property name for this (if you happen to remember it better) is hibernate.hbm2ddl.auto. You can set it, along with other Hibernate native properties, using spring.jpa.properties.* (the prefix is stripped before adding them to the entity manager). Example:
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Hibernate’s own internal property name for this (if you happen to remember it better) is `hibernate.hbm2ddl.auto`. You can set it, along with other Hibernate native properties, using `spring.jpa.properties.*` (the prefix is stripped before adding them to the entity manager). Example: |
+
+```
spring.jpa.properties.hibernate.globally_quoted_identifiers=true
-passes hibernate.globally_quoted_identifiers to the Hibernate entity manager.
-By default the DDL execution (or validation) is deferred until the ApplicationContext has started. There is also a spring.jpa.generate-ddl flag, but it is not used if Hibernate autoconfig is active because the ddl-auto settings are more fine-grained.
+```
+
+passes `hibernate.globally_quoted_identifiers` to the Hibernate entity manager.
+
+By default the DDL execution (or validation) is deferred until the `ApplicationContext` has started. There is also a `spring.jpa.generate-ddl` flag, but it is not used if Hibernate autoconfig is active because the `ddl-auto` settings are more fine-grained.
+
+### 29.3.4 Open EntityManager in View
+
+If you are running a web application, Spring Boot will by default register [`OpenEntityManagerInViewInterceptor`](https://docs.spring.io/spring/docs/4.3.11.RELEASE/javadoc-api/org/springframework/orm/jpa/support/OpenEntityManagerInViewInterceptor.html) to apply the "Open EntityManager in View" pattern, i.e. to allow for lazy loading in web views. If you don’t want this behavior you should set `spring.jpa.open-in-view` to `false` in your `application.properties`.
+
+## 29.4 Using H2’s web console
-29.3.4 Open EntityManager in View
-If you are running a web application, Spring Boot will by default register OpenEntityManagerInViewInterceptor to apply the "Open EntityManager in View" pattern, i.e. to allow for lazy loading in web views. If you don’t want this behavior you should set spring.jpa.open-in-view to false in your application.properties.
+The [H2 database](http://www.h2database.com/) provides a [browser-based console](http://www.h2database.com/html/quickstart.html#h2_console) that Spring Boot can auto-configure for you. The console will be auto-configured when the following conditions are met:
-29.4 Using H2’s web console
-The H2 database provides a browser-based console that Spring Boot can auto-configure for you. The console will be auto-configured when the following conditions are met:
+- You are developing a web application
+- `com.h2database:h2` is on the classpath
+- You are using [Spring Boot’s developer tools](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools)
-You are developing a web application
-com.h2database:h2 is on the classpath
-You are using Spring Boot’s developer tools
-[Tip]
-If you are not using Spring Boot’s developer tools, but would still like to make use of H2’s console, then you can do so by configuring the spring.h2.console.enabled property with a value of true. The H2 console is only intended for use during development so care should be taken to ensure that spring.h2.console.enabled is not set to true in production.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you are not using Spring Boot’s developer tools, but would still like to make use of H2’s console, then you can do so by configuring the `spring.h2.console.enabled` property with a value of `true`. The H2 console is only intended for use during development so care should be taken to ensure that `spring.h2.console.enabled` is not set to `true` in production. |
-29.4.1 Changing the H2 console’s path
-By default the console will be available at /h2-console. You can customize the console’s path using the spring.h2.console.path property.
+### 29.4.1 Changing the H2 console’s path
+
+By default the console will be available at `/h2-console`. You can customize the console’s path using the `spring.h2.console.path` property.
+
+### 29.4.2 Securing the H2 console
-29.4.2 Securing the H2 console
When Spring Security is on the classpath and basic auth is enabled, the H2 console will be automatically secured using basic auth. The following properties can be used to customize the security configuration:
-security.user.role
-security.basic.authorize-mode
-security.basic.enabled
-29.5 Using jOOQ
-Java Object Oriented Querying (jOOQ) is a popular product from Data Geekery which generates Java code from your database, and lets you build type safe SQL queries through its fluent API. Both the commercial and open source editions can be used with Spring Boot.
+- `security.user.role`
+- `security.basic.authorize-mode`
+- `security.basic.enabled`
+
+## 29.5 Using jOOQ
+
+Java Object Oriented Querying ([jOOQ](http://www.jooq.org/)) is a popular product from [Data Geekery](http://www.datageekery.com/) which generates Java code from your database, and lets you build type safe SQL queries through its fluent API. Both the commercial and open source editions can be used with Spring Boot.
-29.5.1 Code Generation
-In order to use jOOQ type-safe queries, you need to generate Java classes from your database schema. You can follow the instructions in the jOOQ user manual. If you are using the jooq-codegen-maven plugin (and you also use the spring-boot-starter-parent “parent POM”) you can safely omit the plugin’s tag. You can also use Spring Boot defined version variables (e.g. h2.version) to declare the plugin’s database dependency. Here’s an example:
+### 29.5.1 Code Generation
+In order to use jOOQ type-safe queries, you need to generate Java classes from your database schema. You can follow the instructions in the [jOOQ user manual](http://www.jooq.org/doc/3.6/manual-single-page/#jooq-in-7-steps-step3). If you are using the `jooq-codegen-maven` plugin (and you also use the `spring-boot-starter-parent` “parent POM”) you can safely omit the plugin’s ``tag. You can also use Spring Boot defined version variables (e.g. `h2.version`) to declare the plugin’s database dependency. Here’s an example:
+
+```
org.jooq
jooq-codegen-maven
@@ -3953,9 +3873,14 @@ In order to use jOOQ type-safe queries, you need to generate Java classes from y
-29.5.2 Using DSLContext
-The fluent API offered by jOOQ is initiated via the org.jooq.DSLContext interface. Spring Boot will auto-configure a DSLContext as a Spring Bean and connect it to your application DataSource. To use the DSLContext you can just @Autowire it:
+```
+
+### 29.5.2 Using DSLContext
+
+The fluent API offered by jOOQ is initiated via the `org.jooq.DSLContext` interface. Spring Boot will auto-configure a `DSLContext` as a Spring Bean and connect it to your application `DataSource`. To use the `DSLContext` you can just `@Autowire` it:
+
+```
@Component
public class JooqExample implements CommandLineRunner {
@@ -3967,39 +3892,57 @@ public class JooqExample implements CommandLineRunner {
}
}
-[Tip]
-The jOOQ manual tends to use a variable named create to hold the DSLContext, we’ve done the same for this example.
-You can then use the DSLContext to construct your queries:
+```
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The jOOQ manual tends to use a variable named `create` to hold the `DSLContext`, we’ve done the same for this example. |
+
+You can then use the `DSLContext` to construct your queries:
+
+```
public List authorsBornAfter1980() {
return this.create.selectFrom(AUTHOR)
.where(AUTHOR.DATE_OF_BIRTH.greaterThan(new GregorianCalendar(1980, 0, 1)))
.fetch(AUTHOR.DATE_OF_BIRTH);
}
-29.5.3 Customizing jOOQ
-You can customize the SQL dialect used by jOOQ by setting spring.jooq.sql-dialect in your application.properties. For example, to specify Postgres you would add:
+```
+
+### 29.5.3 Customizing jOOQ
+
+You can customize the SQL dialect used by jOOQ by setting `spring.jooq.sql-dialect` in your `application.properties`. For example, to specify Postgres you would add:
+
+```
spring.jooq.sql-dialect=Postgres
-More advanced customizations can be achieved by defining your own @Bean definitions which will be used when the jOOQ Configuration is created. You can define beans for the following jOOQ Types:
-ConnectionProvider
-TransactionProvider
-RecordMapperProvider
-RecordListenerProvider
-ExecuteListenerProvider
-VisitListenerProvider
-You can also create your own org.jooq.Configuration @Bean if you want to take complete control of the jOOQ configuration.
+```
+
+More advanced customizations can be achieved by defining your own `@Bean` definitions which will be used when the jOOQ `Configuration` is created. You can define beans for the following jOOQ Types:
+
+- `ConnectionProvider`
+- `TransactionProvider`
+- `RecordMapperProvider`
+- `RecordListenerProvider`
+- `ExecuteListenerProvider`
+- `VisitListenerProvider`
+
+You can also create your own `org.jooq.Configuration` `@Bean` if you want to take complete control of the jOOQ configuration.
-30. Working with NoSQL technologies
-Spring Data provides additional projects that help you access a variety of NoSQL technologies including MongoDB, Neo4J, Elasticsearch, Solr, Redis, Gemfire, Cassandra, Couchbase and LDAP. Spring Boot provides auto-configuration for Redis, MongoDB, Neo4j, Elasticsearch, Solr Cassandra, Couchbase and LDAP; you can make use of the other projects, but you will need to configure them yourself. Refer to the appropriate reference documentation at projects.spring.io/spring-data.
+## 30. Working with NoSQL technologies
-30.1 Redis
-Redis is a cache, message broker and richly-featured key-value store. Spring Boot offers basic auto-configuration for the Jedis client library and abstractions on top of it provided by Spring Data Redis. There is a spring-boot-starter-data-redis ‘Starter’ for collecting the dependencies in a convenient way.
+Spring Data provides additional projects that help you access a variety of NoSQL technologies including [MongoDB](https://projects.spring.io/spring-data-mongodb/), [Neo4J](https://projects.spring.io/spring-data-neo4j/), [Elasticsearch](https://github.com/spring-projects/spring-data-elasticsearch/), [Solr](https://projects.spring.io/spring-data-solr/), [Redis](https://projects.spring.io/spring-data-redis/), [Gemfire](https://projects.spring.io/spring-data-gemfire/),[Cassandra](https://projects.spring.io/spring-data-cassandra/), [Couchbase](https://projects.spring.io/spring-data-couchbase/) and [LDAP](https://projects.spring.io/spring-data-ldap/). Spring Boot provides auto-configuration for Redis, MongoDB, Neo4j, Elasticsearch, Solr Cassandra, Couchbase and LDAP; you can make use of the other projects, but you will need to configure them yourself. Refer to the appropriate reference documentation at [projects.spring.io/spring-data](https://projects.spring.io/spring-data).
-30.1.1 Connecting to Redis
-You can inject an auto-configured RedisConnectionFactory, StringRedisTemplate or vanilla RedisTemplate instance as you would any other Spring Bean. By default the instance will attempt to connect to a Redis server using localhost:6379:
+## 30.1 Redis
+[Redis](http://redis.io/) is a cache, message broker and richly-featured key-value store. Spring Boot offers basic auto-configuration for the [Jedis](https://github.com/xetorthio/jedis/) client library and abstractions on top of it provided by [Spring Data Redis](https://github.com/spring-projects/spring-data-redis). There is a `spring-boot-starter-data-redis` ‘Starter’ for collecting the dependencies in a convenient way.
+
+### 30.1.1 Connecting to Redis
+
+You can inject an auto-configured `RedisConnectionFactory`, `StringRedisTemplate` or vanilla `RedisTemplate` instance as you would any other Spring Bean. By default the instance will attempt to connect to a Redis server using `localhost:6379`:
+
+```
@Component
public class MyBean {
@@ -4013,14 +3956,20 @@ public class MyBean {
// ...
}
-If you add a @Bean of your own of any of the auto-configured types it will replace the default (except in the case of RedisTemplate the exclusion is based on the bean name ‘redisTemplate’ not its type). If commons-pool2 is on the classpath you will get a pooled connection factory by default.
-30.2 MongoDB
-MongoDB is an open-source NoSQL document database that uses a JSON-like schema instead of traditional table-based relational data. Spring Boot offers several conveniences for working with MongoDB, including the spring-boot-starter-data-mongodb ‘Starter’.
+```
+
+If you add a `@Bean` of your own of any of the auto-configured types it will replace the default (except in the case of `RedisTemplate` the exclusion is based on the bean name ‘redisTemplate’ not its type). If `commons-pool2` is on the classpath you will get a pooled connection factory by default.
-30.2.1 Connecting to a MongoDB database
-You can inject an auto-configured org.springframework.data.mongodb.MongoDbFactory to access Mongo databases. By default the instance will attempt to connect to a MongoDB server using the URL mongodb://localhost/test:
+## 30.2 MongoDB
+[MongoDB](https://www.mongodb.com/) is an open-source NoSQL document database that uses a JSON-like schema instead of traditional table-based relational data. Spring Boot offers several conveniences for working with MongoDB, including the `spring-boot-starter-data-mongodb` ‘Starter’.
+
+### 30.2.1 Connecting to a MongoDB database
+
+You can inject an auto-configured `org.springframework.data.mongodb.MongoDbFactory` to access Mongo databases. By default the instance will attempt to connect to a MongoDB server using the URL `mongodb://localhost/test`:
+
+```
import org.springframework.data.mongodb.MongoDbFactory;
import com.mongodb.DB;
@@ -4042,27 +3991,43 @@ public class MyBean {
}
}
-You can set spring.data.mongodb.uri property to change the URL and configure additional settings such as the replica set:
+```
+
+You can set `spring.data.mongodb.uri` property to change the URL and configure additional settings such as the *replica set*:
+
+```
spring.data.mongodb.uri=mongodb://user:secret@mongo1.example.com:12345,mongo2.example.com:23456/test
-Alternatively, as long as you’re using Mongo 2.x, specify a host/port. For example, you might declare the following in your application.properties:
+```
+
+Alternatively, as long as you’re using Mongo 2.x, specify a `host`/`port`. For example, you might declare the following in your `application.properties`:
+
+```
spring.data.mongodb.host=mongoserver
spring.data.mongodb.port=27017
-[Note]
-spring.data.mongodb.host and spring.data.mongodb.port are not supported if you’re using the Mongo 3.0 Java driver. In such cases, spring.data.mongodb.uri should be used to provide all of the configuration.
-[Tip]
-If spring.data.mongodb.port is not specified the default of 27017 is used. You could simply delete this line from the sample above.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| `spring.data.mongodb.host` and `spring.data.mongodb.port` are not supported if you’re using the Mongo 3.0 Java driver. In such cases, `spring.data.mongodb.uri` should be used to provide all of the configuration. |
-[Tip]
-If you aren’t using Spring Data Mongo you can inject com.mongodb.Mongo beans instead of using MongoDbFactory.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If `spring.data.mongodb.port` is not specified the default of `27017` is used. You could simply delete this line from the sample above. |
-You can also declare your own MongoDbFactory or Mongo bean if you want to take complete control of establishing the MongoDB connection.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you aren’t using Spring Data Mongo you can inject `com.mongodb.Mongo` beans instead of using `MongoDbFactory`. |
-30.2.2 MongoTemplate
-Spring Data Mongo provides a MongoTemplate class that is very similar in its design to Spring’s JdbcTemplate. As with JdbcTemplate Spring Boot auto-configures a bean for you to simply inject:
+You can also declare your own `MongoDbFactory` or `Mongo` bean if you want to take complete control of establishing the MongoDB connection.
+### 30.2.2 MongoTemplate
+
+Spring Data Mongo provides a [`MongoTemplate`](https://docs.spring.io/spring-data/mongodb/docs/current/api/org/springframework/data/mongodb/core/MongoTemplate.html) class that is very similar in its design to Spring’s `JdbcTemplate`. As with `JdbcTemplate` Spring Boot auto-configures a bean for you to simply inject:
+
+```
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.mongodb.core.MongoTemplate;
import org.springframework.stereotype.Component;
@@ -4080,14 +4045,19 @@ public class MyBean {
// ...
}
-See the MongoOperations Javadoc for complete details.
-30.2.3 Spring Data MongoDB repositories
-Spring Data includes repository support for MongoDB. As with the JPA repositories discussed earlier, the basic principle is that queries are constructed for you automatically based on method names.
+```
-In fact, both Spring Data JPA and Spring Data MongoDB share the same common infrastructure; so you could take the JPA example from earlier and, assuming that City is now a Mongo data class rather than a JPA @Entity, it will work in the same way.
+See the `MongoOperations` Javadoc for complete details.
-package com.example.myapp.domain;
+### 30.2.3 Spring Data MongoDB repositories
+
+Spring Data includes repository support for MongoDB. As with the JPA repositories discussed earlier, the basic principle is that queries are constructed for you automatically based on method names.
+
+In fact, both Spring Data JPA and Spring Data MongoDB share the same common infrastructure; so you could take the JPA example from earlier and, assuming that `City` is now a Mongo data class rather than a JPA `@Entity`, it will work in the same way.
+
+```
+package com.example.myapp.domain;
import org.springframework.data.domain.*;
import org.springframework.data.repository.*;
@@ -4099,27 +4069,36 @@ public interface CityRepository extends Repository {
City findByNameAndCountryAllIgnoringCase(String name, String country);
}
-[Tip]
-For complete details of Spring Data MongoDB, including its rich object mapping technologies, refer to their reference documentation.
-30.2.4 Embedded Mongo
-Spring Boot offers auto-configuration for Embedded Mongo. To use it in your Spring Boot application add a dependency on de.flapdoodle.embed:de.flapdoodle.embed.mongo.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For complete details of Spring Data MongoDB, including its rich object mapping technologies, refer to their [reference documentation](https://projects.spring.io/spring-data-mongodb/). |
+
+### 30.2.4 Embedded Mongo
+
+Spring Boot offers auto-configuration for [Embedded Mongo](https://github.com/flapdoodle-oss/de.flapdoodle.embed.mongo). To use it in your Spring Boot application add a dependency on`de.flapdoodle.embed:de.flapdoodle.embed.mongo`.
-The port that Mongo will listen on can be configured using the spring.data.mongodb.port property. To use a randomly allocated free port use a value of zero. The MongoClient created by MongoAutoConfiguration will be automatically configured to use the randomly allocated port.
+The port that Mongo will listen on can be configured using the `spring.data.mongodb.port` property. To use a randomly allocated free port use a value of zero. The `MongoClient` created by `MongoAutoConfiguration` will be automatically configured to use the randomly allocated port.
-[Note]
-If you do not configure a custom port, the embedded support will use a random port by default (rather than 27017).
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you do not configure a custom port, the embedded support will use a random port by default (rather than 27017). |
-If you have SLF4J on the classpath, output produced by Mongo will be automatically routed to a logger named org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongo.
+If you have SLF4J on the classpath, output produced by Mongo will be automatically routed to a logger named `org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongo`.
-You can declare your own IMongodConfig and IRuntimeConfig beans to take control of the Mongo instance’s configuration and logging routing.
+You can declare your own `IMongodConfig` and `IRuntimeConfig` beans to take control of the Mongo instance’s configuration and logging routing.
-30.3 Neo4j
-Neo4j is an open-source NoSQL graph database that uses a rich data model of nodes related by first class relationships which is better suited for connected big data than traditional rdbms approaches. Spring Boot offers several conveniences for working with Neo4j, including the spring-boot-starter-data-neo4j ‘Starter’.
+## 30.3 Neo4j
-30.3.1 Connecting to a Neo4j database
-You can inject an auto-configured Neo4jSession, Session or Neo4jOperations instance as you would any other Spring Bean. By default the instance will attempt to connect to a Neo4j server using localhost:7474:
+[Neo4j](http://neo4j.com/) is an open-source NoSQL graph database that uses a rich data model of nodes related by first class relationships which is better suited for connected big data than traditional rdbms approaches. Spring Boot offers several conveniences for working with Neo4j, including the `spring-boot-starter-data-neo4j` ‘Starter’.
+### 30.3.1 Connecting to a Neo4j database
+
+You can inject an auto-configured `Neo4jSession`, `Session` or `Neo4jOperations` instance as you would any other Spring Bean. By default the instance will attempt to connect to a Neo4j server using `localhost:7474`:
+
+```
@Component
public class MyBean {
@@ -4133,37 +4112,63 @@ public class MyBean {
// ...
}
-You can take full control of the configuration by adding a org.neo4j.ogm.config.Configuration @Bean of your own. Also, adding a @Bean of type Neo4jOperations disables the auto-configuration.
-You can configure the user and credentials to use via the spring.data.neo4j.* properties:
+```
+
+You can take full control of the configuration by adding a `org.neo4j.ogm.config.Configuration` `@Bean` of your own. Also, adding a `@Bean` of type`Neo4jOperations` disables the auto-configuration.
+
+You can configure the user and credentials to use via the `spring.data.neo4j.*` properties:
+```
spring.data.neo4j.uri=http://my-server:7474
spring.data.neo4j.username=neo4j
spring.data.neo4j.password=secret
-30.3.2 Using the embedded mode
-If you add org.neo4j:neo4j-ogm-embedded-driver to the dependencies of your application, Spring Boot will automatically configure an in-process embedded instance of Neo4j that will not persist any data when your application shuts down. You can explicitly disable that mode using spring.data.neo4j.embedded.enabled=false. You can also enable persistence for the embedded mode:
+```
+
+### 30.3.2 Using the embedded mode
+
+If you add `org.neo4j:neo4j-ogm-embedded-driver` to the dependencies of your application, Spring Boot will automatically configure an in-process embedded instance of Neo4j that will not persist any data when your application shuts down. You can explicitly disable that mode using `spring.data.neo4j.embedded.enabled=false`. You can also enable persistence for the embedded mode:
+
+```
spring.data.neo4j.uri=file://var/tmp/graph.db
-[Note]
-The Neo4j OGM embedded driver does not provide the Neo4j kernel. Users are expected to provide this dependency manually, see the documentation for more details.
-30.3.3 Neo4jSession
-By default, if you are running a web application, the session is bound to the thread for the entire processing of the request (i.e. the "Open Session in View" pattern). If you don’t want this behavior add the following to your application.properties:
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The Neo4j OGM embedded driver does not provide the Neo4j kernel. Users are expected to provide this dependency manually, see [the documentation](http://neo4j.com/docs/ogm-manual/current/reference/#reference:getting-started) for more details. |
+### 30.3.3 Neo4jSession
+
+By default, if you are running a web application, the session is bound to the thread for the entire processing of the request (i.e. the "Open Session in View" pattern). If you don’t want this behavior add the following to your `application.properties`:
+
+```
spring.data.neo4j.open-in-view=false
-30.3.4 Spring Data Neo4j repositories
+
+```
+
+### 30.3.4 Spring Data Neo4j repositories
+
Spring Data includes repository support for Neo4j.
-In fact, both Spring Data JPA and Spring Data Neo4j share the same common infrastructure; so you could take the JPA example from earlier and, assuming that City is now a Neo4j OGM @NodeEntity rather than a JPA @Entity, it will work in the same way.
+In fact, both Spring Data JPA and Spring Data Neo4j share the same common infrastructure; so you could take the JPA example from earlier and, assuming that `City` is now a Neo4j OGM `@NodeEntity` rather than a JPA `@Entity`, it will work in the same way.
-[Tip]
-You can customize entity scanning locations using the @EntityScan annotation.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You can customize entity scanning locations using the `@EntityScan` annotation. |
-To enable repository support (and optionally support for @Transactional), add the following two annotations to your Spring configuration:
+To enable repository support (and optionally support for `@Transactional`), add the following two annotations to your Spring configuration:
+```
@EnableNeo4jRepositories(basePackages = "com.example.myapp.repository")
@EnableTransactionManagement
-30.3.5 Repository example
+
+```
+
+### 30.3.5 Repository example
+
+```
package com.example.myapp.domain;
import org.springframework.data.domain.*;
@@ -4176,18 +4181,26 @@ public interface CityRepository extends GraphRepository {
City findByNameAndCountry(String name, String country);
}
-[Tip]
-For complete details of Spring Data Neo4j, including its rich object mapping technologies, refer to their reference documentation.
-30.4 Gemfire
-Spring Data Gemfire provides convenient Spring-friendly tools for accessing the Pivotal Gemfire data management platform. There is a spring-boot-starter-data-gemfire ‘Starter’ for collecting the dependencies in a convenient way. There is currently no auto-configuration support for Gemfire, but you can enable Spring Data Repositories with a single annotation (@EnableGemfireRepositories).
+```
-30.5 Solr
-Apache Solr is a search engine. Spring Boot offers basic auto-configuration for the Solr 5 client library and abstractions on top of it provided by Spring Data Solr. There is a spring-boot-starter-data-solr ‘Starter’ for collecting the dependencies in a convenient way.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For complete details of Spring Data Neo4j, including its rich object mapping technologies, refer to their [reference documentation](https://projects.spring.io/spring-data-neo4j/). |
-30.5.1 Connecting to Solr
-You can inject an auto-configured SolrClient instance as you would any other Spring bean. By default the instance will attempt to connect to a server using localhost:8983/solr:
+## 30.4 Gemfire
+[Spring Data Gemfire](https://github.com/spring-projects/spring-data-gemfire) provides convenient Spring-friendly tools for accessing the [Pivotal Gemfire](https://pivotal.io/big-data/pivotal-gemfire#details) data management platform. There is a `spring-boot-starter-data-gemfire` ‘Starter’ for collecting the dependencies in a convenient way. There is currently no auto-configuration support for Gemfire, but you can enable Spring Data Repositories with a [single annotation (`@EnableGemfireRepositories`)](https://github.com/spring-projects/spring-data-gemfire/blob/master/src/main/java/org/springframework/data/gemfire/repository/config/EnableGemfireRepositories.java).
+
+## 30.5 Solr
+
+[Apache Solr](https://lucene.apache.org/solr/) is a search engine. Spring Boot offers basic auto-configuration for the Solr 5 client library and abstractions on top of it provided by [Spring Data Solr](https://github.com/spring-projects/spring-data-solr). There is a `spring-boot-starter-data-solr` ‘Starter’ for collecting the dependencies in a convenient way.
+
+### 30.5.1 Connecting to Solr
+
+You can inject an auto-configured `SolrClient` instance as you would any other Spring bean. By default the instance will attempt to connect to a server using`localhost:8983/solr`:
+
+```
@Component
public class MyBean {
@@ -4201,28 +4214,40 @@ public class MyBean {
// ...
}
-If you add a @Bean of your own of type SolrClient it will replace the default.
-30.5.2 Spring Data Solr repositories
+```
+
+If you add a `@Bean` of your own of type `SolrClient` it will replace the default.
+
+### 30.5.2 Spring Data Solr repositories
+
Spring Data includes repository support for Apache Solr. As with the JPA repositories discussed earlier, the basic principle is that queries are constructed for you automatically based on method names.
-In fact, both Spring Data JPA and Spring Data Solr share the same common infrastructure; so you could take the JPA example from earlier and, assuming that City is now a @SolrDocument class rather than a JPA @Entity, it will work in the same way.
+In fact, both Spring Data JPA and Spring Data Solr share the same common infrastructure; so you could take the JPA example from earlier and, assuming that `City` is now a `@SolrDocument` class rather than a JPA `@Entity`, it will work in the same way.
-[Tip]
-For complete details of Spring Data Solr, refer to their reference documentation.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For complete details of Spring Data Solr, refer to their [reference documentation](https://projects.spring.io/spring-data-solr/). |
-30.6 Elasticsearch
-Elasticsearch is an open source, distributed, real-time search and analytics engine. Spring Boot offers basic auto-configuration for the Elasticsearch and abstractions on top of it provided by Spring Data Elasticsearch. There is a spring-boot-starter-data-elasticsearch ‘Starter’ for collecting the dependencies in a convenient way. Spring Boot also supports Jest.
+## 30.6 Elasticsearch
-30.6.1 Connecting to Elasticsearch using Jest
-If you have Jest on the classpath, you can inject an auto-configured JestClient targeting localhost:9200 by default. You can further tune how the client is configured:
+[Elasticsearch](http://www.elasticsearch.org/) is an open source, distributed, real-time search and analytics engine. Spring Boot offers basic auto-configuration for the Elasticsearch and abstractions on top of it provided by [Spring Data Elasticsearch](https://github.com/spring-projects/spring-data-elasticsearch). There is a `spring-boot-starter-data-elasticsearch` ‘Starter’ for collecting the dependencies in a convenient way. Spring Boot also supports [Jest](https://github.com/searchbox-io/Jest).
+### 30.6.1 Connecting to Elasticsearch using Jest
+
+If you have `Jest` on the classpath, you can inject an auto-configured `JestClient` targeting `localhost:9200` by default. You can further tune how the client is configured:
+
+```
spring.elasticsearch.jest.uris=http://search.example.com:9200
spring.elasticsearch.jest.read-timeout=10000
spring.elasticsearch.jest.username=user
spring.elasticsearch.jest.password=secret
-You can also register an arbitrary number of beans implementing HttpClientConfigBuilderCustomizer for more advanced customizations. The example below tunes additional HTTP settings:
+```
+
+You can also register an arbitrary number of beans implementing `HttpClientConfigBuilderCustomizer` for more advanced customizations. The example below tunes additional HTTP settings:
+
+```
static class HttpSettingsCustomizer implements HttpClientConfigBuilderCustomizer {
@Override
@@ -4231,14 +4256,23 @@ static class HttpSettingsCustomizer implements HttpClientConfigBuilderCustomizer
}
}
-To take full control over the registration, define a JestClient bean.
-30.6.2 Connecting to Elasticsearch using Spring Data
-You can inject an auto-configured ElasticsearchTemplate or Elasticsearch Client instance as you would any other Spring Bean. By default the instance will embed a local in-memory server (a Node in Elasticsearch terms) and use the current working directory as the home directory for the server. In this setup, the first thing to do is to tell Elasticsearch where to store its files:
+```
+To take full control over the registration, define a `JestClient` bean.
+
+### 30.6.2 Connecting to Elasticsearch using Spring Data
+
+You can inject an auto-configured `ElasticsearchTemplate` or Elasticsearch `Client` instance as you would any other Spring Bean. By default the instance will embed a local in-memory server (a `Node` in Elasticsearch terms) and use the current working directory as the home directory for the server. In this setup, the first thing to do is to tell Elasticsearch where to store its files:
+
+```
spring.data.elasticsearch.properties.path.home=/foo/bar
-Alternatively, you can switch to a remote server (i.e. a TransportClient) by setting spring.data.elasticsearch.cluster-nodes to a comma-separated ‘host:port’ list.
+```
+
+Alternatively, you can switch to a remote server (i.e. a `TransportClient`) by setting `spring.data.elasticsearch.cluster-nodes` to a comma-separated ‘host:port’ list.
+
+```
spring.data.elasticsearch.cluster-nodes=localhost:9300
@Component
public class MyBean {
@@ -4253,22 +4287,30 @@ public class MyBean {
// ...
}
-If you add a @Bean of your own of type ElasticsearchTemplate it will replace the default.
-30.6.3 Spring Data Elasticsearch repositories
+```
+
+If you add a `@Bean` of your own of type `ElasticsearchTemplate` it will replace the default.
+
+### 30.6.3 Spring Data Elasticsearch repositories
+
Spring Data includes repository support for Elasticsearch. As with the JPA repositories discussed earlier, the basic principle is that queries are constructed for you automatically based on method names.
-In fact, both Spring Data JPA and Spring Data Elasticsearch share the same common infrastructure; so you could take the JPA example from earlier and, assuming that City is now an Elasticsearch @Document class rather than a JPA @Entity, it will work in the same way.
+In fact, both Spring Data JPA and Spring Data Elasticsearch share the same common infrastructure; so you could take the JPA example from earlier and, assuming that`City` is now an Elasticsearch `@Document` class rather than a JPA `@Entity`, it will work in the same way.
-[Tip]
-For complete details of Spring Data Elasticsearch, refer to their reference documentation.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For complete details of Spring Data Elasticsearch, refer to their [reference documentation](https://docs.spring.io/spring-data/elasticsearch/docs/). |
-30.7 Cassandra
-Cassandra is an open source, distributed database management system designed to handle large amounts of data across many commodity servers. Spring Boot offers auto-configuration for Cassandra and abstractions on top of it provided by Spring Data Cassandra. There is a spring-boot-starter-data-cassandra ‘Starter’ for collecting the dependencies in a convenient way.
+## 30.7 Cassandra
-30.7.1 Connecting to Cassandra
-You can inject an auto-configured CassandraTemplate or a Cassandra Session instance as you would with any other Spring Bean. The spring.data.cassandra.* properties can be used to customize the connection. Generally you will provide keyspace-name and contact-points properties:
+[Cassandra](https://cassandra.apache.org/) is an open source, distributed database management system designed to handle large amounts of data across many commodity servers. Spring Boot offers auto-configuration for Cassandra and abstractions on top of it provided by [Spring Data Cassandra](https://github.com/spring-projects/spring-data-cassandra). There is a `spring-boot-starter-data-cassandra` ‘Starter’ for collecting the dependencies in a convenient way.
+### 30.7.1 Connecting to Cassandra
+
+You can inject an auto-configured `CassandraTemplate` or a Cassandra `Session` instance as you would with any other Spring Bean. The `spring.data.cassandra.*` properties can be used to customize the connection. Generally you will provide `keyspace-name` and `contact-points` properties:
+
+```
spring.data.cassandra.keyspace-name=mykeyspace
spring.data.cassandra.contact-points=cassandrahost1,cassandrahost2
@Component
@@ -4284,38 +4326,56 @@ public class MyBean {
// ...
}
-If you add a @Bean of your own of type CassandraTemplate it will replace the default.
-30.7.2 Spring Data Cassandra repositories
-Spring Data includes basic repository support for Cassandra. Currently this is more limited than the JPA repositories discussed earlier, and will need to annotate finder methods with @Query.
+```
+
+If you add a `@Bean` of your own of type `CassandraTemplate` it will replace the default.
+
+### 30.7.2 Spring Data Cassandra repositories
-[Tip]
-For complete details of Spring Data Cassandra, refer to their reference documentation.
+Spring Data includes basic repository support for Cassandra. Currently this is more limited than the JPA repositories discussed earlier, and will need to annotate finder methods with `@Query`.
-30.8 Couchbase
-Couchbase is an open-source, distributed multi-model NoSQL document-oriented database that is optimized for interactive applications. Spring Boot offers auto-configuration for Couchbase and abstractions on top of it provided by Spring Data Couchbase. There is a spring-boot-starter-data-couchbase ‘Starter’ for collecting the dependencies in a convenient way.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| For complete details of Spring Data Cassandra, refer to their [reference documentation](https://docs.spring.io/spring-data/cassandra/docs/). |
-30.8.1 Connecting to Couchbase
-You can very easily get a Bucket and Cluster by adding the Couchbase SDK and some configuration. The spring.couchbase.* properties can be used to customize the connection. Generally you will provide the bootstrap hosts, bucket name and password:
+## 30.8 Couchbase
+[Couchbase](https://www.couchbase.com/) is an open-source, distributed multi-model NoSQL document-oriented database that is optimized for interactive applications. Spring Boot offers auto-configuration for Couchbase and abstractions on top of it provided by [Spring Data Couchbase](https://github.com/spring-projects/spring-data-couchbase). There is a `spring-boot-starter-data-couchbase` ‘Starter’ for collecting the dependencies in a convenient way.
+
+### 30.8.1 Connecting to Couchbase
+
+You can very easily get a `Bucket` and `Cluster` by adding the Couchbase SDK and some configuration. The `spring.couchbase.*` properties can be used to customize the connection. Generally you will provide the bootstrap hosts, bucket name and password:
+
+```
spring.couchbase.bootstrap-hosts=my-host-1,192.168.1.123
spring.couchbase.bucket.name=my-bucket
spring.couchbase.bucket.password=secret
-[Tip]
-You need to provide at least the bootstrap host(s), in which case the bucket name is default and the password is the empty String. Alternatively, you can define your own org.springframework.data.couchbase.config.CouchbaseConfigurer @Bean to take control over the whole configuration.
-It is also possible to customize some of the CouchbaseEnvironment settings. For instance the following configuration changes the timeout to use to open a new Bucket and enables SSL support:
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You need to provide *at least* the bootstrap host(s), in which case the bucket name is `default` and the password is the empty String. Alternatively, you can define your own `org.springframework.data.couchbase.config.CouchbaseConfigurer` `@Bean` to take control over the whole configuration. |
+It is also possible to customize some of the `CouchbaseEnvironment` settings. For instance the following configuration changes the timeout to use to open a new `Bucket` and enables SSL support:
+
+```
spring.couchbase.env.timeouts.connect=3000
spring.couchbase.env.ssl.key-store=/location/of/keystore.jks
spring.couchbase.env.ssl.key-store-password=secret
-Check the spring.couchbase.env.* properties for more details.
-30.8.2 Spring Data Couchbase repositories
-Spring Data includes repository support for Couchbase. For complete details of Spring Data Couchbase, refer to their reference documentation.
+```
+
+Check the `spring.couchbase.env.*` properties for more details.
+
+### 30.8.2 Spring Data Couchbase repositories
+
+Spring Data includes repository support for Couchbase. For complete details of Spring Data Couchbase, refer to their [reference documentation](https://docs.spring.io/spring-data/couchbase/docs/current/reference/html/).
-You can inject an auto-configured CouchbaseTemplate instance as you would with any other Spring Bean as long as a default CouchbaseConfigurer is available (that happens when you enable the couchbase support as explained above).
+You can inject an auto-configured `CouchbaseTemplate` instance as you would with any other Spring Bean as long as a *default* `CouchbaseConfigurer` is available (that happens when you enable the couchbase support as explained above).
+```
@Component
public class MyBean {
@@ -4329,13 +4389,18 @@ public class MyBean {
// ...
}
+
+```
+
There are a few beans that you can define in your own configuration to override those provided by the auto-configuration:
-A CouchbaseTemplate @Bean with name couchbaseTemplate
-An IndexManager @Bean with name couchbaseIndexManager
-A CustomConversions @Bean with name couchbaseCustomConversions
-To avoid hard-coding those names in your own config, you can reuse BeanNames provided by Spring Data Couchbase. For instance, you can customize the converters to use as follows:
+- A `CouchbaseTemplate` `@Bean` with name `couchbaseTemplate`
+- An `IndexManager` `@Bean` with name `couchbaseIndexManager`
+- A `CustomConversions` `@Bean` with name `couchbaseCustomConversions`
+To avoid hard-coding those names in your own config, you can reuse `BeanNames` provided by Spring Data Couchbase. For instance, you can customize the converters to use as follows:
+
+```
@Configuration
public class SomeConfiguration {
@@ -4347,27 +4412,39 @@ public class SomeConfiguration {
// ...
}
-[Tip]
-If you want to fully bypass the auto-configuration for Spring Data Couchbase, provide your own org.springframework.data.couchbase.config.AbstractCouchbaseDataConfiguration implementation.
-30.9 LDAP
-LDAP (Lightweight Directory Access Protocol) is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an IP network. Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from UnboundID.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you want to fully bypass the auto-configuration for Spring Data Couchbase, provide your own `org.springframework.data.couchbase.config.AbstractCouchbaseDataConfiguration` implementation. |
-LDAP abstractions are provided by Spring Data LDAP. There is a spring-boot-starter-data-ldap ‘Starter’ for collecting the dependencies in a convenient way.
+## 30.9 LDAP
-30.9.1 Connecting to an LDAP server
-To connect to an LDAP server make sure you declare a dependency on the spring-boot-starter-data-ldap ‘Starter’ or spring-ldap-core then declare the URLs of your server in your application.properties:
+[LDAP](https://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol) (Lightweight Directory Access Protocol) is an open, vendor-neutral, industry standard application protocol for accessing and maintaining distributed directory information services over an IP network. Spring Boot offers auto-configuration for any compliant LDAP server as well as support for the embedded in-memory LDAP server from [UnboundID](https://www.ldap.com/unboundid-ldap-sdk-for-java).
+LDAP abstractions are provided by [Spring Data LDAP](https://github.com/spring-projects/spring-data-ldap). There is a `spring-boot-starter-data-ldap` ‘Starter’ for collecting the dependencies in a convenient way.
+
+### 30.9.1 Connecting to an LDAP server
+
+To connect to an LDAP server make sure you declare a dependency on the `spring-boot-starter-data-ldap` ‘Starter’ or `spring-ldap-core` then declare the URLs of your server in your application.properties:
+
+```
spring.ldap.urls=ldap://myserver:1235
spring.ldap.username=admin
spring.ldap.password=secret
-If you need to customize connection settings you can use the spring.ldap.base and spring.ldap.base-environment properties.
-30.9.2 Spring Data LDAP repositories
-Spring Data includes repository support for LDAP. For complete details of Spring Data LDAP, refer to their reference documentation.
+```
+
+If you need to customize connection settings you can use the `spring.ldap.base` and `spring.ldap.base-environment` properties.
-You can also inject an auto-configured LdapTemplate instance as you would with any other Spring Bean.
+### 30.9.2 Spring Data LDAP repositories
+Spring Data includes repository support for LDAP. For complete details of Spring Data LDAP, refer to their [reference documentation](https://docs.spring.io/spring-data/ldap/docs/1.0.x/reference/html/).
+
+You can also inject an auto-configured `LdapTemplate` instance as you would with any other Spring Bean.
+
+```
@Component
public class MyBean {
@@ -4381,24 +4458,35 @@ public class MyBean {
// ...
}
-30.9.3 Embedded in-memory LDAP server
-For testing purposes Spring Boot supports auto-configuration of an in-memory LDAP server from UnboundID. To configure the server add a dependency to com.unboundid:unboundid-ldapsdk and declare a base-dn property:
+```
+
+### 30.9.3 Embedded in-memory LDAP server
+
+For testing purposes Spring Boot supports auto-configuration of an in-memory LDAP server from [UnboundID](https://www.ldap.com/unboundid-ldap-sdk-for-java). To configure the server add a dependency to `com.unboundid:unboundid-ldapsdk` and declare a `base-dn` property:
+
+```
spring.ldap.embedded.base-dn=dc=spring,dc=io
-By default the server will start on a random port and they trigger the regular LDAP support (there is no need to specify a spring.ldap.urls property).
-If there is a schema.ldif file on your classpath it will be used to initialize the server. You can also use the spring.ldap.embedded.ldif property if you want to load the initialization script from a different resource.
+```
+
+By default the server will start on a random port and they trigger the regular LDAP support (there is no need to specify a `spring.ldap.urls` property).
+
+If there is a `schema.ldif` file on your classpath it will be used to initialize the server. You can also use the `spring.ldap.embedded.ldif` property if you want to load the initialization script from a different resource.
+
+By default, a standard schema will be used to validate `LDIF` files, you can turn off validation altogether using the `spring.ldap.embedded.validation.enabled`property. If you have custom attributes, you can use `spring.ldap.embedded.validation.schema` to define your custom attribute types or object classes.
-By default, a standard schema will be used to validate LDIF files, you can turn off validation altogether using the spring.ldap.embedded.validation.enabled property. If you have custom attributes, you can use spring.ldap.embedded.validation.schema to define your custom attribute types or object classes.
+## 31. Caching
-31. Caching
-The Spring Framework provides support for transparently adding caching to an application. At its core, the abstraction applies caching to methods, reducing thus the number of executions based on the information available in the cache. The caching logic is applied transparently, without any interference to the invoker. Spring Boot auto-configures the cache infrastructure as long as the caching support is enabled via the @EnableCaching annotation.
+The Spring Framework provides support for transparently adding caching to an application. At its core, the abstraction applies caching to methods, reducing thus the number of executions based on the information available in the cache. The caching logic is applied transparently, without any interference to the invoker. Spring Boot auto-configures the cache infrastructure as long as the caching support is enabled via the `@EnableCaching` annotation.
-[Note]
-Check the relevant section of the Spring Framework reference for more details.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Check the [relevant section](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#cache) of the Spring Framework reference for more details. |
In a nutshell, adding caching to an operation of your service is as easy as adding the relevant annotation to its method:
+```
import org.springframework.cache.annotation.Cacheable
import org.springframework.stereotype.Component;
@@ -4411,42 +4499,53 @@ public class MathService {
}
}
-This example demonstrates the use of caching on a potentially costly operation. Before invoking computePiDecimal, the abstraction will look for an entry in the piDecimals cache matching the i argument. If an entry is found, the content in the cache is immediately returned to the caller and the method is not invoked. Otherwise, the method is invoked and the cache is updated before returning the value.
-[Note]
-You can also use the standard JSR-107 (JCache) annotations (e.g. @CacheResult) transparently. We strongly advise you however to not mix and match them.
+```
-If you do not add any specific cache library, Spring Boot will auto-configure a Simple provider that uses concurrent maps in memory. When a cache is required (i.e. piDecimals in the example above), this provider will create it on-the-fly for you. The simple provider is not really recommended for production usage, but it’s great for getting started and making sure that you understand the features. When you have made up your mind about the cache provider to use, please make sure to read its documentation to figure out how to configure the caches that your application uses. Practically all providers require you to explicitly configure every cache that you use in the application. Some offer a way to customize the default caches defined by the spring.cache.cache-names property.
+This example demonstrates the use of caching on a potentially costly operation. Before invoking `computePiDecimal`, the abstraction will look for an entry in the `piDecimals` cache matching the `i` argument. If an entry is found, the content in the cache is immediately returned to the caller and the method is not invoked. Otherwise, the method is invoked and the cache is updated before returning the value.
-[Tip]
-It is also possible to update or evict data from the cache transparently.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can also use the standard JSR-107 (JCache) annotations (e.g. `@CacheResult`) transparently. We strongly advise you however to not mix and match them. |
-[Note]
-If you are using the cache infrastructure with beans that are not interface-based, make sure to enable the proxyTargetClass attribute of @EnableCaching.
+If you do not add any specific cache library, Spring Boot will auto-configure a [Simple provider](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-simple) that uses concurrent maps in memory. When a cache is required (i.e. `piDecimals` in the example above), this provider will create it on-the-fly for you. The simple provider is not really recommended for production usage, but it’s great for getting started and making sure that you understand the features. When you have made up your mind about the cache provider to use, please make sure to read its documentation to figure out how to configure the caches that your application uses. Practically all providers require you to explicitly configure every cache that you use in the application. Some offer a way to customize the default caches defined by the `spring.cache.cache-names` property.
-31.1 Supported cache providers
-The cache abstraction does not provide an actual store and relies on abstraction materialized by the org.springframework.cache.Cache and org.springframework.cache.CacheManager interfaces.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| It is also possible to [update](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#cache-annotations-put) or [evict](https://docs.spring.io/spring/docs/4.3.11.RELEASE/spring-framework-reference/htmlsingle/#cache-annotations-evict) data from the cache transparently. |
-If you haven’t defined a bean of type CacheManager or a CacheResolver named cacheResolver (see CachingConfigurer), Spring Boot tries to detect the following providers (in this order):
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you are using the cache infrastructure with beans that are not interface-based, make sure to enable the `proxyTargetClass` attribute of `@EnableCaching`. |
-Generic
-JCache (JSR-107) (EhCache 3, Hazelcast, Infinispan, etc)
-EhCache 2.x
-Hazelcast
-Infinispan
-Couchbase
-Redis
-Caffeine
-Guava (deprecated)
-Simple
-[Tip]
-It is also possible to force the cache provider to use via the spring.cache.type property. Use this property if you need to disable caching altogether in certain environment (e.g. tests).
+## 31.1 Supported cache providers
-[Tip]
-Use the spring-boot-starter-cache ‘Starter’ to quickly add basic caching dependencies. The starter brings in spring-context-support: if you are adding dependencies manually, you must include spring-context-support in order to use the JCache, EhCache 2.x or Guava support.
+The cache abstraction does not provide an actual store and relies on abstraction materialized by the `org.springframework.cache.Cache` and`org.springframework.cache.CacheManager` interfaces.
-If the CacheManager is auto-configured by Spring Boot, you can further tune its configuration before it is fully initialized by exposing a bean implementing the CacheManagerCustomizer interface. The following sets a flag to say that null values should be passed down to the underlying map.
+If you haven’t defined a bean of type `CacheManager` or a `CacheResolver` named `cacheResolver` (see `CachingConfigurer`), Spring Boot tries to detect the following providers (in this order):
+- [Generic](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-generic)
+- [JCache (JSR-107)](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-jcache) (EhCache 3, Hazelcast, Infinispan, etc)
+- [EhCache 2.x](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-ehcache2)
+- [Hazelcast](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-hazelcast)
+- [Infinispan](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-infinispan)
+- [Couchbase](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-couchbase)
+- [Redis](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-redis)
+- [Caffeine](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-caffeine)
+- [Guava](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-guava) (deprecated)
+- [Simple](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-simple)
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| It is also possible to *force* the cache provider to use via the `spring.cache.type` property. Use this property if you need to [disable caching altogether](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-caching-provider-none) in certain environment (e.g. tests). |
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Use the `spring-boot-starter-cache` ‘Starter’ to quickly add basic caching dependencies. The starter brings in `spring-context-support`: if you are adding dependencies manually, you must include `spring-context-support` in order to use the JCache, EhCache 2.x or Guava support. |
+
+If the `CacheManager` is auto-configured by Spring Boot, you can further tune its configuration before it is fully initialized by exposing a bean implementing the`CacheManagerCustomizer` interface. The following sets a flag to say that null values should be passed down to the underlying map.
+
+```
@Bean
public CacheManagerCustomizer cacheManagerCustomizer() {
return new CacheManagerCustomizer() {
@@ -4456,55 +4555,87 @@ public CacheManagerCustomizer cacheManagerCustomizer(
}
};
}
-[Note]
-In the example above, an auto-configured ConcurrentMapCacheManager is expected. If that is not the case (either you provided your own config or a different cache provider was auto-configured), the customizer won’t be invoked at all. You can have as many customizers as you want and you can also order them as usual using @Order or Ordered.
-31.1.1 Generic
-Generic caching is used if the context defines at least one org.springframework.cache.Cache bean. A CacheManager wrapping all beans of that type is created.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| In the example above, an auto-configured `ConcurrentMapCacheManager` is expected. If that is not the case (either you provided your own config or a different cache provider was auto-configured), the customizer won’t be invoked at all. You can have as many customizers as you want and you can also order them as usual using `@Order` or `Ordered`. |
+
+### 31.1.1 Generic
+
+Generic caching is used if the context defines *at least* one `org.springframework.cache.Cache` bean. A `CacheManager` wrapping all beans of that type is created.
+
+### 31.1.2 JCache (JSR-107)
-31.1.2 JCache (JSR-107)
-JCache is bootstrapped via the presence of a javax.cache.spi.CachingProvider on the classpath (i.e. a JSR-107 compliant caching library) and the JCacheCacheManager provided by the spring-boot-starter-cache ‘Starter’. There are various compliant libraries out there and Spring Boot provides dependency management for Ehcache 3, Hazelcast and Infinispan. Any other compliant library can be added as well.
+JCache is bootstrapped via the presence of a `javax.cache.spi.CachingProvider` on the classpath (i.e. a JSR-107 compliant caching library) and the `JCacheCacheManager` provided by the `spring-boot-starter-cache` ‘Starter’. There are various compliant libraries out there and Spring Boot provides dependency management for Ehcache 3, Hazelcast and Infinispan. Any other compliant library can be added as well.
It might happen that more than one provider is present, in which case the provider must be explicitly specified. Even if the JSR-107 standard does not enforce a standardized way to define the location of the configuration file, Spring Boot does its best to accommodate with implementation details.
+```
# Only necessary if more than one provider is present
spring.cache.jcache.provider=com.acme.MyCachingProvider
spring.cache.jcache.config=classpath:acme.xml
-[Note]
-Since a cache library may offer both a native implementation and JSR-107 support Spring Boot will prefer the JSR-107 support so that the same features are available if you switch to a different JSR-107 implementation.
-[Tip]
-Spring Boot has a general support for Hazelcast. If a single HazelcastInstance is available, it is automatically reused for the CacheManager as well unless the spring.cache.jcache.config property is specified.
+```
-There are several ways to customize the underlying javax.cache.cacheManager:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Since a cache library may offer both a native implementation and JSR-107 support Spring Boot will prefer the JSR-107 support so that the same features are available if you switch to a different JSR-107 implementation. |
-Caches can be created on startup via the spring.cache.cache-names property. If a custom javax.cache.configuration.Configuration bean is defined, it is used to customize them.
-org.springframework.boot.autoconfigure.cache.JCacheManagerCustomizer beans are invoked with the reference of the CacheManager for full customization.
-[Tip]
-If a standard javax.cache.CacheManager bean is defined, it is wrapped automatically in a org.springframework.cache.CacheManager implementation that the abstraction expects. No further customization is applied on it.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Spring Boot has a [general support for Hazelcast](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-hazelcast). If a single `HazelcastInstance` is available, it is automatically reused for the `CacheManager` as well unless the `spring.cache.jcache.config` property is specified. |
-31.1.3 EhCache 2.x
-EhCache 2.x is used if a file named ehcache.xml can be found at the root of the classpath. If EhCache 2.x, the EhCacheCacheManager provided by the spring-boot-starter-cache ‘Starter’ and such file is present it is used to bootstrap the cache manager. An alternate configuration file can be provided as well using:
+There are several ways to customize the underlying `javax.cache.cacheManager`:
+- Caches can be created on startup via the `spring.cache.cache-names` property. If a custom `javax.cache.configuration.Configuration` bean is defined, it is used to customize them.
+- `org.springframework.boot.autoconfigure.cache.JCacheManagerCustomizer` beans are invoked with the reference of the `CacheManager` for full customization.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If a standard `javax.cache.CacheManager` bean is defined, it is wrapped automatically in a `org.springframework.cache.CacheManager`implementation that the abstraction expects. No further customization is applied on it. |
+
+### 31.1.3 EhCache 2.x
+
+EhCache 2.x is used if a file named `ehcache.xml` can be found at the root of the classpath. If EhCache 2.x, the `EhCacheCacheManager` provided by the`spring-boot-starter-cache` ‘Starter’ and such file is present it is used to bootstrap the cache manager. An alternate configuration file can be provided as well using:
+
+```
spring.cache.ehcache.config=classpath:config/another-config.xml
-31.1.4 Hazelcast
-Spring Boot has a general support for Hazelcast. If a HazelcastInstance has been auto-configured, it is automatically wrapped in a CacheManager.
-31.1.5 Infinispan
+```
+
+### 31.1.4 Hazelcast
+
+Spring Boot has a [general support for Hazelcast](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-hazelcast). If a `HazelcastInstance` has been auto-configured, it is automatically wrapped in a `CacheManager`.
+
+### 31.1.5 Infinispan
+
Infinispan has no default configuration file location so it must be specified explicitly (or the default bootstrap is used).
+```
spring.cache.infinispan.config=infinispan.xml
-Caches can be created on startup via the spring.cache.cache-names property. If a custom ConfigurationBuilder bean is defined, it is used to customize them.
-[Note]
-The support of Infinispan in Spring Boot is restricted to the embedded mode and is quite basic. If you want more options you should use the official Infinispan Spring Boot starter instead, check the documentation for more details.
+```
-31.1.6 Couchbase
-If the Couchbase java client and the couchbase-spring-cache implementation are available and Couchbase is configured, a CouchbaseCacheManager will be auto-configured. It is also possible to create additional caches on startup using the spring.cache.cache-names property. These will operate on the Bucket that was auto-configured. You can also create additional caches on another Bucket using the customizer: assume you need two caches on the "main" Bucket (foo and bar) and one biz cache with a custom time to live of 2sec on the another Bucket. First, you can create the two first caches simply via configuration:
+Caches can be created on startup via the `spring.cache.cache-names` property. If a custom `ConfigurationBuilder` bean is defined, it is used to customize them.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The support of Infinispan in Spring Boot is restricted to the embedded mode and is quite basic. If you want more options you should use the official Infinispan Spring Boot starter instead, check [the documentation](https://github.com/infinispan/infinispan-spring-boot) for more details. |
+
+### 31.1.6 Couchbase
+
+If the Couchbase java client and the `couchbase-spring-cache` implementation are available and Couchbase is [configured](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-couchbase), a `CouchbaseCacheManager` will be auto-configured. It is also possible to create additional caches on startup using the `spring.cache.cache-names` property. These will operate on the `Bucket` that was auto-configured. You can *also* create additional caches on another `Bucket` using the customizer: assume you need two caches on the "main" `Bucket` (`foo` and `bar`) and one `biz` cache with a custom time to live of 2sec on the `another` `Bucket`. First, you can create the two first caches simply via configuration:
+
+```
spring.cache.cache-names=foo,bar
-Then define this extra @Configuration to configure the extra Bucket and the biz cache:
+```
+
+Then define this extra `@Configuration` to configure the extra `Bucket` and the `biz` cache:
+
+```
@Configuration
public class CouchbaseCacheConfiguration {
@@ -4528,100 +4659,153 @@ public class CouchbaseCacheConfiguration {
}
}
-This sample configuration reuses the Cluster that was created via auto-configuration.
-31.1.7 Redis
-If Redis is available and configured, the RedisCacheManager is auto-configured. It is also possible to create additional caches on startup using the spring.cache.cache-names property.
+```
+
+This sample configuration reuses the `Cluster` that was created via auto-configuration.
+
+### 31.1.7 Redis
+
+If Redis is available and configured, the `RedisCacheManager` is auto-configured. It is also possible to create additional caches on startup using the `spring.cache.cache-names` property.
-[Note]
-By default, a key prefix is added to prevent that if two separate caches use the same key, Redis would have overlapping keys and be likely to return invalid values. We strongly recommend to keep this setting enabled if you create your own RedisCacheManager.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| By default, a key prefix is added to prevent that if two separate caches use the same key, Redis would have overlapping keys and be likely to return invalid values. We strongly recommend to keep this setting enabled if you create your own `RedisCacheManager`. |
-31.1.8 Caffeine
-Caffeine is a Java 8 rewrite of Guava’s cache and will supersede the Guava support in Spring Boot 2.0. If Caffeine is present, a CaffeineCacheManager (provided by the spring-boot-starter-cache ‘Starter’) is auto-configured. Caches can be created on startup using the spring.cache.cache-names property and customized by one of the following (in this order):
+### 31.1.8 Caffeine
-A cache spec defined by spring.cache.caffeine.spec
-A com.github.benmanes.caffeine.cache.CaffeineSpec bean is defined
-A com.github.benmanes.caffeine.cache.Caffeine bean is defined
-For instance, the following configuration creates a foo and bar caches with a maximum size of 500 and a time to live of 10 minutes
+Caffeine is a Java 8 rewrite of Guava’s cache and will supersede the Guava support in Spring Boot 2.0. If Caffeine is present, a `CaffeineCacheManager` (provided by the `spring-boot-starter-cache` ‘Starter’) is auto-configured. Caches can be created on startup using the `spring.cache.cache-names` property and customized by one of the following (in this order):
+1. A cache spec defined by `spring.cache.caffeine.spec`
+2. A `com.github.benmanes.caffeine.cache.CaffeineSpec` bean is defined
+3. A `com.github.benmanes.caffeine.cache.Caffeine` bean is defined
+
+For instance, the following configuration creates a `foo` and `bar` caches with a maximum size of 500 and a *time to live* of 10 minutes
+
+```
spring.cache.cache-names=foo,bar
spring.cache.caffeine.spec=maximumSize=500,expireAfterAccess=600s
-Besides, if a com.github.benmanes.caffeine.cache.CacheLoader bean is defined, it is automatically associated to the CaffeineCacheManager. Since the CacheLoader is going to be associated to all caches managed by the cache manager, it must be defined as CacheLoader
-Then deploy with mvn appengine:deploy (if you need to authenticate first the build will fail).
-[Note]
-Google App Engine Classic is tied to the Servlet 2.5 API, so you can’t deploy a Spring Application there without some modifications. See the Servlet 2.5 section of this guide.
+```
-59. Installing Spring Boot applications
-In additional to running Spring Boot applications using java -jar it is also possible to make fully executable applications for Unix systems. A fully executable jar can be executed like any other executable binary or it can be registered with init.d or systemd. This makes it very easy to install and manage Spring Boot applications in common production environments.
+Then deploy with `mvn appengine:deploy` (if you need to authenticate first the build will fail).
-[Warning]
-Fully executable jars work by embedding an extra script at the front of the file. Currently, some tools do not accept this format so you may not always be able to use this technique. For example, jar -xf may silently fail to extract a jar or war that has been made fully-executable. It is recommended that you only make your jar or war fully executable if you intend to execute it directly, rather than running it with java -jar or deploying it to a servlet container.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Google App Engine Classic is tied to the Servlet 2.5 API, so you can’t deploy a Spring Application there without some modifications. See the [Servlet 2.5 section](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-servlet-2-5) of this guide. |
+
+## 59. Installing Spring Boot applications
+
+In additional to running Spring Boot applications using `java -jar` it is also possible to make fully executable applications for Unix systems. A fully executable jar can be executed like any other executable binary or it can be [registered with `init.d` or `systemd`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-service). This makes it very easy to install and manage Spring Boot applications in common production environments.
+
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| Fully executable jars work by embedding an extra script at the front of the file. Currently, some tools do not accept this format so you may not always be able to use this technique. For example, `jar -xf` may silently fail to extract a jar or war that has been made fully-executable. It is recommended that you only make your jar or war fully executable if you intend to execute it directly, rather than running it with `java -jar` or deploying it to a servlet container. |
To create a ‘fully executable’ jar with Maven use the following plugin configuration:
+```
org.springframework.boot
spring-boot-maven-plugin
@@ -7102,258 +7791,248 @@ To create a ‘fully executable’ jar with Maven use the following plugin confi
true
+
+```
+
With Gradle, the equivalent configuration is:
+```
springBoot {
executable = true
}
-You can then run your application by typing ./my-application.jar (where my-application is the name of your artifact). The directory containing the jar will be used as your application’s working directory.
-
-59.1 Supported operating systems
-The default script supports most Linux distributions and is tested on CentOS and Ubuntu. Other platforms, such as OS X and FreeBSD, will require the use of a custom embeddedLaunchScript.
-
-59.2 Unix/Linux services
-Spring Boot application can be easily started as Unix/Linux services using either init.d or systemd.
-
-59.2.1 Installation as an init.d service (System V)
-If you’ve configured Spring Boot’s Maven or Gradle plugin to generate a fully executable jar, and you’re not using a custom embeddedLaunchScript, then your application can be used as an init.d service. Simply symlink the jar to init.d to support the standard start, stop, restart and status commands.
-The script supports the following features:
-
-Starts the services as the user that owns the jar file
-Tracks application’s PID using /var/run//.pid
-Writes console logs to /var/log/.log
-Assuming that you have a Spring Boot application installed in /var/myapp, to install a Spring Boot application as an init.d service simply create a symlink:
+```
-$ sudo ln -s /var/myapp/myapp.jar /etc/init.d/myapp
-Once installed, you can start and stop the service in the usual way. For example, on a Debian based system:
+You can then run your application by typing `./my-application.jar` (where `my-application` is the name of your artifact). The directory containing the jar will be used as your application’s working directory.
-$ service myapp start
-[Tip]
-If your application fails to start, check the log file written to /var/log/.log for errors.
+## 59.1 Supported operating systems
-You can also flag the application to start automatically using your standard operating system tools. For example, on Debian:
+The default script supports most Linux distributions and is tested on CentOS and Ubuntu. Other platforms, such as OS X and FreeBSD, will require the use of a custom`embeddedLaunchScript`.
-$ update-rc.d myapp defaults
-Securing an init.d service
-[Note]
-The following is a set of guidelines on how to secure a Spring Boot application that’s being run as an init.d service. It is not intended to be an exhaustive list of everything that should be done to harden an application and the environment in which it runs.
+## 59.2 Unix/Linux services
-When executed as root, as is the case when root is being used to start an init.d service, the default executable script will run the application as the user which owns the jar file. You should never run a Spring Boot application as root so your application’s jar file should never be owned by root. Instead, create a specific user to run your application and use chown to make it the owner of the jar file. For example:
+Spring Boot application can be easily started as Unix/Linux services using either `init.d` or `systemd`.
-$ chown bootapp:bootapp your-app.jar
-In this case, the default executable script will run the application as the bootapp user.
+### 59.2.1 Installation as an init.d service (System V)
-[Tip]
-To reduce the chances of the application’s user account being compromised, you should consider preventing it from using a login shell. Set the account’s shell to /usr/sbin/nologin, for example.
+If you’ve configured Spring Boot’s Maven or Gradle plugin to generate a [fully executable jar](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-install), and you’re not using a custom `embeddedLaunchScript`, then your application can be used as an `init.d` service. Simply symlink the jar to `init.d` to support the standard `start`, `stop`, `restart` and `status` commands.
-You should also take steps to prevent the modification of your application’s jar file. Firstly, configure its permissions so that it cannot be written and can only be read or executed by its owner:
+The script supports the following features:
-$ chmod 500 your-app.jar
-Secondly, you should also take steps to limit the damage if your application or the account that’s running it is compromised. If an attacker does gain access, they could make the jar file writable and change its contents. One way to protect against this is to make it immutable using chattr:
+- Starts the services as the user that owns the jar file
+- Tracks application’s PID using `/var/run//.pid`
+- Writes console logs to `/var/log/.log`
-$ sudo chattr +i your-app.jar
-This will prevent any user, including root, from modifying the jar.
+Assuming that you have a Spring Boot application installed in `/var/myapp`, to install a Spring Boot application as an `init.d` service simply create a symlink:
-If root is used to control the application’s service and you use a .conf file to customize its startup, the .conf file will be read and evaluated by the root user. It should be secured accordingly. Use chmod so that the file can only be read by the owner and use chown to make root the owner:
+```
+$ sudo ln -s /var/myapp/myapp.jar /etc/init.d/myapp
-$ chmod 400 your-app.conf
-$ sudo chown root:root your-app.conf
-59.2.2 Installation as a systemd service
-Systemd is the successor of the System V init system, and is now being used by many modern Linux distributions. Although you can continue to use init.d scripts with systemd, it is also possible to launch Spring Boot applications using systemd ‘service’ scripts.
+```
-Assuming that you have a Spring Boot application installed in /var/myapp, to install a Spring Boot application as a systemd service create a script named myapp.service using the following example and place it in /etc/systemd/system directory:
+Once installed, you can start and stop the service in the usual way. For example, on a Debian based system:
-[Unit]
-Description=myapp
-After=syslog.target
+```
+$ service myapp start
-[Service]
-User=myapp
-ExecStart=/var/myapp/myapp.jar
-SuccessExitStatus=143
+```
-[Install]
-WantedBy=multi-user.target
-[Tip]
-Remember to change the Description, User and ExecStart fields for your application.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If your application fails to start, check the log file written to `/var/log/.log` for errors. |
-[Tip]
-Note that ExecStart field does not declare the script action command, which means that run command is used by default.
+You can also flag the application to start automatically using your standard operating system tools. For example, on Debian:
-Note that unlike when running as an init.d service, user that runs the application, PID file and console log file are managed by systemd itself and therefore must be configured using appropriate fields in ‘service’ script. Consult the service unit configuration man page for more details.
+```
+$ update-rc.d myapp defaults
-To flag the application to start automatically on system boot use the following command:
+```
-$ systemctl enable myapp.service
-Refer to man systemctl for more details.
+#### Securing an init.d service
-59.2.3 Customizing the startup script
-The default embedded startup script written by the Maven or Gradle plugin can be customized in a number of ways. For most people, using the default script along with a few customizations is usually enough. If you find you can’t customize something that you need to, you can always use the embeddedLaunchScript option to write your own file entirely.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The following is a set of guidelines on how to secure a Spring Boot application that’s being run as an init.d service. It is not intended to be an exhaustive list of everything that should be done to harden an application and the environment in which it runs. |
-Customizing script when it’s written
-It often makes sense to customize elements of the start script as it’s written into the jar file. For example, init.d scripts can provide a “description” and, since you know this up front (and it won’t change), you may as well provide it when the jar is generated.
+When executed as root, as is the case when root is being used to start an init.d service, the default executable script will run the application as the user which owns the jar file. You should never run a Spring Boot application as `root` so your application’s jar file should never be owned by root. Instead, create a specific user to run your application and use `chown` to make it the owner of the jar file. For example:
-To customize written elements, use the embeddedLaunchScriptProperties option of the Spring Boot Maven or Gradle plugins.
+```
+$ chown bootapp:bootapp your-app.jar
-The following property substitutions are supported with the default script:
+```
-Name Description
-mode
+In this case, the default executable script will run the application as the `bootapp` user.
-The script mode. Defaults to auto.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| To reduce the chances of the application’s user account being compromised, you should consider preventing it from using a login shell. Set the account’s shell to `/usr/sbin/nologin`, for example. |
-initInfoProvides
+You should also take steps to prevent the modification of your application’s jar file. Firstly, configure its permissions so that it cannot be written and can only be read or executed by its owner:
-The Provides section of “INIT INFO”. Defaults to spring-boot-application for Gradle and to ${project.artifactId} for Maven.
+```
+$ chmod 500 your-app.jar
-initInfoRequiredStart
+```
-The Required-Start section of “INIT INFO”. Defaults to $remote_fs $syslog $network.
+Secondly, you should also take steps to limit the damage if your application or the account that’s running it is compromised. If an attacker does gain access, they could make the jar file writable and change its contents. One way to protect against this is to make it immutable using `chattr`:
-initInfoRequiredStop
+```
+$ sudo chattr +i your-app.jar
-The Required-Stop section of “INIT INFO”. Defaults to $remote_fs $syslog $network.
+```
-initInfoDefaultStart
+This will prevent any user, including root, from modifying the jar.
-The Default-Start section of “INIT INFO”. Defaults to 2 3 4 5.
+If root is used to control the application’s service and you [use a `.conf` file](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-script-customization-conf-file) to customize its startup, the `.conf` file will be read and evaluated by the root user. It should be secured accordingly. Use `chmod` so that the file can only be read by the owner and use `chown` to make root the owner:
-initInfoDefaultStop
+```
+$ chmod 400 your-app.conf
+$ sudo chown root:root your-app.conf
-The Default-Stop section of “INIT INFO”. Defaults to 0 1 6.
+```
-initInfoShortDescription
+### 59.2.2 Installation as a systemd service
-The Short-Description section of “INIT INFO”. Defaults to Spring Boot Application for Gradle and to ${project.name} for Maven.
+Systemd is the successor of the System V init system, and is now being used by many modern Linux distributions. Although you can continue to use `init.d` scripts with `systemd`, it is also possible to launch Spring Boot applications using `systemd` ‘service’ scripts.
-initInfoDescription
+Assuming that you have a Spring Boot application installed in `/var/myapp`, to install a Spring Boot application as a `systemd` service create a script named `myapp.service` using the following example and place it in `/etc/systemd/system` directory:
-The Description section of “INIT INFO”. Defaults to Spring Boot Application for Gradle and to ${project.description} (falling back to ${project.name}) for Maven.
+```
+[Unit]
+Description=myapp
+After=syslog.target
-initInfoChkconfig
+[Service]
+User=myapp
+ExecStart=/var/myapp/myapp.jar
+SuccessExitStatus=143
-The chkconfig section of “INIT INFO”. Defaults to 2345 99 01.
+[Install]
+WantedBy=multi-user.target
-confFolder
+```
-The default value for CONF_FOLDER. Defaults to the folder containing the jar.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Remember to change the `Description`, `User` and `ExecStart` fields for your application. |
-logFolder
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Note that `ExecStart` field does not declare the script action command, which means that `run` command is used by default. |
-The default value for LOG_FOLDER. Only valid for an init.d service.
+Note that unlike when running as an `init.d` service, user that runs the application, PID file and console log file are managed by `systemd` itself and therefore must be configured using appropriate fields in ‘service’ script. Consult the [service unit configuration man page](https://www.freedesktop.org/software/systemd/man/systemd.service.html) for more details.
-logFilename
+To flag the application to start automatically on system boot use the following command:
-The default value for LOG_FILENAME. Only valid for an init.d service.
+```
+$ systemctl enable myapp.service
-pidFolder
+```
-The default value for PID_FOLDER. Only valid for an init.d service.
+Refer to `man systemctl` for more details.
-pidFilename
+### 59.2.3 Customizing the startup script
-The default value for the name of the pid file in PID_FOLDER. Only valid for an init.d service.
+The default embedded startup script written by the Maven or Gradle plugin can be customized in a number of ways. For most people, using the default script along with a few customizations is usually enough. If you find you can’t customize something that you need to, you can always use the `embeddedLaunchScript` option to write your own file entirely.
-useStartStopDaemon
+#### Customizing script when it’s written
-If the start-stop-daemon command, when it’s available, should be used to control the process. Defaults to true.
+It often makes sense to customize elements of the start script as it’s written into the jar file. For example, init.d scripts can provide a “description” and, since you know this up front (and it won’t change), you may as well provide it when the jar is generated.
-stopWaitTime
+To customize written elements, use the `embeddedLaunchScriptProperties` option of the Spring Boot Maven or Gradle plugins.
-The default value for STOP_WAIT_TIME. Only valid for an init.d service. Defaults to 60 seconds.
+The following property substitutions are supported with the default script:
-Customizing script when it runs
-For items of the script that need to be customized after the jar has been written you can use environment variables or a config file.
+| Name | Description |
+| -------------------------- | ------------------------------------------------------------ |
+| `mode` | The script mode. Defaults to `auto`. |
+| `initInfoProvides` | The `Provides` section of “INIT INFO”. Defaults to `spring-boot-application` for Gradle and to `${project.artifactId}` for Maven. |
+| `initInfoRequiredStart` | The `Required-Start` section of “INIT INFO”. Defaults to `$remote_fs $syslog $network`. |
+| `initInfoRequiredStop` | The `Required-Stop` section of “INIT INFO”. Defaults to `$remote_fs $syslog $network`. |
+| `initInfoDefaultStart` | The `Default-Start` section of “INIT INFO”. Defaults to `2 3 4 5`. |
+| `initInfoDefaultStop` | The `Default-Stop` section of “INIT INFO”. Defaults to `0 1 6`. |
+| `initInfoShortDescription` | The `Short-Description` section of “INIT INFO”. Defaults to `Spring Boot Application` for Gradle and to `${project.name}` for Maven. |
+| `initInfoDescription` | The `Description` section of “INIT INFO”. Defaults to `Spring Boot Application` for Gradle and to `${project.description}` (falling back to `${project.name}`) for Maven. |
+| `initInfoChkconfig` | The `chkconfig` section of “INIT INFO”. Defaults to `2345 99 01`. |
+| `confFolder` | The default value for `CONF_FOLDER`. Defaults to the folder containing the jar. |
+| `logFolder` | The default value for `LOG_FOLDER`. Only valid for an `init.d` service. |
+| `logFilename` | The default value for `LOG_FILENAME`. Only valid for an `init.d` service. |
+| `pidFolder` | The default value for `PID_FOLDER`. Only valid for an `init.d` service. |
+| `pidFilename` | The default value for the name of the pid file in `PID_FOLDER`. Only valid for an `init.d` service. |
+| `useStartStopDaemon` | If the `start-stop-daemon` command, when it’s available, should be used to control the process. Defaults to `true`. |
+| `stopWaitTime` | The default value for `STOP_WAIT_TIME`. Only valid for an `init.d` service. Defaults to 60 seconds. |
+
+#### Customizing script when it runs
+
+For items of the script that need to be customized *after* the jar has been written you can use environment variables or a [config file](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-script-customization-conf-file).
The following environment properties are supported with the default script:
-Variable Description
-MODE
-
-The “mode” of operation. The default depends on the way the jar was built, but will usually be auto (meaning it tries to guess if it is an init script by checking if it is a symlink in a directory called init.d). You can explicitly set it to service so that the stop|start|status|restart commands work, or to run if you just want to run the script in the foreground.
-
-USE_START_STOP_DAEMON
-
-If the start-stop-daemon command, when it’s available, should be used to control the process. Defaults to true.
-
-PID_FOLDER
-
-The root name of the pid folder (/var/run by default).
-
-LOG_FOLDER
-
-The name of the folder to put log files in (/var/log by default).
-
-CONF_FOLDER
-
-The name of the folder to read .conf files from (same folder as jar-file by default).
-
-LOG_FILENAME
-
-The name of the log file in the LOG_FOLDER (.log by default).
-
-APP_NAME
-
-The name of the app. If the jar is run from a symlink the script guesses the app name, but if it is not a symlink, or you want to explicitly set the app name this can be useful.
-
-RUN_ARGS
-
-The arguments to pass to the program (the Spring Boot app).
-
-JAVA_HOME
-
-The location of the java executable is discovered by using the PATH by default, but you can set it explicitly if there is an executable file at $JAVA_HOME/bin/java.
-
-JAVA_OPTS
+| Variable | Description |
+| ----------------------- | ------------------------------------------------------------ |
+| `MODE` | The “mode” of operation. The default depends on the way the jar was built, but will usually be `auto` *(meaning it tries to guess if it is an init script by checking if it is a symlink in a directory called init.d)*. You can explicitly set it to `service` so that the `stop|start|status|restart` commands work, or to `run` if you just want to run the script in the foreground. |
+| `USE_START_STOP_DAEMON` | If the `start-stop-daemon` command, when it’s available, should be used to control the process. Defaults to `true`. |
+| `PID_FOLDER` | The root name of the pid folder (`/var/run` by default). |
+| `LOG_FOLDER` | The name of the folder to put log files in (`/var/log` by default). |
+| `CONF_FOLDER` | The name of the folder to read .conf files from (same folder as jar-file by default). |
+| `LOG_FILENAME` | The name of the log file in the `LOG_FOLDER` (`.log` by default). |
+| `APP_NAME` | The name of the app. If the jar is run from a symlink the script guesses the app name, but if it is not a symlink, or you want to explicitly set the app name this can be useful. |
+| `RUN_ARGS` | The arguments to pass to the program (the Spring Boot app). |
+| `JAVA_HOME` | The location of the `java` executable is discovered by using the `PATH` by default, but you can set it explicitly if there is an executable file at `$JAVA_HOME/bin/java`. |
+| `JAVA_OPTS` | Options that are passed to the JVM when it is launched. |
+| `JARFILE` | The explicit location of the jar file, in case the script is being used to launch a jar that it is not actually embedded in. |
+| `DEBUG` | if not empty will set the `-x` flag on the shell process, making it easy to see the logic in the script. |
+| `STOP_WAIT_TIME` | The time in seconds to wait when stopping the application before forcing a shutdown (`60` by default). |
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The `PID_FOLDER`, `LOG_FOLDER` and `LOG_FILENAME` variables are only valid for an `init.d` service. With `systemd` the equivalent customizations are made using ‘service’ script. Check the [service unit configuration man page](https://www.freedesktop.org/software/systemd/man/systemd.service.html) for more details. |
+
+With the exception of `JARFILE` and `APP_NAME`, the above settings can be configured using a `.conf` file. The file is expected next to the jar file and have the same name but suffixed with `.conf` rather than `.jar`. For example, a jar named `/var/myapp/myapp.jar` will use the configuration file named `/var/myapp/myapp.conf`.
+
+**myapp.conf.**
+
+```
+JAVA_OPTS=-Xmx1024M
+LOG_FOLDER=/custom/log/folder
-Options that are passed to the JVM when it is launched.
+```
-JARFILE
-The explicit location of the jar file, in case the script is being used to launch a jar that it is not actually embedded in.
-DEBUG
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| You can use a `CONF_FOLDER` environment variable to customize the location of the config file if you don’t like it living next to the jar. |
-if not empty will set the -x flag on the shell process, making it easy to see the logic in the script.
+To learn about securing this file appropriately, please refer to [the guidelines for securing an init.d service](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#deployment-initd-service-securing).
-STOP_WAIT_TIME
+## 59.3 Microsoft Windows services
-The time in seconds to wait when stopping the application before forcing a shutdown (60 by default).
+Spring Boot application can be started as Windows service using [`winsw`](https://github.com/kohsuke/winsw).
-[Note]
-The PID_FOLDER, LOG_FOLDER and LOG_FILENAME variables are only valid for an init.d service. With systemd the equivalent customizations are made using ‘service’ script. Check the service unit configuration man page for more details.
+A sample [maintained separately](https://github.com/snicoll-scratches/spring-boot-daemon) to the core of Spring Boot describes step-by-step how you can create a Windows service for your Spring Boot application.
-With the exception of JARFILE and APP_NAME, the above settings can be configured using a .conf file. The file is expected next to the jar file and have the same name but suffixed with .conf rather than .jar. For example, a jar named /var/myapp/myapp.jar will use the configuration file named /var/myapp/myapp.conf.
+## 60. What to read next
-myapp.conf.
+Check out the [Cloud Foundry](http://www.cloudfoundry.com/), [Heroku](https://www.heroku.com/), [OpenShift](https://www.openshift.com/) and [Boxfuse](https://boxfuse.com/) web sites for more information about the kinds of features that a PaaS can offer. These are just four of the most popular Java PaaS providers, since Spring Boot is so amenable to cloud-based deployment you’re free to consider other providers as well.
-JAVA_OPTS=-Xmx1024M
-LOG_FOLDER=/custom/log/folder
-[Tip]
-You can use a CONF_FOLDER environment variable to customize the location of the config file if you don’t like it living next to the jar.
+The next section goes on to cover the *Spring Boot CLI*; or you can jump ahead to read about *build tool plugins*.
-To learn about securing this file appropriately, please refer to the guidelines for securing an init.d service.
+# Part VII. Spring Boot CLI
-59.3 Microsoft Windows services
-Spring Boot application can be started as Windows service using winsw.
-A sample maintained separately to the core of Spring Boot describes step-by-step how you can create a Windows service for your Spring Boot application.
-60. What to read next
-Check out the Cloud Foundry, Heroku, OpenShift and Boxfuse web sites for more information about the kinds of features that a PaaS can offer. These are just four of the most popular Java PaaS providers, since Spring Boot is so amenable to cloud-based deployment you’re free to consider other providers as well.
+The Spring Boot CLI is a command line tool that can be used if you want to quickly develop with Spring. It allows you to run Groovy scripts, which means that you have a familiar Java-like syntax, without so much boilerplate code. You can also bootstrap a new project or write your own command for it.
-The next section goes on to cover the Spring Boot CLI; or you can jump ahead to read about build tool plugins.
+## 61. Installing the CLI
-Part VII. Spring Boot CLI
-The Spring Boot CLI is a command line tool that can be used if you want to quickly develop with Spring. It allows you to run Groovy scripts, which means that you have a familiar Java-like syntax, without so much boilerplate code. You can also bootstrap a new project or write your own command for it.
+The Spring Boot CLI can be installed manually; using SDKMAN! (the SDK Manager) or using Homebrew or MacPorts if you are an OSX user. See *Section 10.2, “Installing the Spring Boot CLI”* in the “Getting started” section for comprehensive installation instructions.
-61. Installing the CLI
-The Spring Boot CLI can be installed manually; using SDKMAN! (the SDK Manager) or using Homebrew or MacPorts if you are an OSX user. See Section 10.2, “Installing the Spring Boot CLI” in the “Getting started” section for comprehensive installation instructions.
+## 62. Using the CLI
-62. Using the CLI
-Once you have installed the CLI you can run it by typing spring. If you run spring without any arguments, a simple help screen is displayed:
+Once you have installed the CLI you can run it by typing `spring`. If you run `spring` without any arguments, a simple help screen is displayed:
+```
$ spring
usage: spring [--help] [--version]
[]
@@ -7364,8 +8043,12 @@ Available commands are:
Run a spring groovy script
... more command help is shown here
-You can use help to get more details about any of the supported commands. For example:
+```
+
+You can use `help` to get more details about any of the supported commands. For example:
+
+```
$ spring help run
spring run - Run a spring groovy script
@@ -7384,17 +8067,26 @@ Option Description
-v, --verbose Verbose logging of dependency
resolution
--watch Watch the specified file for changes
-The version command provides a quick way to check which version of Spring Boot you are using.
+```
+
+The `version` command provides a quick way to check which version of Spring Boot you are using.
+
+```
$ spring version
Spring CLI v1.5.7.BUILD-SNAPSHOT
-62.1 Running applications using the CLI
-You can compile and run Groovy source code using the run command. The Spring Boot CLI is completely self-contained so you don’t need any external Groovy installation.
+
+```
+
+## 62.1 Running applications using the CLI
+
+You can compile and run Groovy source code using the `run` command. The Spring Boot CLI is completely self-contained so you don’t need any external Groovy installation.
Here is an example “hello world” web application written in Groovy:
-hello.groovy.
+**hello.groovy.**
+```
@RestController
class WebApplication {
@@ -7404,116 +8096,117 @@ class WebApplication {
}
}
-To compile and run the application type:
-
-$ spring run hello.groovy
-To pass command line arguments to the application, you need to use a -- to separate them from the “spring” command arguments, e.g.
-
-$ spring run hello.groovy -- --server.port=9000
-To set JVM command line arguments you can use the JAVA_OPTS environment variable, e.g.
-
-$ JAVA_OPTS=-Xmx1024m spring run hello.groovy
-62.1.1 Deduced “grab” dependencies
-Standard Groovy includes a @Grab annotation which allows you to declare dependencies on a third-party libraries. This useful technique allows Groovy to download jars in the same way as Maven or Gradle would, but without requiring you to use a build tool.
-
-Spring Boot extends this technique further, and will attempt to deduce which libraries to “grab” based on your code. For example, since the WebApplication code above uses @RestController annotations, “Tomcat” and “Spring MVC” will be grabbed.
-The following items are used as “grab hints”:
-
-Items Grabs
-JdbcTemplate, NamedParameterJdbcTemplate, DataSource
-
-JDBC Application.
-
-@EnableJms
+```
-JMS Application.
-@EnableCaching
-Caching abstraction.
-
-@Test
-
-JUnit.
-
-@EnableRabbit
+To compile and run the application type:
-RabbitMQ.
+```
+$ spring run hello.groovy
-@EnableReactor
+```
-Project Reactor.
+To pass command line arguments to the application, you need to use a `--` to separate them from the “spring” command arguments, e.g.
-extends Specification
+```
+$ spring run hello.groovy -- --server.port=9000
-Spock test.
+```
-@EnableBatchProcessing
+To set JVM command line arguments you can use the `JAVA_OPTS` environment variable, e.g.
-Spring Batch.
+```
+$ JAVA_OPTS=-Xmx1024m spring run hello.groovy
-@MessageEndpoint @EnableIntegrationPatterns
+```
-Spring Integration.
+### 62.1.1 Deduced “grab” dependencies
-@EnableDeviceResolver
+Standard Groovy includes a `@Grab` annotation which allows you to declare dependencies on a third-party libraries. This useful technique allows Groovy to download jars in the same way as Maven or Gradle would, but without requiring you to use a build tool.
-Spring Mobile.
+Spring Boot extends this technique further, and will attempt to deduce which libraries to “grab” based on your code. For example, since the `WebApplication` code above uses `@RestController` annotations, “Tomcat” and “Spring MVC” will be grabbed.
-@Controller @RestController @EnableWebMvc
+The following items are used as “grab hints”:
-Spring MVC + Embedded Tomcat.
+| Items | Grabs |
+| ---------------------------------------------------------- | ------------------------------ |
+| `JdbcTemplate`, `NamedParameterJdbcTemplate`, `DataSource` | JDBC Application. |
+| `@EnableJms` | JMS Application. |
+| `@EnableCaching` | Caching abstraction. |
+| `@Test` | JUnit. |
+| `@EnableRabbit` | RabbitMQ. |
+| `@EnableReactor` | Project Reactor. |
+| extends `Specification` | Spock test. |
+| `@EnableBatchProcessing` | Spring Batch. |
+| `@MessageEndpoint` `@EnableIntegrationPatterns` | Spring Integration. |
+| `@EnableDeviceResolver` | Spring Mobile. |
+| `@Controller` `@RestController` `@EnableWebMvc` | Spring MVC + Embedded Tomcat. |
+| `@EnableWebSecurity` | Spring Security. |
+| `@EnableTransactionManagement` | Spring Transaction Management. |
-@EnableWebSecurity
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| See subclasses of [`CompilerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-cli/src/main/java/org/springframework/boot/cli/compiler/CompilerAutoConfiguration.java) in the Spring Boot CLI source code to understand exactly how customizations are applied. |
-Spring Security.
+### 62.1.2 Deduced “grab” coordinates
-@EnableTransactionManagement
+Spring Boot extends Groovy’s standard `@Grab` support by allowing you to specify a dependency without a group or version, for example `@Grab('freemarker')`. This will consult Spring Boot’s default dependency metadata to deduce the artifact’s group and version. Note that the default metadata is tied to the version of the CLI that you’re using – it will only change when you move to a new version of the CLI, putting you in control of when the versions of your dependencies may change. A table showing the dependencies and their versions that are included in the default metadata can be found in the [appendix](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#appendix-dependency-versions).
-Spring Transaction Management.
+### 62.1.3 Default import statements
-[Tip]
-See subclasses of CompilerAutoConfiguration in the Spring Boot CLI source code to understand exactly how customizations are applied.
+To help reduce the size of your Groovy code, several `import` statements are automatically included. Notice how the example above refers to `@Component`,`@RestController` and `@RequestMapping` without needing to use fully-qualified names or `import` statements.
-62.1.2 Deduced “grab” coordinates
-Spring Boot extends Groovy’s standard @Grab support by allowing you to specify a dependency without a group or version, for example @Grab('freemarker'). This will consult Spring Boot’s default dependency metadata to deduce the artifact’s group and version. Note that the default metadata is tied to the version of the CLI that you’re using – it will only change when you move to a new version of the CLI, putting you in control of when the versions of your dependencies may change. A table showing the dependencies and their versions that are included in the default metadata can be found in the appendix.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Many Spring annotations will work without using `import` statements. Try running your application to see what fails before adding imports. |
-62.1.3 Default import statements
-To help reduce the size of your Groovy code, several import statements are automatically included. Notice how the example above refers to @Component, @RestController and @RequestMapping without needing to use fully-qualified names or import statements.
+### 62.1.4 Automatic main method
-[Tip]
-Many Spring annotations will work without using import statements. Try running your application to see what fails before adding imports.
+Unlike the equivalent Java application, you do not need to include a `public static void main(String[] args)` method with your `Groovy` scripts. A`SpringApplication` is automatically created, with your compiled code acting as the `source`.
-62.1.4 Automatic main method
-Unlike the equivalent Java application, you do not need to include a public static void main(String[] args) method with your Groovy scripts. A SpringApplication is automatically created, with your compiled code acting as the source.
+### 62.1.5 Custom dependency management
-62.1.5 Custom dependency management
-By default, the CLI uses the dependency management declared in spring-boot-dependencies when resolving @Grab dependencies. Additional dependency management, that will override the default dependency management, can be configured using the @DependencyManagementBom annotation. The annotation’s value should specify the coordinates (groupId:artifactId:version) of one or more Maven BOMs.
+By default, the CLI uses the dependency management declared in `spring-boot-dependencies` when resolving `@Grab` dependencies. Additional dependency management, that will override the default dependency management, can be configured using the `@DependencyManagementBom` annotation. The annotation’s value should specify the coordinates (`groupId:artifactId:version`) of one or more Maven BOMs.
For example, the following declaration:
+```
@DependencyManagementBom("com.example.custom-bom:1.0.0")
-Will pick up custom-bom-1.0.0.pom in a Maven repository under com/example/custom-versions/1.0.0/.
+
+```
+
+Will pick up `custom-bom-1.0.0.pom` in a Maven repository under `com/example/custom-versions/1.0.0/`.
When multiple BOMs are specified they are applied in the order that they’re declared. For example:
+```
@DependencyManagementBom(["com.example.custom-bom:1.0.0",
"com.example.another-bom:1.0.0"])
-indicates that dependency management in another-bom will override the dependency management in custom-bom.
-You can use @DependencyManagementBom anywhere that you can use @Grab, however, to ensure consistent ordering of the dependency management, you can only use @DependencyManagementBom at most once in your application. A useful source of dependency management (that is a superset of Spring Boot’s dependency management) is the Spring IO Platform, e.g. @DependencyManagementBom('io.spring.platform:platform-bom:1.1.2.RELEASE').
+```
+
+indicates that dependency management in `another-bom` will override the dependency management in `custom-bom`.
-62.2 Testing your code
-The test command allows you to compile and run tests for your application. Typical usage looks like this:
+You can use `@DependencyManagementBom` anywhere that you can use `@Grab`, however, to ensure consistent ordering of the dependency management, you can only use `@DependencyManagementBom` at most once in your application. A useful source of dependency management (that is a superset of Spring Boot’s dependency management) is the [Spring IO Platform](https://platform.spring.io/), e.g. `@DependencyManagementBom('io.spring.platform:platform-bom:1.1.2.RELEASE')`.
+## 62.2 Testing your code
+
+The `test` command allows you to compile and run tests for your application. Typical usage looks like this:
+
+```
$ spring test app.groovy tests.groovy
Total: 1, Success: 1, : Failures: 0
Passed? true
-In this example, tests.groovy contains JUnit @Test methods or Spock Specification classes. All the common framework annotations and static methods should be available to you without having to import them.
-Here is the tests.groovy file that we used above (with a JUnit test):
+```
+
+In this example, `tests.groovy` contains JUnit `@Test` methods or Spock `Specification` classes. All the common framework annotations and static methods should be available to you without having to `import` them.
+
+Here is the `tests.groovy` file that we used above (with a JUnit test):
+```
class ApplicationTests {
@Test
@@ -7522,36 +8215,68 @@ class ApplicationTests {
}
}
-[Tip]
-If you have more than one test source files, you might prefer to organize them into a test directory.
-62.3 Applications with multiple source files
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you have more than one test source files, you might prefer to organize them into a `test` directory. |
+
+## 62.3 Applications with multiple source files
+
You can use “shell globbing” with all commands that accept file input. This allows you to easily use multiple files from a single directory, e.g.
+```
$ spring run *.groovy
+
+```
+
This technique can also be useful if you want to segregate your “test” or “spec” code from the main application code:
+```
$ spring test app/*.groovy test/*.groovy
-62.4 Packaging your application
-You can use the jar command to package your application into a self-contained executable jar file. For example:
+```
+
+## 62.4 Packaging your application
+
+You can use the `jar` command to package your application into a self-contained executable jar file. For example:
+
+```
$ spring jar my-app.jar *.groovy
-The resulting jar will contain the classes produced by compiling the application and all of the application’s dependencies so that it can then be run using java -jar. The jar file will also contain entries from the application’s classpath. You can add explicit paths to the jar using --include and --exclude (both are comma-separated, and both accept prefixes to the values “+” and “-” to signify that they should be removed from the defaults). The default includes are
+```
+
+The resulting jar will contain the classes produced by compiling the application and all of the application’s dependencies so that it can then be run using `java -jar`. The jar file will also contain entries from the application’s classpath. You can add explicit paths to the jar using `--include` and `--exclude` (both are comma-separated, and both accept prefixes to the values “+” and “-” to signify that they should be removed from the defaults). The default includes are
+
+```
public/**, resources/**, static/**, templates/**, META-INF/**, *
+
+```
+
and the default excludes are
+```
.*, repository/**, build/**, target/**, **/*.jar, **/*.groovy
-See the output of spring help jar for more information.
-62.5 Initialize a new project
-The init command allows you to create a new project using start.spring.io without leaving the shell. For example:
+```
+See the output of `spring help jar` for more information.
+
+## 62.5 Initialize a new project
+
+The `init` command allows you to create a new project using [start.spring.io](https://start.spring.io/) without leaving the shell. For example:
+
+```
$ spring init --dependencies=web,data-jpa my-project
Using service at https://start.spring.io
Project extracted to '/Users/developer/example/my-project'
-This creates a my-project directory with a Maven-based project using spring-boot-starter-web and spring-boot-starter-data-jpa. You can list the capabilities of the service using the --list flag
+```
+
+This creates a `my-project` directory with a Maven-based project using `spring-boot-starter-web` and `spring-boot-starter-data-jpa`. You can list the capabilities of the service using the `--list` flag
+
+```
$ spring init --list
=======================================
Capabilities of https://start.spring.io
@@ -7573,40 +8298,71 @@ maven-build - Maven POM [format:build, build:maven]
maven-project - Maven Project [format:project, build:maven] (default)
...
-The init command supports many options, check the help output for more details. For instance, the following command creates a gradle project using Java 8 and war packaging:
+```
+
+The `init` command supports many options, check the `help` output for more details. For instance, the following command creates a gradle project using Java 8 and `war` packaging:
+
+```
$ spring init --build=gradle --java-version=1.8 --dependencies=websocket --packaging=war sample-app.zip
Using service at https://start.spring.io
Content saved to 'sample-app.zip'
-62.6 Using the embedded shell
-Spring Boot includes command-line completion scripts for BASH and zsh shells. If you don’t use either of these shells (perhaps you are a Windows user) then you can use the shell command to launch an integrated shell.
+```
+
+## 62.6 Using the embedded shell
+
+Spring Boot includes command-line completion scripts for BASH and zsh shells. If you don’t use either of these shells (perhaps you are a Windows user) then you can use the `shell` command to launch an integrated shell.
+
+```
$ spring shell
Spring Boot (v1.5.7.BUILD-SNAPSHOT)
Hit TAB to complete. Type \'help' and hit RETURN for help, and \'exit' to quit.
+
+```
+
From inside the embedded shell you can run other commands directly:
+```
$ version
Spring CLI v1.5.7.BUILD-SNAPSHOT
-The embedded shell supports ANSI color output as well as tab completion. If you need to run a native command you can use the ! prefix. Hitting ctrl-c will exit the embedded shell.
-62.7 Adding extensions to the CLI
-You can add extensions to the CLI using the install command. The command takes one or more sets of artifact coordinates in the format group:artifact:version. For example:
+```
+The embedded shell supports ANSI color output as well as `tab` completion. If you need to run a native command you can use the `!` prefix. Hitting `ctrl-c` will exit the embedded shell.
+
+## 62.7 Adding extensions to the CLI
+
+You can add extensions to the CLI using the `install` command. The command takes one or more sets of artifact coordinates in the format `group:artifact:version`. For example:
+
+```
$ spring install com.example:spring-boot-cli-extension:1.0.0.RELEASE
+
+```
+
In addition to installing the artifacts identified by the coordinates you supply, all of the artifacts' dependencies will also be installed.
-To uninstall a dependency use the uninstall command. As with the install command, it takes one or more sets of artifact coordinates in the format group:artifact:version. For example:
+To uninstall a dependency use the `uninstall` command. As with the `install` command, it takes one or more sets of artifact coordinates in the format `group:artifact:version`. For example:
+```
$ spring uninstall com.example:spring-boot-cli-extension:1.0.0.RELEASE
+
+```
+
It will uninstall the artifacts identified by the coordinates you supply and their dependencies.
-To uninstall all additional dependencies you can use the --all option. For example:
+To uninstall all additional dependencies you can use the `--all` option. For example:
+```
$ spring uninstall --all
-63. Developing application with the Groovy beans DSL
-Spring Framework 4.0 has native support for a beans{} “DSL” (borrowed from Grails), and you can embed bean definitions in your Groovy application scripts using the same format. This is sometimes a good way to include external features like middleware declarations. For example:
+```
+
+## 63. Developing application with the Groovy beans DSL
+
+Spring Framework 4.0 has native support for a `beans{}` “DSL” (borrowed from [Grails](http://grails.org/)), and you can embed bean definitions in your Groovy application scripts using the same format. This is sometimes a good way to include external features like middleware declarations. For example:
+
+```
@Configuration
class Application implements CommandLineRunner {
@@ -7627,39 +8383,51 @@ beans {
message = "Hello World"
}
}
-You can mix class declarations with beans{} in the same file as long as they stay at the top level, or you can put the beans DSL in a separate file if you prefer.
-64. Configuring the CLI with settings.xml
-The Spring Boot CLI uses Aether, Maven’s dependency resolution engine, to resolve dependencies. The CLI makes use of the Maven configuration found in ~/.m2/settings.xml to configure Aether. The following configuration settings are honored by the CLI:
+```
+
+You can mix class declarations with `beans{}` in the same file as long as they stay at the top level, or you can put the beans DSL in a separate file if you prefer.
+
+## 64. Configuring the CLI with settings.xml
-Offline
-Mirrors
-Servers
-Proxies
-Profiles
+The Spring Boot CLI uses Aether, Maven’s dependency resolution engine, to resolve dependencies. The CLI makes use of the Maven configuration found in `~/.m2/settings.xml` to configure Aether. The following configuration settings are honored by the CLI:
-Activation
-Repositories
-Active profiles
-Please refer to Maven’s settings documentation for further information.
+- Offline
+- Mirrors
+- Servers
+- Proxies
+- Profiles
+ - Activation
+ - Repositories
+- Active profiles
-65. What to read next
-There are some sample groovy scripts available from the GitHub repository that you can use to try out the Spring Boot CLI. There is also extensive Javadoc throughout the source code.
+Please refer to [Maven’s settings documentation](https://maven.apache.org/settings.html) for further information.
-If you find that you reach the limit of the CLI tool, you will probably want to look at converting your application to full Gradle or Maven built “groovy project”. The next section covers Spring Boot’s Build tool plugins that you can use with Gradle or Maven.
+## 65. What to read next
-Part VIII. Build tool plugins
-Spring Boot provides build tool plugins for Maven and Gradle. The plugins offer a variety of features, including the packaging of executable jars. This section provides more details on both plugins, as well as some help should you need to extend an unsupported build system. If you are just getting started, you might want to read “Chapter 13, Build systems” from the Part III, “Using Spring Boot” section first.
+There are some [sample groovy scripts](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-cli/samples) available from the GitHub repository that you can use to try out the Spring Boot CLI. There is also extensive Javadoc throughout the [source code](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-cli/src/main/java/org/springframework/boot/cli).
-66. Spring Boot Maven plugin
-The Spring Boot Maven Plugin provides Spring Boot support in Maven, allowing you to package executable jar or war archives and run an application “in-place”. To use it you must be using Maven 3.2 (or better).
+If you find that you reach the limit of the CLI tool, you will probably want to look at converting your application to full Gradle or Maven built “groovy project”. The next section covers Spring Boot’s *Build tool plugins* that you can use with Gradle or Maven.
-[Note]
-Refer to the Spring Boot Maven Plugin Site for complete plugin documentation.
+# Part VIII. Build tool plugins
-66.1 Including the plugin
-To use the Spring Boot Maven Plugin simply include the appropriate XML in the plugins section of your pom.xml
+
+Spring Boot provides build tool plugins for Maven and Gradle. The plugins offer a variety of features, including the packaging of executable jars. This section provides more details on both plugins, as well as some help should you need to extend an unsupported build system. If you are just getting started, you might want to read “[Chapter 13, *Build systems*](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-build-systems)” from the [Part III, “Using Spring Boot”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot) section first.
+
+## 66. Spring Boot Maven plugin
+
+The [Spring Boot Maven Plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/) provides Spring Boot support in Maven, allowing you to package executable jar or war archives and run an application “in-place”. To use it you must be using Maven 3.2 (or better).
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Refer to the [Spring Boot Maven Plugin Site](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/) for complete plugin documentation. |
+
+## 66.1 Including the plugin
+
+To use the Spring Boot Maven Plugin simply include the appropriate XML in the `plugins` section of your `pom.xml`
+
+```
@@ -7682,18 +8450,30 @@ To use the Spring Boot Maven Plugin simply include the appropriate XML in the pl
-This configuration will repackage a jar or war that is built during the package phase of the Maven lifecycle. The following example shows both the repackaged jar, as well as the original jar, in the target directory:
+```
+
+This configuration will repackage a jar or war that is built during the `package` phase of the Maven lifecycle. The following example shows both the repackaged jar, as well as the original jar, in the `target` directory:
+
+```
$ mvn package
$ ls target/*.jar
target/myproject-1.0.0.jar target/myproject-1.0.0.jar.original
-If you don’t include the configuration as above, you can run the plugin on its own (but only if the package goal is used as well). For example:
+```
+
+If you don’t include the `` configuration as above, you can run the plugin on its own (but only if the package goal is used as well). For example:
+
+```
$ mvn package spring-boot:repackage
$ ls target/*.jar
target/myproject-1.0.0.jar target/myproject-1.0.0.jar.original
-If you are using a milestone or snapshot release you will also need to add appropriate pluginRepository elements:
+```
+
+If you are using a milestone or snapshot release you will also need to add appropriate `pluginRepository` elements:
+
+```
spring-snapshots
@@ -7704,9 +8484,14 @@ If you are using a milestone or snapshot release you will also need to add appro
http://repo.spring.io/milestone
-66.2 Packaging executable jar and war files
-Once spring-boot-maven-plugin has been included in your pom.xml it will automatically attempt to rewrite archives to make them executable using the spring-boot:repackage goal. You should configure your project to build a jar or war (as appropriate) using the usual packaging element:
+```
+
+## 66.2 Packaging executable jar and war files
+
+Once `spring-boot-maven-plugin` has been included in your `pom.xml` it will automatically attempt to rewrite archives to make them executable using the `spring-boot:repackage` goal. You should configure your project to build a jar or war (as appropriate) using the usual `packaging` element:
+
+```
@@ -7714,14 +8499,22 @@ Once spring-boot-maven-plugin has been included in your pom.xml it will automati
jar
-Your existing archive will be enhanced by Spring Boot during the package phase. The main class that you want to launch can either be specified using a configuration option, or by adding a Main-Class attribute to the manifest in the usual way. If you don’t specify a main class the plugin will search for a class with a public static void main(String[] args) method.
+
+```
+
+Your existing archive will be enhanced by Spring Boot during the `package` phase. The main class that you want to launch can either be specified using a configuration option, or by adding a `Main-Class` attribute to the manifest in the usual way. If you don’t specify a main class the plugin will search for a class with a`public static void main(String[] args)` method.
To build and run a project artifact, you can type the following:
+```
$ mvn package
$ java -jar target/mymodule-0.0.1-SNAPSHOT.jar
+
+```
+
To build a war file that is both executable and deployable into an external container you need to mark the embedded container dependencies as “provided”, e.g:
+```
@@ -7741,17 +8534,24 @@ To build a war file that is both executable and deployable into an external cont
-[Tip]
-See the “Section 85.1, “Create a deployable war file”” section for more details on how to create a deployable war file.
-Advanced configuration options and examples are available in the plugin info page.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| See the “[Section 85.1, “Create a deployable war file”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-a-deployable-war-file)” section for more details on how to create a deployable war file. |
+
+Advanced configuration options and examples are available in the [plugin info page](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/).
+
+## 67. Spring Boot Gradle plugin
+
+The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, allowing you to package executable jar or war archives, run Spring Boot applications and use the dependency management provided by `spring-boot-dependencies`.
-67. Spring Boot Gradle plugin
-The Spring Boot Gradle Plugin provides Spring Boot support in Gradle, allowing you to package executable jar or war archives, run Spring Boot applications and use the dependency management provided by spring-boot-dependencies.
+## 67.1 Including the plugin
-67.1 Including the plugin
-To use the Spring Boot Gradle Plugin simply include a buildscript dependency and apply the spring-boot plugin:
+To use the Spring Boot Gradle Plugin simply include a `buildscript` dependency and apply the `spring-boot` plugin:
+```
buildscript {
repositories {
maven { url 'http://repo.spring.io/snapshot' }
@@ -7762,33 +8562,49 @@ buildscript {
}
}
apply plugin: 'org.springframework.boot'
-67.2 Gradle dependency management
-The spring-boot plugin automatically applies the Dependency Management Plugin and configures it to import the spring-boot-starter-parent bom. This provides a similar dependency management experience to the one that is enjoyed by Maven users. For example, it allows you to omit version numbers when declaring dependencies that are managed in the bom. To make use of this functionality, simply declare dependencies in the usual way, but leave the version number empty:
+```
+
+## 67.2 Gradle dependency management
+
+The `spring-boot` plugin automatically applies the [Dependency Management Plugin](https://github.com/spring-gradle-plugins/dependency-management-plugin/) and configures it to import the `spring-boot-starter-parent` bom. This provides a similar dependency management experience to the one that is enjoyed by Maven users. For example, it allows you to omit version numbers when declaring dependencies that are managed in the bom. To make use of this functionality, simply declare dependencies in the usual way, but leave the version number empty:
+
+```
dependencies {
compile("org.springframework.boot:spring-boot-starter-web")
compile("org.thymeleaf:thymeleaf-spring4")
compile("nz.net.ultraq.thymeleaf:thymeleaf-layout-dialect")
}
-[Note]
-The version of the spring-boot gradle plugin that you declare determines the version of the spring-boot-starter-parent bom that is imported (this ensures that builds are always repeatable). You should always set the version of the spring-boot gradle plugin to the actual Spring Boot version that you wish to use. Details of the versions that are provided can be found in the appendix.
-To learn more about the capabilities of the Dependency Management Plugin, please refer to its documentation.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The version of the `spring-boot` gradle plugin that you declare determines the version of the `spring-boot-starter-parent` bom that is imported (this ensures that builds are always repeatable). You should always set the version of the `spring-boot` gradle plugin to the actual Spring Boot version that you wish to use. Details of the versions that are provided can be found in the [appendix](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#appendix-dependency-versions). |
-67.3 Packaging executable jar and war files
-Once the spring-boot plugin has been applied to your project it will automatically attempt to rewrite archives to make them executable using the bootRepackage task. You should configure your project to build a jar or war (as appropriate) in the usual way.
+To learn more about the capabilities of the Dependency Management Plugin, please refer to its [documentation](https://github.com/spring-gradle-plugins/dependency-management-plugin/blob/master/README.md).
-The main class that you want to launch can either be specified using a configuration option, or by adding a Main-Class attribute to the manifest. If you don’t specify a main class the plugin will search for a class with a public static void main(String[] args) method.
+## 67.3 Packaging executable jar and war files
-[Tip]
-Check Section 67.6, “Repackage configuration” for a full list of configuration options.
+Once the `spring-boot` plugin has been applied to your project it will automatically attempt to rewrite archives to make them executable using the [`bootRepackage`task](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-repackage-configuration). You should configure your project to build a jar or war (as appropriate) in the usual way.
+
+The main class that you want to launch can either be specified using a configuration option, or by adding a `Main-Class` attribute to the manifest. If you don’t specify a main class the plugin will search for a class with a `public static void main(String[] args)` method.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Check [Section 67.6, “Repackage configuration”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-repackage-configuration) for a full list of configuration options. |
To build and run a project artifact, you can type the following:
+```
$ gradle build
$ java -jar build/libs/mymodule-0.0.1-SNAPSHOT.jar
-To build a war file that is both executable and deployable into an external container, you need to mark the embedded container dependencies as belonging to the war plugin’s providedRuntime configuration, e.g.:
+```
+
+To build a war file that is both executable and deployable into an external container, you need to mark the embedded container dependencies as belonging to the war plugin’s `providedRuntime` configuration, e.g.:
+
+```
...
apply plugin: 'war'
@@ -7807,76 +8623,76 @@ dependencies {
providedRuntime("org.springframework.boot:spring-boot-starter-tomcat")
...
}
-[Tip]
-See the “Section 85.1, “Create a deployable war file”” section for more details on how to create a deployable war file.
-67.4 Running a project in-place
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| See the “[Section 85.1, “Create a deployable war file”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-create-a-deployable-war-file)” section for more details on how to create a deployable war file. |
+
+## 67.4 Running a project in-place
+
To run a project in place without building a jar first you can use the “bootRun” task:
+```
$ gradle bootRun
-If devtools has been added to your project it will automatically monitor your application for changes. Alternatively, you can also run the application so that your static classpath resources (i.e. in src/main/resources by default) are reloadable in the live application, which can be helpful at development time.
+```
+
+If [`devtools`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools) has been added to your project it will automatically monitor your application for changes. Alternatively, you can also run the application so that your static classpath resources (i.e. in `src/main/resources` by default) are reloadable in the live application, which can be helpful at development time.
+
+```
bootRun {
addResources = true
}
-Making static classpath resources reloadable means that bootRun does not use the output of the processResources task, i.e., when invoked using bootRun, your application will use the resources in their unprocessed form.
-67.5 Spring Boot plugin configuration
-The gradle plugin automatically extends your build script DSL with a springBoot element for global configuration of the Boot plugin. Set the appropriate properties as you would with any other Gradle extension (see below for a list of configuration options):
+```
+
+Making static classpath resources reloadable means that `bootRun` does not use the output of the `processResources` task, i.e., when invoked using `bootRun`, your application will use the resources in their unprocessed form.
+
+## 67.5 Spring Boot plugin configuration
+
+The gradle plugin automatically extends your build script DSL with a `springBoot` element for global configuration of the Boot plugin. Set the appropriate properties as you would with any other Gradle extension (see below for a list of configuration options):
+```
springBoot {
backupSource = false
}
-67.6 Repackage configuration
-The plugin adds a bootRepackage task which you can also configure directly, e.g.:
-bootRepackage {
- mainClass = 'demo.Application'
-}
-The following configuration options are available:
-
-Name Description
-enabled
-
-Boolean flag to switch the repackager off (sometimes useful if you want the other Boot features but not this one)
-
-mainClass
-
-The main class that should be run. If not specified, and you have applied the application plugin, the mainClassName project property will be used. If the application plugin has not been applied or no mainClassName has been specified, the archive will be searched for a suitable class. "Suitable" means a unique class with a well-formed main() method (if more than one is found the build will fail). If you have applied the application plugin, the main class can also be specified via its "run" task (main property) and/or its "startScripts" task (mainClassName property) as an alternative to using the "springBoot" configuration.
+```
-classifier
+## 67.6 Repackage configuration
-A file name segment (before the extension) to add to the archive, so that the original is preserved in its original location. Defaults to null in which case the archive is repackaged in place. The default is convenient for many purposes, but if you want to use the original jar as a dependency in another project you must use a classifier to define the executable archive.
+The plugin adds a `bootRepackage` task which you can also configure directly, e.g.:
-withJarTask
-
-The name or value of the Jar task (defaults to all tasks of type Jar) which is used to locate the archive to repackage.
-
-customConfiguration
-
-The name of the custom configuration which is used to populate the nested lib directory (without specifying this you get all compile and runtime dependencies).
-
-executable
-
-Boolean flag to indicate if jar files are fully executable on Unix like operating systems. Defaults to false.
-
-embeddedLaunchScript
-
-The embedded launch script to prepend to the front of the jar if it is fully executable. If not specified the 'Spring Boot' default script will be used.
+```
+bootRepackage {
+ mainClass = 'demo.Application'
+}
-embeddedLaunchScriptProperties
+```
-Additional properties that to be expanded in the launch script. The default script supports a mode property which can contain the values auto, service or run.
+The following configuration options are available:
-excludeDevtools
+| Name | Description |
+| -------------------------------- | ------------------------------------------------------------ |
+| `enabled` | Boolean flag to switch the repackager off (sometimes useful if you want the other Boot features but not this one) |
+| `mainClass` | The main class that should be run. If not specified, and you have applied the application plugin, the `mainClassName`project property will be used. If the application plugin has not been applied or no `mainClassName` has been specified, the archive will be searched for a suitable class. "Suitable" means a unique class with a well-formed `main()` method (if more than one is found the build will fail). If you have applied the application plugin, the main class can also be specified via its "run" task (`main` property) and/or its "startScripts" task (`mainClassName` property) as an alternative to using the "springBoot" configuration. |
+| `classifier` | A file name segment (before the extension) to add to the archive, so that the original is preserved in its original location. Defaults to `null` in which case the archive is repackaged in place. The default is convenient for many purposes, but if you want to use the original jar as a dependency in another project you must use a classifier to define the executable archive. |
+| `withJarTask` | The name or value of the `Jar` task (defaults to all tasks of type `Jar`) which is used to locate the archive to repackage. |
+| `customConfiguration` | The name of the custom configuration which is used to populate the nested lib directory (without specifying this you get all compile and runtime dependencies). |
+| `executable` | Boolean flag to indicate if jar files are fully executable on Unix like operating systems. Defaults to `false`. |
+| `embeddedLaunchScript` | The embedded launch script to prepend to the front of the jar if it is fully executable. If not specified the 'Spring Boot' default script will be used. |
+| `embeddedLaunchScriptProperties` | Additional properties that to be expanded in the launch script. The default script supports a `mode` property which can contain the values `auto`, `service` or `run`. |
+| `excludeDevtools` | Boolean flag to indicate if the devtools jar should be excluded from the repackaged archives. Defaults to `true`. |
-Boolean flag to indicate if the devtools jar should be excluded from the repackaged archives. Defaults to true.
+## 67.7 Repackage with custom Gradle configuration
-67.7 Repackage with custom Gradle configuration
-Sometimes it may be more appropriate to not package default dependencies resolved from compile, runtime and provided scopes. If the created executable jar file is intended to be run as it is, you need to have all dependencies nested inside it; however, if the plan is to explode a jar file and run the main class manually, you may already have some of the libraries available via CLASSPATH. This is a situation where you can repackage your jar with a different set of dependencies.
+Sometimes it may be more appropriate to not package default dependencies resolved from `compile`, `runtime` and `provided` scopes. If the created executable jar file is intended to be run as it is, you need to have all dependencies nested inside it; however, if the plan is to explode a jar file and run the main class manually, you may already have some of the libraries available via `CLASSPATH`. This is a situation where you can repackage your jar with a different set of dependencies.
-Using a custom configuration will automatically disable dependency resolving from compile, runtime and provided scopes. Custom configuration can be either defined globally (inside the springBoot section) or per task.
+Using a custom configuration will automatically disable dependency resolving from `compile`, `runtime` and `provided` scopes. Custom configuration can be either defined globally (inside the `springBoot` section) or per task.
+```
task clientJar(type: Jar) {
appendix = 'client'
from sourceSets.main.output
@@ -7887,8 +8703,12 @@ task clientBoot(type: BootRepackage, dependsOn: clientJar) {
withJarTask = clientJar
customConfiguration = "mycustomconfiguration"
}
-In above example, we created a new clientJar Jar task to package a customized file set from your compiled sources. Then we created a new clientBoot BootRepackage task and instructed it to work with only clientJar task and mycustomconfiguration.
+```
+
+In above example, we created a new `clientJar` Jar task to package a customized file set from your compiled sources. Then we created a new `clientBoot`BootRepackage task and instructed it to work with only `clientJar` task and `mycustomconfiguration`.
+
+```
configurations {
mycustomconfiguration.exclude group: 'log4j'
}
@@ -7896,77 +8716,42 @@ configurations {
dependencies {
mycustomconfiguration configurations.runtime
}
-The configuration that we are referring to in BootRepackage is a normal Gradle configuration. In the above example we created a new configuration named mycustomconfiguration instructing it to derive from a runtime and exclude the log4j group. If the clientBoot task is executed, the repackaged boot jar will have all dependencies from runtime but no log4j jars.
-
-67.7.1 Configuration options
-The following configuration options are available:
-
-Name Description
-mainClass
-
-The main class that should be run by the executable archive.
-
-providedConfiguration
-
-The name of the provided configuration (defaults to providedRuntime).
-
-backupSource
-
-If the original source archive should be backed-up before being repackaged (defaults to true).
-
-customConfiguration
-
-The name of the custom configuration.
-
-layout
-The type of archive, corresponding to how the dependencies are laid out inside (defaults to a guess based on the archive type). See available layouts for more details.
+```
-layoutFactory
+The configuration that we are referring to in `BootRepackage` is a normal [Gradle configuration](https://docs.gradle.org/2.14.1/dsl/org.gradle.api.artifacts.Configuration.html). In the above example we created a new configuration named`mycustomconfiguration` instructing it to derive from a `runtime` and exclude the `log4j` group. If the `clientBoot` task is executed, the repackaged boot jar will have all dependencies from `runtime` but no `log4j` jars.
-A layout factory that can be used if a custom layout is required. Alternative layouts can be provided by 3rd parties. Layout factories are only used when layout is not specified.
+### 67.7.1 Configuration options
-requiresUnpack
-
-A list of dependencies (in the form “groupId:artifactId” that must be unpacked from fat jars in order to run. Items are still packaged into the fat jar, but they will be automatically unpacked when it runs.
-
-67.7.2 Available layouts
-The layout attribute configures the format of the archive and whether the bootstrap loader should be included or not. The following layouts are available:
-
-Name Description Executable
-JAR
-
-Regular executable JAR layout.
-
-Yes
-
-WAR
-
-Executable WAR layout. provided dependencies are placed in WEB-INF/lib-provided to avoid any clash when the war is deployed in a servlet container.
-
-Yes
-
-ZIP (alias to DIR)
-
-Similar to JAR layout, using PropertiesLauncher.
-
-Yes
-
-MODULE
+The following configuration options are available:
-Bundle dependencies (excluding those with provided scope) and project resources.
+| Name | Description |
+| ----------------------- | ------------------------------------------------------------ |
+| `mainClass` | The main class that should be run by the executable archive. |
+| `providedConfiguration` | The name of the provided configuration (defaults to `providedRuntime`). |
+| `backupSource` | If the original source archive should be backed-up before being repackaged (defaults to `true`). |
+| `customConfiguration` | The name of the custom configuration. |
+| `layout` | The type of archive, corresponding to how the dependencies are laid out inside (defaults to a guess based on the archive type). See[available layouts for more details](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins-gradle-configuration-layouts). |
+| `layoutFactory` | A layout factory that can be used if a custom layout is required. Alternative layouts can be provided by 3rd parties. Layout factories are only used when `layout` is not specified. |
+| `requiresUnpack` | A list of dependencies (in the form “groupId:artifactId” that must be unpacked from fat jars in order to run. Items are still packaged into the fat jar, but they will be automatically unpacked when it runs. |
-No
+### 67.7.2 Available layouts
-NONE
+The `layout` attribute configures the format of the archive and whether the bootstrap loader should be included or not. The following layouts are available:
-Bundle all dependencies and project resources.
+| Name | Description | Executable |
+| ---------------------- | ------------------------------------------------------------ | ---------- |
+| `JAR` | Regular executable [JAR layout](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-jar-file-structure). | Yes |
+| `WAR` | Executable [WAR layout](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-war-file-structure). `provided` dependencies are placed in `WEB-INF/lib-provided` to avoid any clash when the `war`is deployed in a servlet container. | Yes |
+| `ZIP` (alias to `DIR`) | Similar to `JAR` layout, using [`PropertiesLauncher`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-property-launcher-features). | Yes |
+| `MODULE` | Bundle dependencies (excluding those with `provided` scope) and project resources. | No |
+| `NONE` | Bundle all dependencies and project resources. | No |
-No
+### 67.7.3 Using a custom layout
-67.7.3 Using a custom layout
-If you have custom requirements for how to arrange the dependencies and loader classes inside the repackaged jar, you can use a custom layout. Any library which defines one or more LayoutFactory implementations can be added to the build script dependencies and then the layout factory becomes available in the springBoot configuration. For example:
+If you have custom requirements for how to arrange the dependencies and loader classes inside the repackaged jar, you can use a custom layout. Any library which defines one or more `LayoutFactory` implementations can be added to the build script dependencies and then the layout factory becomes available in the `springBoot` configuration. For example:
+```
buildscript {
repositories {
mavenCentral()
@@ -7980,34 +8765,54 @@ buildscript {
springBoot {
layoutFactory = new com.example.CustomLayoutFactory()
}
-[Note]
-If there is only one custom LayoutFactory on the build classpath and it is listed in META-INF/spring.factories then it is unnecessary to explicitly set it in the springBoot configuration. Layout factories are only used when no explicit layout is specified.
-67.8 Understanding how the Gradle plugin works
-When spring-boot is applied to your Gradle project a default task named bootRepackage is created automatically. The bootRepackage task depends on Gradle assemble task, and when executed, it tries to find all jar artifacts whose qualifier is empty (i.e. tests and sources jars are automatically skipped).
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If there is only one custom `LayoutFactory` on the build classpath and it is listed in `META-INF/spring.factories` then it is unnecessary to explicitly set it in the `springBoot` configuration. Layout factories are only used when no explicit `layout` is specified. |
+
+## 67.8 Understanding how the Gradle plugin works
+
+When `spring-boot` is applied to your Gradle project a default task named `bootRepackage` is created automatically. The `bootRepackage` task depends on Gradle `assemble` task, and when executed, it tries to find all jar artifacts whose qualifier is empty (i.e. tests and sources jars are automatically skipped).
-Due to the fact that bootRepackage finds 'all' created jar artifacts, the order of Gradle task execution is important. Most projects only create a single jar file, so usually this is not an issue; however, if you are planning to create a more complex project setup, with custom Jar and BootRepackage tasks, there are few tweaks to consider.
+Due to the fact that `bootRepackage` finds 'all' created jar artifacts, the order of Gradle task execution is important. Most projects only create a single jar file, so usually this is not an issue; however, if you are planning to create a more complex project setup, with custom `Jar` and `BootRepackage` tasks, there are few tweaks to consider.
-If you are 'just' creating custom jar files from your project you can simply disable default jar and bootRepackage tasks:
+If you are 'just' creating custom jar files from your project you can simply disable default `jar` and `bootRepackage` tasks:
+```
jar.enabled = false
bootRepackage.enabled = false
-Another option is to instruct the default bootRepackage task to only work with a default jar task.
+```
+
+Another option is to instruct the default `bootRepackage` task to only work with a default `jar` task.
+
+```
bootRepackage.withJarTask = jar
-If you have a default project setup where the main jar file is created and repackaged, 'and' you still want to create additional custom jars, you can combine your custom repackage tasks together and use dependsOn so that the bootJars task will run after the default bootRepackage task is executed:
+```
+
+If you have a default project setup where the main jar file is created and repackaged, 'and' you still want to create additional custom jars, you can combine your custom repackage tasks together and use `dependsOn` so that the `bootJars` task will run after the default `bootRepackage` task is executed:
+
+```
task bootJars
bootJars.dependsOn = [clientBoot1,clientBoot2,clientBoot3]
build.dependsOn(bootJars)
+
+```
+
All the above tweaks are usually used to avoid situations where an already created boot jar is repackaged again. Repackaging an existing boot jar will not break anything, but you may find that it includes unnecessary dependencies.
-67.9 Publishing artifacts to a Maven repository using Gradle
-If you are declaring dependencies without versions and you want to publish artifacts to a Maven repository you will need to configure the Maven publication with details of Spring Boot’s dependency management. This can be achieved by configuring it to publish poms that inherit from spring-boot-starter-parent or that import dependency management from spring-boot-dependencies. The exact details of this configuration depend on how you’re using Gradle and how you’re trying to publish the artifacts.
+## 67.9 Publishing artifacts to a Maven repository using Gradle
+
+If you are [declaring dependencies without versions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#) and you want to publish artifacts to a Maven repository you will need to configure the Maven publication with details of Spring Boot’s dependency management. This can be achieved by configuring it to publish poms that inherit from `spring-boot-starter-parent` or that import dependency management from `spring-boot-dependencies`. The exact details of this configuration depend on how you’re using Gradle and how you’re trying to publish the artifacts.
+
+### 67.9.1 Configuring Gradle to produce a pom that inherits dependency management
-67.9.1 Configuring Gradle to produce a pom that inherits dependency management
-The following is an example of configuring Gradle to generate a pom that inherits from spring-boot-starter-parent. Please refer to the Gradle User Guide for further information.
+The following is an example of configuring Gradle to generate a pom that inherits from `spring-boot-starter-parent`. Please refer to the [Gradle User Guide](https://docs.gradle.org/2.14.1/userguide/userguide.html) for further information.
+```
uploadArchives {
repositories {
mavenDeployer {
@@ -8023,9 +8828,14 @@ uploadArchives {
}
}
}
-67.9.2 Configuring Gradle to produce a pom that imports dependency management
-The following is an example of configuring Gradle to generate a pom that imports the dependency management provided by spring-boot-dependencies. Please refer to the Gradle User Guide for further information.
+```
+
+### 67.9.2 Configuring Gradle to produce a pom that imports dependency management
+
+The following is an example of configuring Gradle to generate a pom that imports the dependency management provided by `spring-boot-dependencies`. Please refer to the [Gradle User Guide](http://www.gradle.org/docs/current/userguide/userguide.html) for further information.
+
+```
uploadArchives {
repositories {
mavenDeployer {
@@ -8047,59 +8857,59 @@ uploadArchives {
}
}
}
-68. Spring Boot AntLib module
-The Spring Boot AntLib module provides basic Spring Boot support for Apache Ant. You can use the module to create executable jars. To use the module you need to declare an additional spring-boot namespace in your build.xml:
+```
+
+## 68. Spring Boot AntLib module
+
+The Spring Boot AntLib module provides basic Spring Boot support for Apache Ant. You can use the module to create executable jars. To use the module you need to declare an additional `spring-boot` namespace in your `build.xml`:
+
+```
...
-You’ll need to remember to start Ant using the -lib option, for example:
-
-$ ant -lib
-[Tip]
-The “Using Spring Boot” section includes a more complete example of using Apache Ant with spring-boot-antlib
-68.1 Spring Boot Ant tasks
-Once the spring-boot-antlib namespace has been declared, the following additional tasks are available.
+```
-68.1.1 spring-boot:exejar
-The exejar task can be used to creates a Spring Boot executable jar. The following attributes are supported by the task:
+You’ll need to remember to start Ant using the `-lib` option, for example:
-Attribute Description Required
-destfile
-
-The destination jar file to create
+```
+$ ant -lib
-Yes
+```
-classes
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The “Using Spring Boot” section includes a more complete example of [using Apache Ant with `spring-boot-antlib`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-ant) |
-The root directory of Java class files
+## 68.1 Spring Boot Ant tasks
-Yes
+Once the `spring-boot-antlib` namespace has been declared, the following additional tasks are available.
-start-class
+### 68.1.1 spring-boot:exejar
-The main application class to run
+The `exejar` task can be used to creates a Spring Boot executable jar. The following attributes are supported by the task:
-No (default is first class found declaring a main method)
+| Attribute | Description | Required |
+| ------------- | -------------------------------------- | ----------------------------------------------------------- |
+| `destfile` | The destination jar file to create | Yes |
+| `classes` | The root directory of Java class files | Yes |
+| `start-class` | The main application class to run | No *(default is first class found declaring a main method)* |
The following nested elements can be used with the task:
-Element Description
-resources
-
-One or more Resource Collections describing a set of Resources that should be added to the content of the created jar file.
-
-lib
+| Element | Description |
+| ----------- | ------------------------------------------------------------ |
+| `resources` | One or more [Resource Collections](https://ant.apache.org/manual/Types/resources.html#collection) describing a set of [Resources](https://ant.apache.org/manual/Types/resources.html) that should be added to the content of the created jar file. |
+| `lib` | One or more [Resource Collections](https://ant.apache.org/manual/Types/resources.html#collection) that should be added to the set of jar libraries that make up the runtime dependency classpath of the application. |
-One or more Resource Collections that should be added to the set of jar libraries that make up the runtime dependency classpath of the application.
+### 68.1.2 Examples
-68.1.2 Examples
-Specify start-class.
+**Specify start-class.**
+```
@@ -8109,64 +8919,88 @@ Specify start-class.
-Detect start-class.
+```
+
+
+
+**Detect start-class.**
+
+```
-68.2 spring-boot:findmainclass
-The findmainclass task is used internally by exejar to locate a class declaring a main. You can also use this task directly in your build if needed. The following attributes are supported
-Attribute Description Required
-classesroot
+```
-The root directory of Java class files
-Yes (unless mainclass is specified)
-mainclass
+## 68.2 spring-boot:findmainclass
-Can be used to short-circuit the main class search
+The `findmainclass` task is used internally by `exejar` to locate a class declaring a `main`. You can also use this task directly in your build if needed. The following attributes are supported
-No
+| Attribute | Description | Required |
+| ------------- | ---------------------------------------------------- | ------------------------------------------- |
+| `classesroot` | The root directory of Java class files | Yes *(unless mainclass is specified)* |
+| `mainclass` | Can be used to short-circuit the `main` class search | No |
+| `property` | The Ant property that should be set with the result | No *(result will be logged if unspecified)* |
-property
+### 68.2.1 Examples
-The Ant property that should be set with the result
+**Find and log.**
-No (result will be logged if unspecified)
+```
+
-68.2.1 Examples
-Find and log.
+```
-
-Find and set.
+
+**Find and set.**
+
+```
-Override and set.
+```
+
+
+
+**Override and set.**
+
+```
-69. Supporting other build systems
-If you want to use a build tool other than Maven, Gradle or Ant, you will likely need to develop your own plugin. Executable jars need to follow a specific format and certain entries need to be written in an uncompressed form (see the executable jar format section in the appendix for details).
-The Spring Boot Maven and Gradle plugins both make use of spring-boot-loader-tools to actually generate jars. You are also free to use this library directly yourself if you need to.
+```
-69.1 Repackaging archives
-To repackage an existing archive so that it becomes a self-contained executable archive use org.springframework.boot.loader.tools.Repackager. The Repackager class takes a single constructor argument that refers to an existing jar or war archive. Use one of the two available repackage() methods to either replace the original file or write to a new destination. Various settings can also be configured on the repackager before it is run.
-69.2 Nested libraries
-When repackaging an archive you can include references to dependency files using the org.springframework.boot.loader.tools.Libraries interface. We don’t provide any concrete implementations of Libraries here as they are usually build system specific.
-If your archive already includes libraries you can use Libraries.NONE.
+## 69. Supporting other build systems
-69.3 Finding a main class
-If you don’t use Repackager.setMainClass() to specify a main class, the repackager will use ASM to read class files and attempt to find a suitable class with a public static void main(String[] args) method. An exception is thrown if more than one candidate is found.
+If you want to use a build tool other than Maven, Gradle or Ant, you will likely need to develop your own plugin. Executable jars need to follow a specific format and certain entries need to be written in an uncompressed form (see the *executable jar format* section in the appendix for details).
+
+The Spring Boot Maven and Gradle plugins both make use of `spring-boot-loader-tools` to actually generate jars. You are also free to use this library directly yourself if you need to.
+
+## 69.1 Repackaging archives
+
+To repackage an existing archive so that it becomes a self-contained executable archive use `org.springframework.boot.loader.tools.Repackager`. The `Repackager` class takes a single constructor argument that refers to an existing jar or war archive. Use one of the two available `repackage()` methods to either replace the original file or write to a new destination. Various settings can also be configured on the repackager before it is run.
+
+## 69.2 Nested libraries
+
+When repackaging an archive you can include references to dependency files using the `org.springframework.boot.loader.tools.Libraries` interface. We don’t provide any concrete implementations of `Libraries` here as they are usually build system specific.
+
+If your archive already includes libraries you can use `Libraries.NONE`.
+
+## 69.3 Finding a main class
+
+If you don’t use `Repackager.setMainClass()` to specify a main class, the repackager will use [ASM](http://asm.ow2.org/) to read class files and attempt to find a suitable class with a `public static void main(String[] args)` method. An exception is thrown if more than one candidate is found.
+
+## 69.4 Example repackage implementation
-69.4 Example repackage implementation
Here is a typical example repackage:
+```
Repackager repackager = new Repackager(sourceJarFile);
repackager.setBackupSource(false);
repackager.repackage(new Libraries() {
@@ -8176,53 +9010,75 @@ repackager.repackage(new Libraries() {
// callback.library(new Library(nestedFile, LibraryScope.COMPILE));
}
});
-70. What to read next
-If you’re interested in how the build tool plugins work you can look at the spring-boot-tools module on GitHub. More technical details of the executable jar format are covered in the appendix.
-If you have specific build-related questions you can check out the “how-to” guides.
+```
+
+## 70. What to read next
+
+If you’re interested in how the build tool plugins work you can look at the [`spring-boot-tools`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-tools) module on GitHub. More technical details of the [executable jar format](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar)are covered in the appendix.
+
+If you have specific build-related questions you can check out the “[how-to](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto)” guides.
+
+# Part IX. ‘How-to’ guides
+
+
+
+This section provides answers to some common ‘how do I do that…’ type of questions that often arise when using Spring Boot. This is by no means an exhaustive list, but it does cover quite a lot.
-Part IX. ‘How-to’ guides
-This section provides answers to some common ‘how do I do that…’ type of questions that often arise when using Spring Boot. This is by no means an exhaustive list, but it does cover quite a lot.
+If you are having a specific problem that we don’t cover here, you might want to check out [stackoverflow.com](https://stackoverflow.com/tags/spring-boot) to see if someone has already provided an answer; this is also a great place to ask new questions (please use the `spring-boot` tag).
-If you are having a specific problem that we don’t cover here, you might want to check out stackoverflow.com to see if someone has already provided an answer; this is also a great place to ask new questions (please use the spring-boot tag).
+We’re also more than happy to extend this section; If you want to add a ‘how-to’ you can send us a [pull request](https://github.com/spring-projects/spring-boot/tree/1.5.x).
-We’re also more than happy to extend this section; If you want to add a ‘how-to’ you can send us a pull request.
+## 71. Spring Boot application
-71. Spring Boot application
-71.1 Create your own FailureAnalyzer
-FailureAnalyzer is a great way to intercept an exception on startup and turn it into a human-readable message, wrapped into a FailureAnalysis. Spring Boot provides such analyzer for application context related exceptions, JSR-303 validations and more. It is actually very easy to create your own.
+## 71.1 Create your own FailureAnalyzer
-AbstractFailureAnalyzer is a convenient extension of FailureAnalyzer that checks the presence of a specified exception type in the exception to handle. You can extend from that so that your implementation gets a chance to handle the exception only when it is actually present. If for whatever reason you can’t handle the exception, return null to give another implementation a chance to handle the exception.
+[`FailureAnalyzer`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/diagnostics/FailureAnalyzer.html) is a great way to intercept an exception on startup and turn it into a human-readable message, wrapped into a [`FailureAnalysis`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/diagnostics/FailureAnalysis.html). Spring Boot provides such analyzer for application context related exceptions, JSR-303 validations and more. It is actually very easy to create your own.
-FailureAnalyzer implementations are to be registered in a META-INF/spring.factories: the following registers ProjectConstraintViolationFailureAnalyzer:
+`AbstractFailureAnalyzer` is a convenient extension of `FailureAnalyzer` that checks the presence of a specified exception type in the exception to handle. You can extend from that so that your implementation gets a chance to handle the exception only when it is actually present. If for whatever reason you can’t handle the exception, return `null` to give another implementation a chance to handle the exception.
+`FailureAnalyzer` implementations are to be registered in a `META-INF/spring.factories`: the following registers `ProjectConstraintViolationFailureAnalyzer`:
+
+```
org.springframework.boot.diagnostics.FailureAnalyzer=\
com.example.ProjectConstraintViolationFailureAnalyzer
-71.2 Troubleshoot auto-configuration
+
+```
+
+## 71.2 Troubleshoot auto-configuration
+
The Spring Boot auto-configuration tries its best to ‘do the right thing’, but sometimes things fail and it can be hard to tell why.
-There is a really useful ConditionEvaluationReport available in any Spring Boot ApplicationContext. You will see it if you enable DEBUG logging output. If you use the spring-boot-actuator there is also an autoconfig endpoint that renders the report in JSON. Use that to debug the application and see what features have been added (and which not) by Spring Boot at runtime.
+There is a really useful `ConditionEvaluationReport` available in any Spring Boot `ApplicationContext`. You will see it if you enable `DEBUG` logging output. If you use the `spring-boot-actuator` there is also an `autoconfig` endpoint that renders the report in JSON. Use that to debug the application and see what features have been added (and which not) by Spring Boot at runtime.
Many more questions can be answered by looking at the source code and the Javadoc. Some rules of thumb:
-Look for classes called *AutoConfiguration and read their sources, in particular the @Conditional* annotations to find out what features they enable and when. Add --debug to the command line or a System property -Ddebug to get a log on the console of all the auto-configuration decisions that were made in your app. In a running Actuator app look at the autoconfig endpoint (‘/autoconfig’ or the JMX equivalent) for the same information.
-Look for classes that are @ConfigurationProperties (e.g. ServerProperties) and read from there the available external configuration options. The @ConfigurationProperties has a name attribute which acts as a prefix to external properties, thus ServerProperties has prefix="server" and its configuration properties are server.port, server.address etc. In a running Actuator app look at the configprops endpoint.
-Look for use of RelaxedPropertyResolver to pull configuration values explicitly out of the Environment. It often is used with a prefix.
-Look for @Value annotations that bind directly to the Environment. This is less flexible than the RelaxedPropertyResolver approach, but does allow some relaxed binding, specifically for OS environment variables (so CAPITALS_AND_UNDERSCORES are synonyms for period.separated).
-Look for @ConditionalOnExpression annotations that switch features on and off in response to SpEL expressions, normally evaluated with placeholders resolved from the Environment.
-71.3 Customize the Environment or ApplicationContext before it starts
-A SpringApplication has ApplicationListeners and ApplicationContextInitializers that are used to apply customizations to the context or environment. Spring Boot loads a number of such customizations for use internally from META-INF/spring.factories. There is more than one way to register additional ones:
+- Look for classes called `*AutoConfiguration` and read their sources, in particular the `@Conditional*` annotations to find out what features they enable and when. Add `--debug` to the command line or a System property `-Ddebug` to get a log on the console of all the auto-configuration decisions that were made in your app. In a running Actuator app look at the `autoconfig` endpoint (‘/autoconfig’ or the JMX equivalent) for the same information.
+- Look for classes that are `@ConfigurationProperties` (e.g. [`ServerProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java)) and read from there the available external configuration options. The`@ConfigurationProperties` has a `name` attribute which acts as a prefix to external properties, thus `ServerProperties` has `prefix="server"` and its configuration properties are `server.port`, `server.address` etc. In a running Actuator app look at the `configprops` endpoint.
+- Look for use of `RelaxedPropertyResolver` to pull configuration values explicitly out of the `Environment`. It often is used with a prefix.
+- Look for `@Value` annotations that bind directly to the `Environment`. This is less flexible than the `RelaxedPropertyResolver` approach, but does allow some relaxed binding, specifically for OS environment variables (so `CAPITALS_AND_UNDERSCORES` are synonyms for `period.separated`).
+- Look for `@ConditionalOnExpression` annotations that switch features on and off in response to SpEL expressions, normally evaluated with placeholders resolved from the `Environment`.
-Programmatically per application by calling the addListeners and addInitializers methods on SpringApplication before you run it.
-Declaratively per application by setting context.initializer.classes or context.listener.classes.
-Declaratively for all applications by adding a META-INF/spring.factories and packaging a jar file that the applications all use as a library.
-The SpringApplication sends some special ApplicationEvents to the listeners (even some before the context is created), and then registers the listeners for events published by the ApplicationContext as well. See Section 23.5, “Application events and listeners” in the ‘Spring Boot features’ section for a complete list.
+## 71.3 Customize the Environment or ApplicationContext before it starts
-It is also possible to customize the Environment before the application context is refreshed using EnvironmentPostProcessor. Each implementation should be registered in META-INF/spring.factories:
+A `SpringApplication` has `ApplicationListeners` and `ApplicationContextInitializers` that are used to apply customizations to the context or environment. Spring Boot loads a number of such customizations for use internally from `META-INF/spring.factories`. There is more than one way to register additional ones:
+- Programmatically per application by calling the `addListeners` and `addInitializers` methods on `SpringApplication` before you run it.
+- Declaratively per application by setting `context.initializer.classes` or `context.listener.classes`.
+- Declaratively for all applications by adding a `META-INF/spring.factories` and packaging a jar file that the applications all use as a library.
+
+The `SpringApplication` sends some special `ApplicationEvents` to the listeners (even some before the context is created), and then registers the listeners for events published by the `ApplicationContext` as well. See *Section 23.5, “Application events and listeners”* in the ‘Spring Boot features’ section for a complete list.
+
+It is also possible to customize the `Environment` before the application context is refreshed using `EnvironmentPostProcessor`. Each implementation should be registered in `META-INF/spring.factories`:
+
+```
org.springframework.boot.env.EnvironmentPostProcessor=com.example.YourEnvironmentPostProcessor
-The implementation can load arbitrary files and add them to the Environment. For instance, this example loads a YAML configuration file from the classpath:
+```
+
+The implementation can load arbitrary files and add them to the `Environment`. For instance, this example loads a YAML configuration file from the classpath:
+
+```
public class EnvironmentPostProcessorExample implements EnvironmentPostProcessor {
private final YamlPropertySourceLoader loader = new YamlPropertySourceLoader();
@@ -8249,43 +9105,64 @@ public class EnvironmentPostProcessorExample implements EnvironmentPostProcessor
}
}
-[Tip]
-The Environment will already have been prepared with all the usual property sources that Spring Boot loads by default. It is therefore possible to get the location of the file from the environment. This example adds the custom-resource property source at the end of the list so that a key defined in any of the usual other locations takes precedence. A custom implementation may obviously defines another order.
-[Note]
-While using @PropertySource on your @SpringBootApplication seems convenient and easy enough to load a custom resource in the Environment, we do not recommend it as Spring Boot prepares the Environment before the ApplicationContext is refreshed. Any key defined via @PropertySource will be loaded too late to have any effect on auto-configuration.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `Environment` will already have been prepared with all the usual property sources that Spring Boot loads by default. It is therefore possible to get the location of the file from the environment. This example adds the `custom-resource` property source at the end of the list so that a key defined in any of the usual other locations takes precedence. A custom implementation may obviously defines another order. |
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| While using `@PropertySource` on your `@SpringBootApplication` seems convenient and easy enough to load a custom resource in the `Environment`, we do not recommend it as Spring Boot prepares the `Environment` before the `ApplicationContext` is refreshed. Any key defined via `@PropertySource` will be loaded too late to have any effect on auto-configuration. |
+
+## 71.4 Build an ApplicationContext hierarchy (adding a parent or root context)
-71.4 Build an ApplicationContext hierarchy (adding a parent or root context)
-You can use the ApplicationBuilder class to create parent/child ApplicationContext hierarchies. See Section 23.4, “Fluent builder API” in the ‘Spring Boot features’ section for more information.
+You can use the `ApplicationBuilder` class to create parent/child `ApplicationContext` hierarchies. See *Section 23.4, “Fluent builder API”* in the ‘Spring Boot features’ section for more information.
-71.5 Create a non-web application
-Not all Spring applications have to be web applications (or web services). If you want to execute some code in a main method, but also bootstrap a Spring application to set up the infrastructure to use, then it’s easy with the SpringApplication features of Spring Boot. A SpringApplication changes its ApplicationContext class depending on whether it thinks it needs a web application or not. The first thing you can do to help it is to just leave the servlet API dependencies off the classpath. If you can’t do that (e.g. you are running 2 applications from the same code base) then you can explicitly call setWebEnvironment(false) on your SpringApplication instance, or set the applicationContextClass property (through the Java API or with external properties). Application code that you want to run as your business logic can be implemented as a CommandLineRunner and dropped into the context as a @Bean definition.
+## 71.5 Create a non-web application
+
+Not all Spring applications have to be web applications (or web services). If you want to execute some code in a `main` method, but also bootstrap a Spring application to set up the infrastructure to use, then it’s easy with the `SpringApplication` features of Spring Boot. A `SpringApplication` changes its `ApplicationContext`class depending on whether it thinks it needs a web application or not. The first thing you can do to help it is to just leave the servlet API dependencies off the classpath. If you can’t do that (e.g. you are running 2 applications from the same code base) then you can explicitly call `setWebEnvironment(false)` on your `SpringApplication` instance, or set the `applicationContextClass` property (through the Java API or with external properties). Application code that you want to run as your business logic can be implemented as a `CommandLineRunner` and dropped into the context as a `@Bean` definition.
+
+## 72. Properties & configuration
+
+## 72.1 Automatically expand properties at build time
-72. Properties & configuration
-72.1 Automatically expand properties at build time
Rather than hardcoding some properties that are also specified in your project’s build configuration, you can automatically expand them using the existing build configuration instead. This is possible in both Maven and Gradle.
-72.1.1 Automatic property expansion using Maven
-You can automatically expand properties from the Maven project using resource filtering. If you use the spring-boot-starter-parent you can then refer to your Maven ‘project properties’ via @..@ placeholders, e.g.
+### 72.1.1 Automatic property expansion using Maven
+
+You can automatically expand properties from the Maven project using resource filtering. If you use the `spring-boot-starter-parent` you can then refer to your Maven ‘project properties’ via `@..@` placeholders, e.g.
+```
app.encoding=@project.build.sourceEncoding@
app.java.version=@java.version@
-[Note]
-Only production configuration is filtered that way (i.e. no filtering is applied on src/test/resources).
-[Tip]
-The spring-boot:run can add src/main/resources directly to the classpath (for hot reloading purposes) if you enable the addResources flag. This circumvents the resource filtering and this feature. You can use the exec:java goal instead or customize the plugin’s configuration, see the plugin usage page for more details.
+```
-If you don’t use the starter parent, in your pom.xml you need (inside the element):
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Only production configuration is filtered that way (i.e. no filtering is applied on `src/test/resources`). |
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| The `spring-boot:run` can add `src/main/resources` directly to the classpath (for hot reloading purposes) if you enable the `addResources` flag. This circumvents the resource filtering and this feature. You can use the `exec:java` goal instead or customize the plugin’s configuration, see the [plugin usage page](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/usage.html) for more details. |
+
+If you don’t use the starter parent, in your `pom.xml` you need (inside the `` element):
+
+```
src/main/resources
true
-and (inside ):
+```
+
+and (inside ``):
+
+```
org.apache.maven.plugins
maven-resources-plugin
@@ -8297,72 +9174,111 @@ and (inside ):
false
-[Note]
-The useDefaultDelimiters property is important if you are using standard Spring placeholders in your configuration (e.g. ${foo}). These may be expanded by the build if that property is not set to false.
-72.1.2 Automatic property expansion using Gradle
-You can automatically expand properties from the Gradle project by configuring the Java plugin’s processResources task to do so:
+```
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The `useDefaultDelimiters` property is important if you are using standard Spring placeholders in your configuration (e.g. `${foo}`). These may be expanded by the build if that property is not set to `false`. |
+
+### 72.1.2 Automatic property expansion using Gradle
+
+You can automatically expand properties from the Gradle project by configuring the Java plugin’s `processResources` task to do so:
+
+```
processResources {
expand(project.properties)
}
+
+```
+
You can then refer to your Gradle project’s properties via placeholders, e.g.
+```
app.name=${name}
app.description=${description}
-[Note]
-Gradle’s expand method uses Groovy’s SimpleTemplateEngine which transforms ${..} tokens. The ${..} style conflicts with Spring’s own property placeholder mechanism. To use Spring property placeholders together with automatic expansion the Spring property placeholders need to be escaped like \${..}.
-72.2 Externalize the configuration of SpringApplication
-A SpringApplication has bean properties (mainly setters) so you can use its Java API as you create the application to modify its behavior. Or you can externalize the configuration using properties in spring.main.*. E.g. in application.properties you might have.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Gradle’s `expand` method uses Groovy’s `SimpleTemplateEngine` which transforms `${..}` tokens. The `${..}` style conflicts with Spring’s own property placeholder mechanism. To use Spring property placeholders together with automatic expansion the Spring property placeholders need to be escaped like `\${..}`. |
+
+## 72.2 Externalize the configuration of SpringApplication
+
+A `SpringApplication` has bean properties (mainly setters) so you can use its Java API as you create the application to modify its behavior. Or you can externalize the configuration using properties in `spring.main.*`. E.g. in `application.properties` you might have.
+```
spring.main.web-environment=false
spring.main.banner-mode=off
+
+```
+
and then the Spring Boot banner will not be printed on startup, and the application will not be a web application.
-[Note]
-The example above also demonstrates how flexible binding allows the use of underscores (_) as well as dashes (-) in property names.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The example above also demonstrates how flexible binding allows the use of underscores (`_`) as well as dashes (`-`) in property names. |
-Properties defined in external configuration overrides the values specified via the Java API with the notable exception of the sources used to create the ApplicationContext. Let’s consider this application
+Properties defined in external configuration overrides the values specified via the Java API with the notable exception of the sources used to create the `ApplicationContext`. Let’s consider this application
+```
new SpringApplicationBuilder()
.bannerMode(Banner.Mode.OFF)
.sources(demo.MyApp.class)
.run(args);
+
+```
+
used with the following configuration:
+```
spring.main.sources=com.acme.Config,com.acme.ExtraConfig
spring.main.banner-mode=console
-The actual application will now show the banner (as overridden by configuration) and use three sources for the ApplicationContext (in that order): demo.MyApp, com.acme.Config, com.acme.ExtraConfig.
-72.3 Change the location of external properties of an application
-By default properties from different sources are added to the Spring Environment in a defined order (see Chapter 24, Externalized Configuration in the ‘Spring Boot features’ section for the exact order).
+```
-A nice way to augment and modify this is to add @PropertySource annotations to your application sources. Classes passed to the SpringApplication static convenience methods, and those added using setSources() are inspected to see if they have @PropertySources, and if they do, those properties are added to the Environment early enough to be used in all phases of the ApplicationContext lifecycle. Properties added in this way have lower priority than any added using the default locations (e.g. application.properties), system properties, environment variables or the command line.
+The actual application will *now* show the banner (as overridden by configuration) and use three sources for the `ApplicationContext` (in that order): `demo.MyApp`, `com.acme.Config`, `com.acme.ExtraConfig`.
+
+## 72.3 Change the location of external properties of an application
+
+By default properties from different sources are added to the Spring `Environment` in a defined order (see *Chapter 24, Externalized Configuration* in the ‘Spring Boot features’ section for the exact order).
+
+A nice way to augment and modify this is to add `@PropertySource` annotations to your application sources. Classes passed to the `SpringApplication` static convenience methods, and those added using `setSources()` are inspected to see if they have `@PropertySources`, and if they do, those properties are added to the `Environment` early enough to be used in all phases of the `ApplicationContext` lifecycle. Properties added in this way have lower priority than any added using the default locations (e.g. `application.properties`), system properties, environment variables or the command line.
You can also provide System properties (or environment variables) to change the behavior:
-spring.config.name (SPRING_CONFIG_NAME), defaults to application as the root of the file name.
-spring.config.location (SPRING_CONFIG_LOCATION) is the file to load (e.g. a classpath resource or a URL). A separate Environment property source is set up for this document and it can be overridden by system properties, environment variables or the command line.
-No matter what you set in the environment, Spring Boot will always load application.properties as described above. If YAML is used then files with the ‘.yml’ extension are also added to the list by default.
+- `spring.config.name` (`SPRING_CONFIG_NAME`), defaults to `application` as the root of the file name.
+- `spring.config.location` (`SPRING_CONFIG_LOCATION`) is the file to load (e.g. a classpath resource or a URL). A separate `Environment` property source is set up for this document and it can be overridden by system properties, environment variables or the command line.
+
+No matter what you set in the environment, Spring Boot will always load `application.properties` as described above. If YAML is used then files with the ‘.yml’ extension are also added to the list by default.
-Spring Boot logs the configuration files that are loaded at DEBUG level and the candidates it has not found at TRACE level.
+Spring Boot logs the configuration files that are loaded at `DEBUG` level and the candidates it has not found at `TRACE` level.
-See ConfigFileApplicationListener for more detail.
+See [`ConfigFileApplicationListener`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/context/config/ConfigFileApplicationListener.java) for more detail.
-72.4 Use ‘short’ command line arguments
-Some people like to use (for example) --port=9000 instead of --server.port=9000 to set configuration properties on the command line. You can easily enable this by using placeholders in application.properties, e.g.
+## 72.4 Use ‘short’ command line arguments
+Some people like to use (for example) `--port=9000` instead of `--server.port=9000` to set configuration properties on the command line. You can easily enable this by using placeholders in `application.properties`, e.g.
+
+```
server.port=${port:8080}
-[Tip]
-If you are inheriting from the spring-boot-starter-parent POM, the default filter token of the maven-resources-plugins has been changed from ${*} to @ (i.e. @maven.token@ instead of ${maven.token}) to prevent conflicts with Spring-style placeholders. If you have enabled maven filtering for the application.properties directly, you may want to also change the default filter token to use other delimiters.
-[Note]
-In this specific case the port binding will work in a PaaS environment like Heroku and Cloud Foundry, since in those two platforms the PORT environment variable is set automatically and Spring can bind to capitalized synonyms for Environment properties.
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you are inheriting from the `spring-boot-starter-parent` POM, the default filter token of the `maven-resources-plugins` has been changed from `${*}` to `@` (i.e. `@maven.token@` instead of `${maven.token}`) to prevent conflicts with Spring-style placeholders. If you have enabled maven filtering for the `application.properties` directly, you may want to also change the default filter token to use [other delimiters](https://maven.apache.org/plugins/maven-resources-plugin/resources-mojo.html#delimiters). |
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| In this specific case the port binding will work in a PaaS environment like Heroku and Cloud Foundry, since in those two platforms the `PORT` environment variable is set automatically and Spring can bind to capitalized synonyms for `Environment` properties. |
+
+## 72.5 Use YAML for external properties
-72.5 Use YAML for external properties
YAML is a superset of JSON and as such is a very convenient syntax for storing external properties in a hierarchical format. E.g.
+```
spring:
application:
name: cruncher
@@ -8371,34 +9287,52 @@ spring:
url: jdbc:mysql://localhost/test
server:
port: 9000
-Create a file called application.yml and stick it in the root of your classpath, and also add snakeyaml to your dependencies (Maven coordinates org.yaml:snakeyaml, already included if you use the spring-boot-starter). A YAML file is parsed to a Java Map (like a JSON object), and Spring Boot flattens the map so that it is 1-level deep and has period-separated keys, a lot like people are used to with Properties files in Java.
-The example YAML above corresponds to an application.properties file
+```
+Create a file called `application.yml` and stick it in the root of your classpath, and also add `snakeyaml` to your dependencies (Maven coordinates `org.yaml:snakeyaml`, already included if you use the `spring-boot-starter`). A YAML file is parsed to a Java `Map` (like a JSON object), and Spring Boot flattens the map so that it is 1-level deep and has period-separated keys, a lot like people are used to with `Properties` files in Java.
+
+The example YAML above corresponds to an `application.properties` file
+
+```
spring.application.name=cruncher
spring.datasource.driverClassName=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost/test
server.port=9000
-See Section 24.6, “Using YAML instead of Properties” in the ‘Spring Boot features’ section for more information about YAML.
-72.6 Set the active Spring profiles
-The Spring Environment has an API for this, but normally you would set a System property (spring.profiles.active) or an OS environment variable (SPRING_PROFILES_ACTIVE). E.g. launch your application with a -D argument (remember to put it before the main class or jar archive):
+```
+
+See *Section 24.6, “Using YAML instead of Properties”* in the ‘Spring Boot features’ section for more information about YAML.
+
+## 72.6 Set the active Spring profiles
+The Spring `Environment` has an API for this, but normally you would set a System property (`spring.profiles.active`) or an OS environment variable (`SPRING_PROFILES_ACTIVE`). E.g. launch your application with a `-D` argument (remember to put it before the main class or jar archive):
+
+```
$ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar
-In Spring Boot you can also set the active profile in application.properties, e.g.
+```
+
+In Spring Boot you can also set the active profile in `application.properties`, e.g.
+
+```
spring.profiles.active=production
-A value set this way is replaced by the System property or environment variable setting, but not by the SpringApplicationBuilder.profiles() method. Thus the latter Java API can be used to augment the profiles without changing the defaults.
-See Chapter 25, Profiles in the ‘Spring Boot features’ section for more information.
+```
+
+A value set this way is replaced by the System property or environment variable setting, but not by the `SpringApplicationBuilder.profiles()` method. Thus the latter Java API can be used to augment the profiles without changing the defaults.
-72.7 Change configuration depending on the environment
-A YAML file is actually a sequence of documents separated by --- lines, and each document is parsed separately to a flattened map.
+See *Chapter 25, Profiles* in the ‘Spring Boot features’ section for more information.
-If a YAML document contains a spring.profiles key, then the profiles value (comma-separated list of profiles) is fed into the Spring Environment.acceptsProfiles() and if any of those profiles is active that document is included in the final merge (otherwise not).
+## 72.7 Change configuration depending on the environment
+
+A YAML file is actually a sequence of documents separated by `---` lines, and each document is parsed separately to a flattened map.
+
+If a YAML document contains a `spring.profiles` key, then the profiles value (comma-separated list of profiles) is fed into the Spring`Environment.acceptsProfiles()` and if any of those profiles is active that document is included in the final merge (otherwise not).
Example:
+```
server:
port: 9000
---
@@ -8414,68 +9348,76 @@ spring:
profiles: production
server:
port: 0
+
+```
+
In this example the default port is 9000, but if the Spring profile ‘development’ is active then the port is 9001, and if ‘production’ is active then it is 0.
The YAML documents are merged in the order they are encountered (so later values override earlier ones).
-To do the same thing with properties files you can use application-${profile}.properties to specify profile-specific values.
+To do the same thing with properties files you can use `application-${profile}.properties` to specify profile-specific values.
-72.8 Discover built-in options for external properties
-Spring Boot binds external properties from application.properties (or .yml) (and other places) into an application at runtime. There is not (and technically cannot be) an exhaustive list of all supported properties in a single location because contributions can come from additional jar files on your classpath.
+## 72.8 Discover built-in options for external properties
-A running application with the Actuator features has a configprops endpoint that shows all the bound and bindable properties available through @ConfigurationProperties.
+Spring Boot binds external properties from `application.properties` (or `.yml`) (and other places) into an application at runtime. There is not (and technically cannot be) an exhaustive list of all supported properties in a single location because contributions can come from additional jar files on your classpath.
-The appendix includes an application.properties example with a list of the most common properties supported by Spring Boot. The definitive list comes from searching the source code for @ConfigurationProperties and @Value annotations, as well as the occasional use of RelaxedPropertyResolver.
+A running application with the Actuator features has a `configprops` endpoint that shows all the bound and bindable properties available through `@ConfigurationProperties`.
-73. Embedded servlet containers
-73.1 Add a Servlet, Filter or Listener to an application
-There are two ways to add Servlet, Filter, ServletContextListener and the other listeners supported by the Servlet spec to your application. You can either provide Spring beans for them, or enable scanning for Servlet components.
+The appendix includes an [`application.properties`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#common-application-properties) example with a list of the most common properties supported by Spring Boot. The definitive list comes from searching the source code for `@ConfigurationProperties` and `@Value` annotations, as well as the occasional use of `RelaxedPropertyResolver`.
-73.1.1 Add a Servlet, Filter or Listener using a Spring bean
-To add a Servlet, Filter, or Servlet *Listener provide a @Bean definition for it. This can be very useful when you want to inject configuration or dependencies. However, you must be very careful that they don’t cause eager initialization of too many other beans because they have to be installed in the container very early in the application lifecycle (e.g. it’s not a good idea to have them depend on your DataSource or JPA configuration). You can work around restrictions like that by initializing them lazily when first used instead of on initialization.
+## 73. Embedded servlet containers
-In the case of Filters and Servlets you can also add mappings and init parameters by adding a FilterRegistrationBean or ServletRegistrationBean instead of or as well as the underlying component.
+## 73.1 Add a Servlet, Filter or Listener to an application
-[Note]
-If no dispatcherType is specified on a filter registration, it will match FORWARD,INCLUDE and REQUEST. If async has been enabled, it will match ASYNC as well.
+There are two ways to add `Servlet`, `Filter`, `ServletContextListener` and the other listeners supported by the Servlet spec to your application. You can either provide Spring beans for them, or enable scanning for Servlet components.
-If you are migrating a filter that has no dispatcher element in web.xml you will need to specify a dispatcherType yourself:
+### 73.1.1 Add a Servlet, Filter or Listener using a Spring bean
-@Bean
-public FilterRegistrationBean myFilterRegistration() {
- FilterRegistrationBean registration = new FilterRegistrationBean();
- registration.setDispatcherTypes(DispatcherType.REQUEST);
- ....
+To add a `Servlet`, `Filter`, or Servlet `*Listener` provide a `@Bean` definition for it. This can be very useful when you want to inject configuration or dependencies. However, you must be very careful that they don’t cause eager initialization of too many other beans because they have to be installed in the container very early in the application lifecycle (e.g. it’s not a good idea to have them depend on your `DataSource` or JPA configuration). You can work around restrictions like that by initializing them lazily when first used instead of on initialization.
- return registration;
-}
-Disable registration of a Servlet or Filter
-As described above any Servlet or Filter beans will be registered with the servlet container automatically. To disable registration of a particular Filter or Servlet bean create a registration bean for it and mark it as disabled. For example:
+In the case of `Filters` and `Servlets` you can also add mappings and init parameters by adding a `FilterRegistrationBean` or `ServletRegistrationBean`instead of or as well as the underlying component.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If no `dispatcherType` is specified on a filter registration, it will match `FORWARD`,`INCLUDE` and `REQUEST`. If async has been enabled, it will match `ASYNC` as well.If you are migrating a filter that has no `dispatcher` element in `web.xml` you will need to specify a `dispatcherType` yourself:`*@Bean* public FilterRegistrationBean myFilterRegistration() { FilterRegistrationBean registration = new FilterRegistrationBean(); registration.setDispatcherTypes(DispatcherType.REQUEST); .... return registration; }` |
+
+#### Disable registration of a Servlet or Filter
+
+As [described above](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-add-a-servlet-filter-or-listener-as-spring-bean) any `Servlet` or `Filter` beans will be registered with the servlet container automatically. To disable registration of a particular `Filter` or `Servlet` bean create a registration bean for it and mark it as disabled. For example:
+
+```
@Bean
public FilterRegistrationBean registration(MyFilter filter) {
FilterRegistrationBean registration = new FilterRegistrationBean(filter);
registration.setEnabled(false);
return registration;
}
-73.1.2 Add Servlets, Filters, and Listeners using classpath scanning
-@WebServlet, @WebFilter, and @WebListener annotated classes can be automatically registered with an embedded servlet container by annotating a @Configuration class with @ServletComponentScan and specifying the package(s) containing the components that you want to register. By default, @ServletComponentScan will scan from the package of the annotated class.
-73.2 Change the HTTP port
-In a standalone application the main HTTP port defaults to 8080, but can be set with server.port (e.g. in application.properties or as a System property). Thanks to relaxed binding of Environment values you can also use SERVER_PORT (e.g. as an OS environment variable).
+```
+
+### 73.1.2 Add Servlets, Filters, and Listeners using classpath scanning
+
+`@WebServlet`, `@WebFilter`, and `@WebListener` annotated classes can be automatically registered with an embedded servlet container by annotating a `@Configuration` class with `@ServletComponentScan` and specifying the package(s) containing the components that you want to register. By default, `@ServletComponentScan` will scan from the package of the annotated class.
+
+## 73.2 Change the HTTP port
+
+In a standalone application the main HTTP port defaults to `8080`, but can be set with `server.port` (e.g. in `application.properties` or as a System property). Thanks to relaxed binding of `Environment` values you can also use `SERVER_PORT` (e.g. as an OS environment variable).
+
+To switch off the HTTP endpoints completely, but still create a `WebApplicationContext`, use `server.port=-1` (this is sometimes useful for testing).
-To switch off the HTTP endpoints completely, but still create a WebApplicationContext, use server.port=-1 (this is sometimes useful for testing).
+For more details look at *Section 27.3.4, “Customizing embedded servlet containers”* in the ‘Spring Boot features’ section, or the [`ServerProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerProperties.java) source code.
-For more details look at Section 27.3.4, “Customizing embedded servlet containers” in the ‘Spring Boot features’ section, or the ServerProperties source code.
+## 73.3 Use a random unassigned HTTP port
-73.3 Use a random unassigned HTTP port
-To scan for a free port (using OS natives to prevent clashes) use server.port=0.
+To scan for a free port (using OS natives to prevent clashes) use `server.port=0`.
-73.4 Discover the HTTP port at runtime
-You can access the port the server is running on from log output or from the EmbeddedWebApplicationContext via its EmbeddedServletContainer. The best way to get that and be sure that it has initialized is to add a @Bean of type ApplicationListener and pull the container out of the event when it is published.
+## 73.4 Discover the HTTP port at runtime
-Tests that use @SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT) can also inject the actual port into a field using the @LocalServerPort annotation. For example:
+You can access the port the server is running on from log output or from the `EmbeddedWebApplicationContext` via its `EmbeddedServletContainer`. The best way to get that and be sure that it has initialized is to add a `@Bean` of type `ApplicationListener` and pull the container out of the event when it is published.
+Tests that use `@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)` can also inject the actual port into a field using the `@LocalServerPort`annotation. For example:
+
+```
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(webEnvironment=WebEnvironment.RANDOM_PORT)
public class MyWebIntegrationTests {
@@ -8489,67 +9431,102 @@ public class MyWebIntegrationTests {
// ...
}
-[Note]
-@LocalServerPort is a meta-annotation for @Value("${local.server.port}"). Don’t try to inject the port in a regular application. As we just saw, the value is only set once the container has initialized; contrary to a test, application code callbacks are processed early (i.e. before the value is actually available).
-73.5 Configure SSL
-SSL can be configured declaratively by setting the various server.ssl.* properties, typically in application.properties or application.yml. For example:
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| `@LocalServerPort` is a meta-annotation for `@Value("${local.server.port}")`. Don’t try to inject the port in a regular application. As we just saw, the value is only set once the container has initialized; contrary to a test, application code callbacks are processed early (i.e. before the value is actually available). |
+
+## 73.5 Configure SSL
+
+SSL can be configured declaratively by setting the various `server.ssl.*` properties, typically in `application.properties` or `application.yml`. For example:
+```
server.port=8443
server.ssl.key-store=classpath:keystore.jks
server.ssl.key-store-password=secret
server.ssl.key-password=another-secret
-See Ssl for details of all of the supported properties.
-Using configuration like the example above means the application will no longer support plain HTTP connector at port 8080. Spring Boot doesn’t support the configuration of both an HTTP connector and an HTTPS connector via application.properties. If you want to have both then you’ll need to configure one of them programmatically. It’s recommended to use application.properties to configure HTTPS as the HTTP connector is the easier of the two to configure programmatically. See the spring-boot-sample-tomcat-multi-connectors sample project for an example.
+```
+
+See [`Ssl`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/context/embedded/Ssl.java) for details of all of the supported properties.
+
+Using configuration like the example above means the application will no longer support plain HTTP connector at port 8080. Spring Boot doesn’t support the configuration of both an HTTP connector and an HTTPS connector via `application.properties`. If you want to have both then you’ll need to configure one of them programmatically. It’s recommended to use `application.properties` to configure HTTPS as the HTTP connector is the easier of the two to configure programmatically. See the [`spring-boot-sample-tomcat-multi-connectors`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-tomcat-multi-connectors) sample project for an example.
+
+## 73.6 Configure Access Logging
-73.6 Configure Access Logging
Access logs can be configured for Tomcat and Undertow via their respective namespaces.
-For instance, the following logs access on Tomcat with a custom pattern.
+For instance, the following logs access on Tomcat with a [custom pattern](https://tomcat.apache.org/tomcat-8.0-doc/config/valve.html#Access_Logging).
+```
server.tomcat.basedir=my-tomcat
server.tomcat.accesslog.enabled=true
server.tomcat.accesslog.pattern=%t %a "%r" %s (%D ms)
-[Note]
-The default location for logs is a logs directory relative to the tomcat base dir and said directory is a temp directory by default so you may want to fix Tomcat’s base directory or use an absolute path for the logs. In the example above, the logs will be available in my-tomcat/logs relative to the working directory of the application.
+
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The default location for logs is a `logs` directory relative to the tomcat base dir and said directory is a temp directory by default so you may want to fix Tomcat’s base directory or use an absolute path for the logs. In the example above, the logs will be available in `my-tomcat/logs` relative to the working directory of the application. |
Access logging for undertow can be configured in a similar fashion
+```
server.undertow.accesslog.enabled=true
server.undertow.accesslog.pattern=%t %a "%r" %s (%D ms)
-Logs are stored in a logs directory relative to the working directory of the application. This can be customized via server.undertow.accesslog.directory.
-73.7 Use behind a front-end proxy server
-Your application might need to send 302 redirects or render content with absolute links back to itself. When running behind a proxy, the caller wants a link to the proxy, and not to the physical address of the machine hosting your app. Typically such situations are handled via a contract with the proxy, which will add headers to tell the back end how to construct links to itself.
+```
+
+Logs are stored in a `logs` directory relative to the working directory of the application. This can be customized via `server.undertow.accesslog.directory`.
+
+## 73.7 Use behind a front-end proxy server
+
+Your application might need to send `302` redirects or render content with absolute links back to itself. When running behind a proxy, the caller wants a link to the proxy, and not to the physical address of the machine hosting your app. Typically such situations are handled via a contract with the proxy, which will add headers to tell the back end how to construct links to itself.
-If the proxy adds conventional X-Forwarded-For and X-Forwarded-Proto headers (most do this out of the box) the absolute links should be rendered correctly as long as server.use-forward-headers is set to true in your application.properties.
+If the proxy adds conventional `X-Forwarded-For` and `X-Forwarded-Proto` headers (most do this out of the box) the absolute links should be rendered correctly as long as `server.use-forward-headers` is set to `true` in your `application.properties`.
-[Note]
-If your application is running in Cloud Foundry or Heroku the server.use-forward-headers property will default to true if not specified. In all other instances it defaults to false.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If your application is running in Cloud Foundry or Heroku the `server.use-forward-headers` property will default to `true` if not specified. In all other instances it defaults to `false`. |
+
+### 73.7.1 Customize Tomcat’s proxy configuration
-73.7.1 Customize Tomcat’s proxy configuration
If you are using Tomcat you can additionally configure the names of the headers used to carry “forwarded” information:
+```
server.tomcat.remote-ip-header=x-your-remote-ip-header
server.tomcat.protocol-header=x-your-protocol-header
-Tomcat is also configured with a default regular expression that matches internal proxies that are to be trusted. By default, IP addresses in 10/8, 192.168/16, 169.254/16 and 127/8 are trusted. You can customize the valve’s configuration by adding an entry to application.properties, e.g.
+```
+
+Tomcat is also configured with a default regular expression that matches internal proxies that are to be trusted. By default, IP addresses in `10/8`, `192.168/16`,`169.254/16` and `127/8` are trusted. You can customize the valve’s configuration by adding an entry to `application.properties`, e.g.
+
+```
server.tomcat.internal-proxies=192\\.168\\.\\d{1,3}\\.\\d{1,3}
-[Note]
-The double backslashes are only required when you’re using a properties file for configuration. If you are using YAML, single backslashes are sufficient and a value that’s equivalent to the one shown above would be 192\.168\.\d{1,3}\.\d{1,3}.
-[Note]
-You can trust all proxies by setting the internal-proxies to empty (but don’t do this in production).
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The double backslashes are only required when you’re using a properties file for configuration. If you are using YAML, single backslashes are sufficient and a value that’s equivalent to the one shown above would be `192\.168\.\d{1,3}\.\d{1,3}`. |
-You can take complete control of the configuration of Tomcat’s RemoteIpValve by switching the automatic one off (i.e. set server.use-forward-headers=false) and adding a new valve instance in a TomcatEmbeddedServletContainerFactory bean.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can trust all proxies by setting the `internal-proxies` to empty (but don’t do this in production). |
-73.8 Configure Tomcat
-Generally you can follow the advice from Section 72.8, “Discover built-in options for external properties” about @ConfigurationProperties (ServerProperties is the main one here), but also look at EmbeddedServletContainerCustomizer and various Tomcat-specific *Customizers that you can add in one of those. The Tomcat APIs are quite rich so once you have access to the TomcatEmbeddedServletContainerFactory you can modify it in a number of ways. Or the nuclear option is to add your own TomcatEmbeddedServletContainerFactory.
+You can take complete control of the configuration of Tomcat’s `RemoteIpValve` by switching the automatic one off (i.e. set `server.use-forward-headers=false`) and adding a new valve instance in a `TomcatEmbeddedServletContainerFactory` bean.
-73.9 Enable Multiple Connectors with Tomcat
-Add a org.apache.catalina.connector.Connector to the TomcatEmbeddedServletContainerFactory which can allow multiple connectors, e.g. HTTP and HTTPS connector:
+## 73.8 Configure Tomcat
+Generally you can follow the advice from *Section 72.8, “Discover built-in options for external properties”* about `@ConfigurationProperties` (`ServerProperties`is the main one here), but also look at `EmbeddedServletContainerCustomizer` and various Tomcat-specific `*Customizers` that you can add in one of those. The Tomcat APIs are quite rich so once you have access to the `TomcatEmbeddedServletContainerFactory` you can modify it in a number of ways. Or the nuclear option is to add your own `TomcatEmbeddedServletContainerFactory`.
+
+## 73.9 Enable Multiple Connectors with Tomcat
+
+Add a `org.apache.catalina.connector.Connector` to the `TomcatEmbeddedServletContainerFactory` which can allow multiple connectors, e.g. HTTP and HTTPS connector:
+
+```
@Bean
public EmbeddedServletContainerFactory servletContainer() {
TomcatEmbeddedServletContainerFactory tomcat = new TomcatEmbeddedServletContainerFactory();
@@ -8579,12 +9556,21 @@ private Connector createSslConnector() {
+ "] or truststore: [" + "keystore" + "]", ex);
}
}
-73.10 Use Tomcat’s LegacyCookieProcessor
+
+```
+
+## 73.10 Use Tomcat’s LegacyCookieProcessor
+
The embedded Tomcat used by Spring Boot does not support "Version 0" of the Cookie format out of the box, and you may see the following error:
+```
java.lang.IllegalArgumentException: An invalid character [32] was present in the Cookie value
-If at all possible, you should consider updating your code to only store values compliant with later Cookie specifications. If, however, you’re unable to change the way that cookies are written, you can instead configure Tomcat to use a LegacyCookieProcessor. To switch to the LegacyCookieProcessor use an EmbeddedServletContainerCustomizer bean that adds a TomcatContextCustomizer:
+```
+
+If at all possible, you should consider updating your code to only store values compliant with later Cookie specifications. If, however, you’re unable to change the way that cookies are written, you can instead configure Tomcat to use a `LegacyCookieProcessor`. To switch to the `LegacyCookieProcessor` use an`EmbeddedServletContainerCustomizer` bean that adds a `TomcatContextCustomizer`:
+
+```
@Bean
public EmbeddedServletContainerCustomizer cookieProcessorCustomizer() {
return new EmbeddedServletContainerCustomizer() {
@@ -8606,11 +9592,16 @@ public EmbeddedServletContainerCustomizer cookieProcessorCustomizer() {
};
}
-73.11 Use Jetty instead of Tomcat
-The Spring Boot starters (spring-boot-starter-web in particular) use Tomcat as an embedded container by default. You need to exclude those dependencies and include the Jetty one instead. Spring Boot provides Tomcat and Jetty dependencies bundled together as separate starters to help make this process as easy as possible.
+
+```
+
+## 73.11 Use Jetty instead of Tomcat
+
+The Spring Boot starters (`spring-boot-starter-web` in particular) use Tomcat as an embedded container by default. You need to exclude those dependencies and include the Jetty one instead. Spring Boot provides Tomcat and Jetty dependencies bundled together as separate starters to help make this process as easy as possible.
Example in Maven:
+```
org.springframework.boot
spring-boot-starter-web
@@ -8625,8 +9616,12 @@ Example in Maven:
org.springframework.boot
spring-boot-starter-jetty
+
+```
+
Example in Gradle:
+```
configurations {
compile.exclude module: "spring-boot-starter-tomcat"
}
@@ -8636,14 +9631,20 @@ dependencies {
compile("org.springframework.boot:spring-boot-starter-jetty:1.5.7.BUILD-SNAPSHOT")
// ...
}
-73.12 Configure Jetty
-Generally you can follow the advice from Section 72.8, “Discover built-in options for external properties” about @ConfigurationProperties (ServerProperties is the main one here), but also look at EmbeddedServletContainerCustomizer. The Jetty APIs are quite rich so once you have access to the JettyEmbeddedServletContainerFactory you can modify it in a number of ways. Or the nuclear option is to add your own JettyEmbeddedServletContainerFactory.
-73.13 Use Undertow instead of Tomcat
-Using Undertow instead of Tomcat is very similar to using Jetty instead of Tomcat. You need to exclude the Tomcat dependencies and include the Undertow starter instead.
+```
+
+## 73.12 Configure Jetty
+
+Generally you can follow the advice from *Section 72.8, “Discover built-in options for external properties”* about `@ConfigurationProperties` (`ServerProperties`is the main one here), but also look at `EmbeddedServletContainerCustomizer`. The Jetty APIs are quite rich so once you have access to the `JettyEmbeddedServletContainerFactory` you can modify it in a number of ways. Or the nuclear option is to add your own `JettyEmbeddedServletContainerFactory`.
+
+## 73.13 Use Undertow instead of Tomcat
+
+Using Undertow instead of Tomcat is very similar to [using Jetty instead of Tomcat](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-instead-of-tomcat). You need to exclude the Tomcat dependencies and include the Undertow starter instead.
Example in Maven:
+```
org.springframework.boot
spring-boot-starter-web
@@ -8658,8 +9659,12 @@ Example in Maven:
org.springframework.boot
spring-boot-starter-undertow
+
+```
+
Example in Gradle:
+```
configurations {
compile.exclude module: "spring-boot-starter-tomcat"
}
@@ -8669,12 +9674,18 @@ dependencies {
compile("org.springframework.boot:spring-boot-starter-undertow:1.5.7.BUILD-SNAPSHOT")
// ...
}
-73.14 Configure Undertow
-Generally you can follow the advice from Section 72.8, “Discover built-in options for external properties” about @ConfigurationProperties (ServerProperties and ServerProperties.Undertow are the main ones here), but also look at EmbeddedServletContainerCustomizer. Once you have access to the UndertowEmbeddedServletContainerFactory you can use an UndertowBuilderCustomizer to modify Undertow’s configuration to meet your needs. Or the nuclear option is to add your own UndertowEmbeddedServletContainerFactory.
-73.15 Enable Multiple Listeners with Undertow
-Add an UndertowBuilderCustomizer to the UndertowEmbeddedServletContainerFactory and add a listener to the Builder:
+```
+
+## 73.14 Configure Undertow
+Generally you can follow the advice from *Section 72.8, “Discover built-in options for external properties”* about `@ConfigurationProperties` (`ServerProperties`and `ServerProperties.Undertow` are the main ones here), but also look at `EmbeddedServletContainerCustomizer`. Once you have access to the`UndertowEmbeddedServletContainerFactory` you can use an `UndertowBuilderCustomizer` to modify Undertow’s configuration to meet your needs. Or the nuclear option is to add your own `UndertowEmbeddedServletContainerFactory`.
+
+## 73.15 Enable Multiple Listeners with Undertow
+
+Add an `UndertowBuilderCustomizer` to the `UndertowEmbeddedServletContainerFactory` and add a listener to the `Builder`:
+
+```
@Bean
public UndertowEmbeddedServletContainerFactory embeddedServletContainerFactory() {
UndertowEmbeddedServletContainerFactory factory = new UndertowEmbeddedServletContainerFactory();
@@ -8688,12 +9699,18 @@ public UndertowEmbeddedServletContainerFactory embeddedServletContainerFactory()
});
return factory;
}
-73.16 Use Tomcat 7.x or 8.0
+
+```
+
+## 73.16 Use Tomcat 7.x or 8.0
+
Tomcat 7 & 8.0 work with Spring Boot, but the default is to use Tomcat 8.5. If you cannot use Tomcat 8.5 (for example, because you are using Java 1.6) you will need to change your classpath to reference a different version.
-73.16.1 Use Tomcat 7.x or 8.0 with Maven
-If you are using the starters and parent you can change the Tomcat version property and additionally import tomcat-juli. E.g. for a simple webapp or service:
+### 73.16.1 Use Tomcat 7.x or 8.0 with Maven
+If you are using the starters and parent you can change the Tomcat version property and additionally import `tomcat-juli`. E.g. for a simple webapp or service:
+
+```
7.0.59
@@ -8710,20 +9727,31 @@ If you are using the starters and parent you can change the Tomcat version prope
...
-73.16.2 Use Tomcat 7.x or 8.0 with Gradle
-With Gradle, you can change the Tomcat version by setting the tomcat.version property and then additionally include tomcat-juli:
+```
+
+### 73.16.2 Use Tomcat 7.x or 8.0 with Gradle
+
+With Gradle, you can change the Tomcat version by setting the `tomcat.version` property and then additionally include `tomcat-juli`:
+
+```
ext['tomcat.version'] = '7.0.59'
dependencies {
compile 'org.springframework.boot:spring-boot-starter-web'
compile group:'org.apache.tomcat', name:'tomcat-juli', version:property('tomcat.version')
}
-73.17 Use Jetty 9.2
+
+```
+
+## 73.17 Use Jetty 9.2
+
Jetty 9.2 works with Spring Boot, but the default is to use Jetty 9.3. If you cannot use Jetty 9.3 (for example, because you are using Java 7) you will need to change your classpath to reference Jetty 9.2.
-73.17.1 Use Jetty 9.2 with Maven
-If you are using the starters and parent you can just add the Jetty starter and override the jetty.version property:
+### 73.17.1 Use Jetty 9.2 with Maven
+
+If you are using the starters and parent you can just add the Jetty starter and override the `jetty.version` property:
+```
9.2.17.v20160517
@@ -8743,9 +9771,14 @@ If you are using the starters and parent you can just add the Jetty starter and
spring-boot-starter-jetty
-73.17.2 Use Jetty 9.2 with Gradle
-You can set the jetty.version property. For example, for a simple webapp or service:
+```
+
+### 73.17.2 Use Jetty 9.2 with Gradle
+
+You can set the `jetty.version` property. For example, for a simple webapp or service:
+
+```
ext['jetty.version'] = '9.2.17.v20160517'
dependencies {
compile ('org.springframework.boot:spring-boot-starter-web') {
@@ -8753,12 +9786,18 @@ dependencies {
}
compile ('org.springframework.boot:spring-boot-starter-jetty')
}
-73.18 Use Jetty 8
+
+```
+
+## 73.18 Use Jetty 8
+
Jetty 8 works with Spring Boot, but the default is to use Jetty 9.3. If you cannot use Jetty 9.3 (for example, because you are using Java 1.6) you will need to change your classpath to reference Jetty 8. You will also need to exclude Jetty’s WebSocket-related dependencies.
-73.18.1 Use Jetty 8 with Maven
+### 73.18.1 Use Jetty 8 with Maven
+
If you are using the starters and parent you can just add the Jetty starter with the required WebSocket exclusion and change the version properties, e.g. for a simple webapp or service:
+```
8.1.15.v20140411
2.2.0.v201112011158
@@ -8785,9 +9824,14 @@ If you are using the starters and parent you can just add the Jetty starter with
-73.18.2 Use Jetty 8 with Gradle
-You can set the jetty.version property and exclude the WebSocket dependency, e.g. for a simple webapp or service:
+```
+
+### 73.18.2 Use Jetty 8 with Gradle
+
+You can set the `jetty.version` property and exclude the WebSocket dependency, e.g. for a simple webapp or service:
+
+```
ext['jetty.version'] = '8.1.15.v20140411'
dependencies {
compile ('org.springframework.boot:spring-boot-starter-web') {
@@ -8797,33 +9841,50 @@ dependencies {
exclude group: 'org.eclipse.jetty.websocket'
}
}
-73.19 Create WebSocket endpoints using @ServerEndpoint
-If you want to use @ServerEndpoint in a Spring Boot application that used an embedded container, you must declare a single ServerEndpointExporter @Bean:
+```
+
+## 73.19 Create WebSocket endpoints using @ServerEndpoint
+
+If you want to use `@ServerEndpoint` in a Spring Boot application that used an embedded container, you must declare a single `ServerEndpointExporter``@Bean`:
+
+```
@Bean
public ServerEndpointExporter serverEndpointExporter() {
return new ServerEndpointExporter();
}
-This bean will register any @ServerEndpoint annotated beans with the underlying WebSocket container. When deployed to a standalone servlet container this role is performed by a servlet container initializer and the ServerEndpointExporter bean is not required.
-73.20 Enable HTTP response compression
-HTTP response compression is supported by Jetty, Tomcat, and Undertow. It can be enabled via application.properties:
+```
+
+This bean will register any `@ServerEndpoint` annotated beans with the underlying WebSocket container. When deployed to a standalone servlet container this role is performed by a servlet container initializer and the `ServerEndpointExporter` bean is not required.
+## 73.20 Enable HTTP response compression
+
+HTTP response compression is supported by Jetty, Tomcat, and Undertow. It can be enabled via `application.properties`:
+
+```
server.compression.enabled=true
-By default, responses must be at least 2048 bytes in length for compression to be performed. This can be configured using the server.compression.min-response-size property.
+
+```
+
+By default, responses must be at least 2048 bytes in length for compression to be performed. This can be configured using the `server.compression.min-response-size` property.
By default, responses will only be compressed if their content type is one of the following:
-text/html
-text/xml
-text/plain
-text/css
-This can be configured using the server.compression.mime-types property.
+- `text/html`
+- `text/xml`
+- `text/plain`
+- `text/css`
-74. Spring MVC
-74.1 Write a JSON REST service
-Any Spring @RestController in a Spring Boot application should render JSON response by default as long as Jackson2 is on the classpath. For example:
+This can be configured using the `server.compression.mime-types` property.
+## 74. Spring MVC
+
+## 74.1 Write a JSON REST service
+
+Any Spring `@RestController` in a Spring Boot application should render JSON response by default as long as Jackson2 is on the classpath. For example:
+
+```
@RestController
public class MyController {
@@ -8833,136 +9894,157 @@ public class MyController {
}
}
-As long as MyThing can be serialized by Jackson2 (e.g. a normal POJO or Groovy object) then localhost:8080/thing will serve a JSON representation of it by default. Sometimes in a browser you might see XML responses because browsers tend to send accept headers that prefer XML.
-74.2 Write an XML REST service
-If you have the Jackson XML extension (jackson-dataformat-xml) on the classpath, it will be used to render XML responses and the very same example as we used for JSON would work. To use it, add the following dependency to your project:
+```
+
+As long as `MyThing` can be serialized by Jackson2 (e.g. a normal POJO or Groovy object) then `localhost:8080/thing` will serve a JSON representation of it by default. Sometimes in a browser you might see XML responses because browsers tend to send accept headers that prefer XML.
+## 74.2 Write an XML REST service
+
+If you have the Jackson XML extension (`jackson-dataformat-xml`) on the classpath, it will be used to render XML responses and the very same example as we used for JSON would work. To use it, add the following dependency to your project:
+
+```
com.fasterxml.jackson.dataformat
jackson-dataformat-xml
+
+```
+
You may also want to add a dependency on Woodstox. It’s faster than the default StAX implementation provided by the JDK and also adds pretty print support and improved namespace handling:
+```
org.codehaus.woodstox
woodstox-core-asl
-If Jackson’s XML extension is not available, JAXB (provided by default in the JDK) will be used, with the additional requirement to have MyThing annotated as @XmlRootElement:
+```
+
+If Jackson’s XML extension is not available, JAXB (provided by default in the JDK) will be used, with the additional requirement to have `MyThing` annotated as`@XmlRootElement`:
+
+```
@XmlRootElement
public class MyThing {
private String name;
// .. getters and setters
}
-To get the server to render XML instead of JSON you might have to send an Accept: text/xml header (or use a browser).
-74.3 Customize the Jackson ObjectMapper
-Spring MVC (client and server side) uses HttpMessageConverters to negotiate content conversion in an HTTP exchange. If Jackson is on the classpath you already get the default converter(s) provided by Jackson2ObjectMapperBuilder, an instance of which is auto-configured for you.
+```
-The ObjectMapper (or XmlMapper for Jackson XML converter) instance created by default has the following customized properties:
+To get the server to render XML instead of JSON you might have to send an `Accept: text/xml` header (or use a browser).
-MapperFeature.DEFAULT_VIEW_INCLUSION is disabled
-DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES is disabled
-Spring Boot has also some features to make it easier to customize this behavior.
+## 74.3 Customize the Jackson ObjectMapper
-You can configure the ObjectMapper and XmlMapper instances using the environment. Jackson provides an extensive suite of simple on/off features that can be used to configure various aspects of its processing. These features are described in six enums in Jackson which map onto properties in the environment:
+Spring MVC (client and server side) uses `HttpMessageConverters` to negotiate content conversion in an HTTP exchange. If Jackson is on the classpath you already get the default converter(s) provided by `Jackson2ObjectMapperBuilder`, an instance of which is auto-configured for you.
-Jackson enum Environment property
-com.fasterxml.jackson.databind.DeserializationFeature
+The `ObjectMapper` (or `XmlMapper` for Jackson XML converter) instance created by default has the following customized properties:
-spring.jackson.deserialization.=true|false
+- `MapperFeature.DEFAULT_VIEW_INCLUSION` is disabled
+- `DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES` is disabled
-com.fasterxml.jackson.core.JsonGenerator.Feature
+Spring Boot has also some features to make it easier to customize this behavior.
-spring.jackson.generator.=true|false
+You can configure the `ObjectMapper` and `XmlMapper` instances using the environment. Jackson provides an extensive suite of simple on/off features that can be used to configure various aspects of its processing. These features are described in six enums in Jackson which map onto properties in the environment:
-com.fasterxml.jackson.databind.MapperFeature
+| Jackson enum | Environment property |
+| ------------------------------------------------------- | ------------------------------------------------------------ |
+| `com.fasterxml.jackson.databind.DeserializationFeature` | `spring.jackson.deserialization.=true|false` |
+| `com.fasterxml.jackson.core.JsonGenerator.Feature` | `spring.jackson.generator.=true|false` |
+| `com.fasterxml.jackson.databind.MapperFeature` | `spring.jackson.mapper.=true|false` |
+| `com.fasterxml.jackson.core.JsonParser.Feature` | `spring.jackson.parser.=true|false` |
+| `com.fasterxml.jackson.databind.SerializationFeature` | `spring.jackson.serialization.=true|false` |
+| `com.fasterxml.jackson.annotation.JsonInclude.Include` | `spring.jackson.default-property-inclusion=always|non_null|non_absent|non_default|non_empty` |
-spring.jackson.mapper.=true|false
+For example, to enable pretty print, set `spring.jackson.serialization.indent_output=true`. Note that, thanks to the use of [relaxed binding](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-relaxed-binding), the case of `indent_output` doesn’t have to match the case of the corresponding enum constant which is `INDENT_OUTPUT`.
-com.fasterxml.jackson.core.JsonParser.Feature
+This environment-based configuration is applied to the auto-configured `Jackson2ObjectMapperBuilder` bean, and will apply to any mappers created using the builder, including the auto-configured `ObjectMapper` bean.
-spring.jackson.parser.=true|false
+The context’s `Jackson2ObjectMapperBuilder` can be customized by one or more `Jackson2ObjectMapperBuilderCustomizer` beans. Such customizer beans can be ordered and Boot’s own customizer has an order of 0, allowing additional customization to be applied both before and after Boot’s customization.
-com.fasterxml.jackson.databind.SerializationFeature
+Any beans of type `com.fasterxml.jackson.databind.Module` will be automatically registered with the auto-configured `Jackson2ObjectMapperBuilder` and applied to any `ObjectMapper` instances that it creates. This provides a global mechanism for contributing custom modules when you add new features to your application.
-spring.jackson.serialization.=true|false
+If you want to replace the default `ObjectMapper` completely, either define a `@Bean` of that type and mark it as `@Primary`, or, if you prefer the builder-based approach, define a `Jackson2ObjectMapperBuilder` `@Bean`. Note that in either case this will disable all auto-configuration of the `ObjectMapper`.
-com.fasterxml.jackson.annotation.JsonInclude.Include
+If you provide any `@Beans` of type `MappingJackson2HttpMessageConverter` then they will replace the default value in the MVC configuration. Also, a convenience bean is provided of type `HttpMessageConverters` (always available if you use the default MVC configuration) which has some useful methods to access the default and user-enhanced message converters.
-spring.jackson.default-property-inclusion=always|non_null|non_absent|non_default|non_empty
+See also the *Section 74.4, “Customize the @ResponseBody rendering”* section and the [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.java) source code for more details.
-For example, to enable pretty print, set spring.jackson.serialization.indent_output=true. Note that, thanks to the use of relaxed binding, the case of indent_output doesn’t have to match the case of the corresponding enum constant which is INDENT_OUTPUT.
+## 74.4 Customize the @ResponseBody rendering
-This environment-based configuration is applied to the auto-configured Jackson2ObjectMapperBuilder bean, and will apply to any mappers created using the builder, including the auto-configured ObjectMapper bean.
+Spring uses `HttpMessageConverters` to render `@ResponseBody` (or responses from `@RestController`). You can contribute additional converters by simply adding beans of that type in a Spring Boot context. If a bean you add is of a type that would have been included by default anyway (like `MappingJackson2HttpMessageConverter` for JSON conversions) then it will replace the default value. A convenience bean is provided of type `HttpMessageConverters` (always available if you use the default MVC configuration) which has some useful methods to access the default and user-enhanced message converters (useful, for example if you want to manually inject them into a custom `RestTemplate`).
-The context’s Jackson2ObjectMapperBuilder can be customized by one or more Jackson2ObjectMapperBuilderCustomizer beans. Such customizer beans can be ordered and Boot’s own customizer has an order of 0, allowing additional customization to be applied both before and after Boot’s customization.
+As in normal MVC usage, any `WebMvcConfigurerAdapter` beans that you provide can also contribute converters by overriding the `configureMessageConverters` method, but unlike with normal MVC, you can supply only additional converters that you need (because Spring Boot uses the same mechanism to contribute its defaults). Finally, if you opt-out of the Spring Boot default MVC configuration by providing your own `@EnableWebMvc` configuration, then you can take control completely and do everything manually using `getMessageConverters` from `WebMvcConfigurationSupport`.
-Any beans of type com.fasterxml.jackson.databind.Module will be automatically registered with the auto-configured Jackson2ObjectMapperBuilder and applied to any ObjectMapper instances that it creates. This provides a global mechanism for contributing custom modules when you add new features to your application.
+See the [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.java) source code for more details.
-If you want to replace the default ObjectMapper completely, either define a @Bean of that type and mark it as @Primary, or, if you prefer the builder-based approach, define a Jackson2ObjectMapperBuilder @Bean. Note that in either case this will disable all auto-configuration of the ObjectMapper.
+## 74.5 Handling Multipart File Uploads
-If you provide any @Beans of type MappingJackson2HttpMessageConverter then they will replace the default value in the MVC configuration. Also, a convenience bean is provided of type HttpMessageConverters (always available if you use the default MVC configuration) which has some useful methods to access the default and user-enhanced message converters.
+Spring Boot embraces the Servlet 3 `javax.servlet.http.Part` API to support uploading files. By default Spring Boot configures Spring MVC with a maximum file of 1MB per file and a maximum of 10MB of file data in a single request. You may override these values, as well as the location to which intermediate data is stored (e.g., to the `/tmp` directory) and the threshold past which data is flushed to disk by using the properties exposed in the `MultipartProperties` class. If you want to specify that files be unlimited, for example, set the `spring.http.multipart.max-file-size` property to `-1`.
-See also the Section 74.4, “Customize the @ResponseBody rendering” section and the WebMvcAutoConfiguration source code for more details.
+The multipart support is helpful when you want to receive multipart encoded file data as a `@RequestParam`-annotated parameter of type `MultipartFile` in a Spring MVC controller handler method.
-74.4 Customize the @ResponseBody rendering
-Spring uses HttpMessageConverters to render @ResponseBody (or responses from @RestController). You can contribute additional converters by simply adding beans of that type in a Spring Boot context. If a bean you add is of a type that would have been included by default anyway (like MappingJackson2HttpMessageConverter for JSON conversions) then it will replace the default value. A convenience bean is provided of type HttpMessageConverters (always available if you use the default MVC configuration) which has some useful methods to access the default and user-enhanced message converters (useful, for example if you want to manually inject them into a custom RestTemplate).
+See the [`MultipartAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java) source for more details.
-As in normal MVC usage, any WebMvcConfigurerAdapter beans that you provide can also contribute converters by overriding the configureMessageConverters method, but unlike with normal MVC, you can supply only additional converters that you need (because Spring Boot uses the same mechanism to contribute its defaults). Finally, if you opt-out of the Spring Boot default MVC configuration by providing your own @EnableWebMvc configuration, then you can take control completely and do everything manually using getMessageConverters from WebMvcConfigurationSupport.
+## 74.6 Switch off the Spring MVC DispatcherServlet
-See the WebMvcAutoConfiguration source code for more details.
+Spring Boot wants to serve all content from the root of your application `/` down. If you would rather map your own servlet to that URL you can do it, but of course you may lose some of the other Boot MVC features. To add your own servlet and map it to the root resource just declare a `@Bean` of type `Servlet` and give it the special bean name `dispatcherServlet` (You can also create a bean of a different type with that name if you want to switch it off and not replace it).
-74.5 Handling Multipart File Uploads
-Spring Boot embraces the Servlet 3 javax.servlet.http.Part API to support uploading files. By default Spring Boot configures Spring MVC with a maximum file of 1MB per file and a maximum of 10MB of file data in a single request. You may override these values, as well as the location to which intermediate data is stored (e.g., to the /tmp directory) and the threshold past which data is flushed to disk by using the properties exposed in the MultipartProperties class. If you want to specify that files be unlimited, for example, set the spring.http.multipart.max-file-size property to -1.
+## 74.7 Switch off the Default MVC configuration
-The multipart support is helpful when you want to receive multipart encoded file data as a @RequestParam-annotated parameter of type MultipartFile in a Spring MVC controller handler method.
+The easiest way to take complete control over MVC configuration is to provide your own `@Configuration` with the `@EnableWebMvc` annotation. This will leave all MVC configuration in your hands.
-See the MultipartAutoConfiguration source for more details.
+## 74.8 Customize ViewResolvers
-74.6 Switch off the Spring MVC DispatcherServlet
-Spring Boot wants to serve all content from the root of your application / down. If you would rather map your own servlet to that URL you can do it, but of course you may lose some of the other Boot MVC features. To add your own servlet and map it to the root resource just declare a @Bean of type Servlet and give it the special bean name dispatcherServlet (You can also create a bean of a different type with that name if you want to switch it off and not replace it).
+A `ViewResolver` is a core component of Spring MVC, translating view names in `@Controller` to actual `View` implementations. Note that `ViewResolvers` are mainly used in UI applications, rather than REST-style services (a `View` is not used to render a `@ResponseBody`). There are many implementations of `ViewResolver` to choose from, and Spring on its own is not opinionated about which ones you should use. Spring Boot, on the other hand, installs one or two for you depending on what it finds on the classpath and in the application context. The `DispatcherServlet` uses all the resolvers it finds in the application context, trying each one in turn until it gets a result, so if you are adding your own you have to be aware of the order and in which position your resolver is added.
-74.7 Switch off the Default MVC configuration
-The easiest way to take complete control over MVC configuration is to provide your own @Configuration with the @EnableWebMvc annotation. This will leave all MVC configuration in your hands.
+`WebMvcAutoConfiguration` adds the following `ViewResolvers` to your context:
-74.8 Customize ViewResolvers
-A ViewResolver is a core component of Spring MVC, translating view names in @Controller to actual View implementations. Note that ViewResolvers are mainly used in UI applications, rather than REST-style services (a View is not used to render a @ResponseBody). There are many implementations of ViewResolver to choose from, and Spring on its own is not opinionated about which ones you should use. Spring Boot, on the other hand, installs one or two for you depending on what it finds on the classpath and in the application context. The DispatcherServlet uses all the resolvers it finds in the application context, trying each one in turn until it gets a result, so if you are adding your own you have to be aware of the order and in which position your resolver is added.
+- An `InternalResourceViewResolver` with bean id ‘defaultViewResolver’. This one locates physical resources that can be rendered using the `DefaultServlet` (e.g. static resources and JSP pages if you are using those). It applies a prefix and a suffix to the view name and then looks for a physical resource with that path in the servlet context (defaults are both empty, but accessible for external configuration via `spring.mvc.view.prefix` and `spring.mvc.view.suffix`). It can be overridden by providing a bean of the same type.
+- A `BeanNameViewResolver` with id ‘beanNameViewResolver’. This is a useful member of the view resolver chain and will pick up any beans with the same name as the `View` being resolved. It shouldn’t be necessary to override or replace it.
+- A `ContentNegotiatingViewResolver` with id ‘viewResolver’ is only added if there **are** actually beans of type `View` present. This is a ‘master’ resolver, delegating to all the others and attempting to find a match to the ‘Accept’ HTTP header sent by the client. There is a useful [blog about `ContentNegotiatingViewResolver`](https://spring.io/blog/2013/06/03/content-negotiation-using-views) that you might like to study to learn more, and also look at the source code for detail. You can switch off the auto-configured `ContentNegotiatingViewResolver` by defining a bean named ‘viewResolver’.
+- If you use Thymeleaf you will also have a `ThymeleafViewResolver` with id ‘thymeleafViewResolver’. It looks for resources by surrounding the view name with a prefix and suffix (externalized to `spring.thymeleaf.prefix` and `spring.thymeleaf.suffix`, defaults ‘classpath:/templates/’ and ‘.html’ respectively). It can be overridden by providing a bean of the same name.
+- If you use FreeMarker you will also have a `FreeMarkerViewResolver` with id ‘freeMarkerViewResolver’. It looks for resources in a loader path (externalized to`spring.freemarker.templateLoaderPath`, default ‘classpath:/templates/’) by surrounding the view name with a prefix and suffix (externalized to `spring.freemarker.prefix` and `spring.freemarker.suffix`, with empty and ‘.ftl’ defaults respectively). It can be overridden by providing a bean of the same name.
+- If you use Groovy templates (actually if groovy-templates is on your classpath) you will also have a `GroovyMarkupViewResolver` with id ‘groovyMarkupViewResolver’. It looks for resources in a loader path by surrounding the view name with a prefix and suffix (externalized to `spring.groovy.template.prefix` and `spring.groovy.template.suffix`, defaults ‘classpath:/templates/’ and ‘.tpl’ respectively). It can be overridden by providing a bean of the same name.
-WebMvcAutoConfiguration adds the following ViewResolvers to your context:
+Check out [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.java), [`ThymeleafAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafAutoConfiguration.java), [`FreeMarkerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerAutoConfiguration.java) and [`GroovyTemplateAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateAutoConfiguration.java)
-An InternalResourceViewResolver with bean id ‘defaultViewResolver’. This one locates physical resources that can be rendered using the DefaultServlet (e.g. static resources and JSP pages if you are using those). It applies a prefix and a suffix to the view name and then looks for a physical resource with that path in the servlet context (defaults are both empty, but accessible for external configuration via spring.mvc.view.prefix and spring.mvc.view.suffix). It can be overridden by providing a bean of the same type.
-A BeanNameViewResolver with id ‘beanNameViewResolver’. This is a useful member of the view resolver chain and will pick up any beans with the same name as the View being resolved. It shouldn’t be necessary to override or replace it.
-A ContentNegotiatingViewResolver with id ‘viewResolver’ is only added if there are actually beans of type View present. This is a ‘master’ resolver, delegating to all the others and attempting to find a match to the ‘Accept’ HTTP header sent by the client. There is a useful blog about ContentNegotiatingViewResolver that you might like to study to learn more, and also look at the source code for detail. You can switch off the auto-configured ContentNegotiatingViewResolver by defining a bean named ‘viewResolver’.
-If you use Thymeleaf you will also have a ThymeleafViewResolver with id ‘thymeleafViewResolver’. It looks for resources by surrounding the view name with a prefix and suffix (externalized to spring.thymeleaf.prefix and spring.thymeleaf.suffix, defaults ‘classpath:/templates/’ and ‘.html’ respectively). It can be overridden by providing a bean of the same name.
-If you use FreeMarker you will also have a FreeMarkerViewResolver with id ‘freeMarkerViewResolver’. It looks for resources in a loader path (externalized to spring.freemarker.templateLoaderPath, default ‘classpath:/templates/’) by surrounding the view name with a prefix and suffix (externalized to spring.freemarker.prefix and spring.freemarker.suffix, with empty and ‘.ftl’ defaults respectively). It can be overridden by providing a bean of the same name.
-If you use Groovy templates (actually if groovy-templates is on your classpath) you will also have a GroovyMarkupViewResolver with id ‘groovyMarkupViewResolver’. It looks for resources in a loader path by surrounding the view name with a prefix and suffix (externalized to spring.groovy.template.prefix and spring.groovy.template.suffix, defaults ‘classpath:/templates/’ and ‘.tpl’ respectively). It can be overridden by providing a bean of the same name.
-Check out WebMvcAutoConfiguration, ThymeleafAutoConfiguration, FreeMarkerAutoConfiguration and GroovyTemplateAutoConfiguration
+## 74.9 Use Thymeleaf 3
-74.9 Use Thymeleaf 3
-By default, spring-boot-starter-thymeleaf uses Thymeleaf 2.1. If you are using the spring-boot-starter-parent, you can use Thymeleaf 3 by overriding the thymeleaf.version and thymeleaf-layout-dialect.version properties, for example:
+By default, `spring-boot-starter-thymeleaf` uses Thymeleaf 2.1. If you are using the `spring-boot-starter-parent`, you can use Thymeleaf 3 by overriding the `thymeleaf.version` and `thymeleaf-layout-dialect.version` properties, for example:
+```
3.0.2.RELEASE
2.1.1
-[Note]
-if you are managing dependencies yourself, look at spring-boot-dependencies for the list of artifacts that are related to those two versions.
-To avoid a warning message about the HTML 5 template mode being deprecated and the HTML template mode being used instead, you may also want to explicitly configure spring.thymeleaf.mode to be HTML, for example:
+```
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| if you are managing dependencies yourself, look at `spring-boot-dependencies` for the list of artifacts that are related to those two versions. |
+
+To avoid a warning message about the HTML 5 template mode being deprecated and the HTML template mode being used instead, you may also want to explicitly configure `spring.thymeleaf.mode` to be `HTML`, for example:
+
+```
spring.thymeleaf.mode: HTML
-Please refer to the Thymeleaf 3 sample to see this in action.
+
+```
+
+Please refer to the [Thymeleaf 3 sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-web-thymeleaf3) to see this in action.
If you are using any of the other auto-configured Thymeleaf Extras (Spring Security, Data Attribute, or Java 8 Time) you should also override each of their versions to one that is compatible with Thymeleaf 3.0.
-75. HTTP clients
-75.1 Configure RestTemplate to use a proxy
-As described in Section 33.1, “RestTemplate customization”, a RestTemplateCustomizer can be used with RestTemplateBuilder to build a customized RestTemplate. This is the recommended approach for creating a RestTemplate configured to use a proxy.
+## 75. HTTP clients
-The exact details of the proxy configuration depend on the underlying client request factory that is being used. Here’s an example of configuring HttpComponentsClientRequestFactory with an HttpClient that uses a proxy for all hosts except 192.168.0.5.
+## 75.1 Configure RestTemplate to use a proxy
+As described in [Section 33.1, “RestTemplate customization”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-restclient-customization), a `RestTemplateCustomizer` can be used with `RestTemplateBuilder` to build a customized`RestTemplate`. This is the recommended approach for creating a `RestTemplate` configured to use a proxy.
+
+The exact details of the proxy configuration depend on the underlying client request factory that is being used. Here’s an example of configuring`HttpComponentsClientRequestFactory` with an `HttpClient` that uses a proxy for all hosts except `192.168.0.5`.
+
+```
static class ProxyCustomizer implements RestTemplateCustomizer {
@Override
@@ -8987,46 +10069,66 @@ static class ProxyCustomizer implements RestTemplateCustomizer {
}
}
-76. Logging
-Spring Boot has no mandatory logging dependency, except for the Commons Logging API, of which there are many implementations to choose from. To use Logback you need to include it and jcl-over-slf4j (which implements the Commons Logging API) on the classpath. The simplest way to do that is through the starters which all depend on spring-boot-starter-logging. For a web application you only need spring-boot-starter-web since it depends transitively on the logging starter. For example, using Maven:
+```
+
+## 76. Logging
+
+Spring Boot has no mandatory logging dependency, except for the Commons Logging API, of which there are many implementations to choose from. To use [Logback](http://logback.qos.ch/) you need to include it and `jcl-over-slf4j` (which implements the Commons Logging API) on the classpath. The simplest way to do that is through the starters which all depend on `spring-boot-starter-logging`. For a web application you only need `spring-boot-starter-web` since it depends transitively on the logging starter. For example, using Maven:
+
+```
org.springframework.boot
spring-boot-starter-web
-Spring Boot has a LoggingSystem abstraction that attempts to configure logging based on the content of the classpath. If Logback is available it is the first choice.
-If the only change you need to make to logging is to set the levels of various loggers then you can do that in application.properties using the "logging.level" prefix, e.g.
+```
+
+Spring Boot has a `LoggingSystem` abstraction that attempts to configure logging based on the content of the classpath. If Logback is available it is the first choice.
+If the only change you need to make to logging is to set the levels of various loggers then you can do that in `application.properties` using the "logging.level" prefix, e.g.
+
+```
logging.level.org.springframework.web=DEBUG
logging.level.org.hibernate=ERROR
+
+```
+
You can also set the location of a file to log to (in addition to the console) using "logging.file".
-To configure the more fine-grained settings of a logging system you need to use the native configuration format supported by the LoggingSystem in question. By default Spring Boot picks up the native configuration from its default location for the system (e.g. classpath:logback.xml for Logback), but you can set the location of the config file using the "logging.config" property.
+To configure the more fine-grained settings of a logging system you need to use the native configuration format supported by the `LoggingSystem` in question. By default Spring Boot picks up the native configuration from its default location for the system (e.g. `classpath:logback.xml` for Logback), but you can set the location of the config file using the "logging.config" property.
+
+## 76.1 Configure Logback for logging
-76.1 Configure Logback for logging
-If you put a logback.xml in the root of your classpath it will be picked up from there (or logback-spring.xml to take advantage of the templating features provided by Boot). Spring Boot provides a default base configuration that you can include if you just want to set levels, e.g.
+If you put a `logback.xml` in the root of your classpath it will be picked up from there (or `logback-spring.xml` to take advantage of the templating features provided by Boot). Spring Boot provides a default base configuration that you can include if you just want to set levels, e.g.
+```
-If you look at that base.xml in the spring-boot jar, you will see that it uses some useful System properties which the LoggingSystem takes care of creating for you. These are:
-${PID} the current process ID.
-${LOG_FILE} if logging.file was set in Boot’s external configuration.
-${LOG_PATH} if logging.path was set (representing a directory for log files to live in).
-${LOG_EXCEPTION_CONVERSION_WORD} if logging.exception-conversion-word was set in Boot’s external configuration.
-Spring Boot also provides some nice ANSI colour terminal output on a console (but not in a log file) using a custom Logback converter. See the default base.xml configuration for details.
+```
-If Groovy is on the classpath you should be able to configure Logback with logback.groovy as well (it will be given preference if present).
+If you look at that `base.xml` in the spring-boot jar, you will see that it uses some useful System properties which the `LoggingSystem` takes care of creating for you. These are:
-76.1.1 Configure logback for file only output
-If you want to disable console logging and write output only to a file you need a custom logback-spring.xml that imports file-appender.xml but not console-appender.xml:
+- `${PID}` the current process ID.
+- `${LOG_FILE}` if `logging.file` was set in Boot’s external configuration.
+- `${LOG_PATH}` if `logging.path` was set (representing a directory for log files to live in).
+- `${LOG_EXCEPTION_CONVERSION_WORD}` if `logging.exception-conversion-word` was set in Boot’s external configuration.
-
-
+Spring Boot also provides some nice ANSI colour terminal output on a console (but not in a log file) using a custom Logback converter. See the default `base.xml`configuration for details.
+
+If Groovy is on the classpath you should be able to configure Logback with `logback.groovy` as well (it will be given preference if present).
+
+### 76.1.1 Configure logback for file only output
+
+If you want to disable console logging and write output only to a file you need a custom `logback-spring.xml` that imports `file-appender.xml` but not `console-appender.xml`:
+
+```
+
+
@@ -9034,14 +10136,23 @@ If you want to disable console logging and write output only to a file you need
-You also need to add logging.file to your application.properties:
+```
+
+You also need to add `logging.file` to your `application.properties`:
+
+```
logging.file=myapplication.log
-76.2 Configure Log4j for logging
-Spring Boot supports Log4j 2 for logging configuration if it is on the classpath. If you are using the starters for assembling dependencies that means you have to exclude Logback and then include log4j 2 instead. If you aren’t using the starters then you need to provide jcl-over-slf4j (at least) in addition to Log4j 2.
+
+```
+
+## 76.2 Configure Log4j for logging
+
+Spring Boot supports [Log4j 2](https://logging.apache.org/log4j/2.x) for logging configuration if it is on the classpath. If you are using the starters for assembling dependencies that means you have to exclude Logback and then include log4j 2 instead. If you aren’t using the starters then you need to provide `jcl-over-slf4j` (at least) in addition to Log4j 2.
The simplest path is probably through the starters, even though it requires some jiggling with excludes, .e.g. in Maven:
+```
org.springframework.boot
spring-boot-starter-web
@@ -9060,29 +10171,29 @@ The simplest path is probably through the starters, even though it requires some
org.springframework.boot
spring-boot-starter-log4j2
-[Note]
-The use of the Log4j starters gathers together the dependencies for common logging requirements (e.g. including having Tomcat use java.util.logging but configuring the output using Log4j 2). See the Actuator Log4j 2 samples for more detail and to see it in action.
-76.2.1 Use YAML or JSON to configure Log4j 2
-In addition to its default XML configuration format, Log4j 2 also supports YAML and JSON configuration files. To configure Log4j 2 to use an alternative configuration file format, add the appropriate dependencies to the classpath and name your configuration files to match your chosen file format:
+```
-Format Dependencies File names
-YAML
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The use of the Log4j starters gathers together the dependencies for common logging requirements (e.g. including having Tomcat use `java.util.logging` but configuring the output using Log4j 2). See the Actuator Log4j 2 samples for more detail and to see it in action. |
-com.fasterxml.jackson.core:jackson-databind com.fasterxml.jackson.dataformat:jackson-dataformat-yaml
+### 76.2.1 Use YAML or JSON to configure Log4j 2
-log4j2.yaml log4j2.yml
+In addition to its default XML configuration format, Log4j 2 also supports YAML and JSON configuration files. To configure Log4j 2 to use an alternative configuration file format, add the appropriate dependencies to the classpath and name your configuration files to match your chosen file format:
-JSON
+| Format | Dependencies | File names |
+| ------ | ------------------------------------------------------------ | ------------------------- |
+| YAML | `com.fasterxml.jackson.core:jackson-databind``com.fasterxml.jackson.dataformat:jackson-dataformat-yaml` | `log4j2.yaml``log4j2.yml` |
+| JSON | `com.fasterxml.jackson.core:jackson-databind` | `log4j2.json``log4j2.jsn` |
-com.fasterxml.jackson.core:jackson-databind
+## 77. Data Access
-log4j2.json log4j2.jsn
+## 77.1 Configure a custom DataSource
-77. Data Access
-77.1 Configure a custom DataSource
-To configure your own DataSource define a @Bean of that type in your configuration. Spring Boot will reuse your DataSource anywhere one is required, including database initialization. If you need to externalize some settings, you can easily bind your DataSource to the environment (see Section 24.7.1, “Third-party configuration”).
+To configure your own `DataSource` define a `@Bean` of that type in your configuration. Spring Boot will reuse your `DataSource` anywhere one is required, including database initialization. If you need to externalize some settings, you can easily bind your `DataSource` to the environment (see [Section 24.7.1, “Third-party configuration”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config-3rd-party-configuration)).
+```
@Bean
@ConfigurationProperties(prefix="app.datasource")
public DataSource dataSource() {
@@ -9091,45 +10202,69 @@ public DataSource dataSource() {
app.datasource.url=jdbc:h2:mem:mydb
app.datasource.username=sa
app.datasource.pool-size=30
-Assuming that your FancyDataSource has regular JavaBean properties for the url, the username and the pool size, these settings will be bound automatically before the DataSource is made available to other components. The regular database initialization will also happen (so the relevant sub-set of spring.datasource.* can still be used with your custom configuration).
-You can apply the same principle if you are configuring a custom JNDI DataSource:
+```
+
+Assuming that your `FancyDataSource` has regular JavaBean properties for the url, the username and the pool size, these settings will be bound automatically before the `DataSource` is made available to other components. The regular [database initialization](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-initialize-a-database-using-spring-jdbc) will also happen (so the relevant sub-set of `spring.datasource.*` can still be used with your custom configuration).
+You can apply the same principle if you are configuring a custom JNDI `DataSource`:
+
+```
@Bean(destroyMethod="")
@ConfigurationProperties(prefix="app.datasource")
public DataSource dataSource() throws Exception {
JndiDataSourceLookup dataSourceLookup = new JndiDataSourceLookup();
return dataSourceLookup.getDataSource("java:comp/env/jdbc/YourDS");
}
-Spring Boot also provides a utility builder class DataSourceBuilder that can be used to create one of the standard data sources (if it is on the classpath). The builder can detect the one to use based on what’s available on the classpath. It also auto detects the driver based on the JDBC url.
+```
+
+Spring Boot also provides a utility builder class `DataSourceBuilder` that can be used to create one of the standard data sources (if it is on the classpath). The builder can detect the one to use based on what’s available on the classpath. It also auto detects the driver based on the JDBC url.
+
+```
@Bean
@ConfigurationProperties("app.datasource")
public DataSource dataSource() {
return DataSourceBuilder.create().build();
}
-To run an app with that DataSource, all that is needed really is the connection information; pool-specific settings can also be provided, check the implementation that is going to be used at runtime for more details.
+```
+
+To run an app with that `DataSource`, all that is needed really is the connection information; pool-specific settings can also be provided, check the implementation that is going to be used at runtime for more details.
+
+```
app.datasource.url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.pool-size=30
-There is a catch however. Because the actual type of the connection pool is not exposed, no keys are generated in the metadata for your custom DataSource and no completion is available in your IDE (The DataSource interface doesn’t expose any property). Also, if you happen to only have Hikari on the classpath, this basic setup will not work because Hikari has no url parameter (but a jdbcUrl parameter). You will have to rewrite your configuration as follows:
+```
+
+There is a catch however. Because the actual type of the connection pool is not exposed, no keys are generated in the metadata for your custom `DataSource` and no completion is available in your IDE (The `DataSource` interface doesn’t expose any property). Also, if you happen to *only* have Hikari on the classpath, this basic setup will not work because Hikari has no `url` parameter (but a `jdbcUrl` parameter). You will have to rewrite your configuration as follows:
+
+```
app.datasource.jdbc-url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.maximum-pool-size=30
-You can fix that by forcing the connection pool to use and return a dedicated implementation rather than DataSource. You won’t be able to change the implementation at runtime but the list of options will be explicit.
+```
+
+You can fix that by forcing the connection pool to use and return a dedicated implementation rather than `DataSource`. You won’t be able to change the implementation at runtime but the list of options will be explicit.
+
+```
@Bean
@ConfigurationProperties("app.datasource")
public HikariDataSource dataSource() {
return (HikariDataSource) DataSourceBuilder.create()
.type(HikariDataSource.class).build();
}
-You can even go further by leveraging what DataSourceProperties does for you, that is providing a default embedded database if no url is provided with a sensible username and password for it. You can easily initialize a DataSourceBuilder from the state of any DataSourceProperties so you could just as well inject the one Spring Boot creates automatically. However, that would split your configuration in two namespaces: url, username, password, type and driver on spring.datasource and the rest on your custom namespace (app.datasource). To avoid that, you can redefine a custom DataSourceProperties on your custom namespace:
+```
+
+You can even go further by leveraging what `DataSourceProperties` does for you, that is providing a default embedded database if no url is provided with a sensible username and password for it. You can easily initialize a `DataSourceBuilder` from the state of any `DataSourceProperties` so you could just as well inject the one Spring Boot creates automatically. However, that would split your configuration in two namespaces: url, username, password, type and driver on `spring.datasource` and the rest on your custom namespace (`app.datasource`). To avoid that, you can redefine a custom `DataSourceProperties` on your custom namespace:
+
+```
@Bean
@Primary
@ConfigurationProperties("app.datasource")
@@ -9143,22 +10278,32 @@ public HikariDataSource dataSource(DataSourceProperties properties) {
return (HikariDataSource) properties.initializeDataSourceBuilder()
.type(HikariDataSource.class).build();
}
-This setup puts you in pair with what Spring Boot does for you by default, except that a dedicated connection pool is chosen (in code) and its settings are exposed in the same namespace. Because DataSourceProperties is taking care of the url/jdbcUrl translation for you, you can configure it like this:
+```
+
+This setup puts you *in pair* with what Spring Boot does for you by default, except that a dedicated connection pool is chosen (in code) and its settings are exposed in the same namespace. Because `DataSourceProperties` is taking care of the `url`/`jdbcUrl` translation for you, you can configure it like this:
+
+```
app.datasource.url=jdbc:mysql://localhost/test
app.datasource.username=dbuser
app.datasource.password=dbpass
app.datasource.maximum-pool-size=30
-[Note]
-Because your custom configuration chooses to go with Hikari, app.datasource.type will have no effect. In practice the builder will be initialized with whatever value you might set there and then overridden by the call to .type().
-See Section 29.1, “Configure a DataSource” in the ‘Spring Boot features’ section and the DataSourceAutoConfiguration class for more details.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Because your custom configuration chooses to go with Hikari, `app.datasource.type` will have no effect. In practice the builder will be initialized with whatever value you might set there and then overridden by the call to `.type()`. |
-77.2 Configure Two DataSources
-If you need to configure multiple data sources, you can apply the same tricks that are described in the previous section. You must, however, mark one of the DataSource @Primary as various auto-configurations down the road expect to be able to get one by type.
+See *Section 29.1, “Configure a DataSource”* in the ‘Spring Boot features’ section and the [`DataSourceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java) class for more details.
-If you create your own DataSource, the auto-configuration will back off. In the example below, we provide the exact same features set than what the auto-configuration provides on the primary data source:
+## 77.2 Configure Two DataSources
+If you need to configure multiple data sources, you can apply the same tricks that are described in the previous section. You must, however, mark one of the `DataSource` `@Primary` as various auto-configurations down the road expect to be able to get one by type.
+
+If you create your own `DataSource`, the auto-configuration will back off. In the example below, we provide the *exact* same features set than what the auto-configuration provides on the primary data source:
+
+```
@Bean
@Primary
@ConfigurationProperties("app.datasource.foo")
@@ -9179,11 +10324,16 @@ public BasicDataSource barDataSource() {
return (BasicDataSource) DataSourceBuilder.create()
.type(BasicDataSource.class).build();
}
-[Tip]
-fooDataSourceProperties has to be flagged @Primary so that the database initializer feature uses your copy (should you use that).
+
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| `fooDataSourceProperties` has to be flagged `@Primary` so that the database initializer feature uses your copy (should you use that). |
Both data sources are also bound for advanced customizations. For instance you could configure them as follows:
+```
app.datasource.foo.type=com.zaxxer.hikari.HikariDataSource
app.datasource.foo.maximum-pool-size=30
@@ -9191,8 +10341,12 @@ app.datasource.bar.url=jdbc:mysql://localhost/test
app.datasource.bar.username=dbuser
app.datasource.bar.password=dbpass
app.datasource.bar.max-total=30
-Of course, you can apply the same concept to the secondary DataSource as well:
+```
+
+Of course, you can apply the same concept to the secondary `DataSource` as well:
+
+```
@Bean
@Primary
@ConfigurationProperties("app.datasource.foo")
@@ -9218,18 +10372,24 @@ public DataSourceProperties barDataSourceProperties() {
public DataSource barDataSource() {
return barDataSourceProperties().initializeDataSourceBuilder().build();
}
+
+```
+
This final example configures two data sources on custom namespaces with the same logic than what Spring Boot would do in auto-configuration.
-77.3 Use Spring Data repositories
-Spring Data can create implementations for you of @Repository interfaces of various flavors. Spring Boot will handle all of that for you as long as those @Repositories are included in the same package (or a sub-package) of your @EnableAutoConfiguration class.
+## 77.3 Use Spring Data repositories
-For many applications all you will need is to put the right Spring Data dependencies on your classpath (there is a spring-boot-starter-data-jpa for JPA and a spring-boot-starter-data-mongodb for Mongodb), create some repository interfaces to handle your @Entity objects. Examples are in the JPA sample or the Mongodb sample.
+Spring Data can create implementations for you of `@Repository` interfaces of various flavors. Spring Boot will handle all of that for you as long as those `@Repositories` are included in the same package (or a sub-package) of your `@EnableAutoConfiguration` class.
-Spring Boot tries to guess the location of your @Repository definitions, based on the @EnableAutoConfiguration it finds. To get more control, use the @EnableJpaRepositories annotation (from Spring Data JPA).
+For many applications all you will need is to put the right Spring Data dependencies on your classpath (there is a `spring-boot-starter-data-jpa` for JPA and a`spring-boot-starter-data-mongodb` for Mongodb), create some repository interfaces to handle your `@Entity` objects. Examples are in the [JPA sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-data-jpa) or the [Mongodb sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-data-mongodb).
-77.4 Separate @Entity definitions from Spring configuration
-Spring Boot tries to guess the location of your @Entity definitions, based on the @EnableAutoConfiguration it finds. To get more control, you can use the @EntityScan annotation, e.g.
+Spring Boot tries to guess the location of your `@Repository` definitions, based on the `@EnableAutoConfiguration` it finds. To get more control, use the `@EnableJpaRepositories` annotation (from Spring Data JPA).
+## 77.4 Separate @Entity definitions from Spring configuration
+
+Spring Boot tries to guess the location of your `@Entity` definitions, based on the `@EnableAutoConfiguration` it finds. To get more control, you can use the `@EntityScan` annotation, e.g.
+
+```
@Configuration
@EnableAutoConfiguration
@EntityScan(basePackageClasses=City.class)
@@ -9238,40 +10398,57 @@ public class Application {
//...
}
-77.5 Configure JPA properties
+
+```
+
+## 77.5 Configure JPA properties
+
Spring Data JPA already provides some vendor-independent configuration options (e.g. for SQL logging) and Spring Boot exposes those, and a few more for hibernate as external configuration properties. Some of them are automatically detected according to the context so you shouldn’t have to set them.
-The spring.jpa.hibernate.ddl-auto is a special case in that it has different defaults depending on whether you are using an embedded database (create-drop) or not (none). The dialect to use is also automatically detected based on the current DataSource but you can set spring.jpa.database yourself if you want to be explicit and bypass that check on startup.
+The `spring.jpa.hibernate.ddl-auto` is a special case in that it has different defaults depending on whether you are using an embedded database (`create-drop`) or not (`none`). The dialect to use is also automatically detected based on the current `DataSource` but you can set `spring.jpa.database`yourself if you want to be explicit and bypass that check on startup.
-[Note]
-Specifying a database leads to the configuration of a well-defined Hibernate dialect. Several databases have more than one Dialect and this may not suit your need. In that case, you can either set spring.jpa.database to default to let Hibernate figure things out or set the dialect using the spring.jpa.database-platform property.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Specifying a `database` leads to the configuration of a well-defined Hibernate dialect. Several databases have more than one `Dialect` and this may not suit your need. In that case, you can either set `spring.jpa.database` to `default` to let Hibernate figure things out or set the dialect using the `spring.jpa.database-platform` property. |
The most common options to set are:
+```
spring.jpa.hibernate.naming.physical-strategy=com.example.MyPhysicalNamingStrategy
spring.jpa.show-sql=true
-In addition all properties in spring.jpa.properties.* are passed through as normal JPA properties (with the prefix stripped) when the local EntityManagerFactory is created.
-77.6 Configure Hibernate Naming Strategy
-Spring Boot provides a consistent naming strategy regardless of the Hibernate generation that you are using. If you are using Hibernate 4, you can customize it using spring.jpa.hibernate.naming.strategy; Hibernate 5 defines a Physical and Implicit naming strategies.
+```
+
+In addition all properties in `spring.jpa.properties.*` are passed through as normal JPA properties (with the prefix stripped) when the local `EntityManagerFactory` is created.
+
+## 77.6 Configure Hibernate Naming Strategy
+
+Spring Boot provides a consistent naming strategy regardless of the Hibernate generation that you are using. If you are using Hibernate 4, you can customize it using`spring.jpa.hibernate.naming.strategy`; Hibernate 5 defines a `Physical` and `Implicit` naming strategies.
-Spring Boot configures SpringPhysicalNamingStrategy by default. This implementation provides the same table structure as Hibernate 4: all dots are replaced by underscores and camel cases are replaced by underscores as well. By default, all table names are generated in lower case but it is possible to override that flag if your schema requires it.
+Spring Boot configures `SpringPhysicalNamingStrategy` by default. This implementation provides the same table structure as Hibernate 4: all dots are replaced by underscores and camel cases are replaced by underscores as well. By default, all table names are generated in lower case but it is possible to override that flag if your schema requires it.
-Concretely, a TelephoneNumber entity will be mapped to the telephone_number table.
+Concretely, a `TelephoneNumber` entity will be mapped to the `telephone_number` table.
If you’d rather use Hibernate 5’s default instead, set the following property:
+```
spring.jpa.hibernate.naming.physical-strategy=org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
-See HibernateJpaAutoConfiguration and JpaBaseConfiguration for more details.
-77.7 Use a custom EntityManagerFactory
-To take full control of the configuration of the EntityManagerFactory, you need to add a @Bean named ‘entityManagerFactory’. Spring Boot auto-configuration switches off its entity manager based on the presence of a bean of that type.
+```
+
+See [`HibernateJpaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaAutoConfiguration.java) and [`JpaBaseConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java) for more details.
+
+## 77.7 Use a custom EntityManagerFactory
+
+To take full control of the configuration of the `EntityManagerFactory`, you need to add a `@Bean` named ‘entityManagerFactory’. Spring Boot auto-configuration switches off its entity manager based on the presence of a bean of that type.
+
+## 77.8 Use Two EntityManagers
-77.8 Use Two EntityManagers
-Even if the default EntityManagerFactory works fine, you will need to define a new one because otherwise the presence of the second bean of that type will switch off the default. To make it easy to do that you can use the convenient EntityManagerBuilder provided by Spring Boot, or if you prefer you can just use the LocalContainerEntityManagerFactoryBean directly from Spring ORM.
+Even if the default `EntityManagerFactory` works fine, you will need to define a new one because otherwise the presence of the second bean of that type will switch off the default. To make it easy to do that you can use the convenient `EntityManagerBuilder` provided by Spring Boot, or if you prefer you can just use the`LocalContainerEntityManagerFactoryBean` directly from Spring ORM.
Example:
+```
// add two data sources configured as above
@Bean
@@ -9293,10 +10470,14 @@ public LocalContainerEntityManagerFactoryBean orderEntityManagerFactory(
.persistenceUnit("orders")
.build();
}
-The configuration above almost works on its own. To complete the picture you need to configure TransactionManagers for the two EntityManagers as well. One of them could be picked up by the default JpaTransactionManager in Spring Boot if you mark it as @Primary. The other would have to be explicitly injected into a new instance. Or you might be able to use a JTA transaction manager spanning both.
-If you are using Spring Data, you need to configure @EnableJpaRepositories accordingly:
+```
+The configuration above almost works on its own. To complete the picture you need to configure `TransactionManagers` for the two `EntityManagers` as well. One of them could be picked up by the default `JpaTransactionManager` in Spring Boot if you mark it as `@Primary`. The other would have to be explicitly injected into a new instance. Or you might be able to use a JTA transaction manager spanning both.
+
+If you are using Spring Data, you need to configure `@EnableJpaRepositories` accordingly:
+
+```
@Configuration
@EnableJpaRepositories(basePackageClasses = Customer.class,
entityManagerFactoryRef = "customerEntityManagerFactory")
@@ -9310,31 +10491,40 @@ public class CustomerConfiguration {
public class OrderConfiguration {
...
}
-77.9 Use a traditional persistence.xml
-Spring doesn’t require the use of XML to configure the JPA provider, and Spring Boot assumes you want to take advantage of that feature. If you prefer to use persistence.xml then you need to define your own @Bean of type LocalEntityManagerFactoryBean (with id ‘entityManagerFactory’, and set the persistence unit name there.
-See JpaBaseConfiguration for the default settings.
+```
+
+## 77.9 Use a traditional persistence.xml
+
+Spring doesn’t require the use of XML to configure the JPA provider, and Spring Boot assumes you want to take advantage of that feature. If you prefer to use `persistence.xml` then you need to define your own `@Bean` of type `LocalEntityManagerFactoryBean` (with id ‘entityManagerFactory’, and set the persistence unit name there.
-77.10 Use Spring Data JPA and Mongo repositories
-Spring Data JPA and Spring Data Mongo can both create Repository implementations for you automatically. If they are both present on the classpath, you might have to do some extra configuration to tell Spring Boot which one (or both) you want to create repositories for you. The most explicit way to do that is to use the standard Spring Data @Enable*Repositories and tell it the location of your Repository interfaces (where ‘*’ is ‘Jpa’ or ‘Mongo’ or both).
+See [`JpaBaseConfiguration`](https://github.com/spring-projects/spring-boot/blob/master/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/JpaBaseConfiguration.java) for the default settings.
-There are also flags spring.data.*.repositories.enabled that you can use to switch the auto-configured repositories on and off in external configuration. This is useful for instance in case you want to switch off the Mongo repositories and still use the auto-configured MongoTemplate.
+## 77.10 Use Spring Data JPA and Mongo repositories
+
+Spring Data JPA and Spring Data Mongo can both create `Repository` implementations for you automatically. If they are both present on the classpath, you might have to do some extra configuration to tell Spring Boot which one (or both) you want to create repositories for you. The most explicit way to do that is to use the standard Spring Data `@Enable*Repositories` and tell it the location of your `Repository` interfaces (where ‘*’ is ‘Jpa’ or ‘Mongo’ or both).
+
+There are also flags `spring.data.*.repositories.enabled` that you can use to switch the auto-configured repositories on and off in external configuration. This is useful for instance in case you want to switch off the Mongo repositories and still use the auto-configured `MongoTemplate`.
The same obstacle and the same features exist for other auto-configured Spring Data repository types (Elasticsearch, Solr). Just change the names of the annotations and flags respectively.
-77.11 Expose Spring Data repositories as REST endpoint
-Spring Data REST can expose the Repository implementations as REST endpoints for you as long as Spring MVC has been enabled for the application.
+## 77.11 Expose Spring Data repositories as REST endpoint
+
+Spring Data REST can expose the `Repository` implementations as REST endpoints for you as long as Spring MVC has been enabled for the application.
+
+Spring Boot exposes as set of useful properties from the `spring.data.rest` namespace that customize the [`RepositoryRestConfiguration`](https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest/core/config/RepositoryRestConfiguration.html). If you need to provide additional customization, you should use a [`RepositoryRestConfigurer`](https://docs.spring.io/spring-data/rest/docs/current/api/org/springframework/data/rest/webmvc/config/RepositoryRestConfigurer.html) bean.
-Spring Boot exposes as set of useful properties from the spring.data.rest namespace that customize the RepositoryRestConfiguration. If you need to provide additional customization, you should use a RepositoryRestConfigurer bean.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you don’t specify any order on your custom `RepositoryRestConfigurer` it will run after the one Spring Boot uses internally. If you need to specify an order, make sure it is higher than 0. |
-[Note]
-If you don’t specify any order on your custom RepositoryRestConfigurer it will run after the one Spring Boot uses internally. If you need to specify an order, make sure it is higher than 0.
+## 77.12 Configure a component that is used by JPA
-77.12 Configure a component that is used by JPA
If you want to configure a component that will be used by JPA then you need to ensure that the component is initialized before JPA. Where the component is auto-configured Spring Boot will take care of this for you. For example, when Flyway is auto-configured, Hibernate is configured to depend upon Flyway so that the latter has a chance to initialize the database before Hibernate tries to use it.
-If you are configuring a component yourself, you can use an EntityManagerFactoryDependsOnPostProcessor subclass as a convenient way of setting up the necessary dependencies. For example, if you are using Hibernate Search with Elasticsearch as its index manager then any EntityManagerFactory beans must be configured to depend on the elasticsearchClient bean:
+If you are configuring a component yourself, you can use an `EntityManagerFactoryDependsOnPostProcessor` subclass as a convenient way of setting up the necessary dependencies. For example, if you are using Hibernate Search with Elasticsearch as its index manager then any `EntityManagerFactory` beans must be configured to depend on the `elasticsearchClient` bean:
+```
/**
* {@link EntityManagerFactoryDependsOnPostProcessor} that ensures that
* {@link EntityManagerFactory} beans depend on the {@code elasticsearchClient} bean.
@@ -9348,69 +10538,90 @@ static class ElasticsearchJpaDependencyConfiguration
}
}
-78. Database initialization
+
+```
+
+## 78. Database initialization
+
An SQL database can be initialized in different ways depending on what your stack is. Or of course you can do it manually as long as the database is a separate process.
-78.1 Initialize a database using JPA
+## 78.1 Initialize a database using JPA
+
JPA has features for DDL generation, and these can be set up to run on startup against the database. This is controlled through two external properties:
-spring.jpa.generate-ddl (boolean) switches the feature on and off and is vendor independent.
-spring.jpa.hibernate.ddl-auto (enum) is a Hibernate feature that controls the behavior in a more fine-grained way. See below for more detail.
-78.2 Initialize a database using Hibernate
-You can set spring.jpa.hibernate.ddl-auto explicitly and the standard Hibernate property values are none, validate, update, create, create-drop. Spring Boot chooses a default value for you based on whether it thinks your database is embedded (default create-drop) or not (default none). An embedded database is detected by looking at the Connection type: hsqldb, h2 and derby are embedded, the rest are not. Be careful when switching from in-memory to a ‘real’ database that you don’t make assumptions about the existence of the tables and data in the new platform. You either have to set ddl-auto explicitly, or use one of the other mechanisms to initialize the database.
+- `spring.jpa.generate-ddl` (boolean) switches the feature on and off and is vendor independent.
+- `spring.jpa.hibernate.ddl-auto` (enum) is a Hibernate feature that controls the behavior in a more fine-grained way. See below for more detail.
+
+## 78.2 Initialize a database using Hibernate
+
+You can set `spring.jpa.hibernate.ddl-auto` explicitly and the standard Hibernate property values are `none`, `validate`, `update`, `create`, `create-drop`. Spring Boot chooses a default value for you based on whether it thinks your database is embedded (default `create-drop`) or not (default `none`). An embedded database is detected by looking at the `Connection` type: `hsqldb`, `h2` and `derby` are embedded, the rest are not. Be careful when switching from in-memory to a ‘real’ database that you don’t make assumptions about the existence of the tables and data in the new platform. You either have to set `ddl-auto` explicitly, or use one of the other mechanisms to initialize the database.
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You can output the schema creation by enabling the `org.hibernate.SQL` logger. This is done for you automatically if you enable the [debug mode](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-logging-console-output). |
+
+In addition, a file named `import.sql` in the root of the classpath will be executed on startup if Hibernate creates the schema from scratch (that is if the `ddl-auto`property is set to `create` or `create-drop`). This can be useful for demos and for testing if you are careful, but probably not something you want to be on the classpath in production. It is a Hibernate feature (nothing to do with Spring).
-[Note]
-You can output the schema creation by enabling the org.hibernate.SQL logger. This is done for you automatically if you enable the debug mode.
+## 78.3 Initialize a database using Spring JDBC
-In addition, a file named import.sql in the root of the classpath will be executed on startup if Hibernate creates the schema from scratch (that is if the ddl-auto property is set to create or create-drop). This can be useful for demos and for testing if you are careful, but probably not something you want to be on the classpath in production. It is a Hibernate feature (nothing to do with Spring).
+Spring JDBC has a `DataSource` initializer feature. Spring Boot enables it by default and loads SQL from the standard locations `schema.sql` and `data.sql` (in the root of the classpath). In addition Spring Boot will load the `schema-${platform}.sql` and `data-${platform}.sql` files (if present), where `platform` is the value of `spring.datasource.platform`, e.g. you might choose to set it to the vendor name of the database (`hsqldb`, `h2`, `oracle`, `mysql`, `postgresql`etc.). Spring Boot enables the fail-fast feature of the Spring JDBC initializer by default, so if the scripts cause exceptions the application will fail to start. The script locations can be changed by setting `spring.datasource.schema` and `spring.datasource.data`, and neither location will be processed if`spring.datasource.initialize=false`.
-78.3 Initialize a database using Spring JDBC
-Spring JDBC has a DataSource initializer feature. Spring Boot enables it by default and loads SQL from the standard locations schema.sql and data.sql (in the root of the classpath). In addition Spring Boot will load the schema-${platform}.sql and data-${platform}.sql files (if present), where platform is the value of spring.datasource.platform, e.g. you might choose to set it to the vendor name of the database (hsqldb, h2, oracle, mysql, postgresql etc.). Spring Boot enables the fail-fast feature of the Spring JDBC initializer by default, so if the scripts cause exceptions the application will fail to start. The script locations can be changed by setting spring.datasource.schema and spring.datasource.data, and neither location will be processed if spring.datasource.initialize=false.
+To disable the fail-fast you can set `spring.datasource.continue-on-error=true`. This can be useful once an application has matured and been deployed a few times, since the scripts can act as ‘poor man’s migrations’ — inserts that fail mean that the data is already there, so there would be no need to prevent the application from running, for instance.
-To disable the fail-fast you can set spring.datasource.continue-on-error=true. This can be useful once an application has matured and been deployed a few times, since the scripts can act as ‘poor man’s migrations’ — inserts that fail mean that the data is already there, so there would be no need to prevent the application from running, for instance.
+If you want to use the `schema.sql` initialization in a JPA app (with Hibernate) then `ddl-auto=create-drop` will lead to errors if Hibernate tries to create the same tables. To avoid those errors set `ddl-auto` explicitly to "" (preferable) or "none". Whether or not you use `ddl-auto=create-drop` you can always use `data.sql`to initialize new data.
-If you want to use the schema.sql initialization in a JPA app (with Hibernate) then ddl-auto=create-drop will lead to errors if Hibernate tries to create the same tables. To avoid those errors set ddl-auto explicitly to "" (preferable) or "none". Whether or not you use ddl-auto=create-drop you can always use data.sql to initialize new data.
+## 78.4 Initialize a Spring Batch database
-78.4 Initialize a Spring Batch database
-If you are using Spring Batch then it comes pre-packaged with SQL initialization scripts for most popular database platforms. Spring Boot will detect your database type, and execute those scripts by default, and in this case will switch the fail fast setting to false (errors are logged but do not prevent the application from starting). This is because the scripts are known to be reliable and generally do not contain bugs, so errors are ignorable, and ignoring them makes the scripts idempotent. You can switch off the initialization explicitly using spring.batch.initializer.enabled=false.
+If you are using Spring Batch then it comes pre-packaged with SQL initialization scripts for most popular database platforms. Spring Boot will detect your database type, and execute those scripts by default, and in this case will switch the fail fast setting to false (errors are logged but do not prevent the application from starting). This is because the scripts are known to be reliable and generally do not contain bugs, so errors are ignorable, and ignoring them makes the scripts idempotent. You can switch off the initialization explicitly using `spring.batch.initializer.enabled=false`.
-78.5 Use a higher-level database migration tool
-Spring Boot supports two higher-level migration tools: Flyway and Liquibase.
+## 78.5 Use a higher-level database migration tool
-78.5.1 Execute Flyway database migrations on startup
-To automatically run Flyway database migrations on startup, add the org.flywaydb:flyway-core to your classpath.
+Spring Boot supports two higher-level migration tools: [Flyway](http://flywaydb.org/) and [Liquibase](http://www.liquibase.org/).
-The migrations are scripts in the form V__.sql (with an underscore-separated version, e.g. ‘1’ or ‘2_1’). By default they live in a folder classpath:db/migration but you can modify that using flyway.locations. You can also add a special {vendor} placeholder to use vendor-specific scripts. Assume the following:
+### 78.5.1 Execute Flyway database migrations on startup
+To automatically run Flyway database migrations on startup, add the `org.flywaydb:flyway-core` to your classpath.
+
+The migrations are scripts in the form `V__.sql` (with `` an underscore-separated version, e.g. ‘1’ or ‘2_1’). By default they live in a folder`classpath:db/migration` but you can modify that using `flyway.locations`. You can also add a special `{vendor}` placeholder to use vendor-specific scripts. Assume the following:
+
+```
flyway.locations=db/migration/{vendor}
-Rather than using db/migration, this configuration will set the folder to use according to the type of the database (i.e. db/migration/mysql for MySQL). The list of supported database are available in DatabaseDriver.
-See also the Flyway class from flyway-core for details of available settings like schemas etc. In addition Spring Boot provides a small set of properties in FlywayProperties that can be used to disable the migrations, or switch off the location checking. Spring Boot will call Flyway.migrate() to perform the database migration. If you would like more control, provide a @Bean that implements FlywayMigrationStrategy.
+```
+
+Rather than using `db/migration`, this configuration will set the folder to use according to the type of the database (i.e. `db/migration/mysql` for MySQL). The list of supported database are available in [`DatabaseDriver`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot/src/main/java/org/springframework/boot/jdbc/DatabaseDriver.java).
+
+See also the Flyway class from flyway-core for details of available settings like schemas etc. In addition Spring Boot provides a small set of properties in[`FlywayProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayProperties.java) that can be used to disable the migrations, or switch off the location checking. Spring Boot will call `Flyway.migrate()` to perform the database migration. If you would like more control, provide a `@Bean` that implements [`FlywayMigrationStrategy`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayMigrationStrategy.java).
-[Tip]
-If you want to make use of Flyway callbacks, those scripts should also live in the classpath:db/migration folder.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| If you want to make use of [Flyway callbacks](http://flywaydb.org/documentation/callbacks.html), those scripts should also live in the `classpath:db/migration` folder. |
-By default Flyway will autowire the (@Primary) DataSource in your context and use that for migrations. If you like to use a different DataSource you can create one and mark its @Bean as @FlywayDataSource - if you do that remember to create another one and mark it as @Primary if you want two data sources. Or you can use Flyway’s native DataSource by setting flyway.[url,user,password] in external properties.
+By default Flyway will autowire the (`@Primary`) `DataSource` in your context and use that for migrations. If you like to use a different `DataSource` you can create one and mark its `@Bean` as `@FlywayDataSource` - if you do that remember to create another one and mark it as `@Primary` if you want two data sources. Or you can use Flyway’s native `DataSource` by setting `flyway.[url,user,password]` in external properties.
-There is a Flyway sample so you can see how to set things up.
+There is a [Flyway sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-flyway) so you can see how to set things up.
-You can also use Flyway to provide data for specific scenarios. For example, you can place test-specific migrations in src/test/resources and they will only be run when your application starts for testing. If you want to be more sophisticated you can use profile-specific configuration to customize flyway.locations so that certain migrations will only run when a particular profile is active. For example, in application-dev.properties you could set flyway.locations to classpath:/db/migration, classpath:/dev/db/migration and migrations in dev/db/migration will only run when the dev profile is active.
+You can also use Flyway to provide data for specific scenarios. For example, you can place test-specific migrations in `src/test/resources` and they will only be run when your application starts for testing. If you want to be more sophisticated you can use profile-specific configuration to customize `flyway.locations` so that certain migrations will only run when a particular profile is active. For example, in `application-dev.properties` you could set `flyway.locations` to`classpath:/db/migration, classpath:/dev/db/migration` and migrations in `dev/db/migration` will only run when the `dev` profile is active.
-78.5.2 Execute Liquibase database migrations on startup
-To automatically run Liquibase database migrations on startup, add the org.liquibase:liquibase-core to your classpath.
+### 78.5.2 Execute Liquibase database migrations on startup
-The master change log is by default read from db/changelog/db.changelog-master.yaml but can be set using liquibase.change-log. In addition to YAML, Liquibase also supports JSON, XML, and SQL change log formats.
+To automatically run Liquibase database migrations on startup, add the `org.liquibase:liquibase-core` to your classpath.
-By default Liquibase will autowire the (@Primary) DataSource in your context and use that for migrations. If you like to use a different DataSource you can create one and mark its @Bean as @LiquibaseDataSource - if you do that remember to create another one and mark it as @Primary if you want two data sources. Or you can use Liquibase’s native DataSource by setting liquibase.[url,user,password] in external properties.
+The master change log is by default read from `db/changelog/db.changelog-master.yaml` but can be set using `liquibase.change-log`. In addition to YAML, Liquibase also supports JSON, XML, and SQL change log formats.
-See LiquibaseProperties for details of available settings like contexts, default schema etc.
+By default Liquibase will autowire the (`@Primary`) `DataSource` in your context and use that for migrations. If you like to use a different `DataSource` you can create one and mark its `@Bean` as `@LiquibaseDataSource` - if you do that remember to create another one and mark it as `@Primary` if you want two data sources. Or you can use Liquibase’s native `DataSource` by setting `liquibase.[url,user,password]` in external properties.
-There is a Liquibase sample so you can see how to set things up.
+See [`LiquibaseProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseProperties.java) for details of available settings like contexts, default schema etc.
-79. Messaging
-79.1 Disable transacted JMS session
-If your JMS broker does not support transacted session, you will have to disable the support of transactions altogether. If you create your own JmsListenerContainerFactory there is nothing to do since it won’t be transacted by default. If you want to use the DefaultJmsListenerContainerFactoryConfigurer to reuse Spring Boot’s default, you can disable transacted session as follows:
+There is a [Liquibase sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-liquibase) so you can see how to set things up.
+## 79. Messaging
+
+## 79.1 Disable transacted JMS session
+
+If your JMS broker does not support transacted session, you will have to disable the support of transactions altogether. If you create your own `JmsListenerContainerFactory` there is nothing to do since it won’t be transacted by default. If you want to use the `DefaultJmsListenerContainerFactoryConfigurer` to reuse Spring Boot’s default, you can disable transacted session as follows:
+
+```
@Bean
public DefaultJmsListenerContainerFactory jmsListenerContainerFactory(
ConnectionFactory connectionFactory,
@@ -9422,49 +10633,64 @@ public DefaultJmsListenerContainerFactory jmsListenerContainerFactory(
listenerFactory.setSessionTransacted(false);
return listenerFactory;
}
+
+```
+
This overrides the default factory and this should be applied to any other factory that your application defines, if any.
-80. Batch applications
-[Note]
-By default, batch applications require a DataSource to store job details. If you want to deviate from that, you’ll need to implement BatchConfigurer, see The Javadoc of @EnableBatchProcessing for more details.
+## 80. Batch applications
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| By default, batch applications require a `DataSource` to store job details. If you want to deviate from that, you’ll need to implement `BatchConfigurer`, see [The Javadoc of `@EnableBatchProcessing`](https://docs.spring.io/spring-batch/apidocs/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.html) for more details. |
+
+## 80.1 Execute Spring Batch jobs on startup
+
+Spring Batch auto-configuration is enabled by adding `@EnableBatchProcessing` (from Spring Batch) somewhere in your context.
-80.1 Execute Spring Batch jobs on startup
-Spring Batch auto-configuration is enabled by adding @EnableBatchProcessing (from Spring Batch) somewhere in your context.
+By default it executes **all** `Jobs` in the application context on startup (see [JobLauncherCommandLineRunner](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/JobLauncherCommandLineRunner.java) for details). You can narrow down to a specific job or jobs by specifying `spring.batch.job.names` (comma-separated job name patterns).
-By default it executes all Jobs in the application context on startup (see JobLauncherCommandLineRunner for details). You can narrow down to a specific job or jobs by specifying spring.batch.job.names (comma-separated job name patterns).
+If the application context includes a `JobRegistry` then the jobs in `spring.batch.job.names` are looked up in the registry instead of being autowired from the context. This is a common pattern with more complex systems where multiple jobs are defined in child contexts and registered centrally.
-If the application context includes a JobRegistry then the jobs in spring.batch.job.names are looked up in the registry instead of being autowired from the context. This is a common pattern with more complex systems where multiple jobs are defined in child contexts and registered centrally.
+See [BatchAutoConfiguration](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.java) and [@EnableBatchProcessing](https://github.com/spring-projects/spring-batch/blob/master/spring-batch-core/src/main/java/org/springframework/batch/core/configuration/annotation/EnableBatchProcessing.java) for more details.
-See BatchAutoConfiguration and @EnableBatchProcessing for more details.
+## 81. Actuator
-81. Actuator
-81.1 Change the HTTP port or address of the actuator endpoints
-In a standalone application the Actuator HTTP port defaults to the same as the main HTTP port. To make the application listen on a different port set the external property management.port. To listen on a completely different network address (e.g. if you have an internal network for management and an external one for user applications) you can also set management.address to a valid IP address that the server is able to bind to.
+## 81.1 Change the HTTP port or address of the actuator endpoints
-For more detail look at the ManagementServerProperties source code and Section 48.3, “Customizing the management server port” in the ‘Production-ready features’ section.
+In a standalone application the Actuator HTTP port defaults to the same as the main HTTP port. To make the application listen on a different port set the external property`management.port`. To listen on a completely different network address (e.g. if you have an internal network for management and an external one for user applications) you can also set `management.address` to a valid IP address that the server is able to bind to.
+
+For more detail look at the [`ManagementServerProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerProperties.java) source code and *Section 48.3, “Customizing the management server port”* in the ‘Production-ready features’ section.
+
+## 81.2 Customize the ‘whitelabel’ error page
-81.2 Customize the ‘whitelabel’ error page
Spring Boot installs a ‘whitelabel’ error page that you will see in browser client if you encounter a server error (machine clients consuming JSON and other media types should see a sensible response with the right error code).
-[Note]
-Set server.error.whitelabel.enabled=false to switch the default error page off which will restore the default of the servlet container that you are using. Note that Spring Boot will still attempt to resolve the error view so you’d probably add you own error page rather than disabling it completely.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Set `server.error.whitelabel.enabled=false` to switch the default error page off which will restore the default of the servlet container that you are using. Note that Spring Boot will still attempt to resolve the error view so you’d probably add you own error page rather than disabling it completely. |
+
+Overriding the error page with your own depends on the templating technology that you are using. For example, if you are using Thymeleaf you would add an `error.html` template and if you are using FreeMarker you would add an `error.ftl` template. In general what you need is a `View` that resolves with a name of `error`, and/or a `@Controller` that handles the `/error` path. Unless you replaced some of the default configuration you should find a `BeanNameViewResolver`in your `ApplicationContext` so a `@Bean` with id `error` would be a simple way of doing that. Look at [`ErrorMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorMvcAutoConfiguration.java) for more options.
+
+See also the section on [Error Handling](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-error-handling) for details of how to register handlers in the servlet container.
-Overriding the error page with your own depends on the templating technology that you are using. For example, if you are using Thymeleaf you would add an error.html template and if you are using FreeMarker you would add an error.ftl template. In general what you need is a View that resolves with a name of error, and/or a @Controller that handles the /error path. Unless you replaced some of the default configuration you should find a BeanNameViewResolver in your ApplicationContext so a @Bean with id error would be a simple way of doing that. Look at ErrorMvcAutoConfiguration for more options.
+## 81.3 Actuator and Jersey
-See also the section on Error Handling for details of how to register handlers in the servlet container.
+Actuator HTTP endpoints are only available for Spring MVC-based applications. If you want to use Jersey and still use the actuator you will need to enable Spring MVC (by depending on `spring-boot-starter-web`, for example). By default, both Jersey and the Spring MVC dispatcher servlet are mapped to the same path (`/`). You will need to change the path for one of them (by configuring `server.servlet-path` for Spring MVC or `spring.jersey.application-path` for Jersey). For example, if you add `server.servlet-path=/system` into `application.properties`, the actuator HTTP endpoints will be available under `/system`.
-81.3 Actuator and Jersey
-Actuator HTTP endpoints are only available for Spring MVC-based applications. If you want to use Jersey and still use the actuator you will need to enable Spring MVC (by depending on spring-boot-starter-web, for example). By default, both Jersey and the Spring MVC dispatcher servlet are mapped to the same path (/). You will need to change the path for one of them (by configuring server.servlet-path for Spring MVC or spring.jersey.application-path for Jersey). For example, if you add server.servlet-path=/system into application.properties, the actuator HTTP endpoints will be available under /system.
+## 82. Security
-82. Security
-82.1 Switch off the Spring Boot security configuration
-If you define a @Configuration with @EnableWebSecurity anywhere in your application it will switch off the default webapp security settings in Spring Boot (but leave the Actuator’s security enabled). To tweak the defaults try setting properties in security.* (see SecurityProperties for details of available settings) and SECURITY section of Common application properties.
+## 82.1 Switch off the Spring Boot security configuration
-82.2 Change the AuthenticationManager and add user accounts
-If you provide a @Bean of type AuthenticationManager the default one will not be created, so you have the full feature set of Spring Security available (e.g. various authentication options).
+If you define a `@Configuration` with `@EnableWebSecurity` anywhere in your application it will switch off the default webapp security settings in Spring Boot (but leave the Actuator’s security enabled). To tweak the defaults try setting properties in `security.*` (see [`SecurityProperties`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityProperties.java) for details of available settings) and `SECURITY` section of [Common application properties](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#common-application-properties-security).
-Spring Security also provides a convenient AuthenticationManagerBuilder which can be used to build an AuthenticationManager with common options. The recommended way to use this in a webapp is to inject it into a void method in a WebSecurityConfigurerAdapter, e.g.
+## 82.2 Change the AuthenticationManager and add user accounts
+If you provide a `@Bean` of type `AuthenticationManager` the default one will not be created, so you have the full feature set of Spring Security available (e.g. [various authentication options](https://docs.spring.io/spring-security/site/docs/current/reference/htmlsingle/#jc-authentication)).
+
+Spring Security also provides a convenient `AuthenticationManagerBuilder` which can be used to build an `AuthenticationManager` with common options. The recommended way to use this in a webapp is to inject it into a void method in a `WebSecurityConfigurerAdapter`, e.g.
+
+```
@Configuration
public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
@@ -9477,10 +10703,14 @@ public class SecurityConfiguration extends WebSecurityConfigurerAdapter {
// ... other stuff for application security
}
-You will get the best results if you put this in a nested class, or a standalone class (i.e. not mixed in with a lot of other @Beans that might be allowed to influence the order of instantiation). The secure web sample is a useful template to follow.
-If you experience instantiation issues (e.g. using JDBC or JPA for the user detail store) it might be worth extracting the AuthenticationManagerBuilder callback into a GlobalAuthenticationConfigurerAdapter (in the init() method so it happens before the authentication manager is needed elsewhere), e.g.
+```
+
+You will get the best results if you put this in a nested class, or a standalone class (i.e. not mixed in with a lot of other `@Beans` that might be allowed to influence the order of instantiation). The [secure web sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-web-secure) is a useful template to follow.
+
+If you experience instantiation issues (e.g. using JDBC or JPA for the user detail store) it might be worth extracting the `AuthenticationManagerBuilder` callback into a `GlobalAuthenticationConfigurerAdapter` (in the `init()` method so it happens before the authentication manager is needed elsewhere), e.g.
+```
@Configuration
public class AuthenticationManagerConfiguration extends
GlobalAuthenticationConfigurerAdapter {
@@ -9491,48 +10721,66 @@ public class AuthenticationManagerConfiguration extends
}
}
-82.3 Enable HTTPS when running behind a proxy server
-Ensuring that all your main endpoints are only available over HTTPS is an important chore for any application. If you are using Tomcat as a servlet container, then Spring Boot will add Tomcat’s own RemoteIpValve automatically if it detects some environment settings, and you should be able to rely on the HttpServletRequest to report whether it is secure or not (even downstream of a proxy server that handles the real SSL termination). The standard behavior is determined by the presence or absence of certain request headers (x-forwarded-for and x-forwarded-proto), whose names are conventional, so it should work with most front end proxies. You can switch on the valve by adding some entries to application.properties, e.g.
+```
+
+## 82.3 Enable HTTPS when running behind a proxy server
+
+Ensuring that all your main endpoints are only available over HTTPS is an important chore for any application. If you are using Tomcat as a servlet container, then Spring Boot will add Tomcat’s own `RemoteIpValve` automatically if it detects some environment settings, and you should be able to rely on the `HttpServletRequest` to report whether it is secure or not (even downstream of a proxy server that handles the real SSL termination). The standard behavior is determined by the presence or absence of certain request headers (`x-forwarded-for` and `x-forwarded-proto`), whose names are conventional, so it should work with most front end proxies. You can switch on the valve by adding some entries to `application.properties`, e.g.
+
+```
server.tomcat.remote-ip-header=x-forwarded-for
server.tomcat.protocol-header=x-forwarded-proto
-(The presence of either of those properties will switch on the valve. Or you can add the RemoteIpValve yourself by adding a TomcatEmbeddedServletContainerFactory bean.)
-Spring Security can also be configured to require a secure channel for all (or some requests). To switch that on in a Spring Boot application you just need to set security.require_ssl to true in application.properties.
+```
+
+(The presence of either of those properties will switch on the valve. Or you can add the `RemoteIpValve` yourself by adding a `TomcatEmbeddedServletContainerFactory` bean.)
-83. Hot swapping
-83.1 Reload static content
-There are several options for hot reloading. The recommended approach is to use spring-boot-devtools as it provides additional development-time features such as support for fast application restarts and LiveReload as well as sensible development-time configuration (e.g. template caching). Devtools works by monitoring the classpath for changes. This means that static resource changes must be "built" for the change to take affect. By default, this happens automatically in Eclipse when you save your changes. In IntelliJ IDEA, Make Project will trigger the necessary build. Due to the default restart exclusions, changes to static resources will not trigger a restart of your application. They will, however, trigger a live reload.
+Spring Security can also be configured to require a secure channel for all (or some requests). To switch that on in a Spring Boot application you just need to set`security.require_ssl` to `true` in `application.properties`.
+
+## 83. Hot swapping
+
+## 83.1 Reload static content
+
+There are several options for hot reloading. The recommended approach is to use [`spring-boot-devtools`](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools) as it provides additional development-time features such as support for fast application restarts and LiveReload as well as sensible development-time configuration (e.g. template caching). Devtools works by monitoring the classpath for changes. This means that static resource changes must be "built" for the change to take affect. By default, this happens automatically in Eclipse when you save your changes. In IntelliJ IDEA, Make Project will trigger the necessary build. Due to the [default restart exclusions](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-restart-exclude), changes to static resources will not trigger a restart of your application. They will, however, trigger a live reload.
Alternatively, running in an IDE (especially with debugging on) is a good way to do development (all modern IDEs allow reloading of static resources and usually also hot-swapping of Java class changes).
-Finally, the Maven and Gradle plugins can be configured (see the addResources property) to support running from the command line with reloading of static files directly from source. You can use that with an external css/js compiler process if you are writing that code with higher level tools.
+Finally, the [Maven and Gradle plugins](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins) can be configured (see the `addResources` property) to support running from the command line with reloading of static files directly from source. You can use that with an external css/js compiler process if you are writing that code with higher level tools.
+
+## 83.2 Reload templates without restarting the container
+
+Most of the templating technologies supported by Spring Boot include a configuration option to disable caching (see below for details). If you’re using the`spring-boot-devtools` module these properties will be [automatically configured](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools-property-defaults) for you at development time.
+
+### 83.2.1 Thymeleaf templates
+
+If you are using Thymeleaf, then set `spring.thymeleaf.cache` to `false`. See [`ThymeleafAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafAutoConfiguration.java) for other Thymeleaf customization options.
+
+### 83.2.2 FreeMarker templates
-83.2 Reload templates without restarting the container
-Most of the templating technologies supported by Spring Boot include a configuration option to disable caching (see below for details). If you’re using the spring-boot-devtools module these properties will be automatically configured for you at development time.
+If you are using FreeMarker, then set `spring.freemarker.cache` to `false`. See [`FreeMarkerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerAutoConfiguration.java) for other FreeMarker customization options.
-83.2.1 Thymeleaf templates
-If you are using Thymeleaf, then set spring.thymeleaf.cache to false. See ThymeleafAutoConfiguration for other Thymeleaf customization options.
+### 83.2.3 Groovy templates
-83.2.2 FreeMarker templates
-If you are using FreeMarker, then set spring.freemarker.cache to false. See FreeMarkerAutoConfiguration for other FreeMarker customization options.
+If you are using Groovy templates, then set `spring.groovy.template.cache` to `false`. See [`GroovyTemplateAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateAutoConfiguration.java) for other Groovy customization options.
-83.2.3 Groovy templates
-If you are using Groovy templates, then set spring.groovy.template.cache to false. See GroovyTemplateAutoConfiguration for other Groovy customization options.
+## 83.3 Fast application restarts
-83.3 Fast application restarts
-The spring-boot-devtools module includes support for automatic application restarts. Whilst not as fast as technologies such as JRebel or Spring Loaded it’s usually significantly faster than a “cold start”. You should probably give it a try before investigating some of the more complex reload options discussed below.
+The `spring-boot-devtools` module includes support for automatic application restarts. Whilst not as fast as technologies such as [JRebel](http://zeroturnaround.com/software/jrebel/) or [Spring Loaded](https://github.com/spring-projects/spring-loaded) it’s usually significantly faster than a “cold start”. You should probably give it a try before investigating some of the more complex reload options discussed below.
-For more details see the Chapter 20, Developer tools section.
+For more details see the [Chapter 20, *Developer tools*](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#using-boot-devtools) section.
+
+## 83.4 Reload Java classes without restarting the container
-83.4 Reload Java classes without restarting the container
Modern IDEs (Eclipse, IDEA, etc.) all support hot swapping of bytecode, so if you make a change that doesn’t affect class or method signatures it should reload cleanly with no side effects.
-Spring Loaded goes a little further in that it can reload class definitions with changes in the method signatures. With some customization it can force an ApplicationContext to refresh itself (but there is no general mechanism to ensure that would be safe for a running application anyway, so it would only ever be a development time trick probably).
+[Spring Loaded](https://github.com/spring-projects/spring-loaded) goes a little further in that it can reload class definitions with changes in the method signatures. With some customization it can force an `ApplicationContext` to refresh itself (but there is no general mechanism to ensure that would be safe for a running application anyway, so it would only ever be a development time trick probably).
+
+### 83.4.1 Configuring Spring Loaded for use with Maven
-83.4.1 Configuring Spring Loaded for use with Maven
To use Spring Loaded with the Maven command line, just add it as a dependency in the Spring Boot plugin declaration, e.g.
+```
org.springframework.boot
spring-boot-maven-plugin
@@ -9544,13 +10792,18 @@ To use Spring Loaded with the Maven command line, just add it as a dependency in
+
+```
+
This normally works pretty well with Eclipse and IntelliJ IDEA as long as they have their build configuration aligned with the Maven defaults (Eclipse m2e does this out of the box).
-83.4.2 Configuring Spring Loaded for use with Gradle and IntelliJ IDEA
+### 83.4.2 Configuring Spring Loaded for use with Gradle and IntelliJ IDEA
+
You need to jump through a few hoops if you want to use Spring Loaded in combination with Gradle and IntelliJ IDEA. By default, IntelliJ IDEA will compile classes into a different location than Gradle, causing Spring Loaded monitoring to fail.
-To configure IntelliJ IDEA correctly you can use the idea Gradle plugin:
+To configure IntelliJ IDEA correctly you can use the `idea` Gradle plugin:
+```
buildscript {
repositories { jcenter() }
dependencies {
@@ -9569,17 +10822,24 @@ idea {
}
// ...
-[Note]
-IntelliJ IDEA must be configured to use the same Java version as the command line Gradle task and springloaded must be included as a buildscript dependency.
+
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| IntelliJ IDEA must be configured to use the same Java version as the command line Gradle task and `springloaded` **must** be included as a `buildscript` dependency. |
You can also additionally enable ‘Make Project Automatically’ inside IntelliJ IDEA to automatically compile your code whenever a file is saved.
-84. Build
-84.1 Generate build information
-Both the Maven and Gradle plugin allow to generate build information containing the coordinates, name and version of the project. The plugin can also be configured to add additional properties through configuration. When such file is present, Spring Boot auto-configures a BuildProperties bean.
+## 84. Build
+
+## 84.1 Generate build information
-To generate build information with Maven, add an execution for the build-info goal:
+Both the Maven and Gradle plugin allow to generate build information containing the coordinates, name and version of the project. The plugin can also be configured to add additional properties through configuration. When such file is present, Spring Boot auto-configures a `BuildProperties` bean.
+To generate build information with Maven, add an execution for the `build-info` goal:
+
+```
@@ -9596,16 +10856,25 @@ To generate build information with Maven, add an execution for the build-info go
-[Tip]
-Check the Spring Boot Maven Plugin documentation for more details.
+
+```
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Check the [Spring Boot Maven Plugin documentation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/) for more details. |
And to do the same with Gradle:
+```
springBoot {
buildInfo()
}
+
+```
+
Additional properties can be added using the DSL:
+```
springBoot {
buildInfo {
additionalProperties = [
@@ -9613,11 +10882,16 @@ springBoot {
]
}
}
-84.2 Generate git information
-Both Maven and Gradle allow to generate a git.properties file containing information about the state of your git source code repository when the project was built.
-For Maven users the spring-boot-starter-parent POM includes a pre-configured plugin to generate a git.properties file. Simply add the following declaration to your POM:
+```
+
+## 84.2 Generate git information
+
+Both Maven and Gradle allow to generate a `git.properties` file containing information about the state of your `git` source code repository when the project was built.
+
+For Maven users the `spring-boot-starter-parent` POM includes a pre-configured plugin to generate a `git.properties` file. Simply add the following declaration to your POM:
+```
@@ -9626,31 +10900,51 @@ For Maven users the spring-boot-starter-parent POM includes a pre-configured plu
-Gradle users can achieve the same result using the gradle-git-properties plugin
+```
+
+Gradle users can achieve the same result using the [`gradle-git-properties`](https://plugins.gradle.org/plugin/com.gorylenko.gradle-git-properties) plugin
+
+```
plugins {
id "com.gorylenko.gradle-git-properties" version "1.4.17"
}
-84.3 Customize dependency versions
-If you use a Maven build that inherits directly or indirectly from spring-boot-dependencies (for instance spring-boot-starter-parent) but you want to override a specific third-party dependency you can add appropriate elements. Browse the spring-boot-dependencies POM for a complete list of properties. For example, to pick a different slf4j version you would add the following:
+```
+
+## 84.3 Customize dependency versions
+
+If you use a Maven build that inherits directly or indirectly from `spring-boot-dependencies` (for instance `spring-boot-starter-parent`) but you want to override a specific third-party dependency you can add appropriate `` elements. Browse the [`spring-boot-dependencies`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-dependencies/pom.xml) POM for a complete list of properties. For example, to pick a different `slf4j` version you would add the following:
+
+```
1.7.5
-[Note]
-This only works if your Maven project inherits (directly or indirectly) from spring-boot-dependencies. If you have added spring-boot-dependencies in your own dependencyManagement section with import you have to redefine the artifact yourself instead of overriding the property.
-[Warning]
-Each Spring Boot release is designed and tested against a specific set of third-party dependencies. Overriding versions may cause compatibility issues.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| This only works if your Maven project inherits (directly or indirectly) from `spring-boot-dependencies`. If you have added `spring-boot-dependencies` in your own `dependencyManagement` section with `import` you have to redefine the artifact yourself instead of overriding the property. |
+
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| Each Spring Boot release is designed and tested against a specific set of third-party dependencies. Overriding versions may cause compatibility issues. |
To override dependency versions in Gradle, you can specify a version as shown below:
+```
ext['slf4j.version'] = '1.7.5'
-For additional information, please refer to the Gradle Dependency Management Plugin documentation.
-84.4 Create an executable JAR with Maven
-The spring-boot-maven-plugin can be used to create an executable ‘fat’ JAR. If you are using the spring-boot-starter-parent POM you can simply declare the plugin and your jars will be repackaged:
+```
+
+For additional information, please refer to the [Gradle Dependency Management Plugin documentation](https://github.com/spring-gradle-plugins/dependency-management-plugin).
+## 84.4 Create an executable JAR with Maven
+
+The `spring-boot-maven-plugin` can be used to create an executable ‘fat’ JAR. If you are using the `spring-boot-starter-parent` POM you can simply declare the plugin and your jars will be repackaged:
+
+```
@@ -9659,8 +10953,12 @@ The spring-boot-maven-plugin can be used to create an executable ‘fat’ JAR.
-If you are not using the parent POM you can still use the plugin, however, you must additionally add an section:
+```
+
+If you are not using the parent POM you can still use the plugin, however, you must additionally add an `` section:
+
+```
@@ -9677,17 +10975,22 @@ If you are not using the parent POM you can still use the plugin, however, you m
-See the plugin documentation for full usage details.
-84.5 Use a Spring Boot application as a dependency
+```
+
+See the [plugin documentation](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/usage.html) for full usage details.
+
+## 84.5 Use a Spring Boot application as a dependency
+
Like a war file, a Spring Boot application is not intended to be used as a dependency. If your application contains classes that you want to share with other projects, the recommended approach is to move that code into a separate module. The separate module can then be depended upon by your application and other projects.
-If you cannot rearrange your code as recommended above, Spring Boot’s Maven and Gradle plugins must be configured to produce a separate artifact that is suitable for use as a dependency. The executable archive cannot be used as a dependency as the executable jar format packages application classes in BOOT-INF/classes. This means that they cannot be found when the executable jar is used as a dependency.
+If you cannot rearrange your code as recommended above, Spring Boot’s Maven and Gradle plugins must be configured to produce a separate artifact that is suitable for use as a dependency. The executable archive cannot be used as a dependency as the [executable jar format](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#executable-jar-jar-file-structure) packages application classes in `BOOT-INF/classes`. This means that they cannot be found when the executable jar is used as a dependency.
To produce the two artifacts, one that can be used as a dependency and one that is executable, a classifier must be specified. This classifier is applied to the name of the executable archive, leaving the default archive for use as dependency.
-To configure a classifier of exec in Maven, the following configuration can be used:
+To configure a classifier of `exec` in Maven, the following configuration can be used:
+```
@@ -9699,18 +11002,27 @@ To configure a classifier of exec in Maven, the following configuration can be u
+
+```
+
And when using Gradle, the following configuration can be used:
+```
bootRepackage {
classifier = 'exec'
}
-84.6 Extract specific libraries when an executable jar runs
-Most nested libraries in an executable jar do not need to be unpacked in order to run, however, certain libraries can have problems. For example, JRuby includes its own nested jar support which assumes that the jruby-complete.jar is always directly available as a file in its own right.
+
+```
+
+## 84.6 Extract specific libraries when an executable jar runs
+
+Most nested libraries in an executable jar do not need to be unpacked in order to run, however, certain libraries can have problems. For example, JRuby includes its own nested jar support which assumes that the `jruby-complete.jar` is always directly available as a file in its own right.
To deal with any problematic libraries, you can flag that specific nested jars should be automatically unpacked to the ‘temp folder’ when the executable jar first runs.
For example, to indicate that JRuby should be flagged for unpack using the Maven Plugin you would add the following configuration:
+```
@@ -9727,16 +11039,25 @@ For example, to indicate that JRuby should be flagged for unpack using the Maven
+
+```
+
And to do that same with Gradle:
+```
springBoot {
requiresUnpack = ['org.jruby:jruby-complete']
}
-84.7 Create a non-executable JAR with exclusions
-Often if you have an executable and a non-executable jar as build products, the executable version will have additional configuration files that are not needed in a library jar. E.g. the application.yml configuration file might excluded from the non-executable JAR.
+
+```
+
+## 84.7 Create a non-executable JAR with exclusions
+
+Often if you have an executable and a non-executable jar as build products, the executable version will have additional configuration files that are not needed in a library jar. E.g. the `application.yml` configuration file might excluded from the non-executable JAR.
Here’s how to do that in Maven:
+```
@@ -9776,8 +11097,12 @@ Here’s how to do that in Maven:
-In Gradle you can create a new JAR archive with standard task DSL features, and then have the bootRepackage task depend on that one using its withJarTask property:
+```
+
+In Gradle you can create a new JAR archive with standard task DSL features, and then have the `bootRepackage` task depend on that one using its `withJarTask`property:
+
+```
jar {
baseName = 'spring-boot-sample-profile'
version = '0.0.0'
@@ -9794,34 +11119,50 @@ task('execJar', type:Jar, dependsOn: 'jar') {
bootRepackage {
withJarTask = tasks['execJar']
}
-84.8 Remote debug a Spring Boot application started with Maven
-To attach a remote debugger to a Spring Boot application started with Maven you can use the jvmArguments property of the maven plugin.
-Check this example for more details.
+```
+
+## 84.8 Remote debug a Spring Boot application started with Maven
-84.9 Remote debug a Spring Boot application started with Gradle
-To attach a remote debugger to a Spring Boot application started with Gradle you can use the jvmArgs property of bootRun task or --debug-jvm command line option.
+To attach a remote debugger to a Spring Boot application started with Maven you can use the `jvmArguments` property of the [maven plugin](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/).
-build.gradle:
+Check [this example](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/maven-plugin/examples/run-debug.html) for more details.
+## 84.9 Remote debug a Spring Boot application started with Gradle
+
+To attach a remote debugger to a Spring Boot application started with Gradle you can use the `jvmArgs` property of `bootRun` task or `--debug-jvm` command line option.
+
+`build.gradle`:
+
+```
bootRun {
jvmArgs "-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=5005"
}
+
+```
+
Command line:
+```
$ gradle bootRun --debug-jvm
-Check Gradle Application Plugin for more details.
-84.10 Build an executable archive from Ant without using spring-boot-antlib
-To build with Ant you need to grab dependencies, compile and then create a jar or war archive. To make it executable you can either use the spring-boot-antlib module, or you can follow these instructions:
+```
+
+Check [Gradle Application Plugin](http://www.gradle.org/docs/current/userguide/application_plugin.html) for more details.
+
+## 84.10 Build an executable archive from Ant without using spring-boot-antlib
+
+To build with Ant you need to grab dependencies, compile and then create a jar or war archive. To make it executable you can either use the `spring-boot-antlib`module, or you can follow these instructions:
+
+1. If you are building a jar, package the application’s classes and resources in a nested `BOOT-INF/classes` directory. If you are building a war, package the application’s classes in a nested `WEB-INF/classes` directory as usual.
+2. Add the runtime dependencies in a nested `BOOT-INF/lib` directory for a jar or `WEB-INF/lib` for a war. Remember **not** to compress the entries in the archive.
+3. Add the `provided` (embedded container) dependencies in a nested `BOOT-INF/lib` directory for jar or `WEB-INF/lib-provided` for a war. Remember **not** to compress the entries in the archive.
+4. Add the `spring-boot-loader` classes at the root of the archive (so the `Main-Class` is available).
+5. Use the appropriate launcher, e.g. `JarLauncher` for a jar file, as a `Main-Class` attribute in the manifest and specify the other properties it needs as manifest entries, principally a `Start-Class`.
-If you are building a jar, package the application’s classes and resources in a nested BOOT-INF/classes directory. If you are building a war, package the application’s classes in a nested WEB-INF/classes directory as usual.
-Add the runtime dependencies in a nested BOOT-INF/lib directory for a jar or WEB-INF/lib for a war. Remember not to compress the entries in the archive.
-Add the provided (embedded container) dependencies in a nested BOOT-INF/lib directory for jar or WEB-INF/lib-provided for a war. Remember not to compress the entries in the archive.
-Add the spring-boot-loader classes at the root of the archive (so the Main-Class is available).
-Use the appropriate launcher, e.g. JarLauncher for a jar file, as a Main-Class attribute in the manifest and specify the other properties it needs as manifest entries, principally a Start-Class.
Example:
+```
@@ -9843,30 +11184,48 @@ Example:
-The Ant Sample has a build.xml with a manual task that should work if you run it with
+```
+
+The [Ant Sample](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-ant) has a `build.xml` with a `manual` task that should work if you run it with
+
+```
$ ant -lib clean manual
+
+```
+
after which you can run the application with
+```
$ java -jar target/*.jar
-84.11 How to use Java 6
+
+```
+
+## 84.11 How to use Java 6
+
If you want to use Spring Boot with Java 6 there are a small number of configuration changes that you will have to make. The exact changes depend on your application’s functionality.
-84.11.1 Embedded servlet container compatibility
-If you are using one of Boot’s embedded Servlet containers you will have to use a Java 6-compatible container. Both Tomcat 7 and Jetty 8 are Java 6 compatible. See Section 73.16, “Use Tomcat 7.x or 8.0” and Section 73.18, “Use Jetty 8” for details.
+### 84.11.1 Embedded servlet container compatibility
+
+If you are using one of Boot’s embedded Servlet containers you will have to use a Java 6-compatible container. Both Tomcat 7 and Jetty 8 are Java 6 compatible. See[Section 73.16, “Use Tomcat 7.x or 8.0”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-tomcat-7) and [Section 73.18, “Use Jetty 8”](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-use-jetty-8) for details.
+
+### 84.11.2 Jackson
-84.11.2 Jackson
Jackson 2.7 and later requires Java 7. If you want to use Jackson with Java 6 you will have to downgrade to Jackson 2.6.
-Spring Boot uses the Jackson BOM that was introduced as of Jackson 2.7 so you can’t just override the jackson.version property. In order to use Jackson 2.6, you will have to define the individual modules in the dependencyManagement section of your build, check this example for more details.
+Spring Boot uses the Jackson BOM that was introduced as of Jackson 2.7 so you can’t just override the `jackson.version` property. In order to use Jackson 2.6, you will have to define the individual modules in the `dependencyManagement` section of your build, check [this example](https://github.com/spring-projects/spring-boot/blob/0ffc7dc13f6de82c199a6d503354a88c7aaec2d9/spring-boot-dependencies/pom.xml#L523-L597) for more details.
+
+### 84.11.3 JTA API compatibility
+
+While the Java Transaction API itself doesn’t require Java 7 the official API jar contains classes that have been built to require Java 7. If you are using JTA then you will need to replace the official JTA 1.2 API jar with one that has been built to work on Java 6. To do so, exclude any transitive dependencies on`javax.transaction:javax.transaction-api` and replace them with a dependency on`org.jboss.spec.javax.transaction:jboss-transaction-api_1.2_spec:1.0.0.Final`
-84.11.3 JTA API compatibility
-While the Java Transaction API itself doesn’t require Java 7 the official API jar contains classes that have been built to require Java 7. If you are using JTA then you will need to replace the official JTA 1.2 API jar with one that has been built to work on Java 6. To do so, exclude any transitive dependencies on javax.transaction:javax.transaction-api and replace them with a dependency on org.jboss.spec.javax.transaction:jboss-transaction-api_1.2_spec:1.0.0.Final
+## 85. Traditional deployment
-85. Traditional deployment
-85.1 Create a deployable war file
-The first step in producing a deployable war file is to provide a SpringBootServletInitializer subclass and override its configure method. This makes use of Spring Framework’s Servlet 3.0 support and allows you to configure your application when it’s launched by the servlet container. Typically, you update your application’s main class to extend SpringBootServletInitializer:
+## 85.1 Create a deployable war file
+The first step in producing a deployable war file is to provide a `SpringBootServletInitializer` subclass and override its `configure` method. This makes use of Spring Framework’s Servlet 3.0 support and allows you to configure your application when it’s launched by the servlet container. Typically, you update your application’s main class to extend `SpringBootServletInitializer`:
+
+```
@SpringBootApplication
public class Application extends SpringBootServletInitializer {
@@ -9880,16 +11239,28 @@ public class Application extends SpringBootServletInitializer {
}
}
-The next step is to update your build configuration so that your project produces a war file rather than a jar file. If you’re using Maven and using spring-boot-starter-parent (which configures Maven’s war plugin for you) all you need to do is to modify pom.xml to change the packaging to war:
+```
+
+The next step is to update your build configuration so that your project produces a war file rather than a jar file. If you’re using Maven and using `spring-boot-starter-parent` (which configures Maven’s war plugin for you) all you need to do is to modify `pom.xml` to change the packaging to war:
+
+```
war
-If you’re using Gradle, you need to modify build.gradle to apply the war plugin to the project:
+```
+
+If you’re using Gradle, you need to modify `build.gradle` to apply the war plugin to the project:
+
+```
apply plugin: 'war'
+
+```
+
The final step in the process is to ensure that the embedded servlet container doesn’t interfere with the servlet container to which the war file will be deployed. To do so, you need to mark the embedded servlet container dependency as provided.
If you’re using Maven:
+```
@@ -9899,29 +11270,41 @@ If you’re using Maven:
+
+```
+
And if you’re using Gradle:
+```
dependencies {
// …
providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat'
// …
}
-[Note]
-If you are using a version of Gradle that supports compile only dependencies (2.12 or later), you should continue to use providedRuntime. Among other limitations, compileOnly dependencies are not on the test classpath so any web-based integration tests will fail.
-If you’re using the Spring Boot build tools, marking the embedded servlet container dependency as provided will produce an executable war file with the provided dependencies packaged in a lib-provided directory. This means that, in addition to being deployable to a servlet container, you can also run your application using java -jar on the command line.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you are using a version of Gradle that supports compile only dependencies (2.12 or later), you should continue to use `providedRuntime`. Among other limitations, `compileOnly` dependencies are not on the test classpath so any web-based integration tests will fail. |
+
+If you’re using the [Spring Boot build tools](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#build-tool-plugins), marking the embedded servlet container dependency as provided will produce an executable war file with the provided dependencies packaged in a `lib-provided` directory. This means that, in addition to being deployable to a servlet container, you can also run your application using `java -jar` on the command line.
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Take a look at Spring Boot’s sample applications for a [Maven-based example](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-samples/spring-boot-sample-traditional/pom.xml) of the above-described configuration. |
-[Tip]
-Take a look at Spring Boot’s sample applications for a Maven-based example of the above-described configuration.
+## 85.2 Create a deployable war file for older servlet containers
-85.2 Create a deployable war file for older servlet containers
-Older Servlet containers don’t have support for the ServletContextInitializer bootstrap process used in Servlet 3.0. You can still use Spring and Spring Boot in these containers but you are going to need to add a web.xml to your application and configure it to load an ApplicationContext via a DispatcherServlet.
+Older Servlet containers don’t have support for the `ServletContextInitializer` bootstrap process used in Servlet 3.0. You can still use Spring and Spring Boot in these containers but you are going to need to add a `web.xml` to your application and configure it to load an `ApplicationContext` via a `DispatcherServlet`.
-85.3 Convert an existing application to Spring Boot
-For a non-web application it should be easy (throw away the code that creates your ApplicationContext and replace it with calls to SpringApplication or SpringApplicationBuilder). Spring MVC web applications are generally amenable to first creating a deployable war application, and then migrating it later to an executable war and/or jar. Useful reading is in the Getting Started Guide on Converting a jar to a war.
+## 85.3 Convert an existing application to Spring Boot
-Create a deployable war by extending SpringBootServletInitializer (e.g. in a class called Application), and add the Spring Boot @SpringBootApplication annotation. Example:
+For a non-web application it should be easy (throw away the code that creates your `ApplicationContext` and replace it with calls to `SpringApplication` or`SpringApplicationBuilder`). Spring MVC web applications are generally amenable to first creating a deployable war application, and then migrating it later to an executable war and/or jar. Useful reading is in the [Getting Started Guide on Converting a jar to a war](https://spring.io/guides/gs/convert-jar-to-war/).
+Create a deployable war by extending `SpringBootServletInitializer` (e.g. in a class called `Application`), and add the Spring Boot `@SpringBootApplication` annotation. Example:
+
+```
@SpringBootApplication
public class Application extends SpringBootServletInitializer {
@@ -9934,57 +11317,52 @@ public class Application extends SpringBootServletInitializer {
}
}
-Remember that whatever you put in the sources is just a Spring ApplicationContext and normally anything that already works should work here. There might be some beans you can remove later and let Spring Boot provide its own defaults for them, but it should be possible to get something working first.
-Static resources can be moved to /public (or /static or /resources or /META-INF/resources) in the classpath root. Same for messages.properties (Spring Boot detects this automatically in the root of the classpath).
+```
+
+Remember that whatever you put in the `sources` is just a Spring `ApplicationContext` and normally anything that already works should work here. There might be some beans you can remove later and let Spring Boot provide its own defaults for them, but it should be possible to get something working first.
+
+Static resources can be moved to `/public` (or `/static` or `/resources` or `/META-INF/resources`) in the classpath root. Same for `messages.properties`(Spring Boot detects this automatically in the root of the classpath).
+
+Vanilla usage of Spring `DispatcherServlet` and Spring Security should require no further changes. If you have other features in your application, using other servlets or filters for instance, then you may need to add some configuration to your `Application` context, replacing those elements from the `web.xml` as follows:
-Vanilla usage of Spring DispatcherServlet and Spring Security should require no further changes. If you have other features in your application, using other servlets or filters for instance, then you may need to add some configuration to your Application context, replacing those elements from the web.xml as follows:
+- A `@Bean` of type `Servlet` or `ServletRegistrationBean` installs that bean in the container as if it was a `` and `` in `web.xml`.
+- A `@Bean` of type `Filter` or `FilterRegistrationBean` behaves similarly (like a `` and ``.
+- An `ApplicationContext` in an XML file can be added through an `@ImportResource` in your `Application`. Or simple cases where annotation configuration is heavily used already can be recreated in a few lines as `@Bean` definitions.
-A @Bean of type Servlet or ServletRegistrationBean installs that bean in the container as if it was a and in web.xml.
-A @Bean of type Filter or FilterRegistrationBean behaves similarly (like a and .
-An ApplicationContext in an XML file can be added through an @ImportResource in your Application. Or simple cases where annotation configuration is heavily used already can be recreated in a few lines as @Bean definitions.
-Once the war is working we make it executable by adding a main method to our Application, e.g.
+Once the war is working we make it executable by adding a `main` method to our `Application`, e.g.
+```
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
-[Note]
-If you intend to start your application as a war or as an executable application, you need to share the customizations of the builder in a method that is both available to the SpringBootServletInitializer callback and the main method, something like:
-@SpringBootApplication
-public class Application extends SpringBootServletInitializer {
-
- @Override
- protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) {
- return configureApplication(builder);
- }
-
- public static void main(String[] args) {
- configureApplication(new SpringApplicationBuilder()).run(args);
- }
+```
- private static SpringApplicationBuilder configureApplication(SpringApplicationBuilder builder) {
- return builder.sources(Application.class).bannerMode(Banner.Mode.OFF);
- }
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you intend to start your application as a war or as an executable application, you need to share the customizations of the builder in a method that is both available to the `SpringBootServletInitializer` callback and the `main` method, something like:`*@SpringBootApplication* public class Application extends SpringBootServletInitializer { *@Override* protected SpringApplicationBuilder configure(SpringApplicationBuilder builder) { return configureApplication(builder); } public static void main(String[] args) { configureApplication(new SpringApplicationBuilder()).run(args); } private static SpringApplicationBuilder configureApplication(SpringApplicationBuilder builder) { return builder.sources(Application.class).bannerMode(Banner.Mode.OFF); } }` |
-}
Applications can fall into more than one category:
-Servlet 3.0+ applications with no web.xml.
-Applications with a web.xml.
-Applications with a context hierarchy.
-Applications without a context hierarchy.
+- Servlet 3.0+ applications with no `web.xml`.
+- Applications with a `web.xml`.
+- Applications with a context hierarchy.
+- Applications without a context hierarchy.
+
All of these should be amenable to translation, but each might require slightly different tricks.
-Servlet 3.0+ applications might translate pretty easily if they already use the Spring Servlet 3.0+ initializer support classes. Normally all the code from an existing WebApplicationInitializer can be moved into a SpringBootServletInitializer. If your existing application has more than one ApplicationContext (e.g. if it uses AbstractDispatcherServletInitializer) then you might be able to squash all your context sources into a single SpringApplication. The main complication you might encounter is if that doesn’t work and you need to maintain the context hierarchy. See the entry on building a hierarchy for examples. An existing parent context that contains web-specific features will usually need to be broken up so that all the ServletContextAware components are in the child context.
+Servlet 3.0+ applications might translate pretty easily if they already use the Spring Servlet 3.0+ initializer support classes. Normally all the code from an existing`WebApplicationInitializer` can be moved into a `SpringBootServletInitializer`. If your existing application has more than one `ApplicationContext`(e.g. if it uses `AbstractDispatcherServletInitializer`) then you might be able to squash all your context sources into a single `SpringApplication`. The main complication you might encounter is if that doesn’t work and you need to maintain the context hierarchy. See the [entry on building a hierarchy](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#howto-build-an-application-context-hierarchy) for examples. An existing parent context that contains web-specific features will usually need to be broken up so that all the `ServletContextAware` components are in the child context.
Applications that are not already Spring applications might be convertible to a Spring Boot application, and the guidance above might help, but your mileage may vary.
-85.4 Deploying a WAR to WebLogic
-To deploy a Spring Boot application to WebLogic you must ensure that your servlet initializer directly implements WebApplicationInitializer (even if you extend from a base class that already implements it).
+## 85.4 Deploying a WAR to WebLogic
+
+To deploy a Spring Boot application to WebLogic you must ensure that your servlet initializer **directly** implements `WebApplicationInitializer` (even if you extend from a base class that already implements it).
A typical initializer for WebLogic would be something like this:
+```
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.web.SpringBootServletInitializer;
import org.springframework.web.WebApplicationInitializer;
@@ -9993,8 +11371,12 @@ import org.springframework.web.WebApplicationInitializer;
public class MyApplication extends SpringBootServletInitializer implements WebApplicationInitializer {
}
-If you use logback, you will also need to tell WebLogic to prefer the packaged version rather than the version that pre-installed with the server. You can do this by adding a WEB-INF/weblogic.xml file with the following contents:
+```
+
+If you use logback, you will also need to tell WebLogic to prefer the packaged version rather than the version that pre-installed with the server. You can do this by adding a `WEB-INF/weblogic.xml` file with the following contents:
+
+```
-85.5 Deploying a WAR in an Old (Servlet 2.5) Container
-Spring Boot uses Servlet 3.0 APIs to initialize the ServletContext (register Servlets etc.) so you can’t use the same application out of the box in a Servlet 2.5 container. It is however possible to run a Spring Boot application on an older container with some special tools. If you include org.springframework.boot:spring-boot-legacy as a dependency (maintained separately to the core of Spring Boot and currently available at 1.0.2.RELEASE), all you should need to do is create a web.xml and declare a context listener to create the application context and your filters and servlets. The context listener is a special purpose one for Spring Boot, but the rest of it is normal for a Spring application in Servlet 2.5. Example:
+```
+
+## 85.5 Deploying a WAR in an Old (Servlet 2.5) Container
+
+Spring Boot uses Servlet 3.0 APIs to initialize the `ServletContext` (register `Servlets` etc.) so you can’t use the same application out of the box in a Servlet 2.5 container. It **is** however possible to run a Spring Boot application on an older container with some special tools. If you include `org.springframework.boot:spring-boot-legacy` as a dependency ([maintained separately](https://github.com/scratches/spring-boot-legacy) to the core of Spring Boot and currently available at 1.0.2.RELEASE), all you should need to do is create a `web.xml` and declare a context listener to create the application context and your filters and servlets. The context listener is a special purpose one for Spring Boot, but the rest of it is normal for a Spring application in Servlet 2.5. Example:
+
+```
-In this example we are using a single application context (the one created by the context listener) and attaching it to the DispatcherServlet using an init parameter. This is normal in a Spring Boot application (you normally only have one application context).
-Part X. Appendices
-Appendix A. Common application properties
-Various properties can be specified inside your application.properties/application.yml file or as command line switches. This section provides a list of common Spring Boot properties and references to the underlying classes that consume them.
+```
+
+In this example we are using a single application context (the one created by the context listener) and attaching it to the `DispatcherServlet` using an init parameter. This is normal in a Spring Boot application (you normally only have one application context).
+
+# Part X. Appendices
+
+## Appendix A. Common application properties
-[Note]
-Property contributions can come from additional jar files on your classpath so you should not consider this an exhaustive list. It is also perfectly legit to define your own properties.
+Various properties can be specified inside your `application.properties`/`application.yml` file or as command line switches. This section provides a list of common Spring Boot properties and references to the underlying classes that consume them.
-[Warning]
-This sample file is meant as a guide only. Do not copy/paste the entire content into your application; rather pick only the properties that you need.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Property contributions can come from additional jar files on your classpath so you should not consider this an exhaustive list. It is also perfectly legit to define your own properties. |
+| ![[Warning]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/warning.png) |
+| ------------------------------------------------------------ |
+| This sample file is meant as a guide only. Do **not** copy/paste the entire content into your application; rather pick only the properties that you need. |
+
+```
# ===================================================================
# COMMON SPRING BOOT PROPERTIES
#
@@ -11258,14 +12653,20 @@ spring.devtools.remote.secret-header-name=X-AUTH-TOKEN # HTTP header used to tra
spring.test.database.replace=any # Type of existing DataSource to replace.
spring.test.mockmvc.print=default # MVC Print option.
-Appendix B. Configuration meta-data
-Spring Boot jars are shipped with meta-data files that provide details of all supported configuration properties. The files are designed to allow IDE developers to offer contextual help and “code completion” as users are working with application.properties or application.yml files.
-The majority of the meta-data file is generated automatically at compile time by processing all items annotated with @ConfigurationProperties. However, it is possible to write part of the meta-data manually for corner cases or more advanced use cases.
+```
+
+## Appendix B. Configuration meta-data
+
+Spring Boot jars are shipped with meta-data files that provide details of all supported configuration properties. The files are designed to allow IDE developers to offer contextual help and “code completion” as users are working with `application.properties` or `application.yml` files.
+
+The majority of the meta-data file is generated automatically at compile time by processing all items annotated with `@ConfigurationProperties`. However, it is possible to [write part of the meta-data manually](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-additional-metadata) for corner cases or more advanced use cases.
-B.1 Meta-data format
-Configuration meta-data files are located inside jars under META-INF/spring-configuration-metadata.json They use a simple JSON format with items categorized under either “groups” or “properties” and additional values hint categorized under "hints":
+## B.1 Meta-data format
+Configuration meta-data files are located inside jars under `META-INF/spring-configuration-metadata.json` They use a simple JSON format with items categorized under either “groups” or “properties” and additional values hint categorized under "hints":
+
+```
{"groups": [
{
"name": "server",
@@ -11325,117 +12726,65 @@ Configuration meta-data files are located inside jars under META-INF/spring-conf
]
}
]}
-Each “property” is a configuration item that the user specifies with a given value. For example server.port and server.servlet-path might be specified in application.properties as follows:
-
-server.port=9090
-server.servlet-path=/home
-The “groups” are higher level items that don’t themselves specify a value, but instead provide a contextual grouping for properties. For example the server.port and server.servlet-path properties are part of the server group.
-
-[Note]
-It is not required that every “property” has a “group”, some properties might just exist in their own right.
-
-Finally, “hints” are additional information used to assist the user in configuring a given property. When configuring the spring.jpa.hibernate.ddl-auto property, a tool can use it to offer some auto-completion help for the none, validate, update, create and create-drop values.
-
-B.1.1 Group Attributes
-The JSON object contained in the groups array can contain the following attributes:
-
-Name Type Purpose
-name
-
-String
-
-The full name of the group. This attribute is mandatory.
-
-type
-
-String
-
-The class name of the data type of the group. For example, if the group was based on a class annotated with @ConfigurationProperties the attribute would contain the fully qualified name of that class. If it was based on a @Bean method, it would be the return type of that method. The attribute may be omitted if the type is not known.
-
-description
-
-String
-
-A short description of the group that can be displayed to users. May be omitted if no description is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (.).
-
-sourceType
-
-String
-
-The class name of the source that contributed this group. For example, if the group was based on a @Bean method annotated with @ConfigurationProperties this attribute would contain the fully qualified name of the @Configuration class containing the method. The attribute may be omitted if the source type is not known.
-
-sourceMethod
-
-String
-
-The full name of the method (include parenthesis and argument types) that contributed this group. For example, the name of a @ConfigurationProperties annotated @Bean method. May be omitted if the source method is not known.
-
-B.1.2 Property Attributes
-The JSON object contained in the properties array can contain the following attributes:
-
-Name Type Purpose
-name
-String
+```
-The full name of the property. Names are in lowercase dashed form (e.g. server.servlet-path). This attribute is mandatory.
+Each “property” is a configuration item that the user specifies with a given value. For example `server.port` and `server.servlet-path` might be specified in`application.properties` as follows:
-type
-
-String
-
-The full signature of the data type of the property. For example, java.lang.String but also a full generic type such as java.util.Map. This attribute can be used to guide the user as to the types of values that they can enter. For consistency, the type of a primitive is specified using its wrapper counterpart, i.e. boolean becomes java.lang.Boolean. Note that this class may be a complex type that gets converted from a String as values are bound. May be omitted if the type is not known.
-
-description
-
-String
-
-A short description of the group that can be displayed to users. May be omitted if no description is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (.).
-
-sourceType
-
-String
-
-The class name of the source that contributed this property. For example, if the property was from a class annotated with @ConfigurationProperties this attribute would contain the fully qualified name of that class. May be omitted if the source type is not known.
-
-defaultValue
-
-Object
-
-The default value which will be used if the property is not specified. Can also be an array of value(s) if the type of the property is an array. May be omitted if the default value is not known.
-
-deprecation
+```
+server.port=9090
+server.servlet-path=/home
-Deprecation
+```
-Specify if the property is deprecated. May be omitted if the field is not deprecated or if that information is not known. See below for more details.
+The “groups” are higher level items that don’t themselves specify a value, but instead provide a contextual grouping for properties. For example the `server.port` and`server.servlet-path` properties are part of the `server` group.
-The JSON object contained in the deprecation attribute of each properties element can contain the following attributes:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| It is not required that every “property” has a “group”, some properties might just exist in their own right. |
-Name Type Purpose
-level
+Finally, “hints” are additional information used to assist the user in configuring a given property. When configuring the `spring.jpa.hibernate.ddl-auto` property, a tool can use it to offer some auto-completion help for the `none`, `validate`, `update`, `create` and `create-drop` values.
-String
+### B.1.1 Group Attributes
-The level of deprecation, can be either warning (default) or error. When a property has a warning deprecation level it should still be bound in the environment. When it has an error deprecation level however, the property is no longer managed and will not be bound.
+The JSON object contained in the `groups` array can contain the following attributes:
-reason
+| Name | Type | Purpose |
+| -------------- | ------ | ------------------------------------------------------------ |
+| `name` | String | The full name of the group. This attribute is mandatory. |
+| `type` | String | The class name of the data type of the group. For example, if the group was based on a class annotated with `@ConfigurationProperties` the attribute would contain the fully qualified name of that class. If it was based on a `@Bean`method, it would be the return type of that method. The attribute may be omitted if the type is not known. |
+| `description` | String | A short description of the group that can be displayed to users. May be omitted if no description is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (`.`). |
+| `sourceType` | String | The class name of the source that contributed this group. For example, if the group was based on a `@Bean` method annotated with `@ConfigurationProperties` this attribute would contain the fully qualified name of the `@Configuration` class containing the method. The attribute may be omitted if the source type is not known. |
+| `sourceMethod` | String | The full name of the method (include parenthesis and argument types) that contributed this group. For example, the name of a `@ConfigurationProperties` annotated `@Bean` method. May be omitted if the source method is not known. |
-String
+### B.1.2 Property Attributes
-A short description of the reason why the property was deprecated. May be omitted if no reason is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (.).
+The JSON object contained in the `properties` array can contain the following attributes:
-replacement
+| Name | Type | Purpose |
+| -------------- | ----------- | ------------------------------------------------------------ |
+| `name` | String | The full name of the property. Names are in lowercase dashed form (e.g. `server.servlet-path`). This attribute is mandatory. |
+| `type` | String | The full signature of the data type of the property. For example, `java.lang.String` but also a full generic type such as `java.util.Map`. This attribute can be used to guide the user as to the types of values that they can enter. For consistency, the type of a primitive is specified using its wrapper counterpart, i.e. `boolean`becomes `java.lang.Boolean`. Note that this class may be a complex type that gets converted from a String as values are bound. May be omitted if the type is not known. |
+| `description` | String | A short description of the group that can be displayed to users. May be omitted if no description is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (`.`). |
+| `sourceType` | String | The class name of the source that contributed this property. For example, if the property was from a class annotated with `@ConfigurationProperties` this attribute would contain the fully qualified name of that class. May be omitted if the source type is not known. |
+| `defaultValue` | Object | The default value which will be used if the property is not specified. Can also be an array of value(s) if the type of the property is an array. May be omitted if the default value is not known. |
+| `deprecation` | Deprecation | Specify if the property is deprecated. May be omitted if the field is not deprecated or if that information is not known. See below for more details. |
-String
+The JSON object contained in the `deprecation` attribute of each `properties` element can contain the following attributes:
-The full name of the property that is replacing this deprecated property. May be omitted if there is no replacement for this property.
+| Name | Type | Purpose |
+| ------------- | ------ | ------------------------------------------------------------ |
+| `level` | String | The level of deprecation, can be either `warning` (default) or `error`. When a property has a `warning` deprecation level it should still be bound in the environment. When it has an `error` deprecation level however, the property is no longer managed and will not be bound. |
+| `reason` | String | A short description of the reason why the property was deprecated. May be omitted if no reason is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (`.`). |
+| `replacement` | String | The full name of the property that is *replacing* this deprecated property. May be omitted if there is no replacement for this property. |
-[Note]
-Prior to Spring Boot 1.3, a single deprecated boolean attribute can be used instead of the deprecation element. This is still supported in a deprecated fashion and should no longer be used. If no reason and replacement are available, an empty deprecation object should be set.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Prior to Spring Boot 1.3, a single `deprecated` boolean attribute can be used instead of the `deprecation` element. This is still supported in a deprecated fashion and should no longer be used. If no reason and replacement are available, an empty `deprecation` object should be set. |
-Deprecation can also be specified declaratively in code by adding the @DeprecatedConfigurationProperty annotation to the getter exposing the deprecated property. For instance, let’s assume the app.foo.target property was confusing and was renamed to app.foo.name
+Deprecation can also be specified declaratively in code by adding the `@DeprecatedConfigurationProperty` annotation to the getter exposing the deprecated property. For instance, let’s assume the `app.foo.target` property was confusing and was renamed to `app.foo.name`
+```
@ConfigurationProperties("app.foo")
public class FooProperties {
@@ -11456,86 +12805,71 @@ public class FooProperties {
setName(target);
}
}
-[Note]
-There is no way to set a level as warning is always assumed since code is still handling the property.
-
-The code above makes sure that the deprecated property still works (delegating to the name property behind the scenes). Once the getTarget and setTarget methods can be removed from your public API, the automatic deprecation hint in the meta-data will go away as well. If you want to keep a hint, adding manual meta-data with an error deprecation level ensures that users are still informed about that property and is particularly useful when a replacement is provided.
-
-B.1.3 Hint Attributes
-The JSON object contained in the hints array can contain the following attributes:
-Name Type Purpose
-name
+```
-String
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| There is no way to set a `level` as `warning` is always assumed since code is still handling the property. |
-The full name of the property that this hint refers to. Names are in lowercase dashed form (e.g. server.servlet-path). If the property refers to a map (e.g. system.contexts) the hint either applies to the keys of the map (system.context.keys) or the values (system.context.values). This attribute is mandatory.
+The code above makes sure that the deprecated property still works (delegating to the `name` property behind the scenes). Once the `getTarget` and `setTarget`methods can be removed from your public API, the automatic deprecation hint in the meta-data will go away as well. If you want to keep a hint, adding manual meta-data with an `error` deprecation level ensures that users are still informed about that property and is particularly useful when a `replacement` is provided.
-values
+### B.1.3 Hint Attributes
-ValueHint[]
+The JSON object contained in the `hints` array can contain the following attributes:
-A list of valid values as defined by the ValueHint object (see below). Each entry defines the value and may have a description
+| Name | Type | Purpose |
+| ----------- | --------------- | ------------------------------------------------------------ |
+| `name` | String | The full name of the property that this hint refers to. Names are in lowercase dashed form (e.g. `server.servlet-path`). If the property refers to a map (e.g. `system.contexts`) the hint either applies to the *keys* of the map (`system.context.keys`) or the values (`system.context.values`). This attribute is mandatory. |
+| `values` | ValueHint[] | A list of valid values as defined by the `ValueHint` object (see below). Each entry defines the value and may have a description |
+| `providers` | ValueProvider[] | A list of providers as defined by the `ValueProvider` object (see below). Each entry defines the name of the provider and its parameters, if any. |
-providers
+The JSON object contained in the `values` attribute of each `hint` element can contain the following attributes:
-ValueProvider[]
+| Name | Type | Purpose |
+| ------------- | ------ | ------------------------------------------------------------ |
+| `value` | Object | A valid value for the element to which the hint refers to. Can also be an array of value(s) if the type of the property is an array. This attribute is mandatory. |
+| `description` | String | A short description of the value that can be displayed to users. May be omitted if no description is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (`.`). |
-A list of providers as defined by the ValueProvider object (see below). Each entry defines the name of the provider and its parameters, if any.
+The JSON object contained in the `providers` attribute of each `hint` element can contain the following attributes:
-The JSON object contained in the values attribute of each hint element can contain the following attributes:
+| Name | Type | Purpose |
+| ------------ | ----------- | ------------------------------------------------------------ |
+| `name` | String | The name of the provider to use to offer additional content assistance for the element to which the hint refers to. |
+| `parameters` | JSON object | Any additional parameter that the provider supports (check the documentation of the provider for more details). |
-Name Type Purpose
-value
+### B.1.4 Repeated meta-data items
-Object
-
-A valid value for the element to which the hint refers to. Can also be an array of value(s) if the type of the property is an array. This attribute is mandatory.
-
-description
-
-String
-
-A short description of the value that can be displayed to users. May be omitted if no description is available. It is recommended that descriptions are a short paragraphs, with the first line providing a concise summary. The last line in the description should end with a period (.).
-
-The JSON object contained in the providers attribute of each hint element can contain the following attributes:
-
-Name Type Purpose
-name
-
-String
-
-The name of the provider to use to offer additional content assistance for the element to which the hint refers to.
-
-parameters
+It is perfectly acceptable for “property” and “group” objects with the same name to appear multiple times within a meta-data file. For example, you could bind two separate classes to the same prefix, with each potentially offering overlap of property names. While this is not supposed to be a frequent scenario, consumers of meta-data should take care to ensure that they support such scenarios.
-JSON object
+## B.2 Providing manual hints
-Any additional parameter that the provider supports (check the documentation of the provider for more details).
+To improve the user experience and further assist the user in configuring a given property, you can provide additional meta-data that:
-B.1.4 Repeated meta-data items
-It is perfectly acceptable for “property” and “group” objects with the same name to appear multiple times within a meta-data file. For example, you could bind two separate classes to the same prefix, with each potentially offering overlap of property names. While this is not supposed to be a frequent scenario, consumers of meta-data should take care to ensure that they support such scenarios.
+1. Describes the list of potential values for a property.
+2. Associates a provider to attach a well-defined semantic to a property so that a tool can discover the list of potential values based on the project’s context.
-B.2 Providing manual hints
-To improve the user experience and further assist the user in configuring a given property, you can provide additional meta-data that:
+### B.2.1 Value hint
-Describes the list of potential values for a property.
-Associates a provider to attach a well-defined semantic to a property so that a tool can discover the list of potential values based on the project’s context.
-B.2.1 Value hint
-The name attribute of each hint refers to the name of a property. In the initial example above, we provide 5 values for the spring.jpa.hibernate.ddl-auto property: none, validate, update, create and create-drop. Each value may have a description as well.
+The `name` attribute of each hint refers to the `name` of a property. In the initial example above, we provide 5 values for the `spring.jpa.hibernate.ddl-auto`property: `none`, `validate`, `update`, `create` and `create-drop`. Each value may have a description as well.
-If your property is of type Map, you can provide hints for both the keys and the values (but not for the map itself). The special .keys and .values suffixes must be used to refer to the keys and the values respectively.
+If your property is of type `Map`, you can provide hints for both the keys and the values (but not for the map itself). The special `.keys` and `.values` suffixes must be used to refer to the keys and the values respectively.
-Let’s assume a foo.contexts that maps magic String values to an integer:
+Let’s assume a `foo.contexts` that maps magic String values to an integer:
+```
@ConfigurationProperties("foo")
public class FooProperties {
private Map contexts;
// getters and setters
}
-The magic values are foo and bar for instance. In order to offer additional content assistance for the keys, you could add the following to the manual meta-data of the module:
+```
+
+The magic values are foo and bar for instance. In order to offer additional content assistance for the keys, you could add the following to [the manual meta-data of the module](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/#configuration-metadata-additional-metadata):
+
+```
{"hints": [
{
"name": "foo.contexts.keys",
@@ -11549,52 +12883,45 @@ The magic values are foo and bar for instance. In order to offer additional cont
]
}
]}
-[Note]
-Of course, you should have an Enum for those two values instead. This is by far the most effective approach to auto-completion if your IDE supports it.
-B.2.2 Value provider
-Providers are a powerful way of attaching semantics to a property. We define in the section below the official providers that you can use for your own hints. Bare in mind however that your favorite IDE may implement some of these or none of them. It could eventually provide its own as well.
+```
-[Note]
-As this is a new feature, IDE vendors will have to catch up with this new feature.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| Of course, you should have an `Enum` for those two values instead. This is by far the most effective approach to auto-completion if your IDE supports it. |
-The table below summarizes the list of supported providers:
-
-Name Description
-any
-
-Permit any additional value to be provided.
-
-class-reference
-
-Auto-complete the classes available in the project. Usually constrained by a base class that is specified via the target parameter.
-
-handle-as
-
-Handle the property as if it was defined by the type defined via the mandatory target parameter.
-
-logger-name
+### B.2.2 Value provider
-Auto-complete valid logger names. Typically, package and class names available in the current project can be auto-completed.
+Providers are a powerful way of attaching semantics to a property. We define in the section below the official providers that you can use for your own hints. Bare in mind however that your favorite IDE may implement some of these or none of them. It could eventually provide its own as well.
-spring-bean-reference
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| As this is a new feature, IDE vendors will have to catch up with this new feature. |
-Auto-complete the available bean names in the current project. Usually constrained by a base class that is specified via the target parameter.
+The table below summarizes the list of supported providers:
-spring-profile-name
+| Name | Description |
+| ----------------------- | ------------------------------------------------------------ |
+| `any` | Permit any additional value to be provided. |
+| `class-reference` | Auto-complete the classes available in the project. Usually constrained by a base class that is specified via the `target` parameter. |
+| `handle-as` | Handle the property as if it was defined by the type defined via the mandatory `target` parameter. |
+| `logger-name` | Auto-complete valid logger names. Typically, package and class names available in the current project can be auto-completed. |
+| `spring-bean-reference` | Auto-complete the available bean names in the current project. Usually constrained by a base class that is specified via the `target` parameter. |
+| `spring-profile-name` | Auto-complete the available Spring profile names in the project. |
-Auto-complete the available Spring profile names in the project.
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| No more than one provider can be active for a given property but you can specify several providers if they can all manage the property *in some ways*. Make sure to place the most powerful provider first as the IDE must use the first one in the JSON section it can handle. If no provider for a given property is supported, no special content assistance is provided either. |
-[Tip]
-No more than one provider can be active for a given property but you can specify several providers if they can all manage the property in some ways. Make sure to place the most powerful provider first as the IDE must use the first one in the JSON section it can handle. If no provider for a given property is supported, no special content assistance is provided either.
+#### Any
-Any
-The any provider permits any additional values to be provided. Regular value validation based on the property type should be applied if this is supported.
+The **any** provider permits any additional values to be provided. Regular value validation based on the property type should be applied if this is supported.
This provider will be typically used if you have a list of values and any extra values are still to be considered as valid.
-The example below offers on and off as auto-completion values for system.state; any other value is also allowed:
+The example below offers `on` and `off` as auto-completion values for `system.state`; any other value is also allowed:
+```
{"hints": [
{
"name": "system.state",
@@ -11613,28 +12940,21 @@ The example below offers on and off as auto-completion values for system.state;
]
}
]}
-Class reference
-The class-reference provider auto-completes classes available in the project. This provider supports these parameters:
-
-Parameter Type Default value Description
-target
-
-String (Class)
-none
+```
-The fully qualified name of the class that should be assignable to the chosen value. Typically used to filter out non candidate classes. Note that this information can be provided by the type itself by exposing a class with the appropriate upper bound.
+#### Class reference
-concrete
+The **class-reference** provider auto-completes classes available in the project. This provider supports these parameters:
-boolean
+| Parameter | Type | Default value | Description |
+| ---------- | ----------------- | ------------- | ------------------------------------------------------------ |
+| `target` | `String`(`Class`) | *none* | The fully qualified name of the class that should be assignable to the chosen value. Typically used to filter out non candidate classes. Note that this information can be provided by the type itself by exposing a class with the appropriate upper bound. |
+| `concrete` | `boolean` | true | Specify if only concrete classes are to be considered as valid candidates. |
-true
-
-Specify if only concrete classes are to be considered as valid candidates.
-
-The meta-data snippet below corresponds to the standard server.jsp-servlet.class-name property that defines the JspServlet class name to use:
+The meta-data snippet below corresponds to the standard `server.jsp-servlet.class-name` property that defines the `JspServlet` class name to use:
+```
{"hints": [
{
"name": "server.jsp-servlet.class-name",
@@ -11648,30 +12968,32 @@ The meta-data snippet below corresponds to the standard server.jsp-servlet.class
]
}
]}
-Handle As
-The handle-as provider allows you to substitute the type of the property to a more high-level type. This typically happens when the property has a java.lang.String type because you don’t want your configuration classes to rely on classes that may not be on the classpath. This provider supports these parameters:
-Parameter Type Default value Description
-target
+```
-String (Class)
+#### Handle As
-none
+The **handle-as** provider allows you to substitute the type of the property to a more high-level type. This typically happens when the property has a `java.lang.String`type because you don’t want your configuration classes to rely on classes that may not be on the classpath. This provider supports these parameters:
-The fully qualified name of the type to consider for the property. This parameter is mandatory.
+| Parameter | Type | Default value | Description |
+| ---------- | ------------------ | ------------- | ------------------------------------------------------------ |
+| **target** | `String` (`Class`) | *none* | The fully qualified name of the type to consider for the property. This parameter is mandatory. |
The following types can be used:
-Any java.lang.Enum that lists the possible values for the property (By all means, try to define the property with the Enum type instead as no further hint should be required for the IDE to auto-complete the values).
-java.nio.charset.Charset: auto-completion of charset/encoding values (e.g. UTF-8)
-java.util.Locale: auto-completion of locales (e.g. en_US)
-org.springframework.util.MimeType: auto-completion of content type values (e.g. text/plain)
-org.springframework.core.io.Resource: auto-completion of Spring’s Resource abstraction to refer to a file on the filesystem or on the classpath. (e.g. classpath:/foo.properties)
-[Note]
-If multiple values can be provided, use a Collection or Array type to teach the IDE about it.
+- Any `java.lang.Enum` that lists the possible values for the property (By all means, try to define the property with the `Enum` type instead as no further hint should be required for the IDE to auto-complete the values).
+- `java.nio.charset.Charset`: auto-completion of charset/encoding values (e.g. `UTF-8`)
+- `java.util.Locale`: auto-completion of locales (e.g. `en_US`)
+- `org.springframework.util.MimeType`: auto-completion of content type values (e.g. `text/plain`)
+- `org.springframework.core.io.Resource`: auto-completion of Spring’s Resource abstraction to refer to a file on the filesystem or on the classpath. (e.g. `classpath:/foo.properties`)
-The meta-data snippet below corresponds to the standard liquibase.change-log property that defines the path to the changelog to use. It is actually used internally as a org.springframework.core.io.Resource but cannot be exposed as such as we need to keep the original String value to pass it to the Liquibase API.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If multiple values can be provided, use a `Collection` or *Array* type to teach the IDE about it. |
+The meta-data snippet below corresponds to the standard `liquibase.change-log` property that defines the path to the changelog to use. It is actually used internally as a `org.springframework.core.io.Resource` but cannot be exposed as such as we need to keep the original String value to pass it to the Liquibase API.
+
+```
{"hints": [
{
"name": "liquibase.change-log",
@@ -11685,13 +13007,18 @@ The meta-data snippet below corresponds to the standard liquibase.change-log pro
]
}
]}
-Logger name
-The logger-name provider auto-completes valid logger names. Typically, package and class names available in the current project can be auto-completed. Specific frameworks may have extra magic logger names that could be supported as well.
+
+```
+
+#### Logger name
+
+The **logger-name** provider auto-completes valid logger names. Typically, package and class names available in the current project can be auto-completed. Specific frameworks may have extra magic logger names that could be supported as well.
Since a logger name can be any arbitrary name, really, this provider should allow any value but could highlight valid packages and class names that are not available in the project’s classpath.
-The meta-data snippet below corresponds to the standard logging.level property, keys are logger names and values correspond to the standard log levels or any custom level:
+The meta-data snippet below corresponds to the standard `logging.level` property, keys are *logger names* and values correspond to the standard log levels or any custom level:
+```
{"hints": [
{
"name": "logging.level.keys",
@@ -11740,20 +13067,20 @@ The meta-data snippet below corresponds to the standard logging.level property,
]
}
]}
-Spring bean reference
-The spring-bean-reference provider auto-completes the beans that are defined in the configuration of the current project. This provider supports these parameters:
-Parameter Type Default value Description
-target
+```
-String (Class)
+#### Spring bean reference
-none
+The **spring-bean-reference** provider auto-completes the beans that are defined in the configuration of the current project. This provider supports these parameters:
-The fully qualified name of the bean class that should be assignable to the candidate. Typically used to filter out non candidate beans.
+| Parameter | Type | Default value | Description |
+| --------- | ----------------- | ------------- | ------------------------------------------------------------ |
+| `target` | `String`(`Class`) | *none* | The fully qualified name of the bean class that should be assignable to the candidate. Typically used to filter out non candidate beans. |
-The meta-data snippet below corresponds to the standard spring.jmx.server property that defines the name of the MBeanServer bean to use:
+The meta-data snippet below corresponds to the standard `spring.jmx.server` property that defines the name of the `MBeanServer` bean to use:
+```
{"hints": [
{
"name": "spring.jmx.server",
@@ -11767,14 +13094,20 @@ The meta-data snippet below corresponds to the standard spring.jmx.server proper
]
}
]}
-[Note]
-The binder is not aware of the meta-data so if you provide that hint, you will still need to transform the bean name into an actual Bean reference using the ApplicationContext.
-Spring profile name
-The spring-profile-name provider auto-completes the Spring profiles that are defined in the configuration of the current project.
+```
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| The binder is not aware of the meta-data so if you provide that hint, you will still need to transform the bean name into an actual Bean reference using the `ApplicationContext`. |
+
+#### Spring profile name
-The meta-data snippet below corresponds to the standard spring.profiles.active property that defines the name of the Spring profile(s) to enable:
+The **spring-profile-name** provider auto-completes the Spring profiles that are defined in the configuration of the current project.
+The meta-data snippet below corresponds to the standard `spring.profiles.active` property that defines the name of the Spring profile(s) to enable:
+
+```
{"hints": [
{
"name": "spring.profiles.active",
@@ -11785,44 +13118,54 @@ The meta-data snippet below corresponds to the standard spring.profiles.active p
]
}
]}
-B.3 Generating your own meta-data using the annotation processor
-You can easily generate your own configuration meta-data file from items annotated with @ConfigurationProperties by using the spring-boot-configuration-processor jar. The jar includes a Java annotation processor which is invoked as your project is compiled. To use the processor, simply include spring-boot-configuration-processor as an optional dependency, for example with Maven you would add:
+```
+
+## B.3 Generating your own meta-data using the annotation processor
+
+You can easily generate your own configuration meta-data file from items annotated with `@ConfigurationProperties` by using the `spring-boot-configuration-processor` jar. The jar includes a Java annotation processor which is invoked as your project is compiled. To use the processor, simply include `spring-boot-configuration-processor` as an optional dependency, for example with Maven you would add:
+
+```
org.springframework.boot
spring-boot-configuration-processor
true
-With Gradle, you can use the propdeps-plugin and specify:
+```
+
+With Gradle, you can use the [propdeps-plugin](https://github.com/spring-gradle-plugins/propdeps-plugin) and specify:
+
+```
dependencies {
optional "org.springframework.boot:spring-boot-configuration-processor"
}
compileJava.dependsOn(processResources)
-[Note]
-You need to add compileJava.dependsOn(processResources) to your build to ensure that resources are processed before code is compiled. Without this directive any additional-spring-configuration-metadata.json files will not be processed.
-The processor will pick up both classes and methods that are annotated with @ConfigurationProperties. The Javadoc for field values within configuration classes will be used to populate the description attribute.
+```
-[Note]
-You should only use simple text with @ConfigurationProperties field Javadoc since they are not processed before being added to the JSON.
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You need to add `compileJava.dependsOn(processResources)` to your build to ensure that resources are processed before code is compiled. Without this directive any `additional-spring-configuration-metadata.json` files will not be processed. |
-Properties are discovered via the presence of standard getters and setters with special handling for collection types (that will be detected even if only a getter is present). The annotation processor also supports the use of the @Data, @Getter and @Setter lombok annotations.
+The processor will pick up both classes and methods that are annotated with `@ConfigurationProperties`. The Javadoc for field values within configuration classes will be used to populate the `description` attribute.
-[Note]
-If you are using AspectJ in your project, you need to make sure that the annotation processor only runs once. There are several ways to do this: with Maven, you can configure the maven-apt-plugin explicitly and add the dependency to the annotation processor only there. You could also let the AspectJ plugin run all the processing and disable annotation processing in the maven-compiler-plugin configuration:
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You should only use simple text with `@ConfigurationProperties` field Javadoc since they are not processed before being added to the JSON. |
+
+Properties are discovered via the presence of standard getters and setters with special handling for collection types (that will be detected even if only a getter is present). The annotation processor also supports the use of the `@Data`, `@Getter` and `@Setter` lombok annotations.
+
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| If you are using AspectJ in your project, you need to make sure that the annotation processor only runs once. There are several ways to do this: with Maven, you can configure the `maven-apt-plugin` explicitly and add the dependency to the annotation processor only there. You could also let the AspectJ plugin run all the processing and disable annotation processing in the `maven-compiler-plugin` configuration:` org.apache.maven.plugins maven-compiler-plugin none ` |
+
+### B.3.1 Nested properties
-
- org.apache.maven.plugins
- maven-compiler-plugin
-
- none
-
-
-B.3.1 Nested properties
The annotation processor will automatically consider inner classes as nested properties. For example, the following class:
+```
@ConfigurationProperties(prefix="server")
public class ServerProperties {
@@ -11843,4059 +13186,925 @@ public class ServerProperties {
}
}
-Will produce meta-data information for server.name, server.host.ip and server.host.port properties. You can use the @NestedConfigurationProperty annotation on a field to indicate that a regular (non-inner) class should be treated as if it were nested.
-
-[Tip]
-This has no effect on collections and maps as those types are automatically identified and a single meta-data property is generated for each of them.
-
-B.3.2 Adding additional meta-data
-Spring Boot’s configuration file handling is quite flexible; and it is often the case that properties may exist that are not bound to a @ConfigurationProperties bean. You may also need to tune some attributes of an existing key. To support such cases and allow you to provide custom "hints", the annotation processor will automatically merge items from META-INF/additional-spring-configuration-metadata.json into the main meta-data file.
-
-If you refer to a property that has been detected automatically, the description, default value and deprecation information are overridden if specified. If the manual property declaration is not identified in the current module, it is added as a brand new property.
-
-The format of the additional-spring-configuration-metadata.json file is exactly the same as the regular spring-configuration-metadata.json. The additional properties file is optional, if you don’t have any additional properties, simply don’t add it.
-
-Appendix C. Auto-configuration classes
-Here is a list of all auto-configuration classes provided by Spring Boot with links to documentation and source code. Remember to also look at the autoconfig report in your application for more details of which features are switched on. (start the app with --debug or -Ddebug, or in an Actuator application use the autoconfig endpoint).
-
-C.1 From the “spring-boot-autoconfigure” module
-The following auto-configuration classes are from the spring-boot-autoconfigure module:
-
-Configuration Class Links
-ActiveMQAutoConfiguration
-
-javadoc
-
-AopAutoConfiguration
-
-javadoc
-
-ArtemisAutoConfiguration
-
-javadoc
-
-BatchAutoConfiguration
-
-javadoc
-
-CacheAutoConfiguration
-
-javadoc
-
-CassandraAutoConfiguration
-
-javadoc
-
-CassandraDataAutoConfiguration
-
-javadoc
-
-CassandraRepositoriesAutoConfiguration
-
-javadoc
-
-CloudAutoConfiguration
-
-javadoc
-
-ConfigurationPropertiesAutoConfiguration
-
-javadoc
-
-CouchbaseAutoConfiguration
-
-javadoc
-
-CouchbaseDataAutoConfiguration
-
-javadoc
-
-CouchbaseRepositoriesAutoConfiguration
-
-javadoc
-
-DataSourceAutoConfiguration
-
-javadoc
-
-DataSourceTransactionManagerAutoConfiguration
-
-javadoc
-
-DeviceDelegatingViewResolverAutoConfiguration
-
-javadoc
-
-DeviceResolverAutoConfiguration
-
-javadoc
-
-DispatcherServletAutoConfiguration
-
-javadoc
-
-ElasticsearchAutoConfiguration
-
-javadoc
-
-ElasticsearchDataAutoConfiguration
-
-javadoc
-
-ElasticsearchRepositoriesAutoConfiguration
-
-javadoc
-
-EmbeddedLdapAutoConfiguration
-
-javadoc
-
-EmbeddedMongoAutoConfiguration
-
-javadoc
-
-EmbeddedServletContainerAutoConfiguration
-
-javadoc
-
-ErrorMvcAutoConfiguration
-
-javadoc
-
-FacebookAutoConfiguration
-
-javadoc
-
-FallbackWebSecurityAutoConfiguration
-
-javadoc
-
-FlywayAutoConfiguration
-
-javadoc
-
-FreeMarkerAutoConfiguration
-
-javadoc
-
-GroovyTemplateAutoConfiguration
-
-javadoc
-
-GsonAutoConfiguration
-
-javadoc
-
-H2ConsoleAutoConfiguration
-
-javadoc
-
-HazelcastAutoConfiguration
-
-javadoc
-
-HazelcastJpaDependencyAutoConfiguration
-
-javadoc
-
-HibernateJpaAutoConfiguration
-
-javadoc
-
-HttpEncodingAutoConfiguration
-
-javadoc
-
-HttpMessageConvertersAutoConfiguration
-
-javadoc
-
-HypermediaAutoConfiguration
-
-javadoc
-
-IntegrationAutoConfiguration
-
-javadoc
-
-JacksonAutoConfiguration
-
-javadoc
-
-JdbcTemplateAutoConfiguration
-
-javadoc
-
-JerseyAutoConfiguration
-
-javadoc
-
-JestAutoConfiguration
-
-javadoc
-
-JmsAutoConfiguration
-javadoc
+```
-JmxAutoConfiguration
+Will produce meta-data information for `server.name`, `server.host.ip` and `server.host.port` properties. You can use the `@NestedConfigurationProperty` annotation on a field to indicate that a regular (non-inner) class should be treated as if it were nested.
-javadoc
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| This has no effect on collections and maps as those types are automatically identified and a single meta-data property is generated for each of them. |
-JndiConnectionFactoryAutoConfiguration
+### B.3.2 Adding additional meta-data
-javadoc
+Spring Boot’s configuration file handling is quite flexible; and it is often the case that properties may exist that are not bound to a `@ConfigurationProperties` bean. You may also need to tune some attributes of an existing key. To support such cases and allow you to provide custom "hints", the annotation processor will automatically merge items from `META-INF/additional-spring-configuration-metadata.json` into the main meta-data file.
-JndiDataSourceAutoConfiguration
-
-javadoc
-
-JooqAutoConfiguration
-
-javadoc
-
-JpaRepositoriesAutoConfiguration
-
-javadoc
-
-JtaAutoConfiguration
-
-javadoc
-
-KafkaAutoConfiguration
-
-javadoc
-
-LdapAutoConfiguration
-
-javadoc
-
-LdapDataAutoConfiguration
-
-javadoc
-
-LdapRepositoriesAutoConfiguration
-
-javadoc
-
-LinkedInAutoConfiguration
-
-javadoc
-
-LiquibaseAutoConfiguration
-
-javadoc
-
-MailSenderAutoConfiguration
-
-javadoc
-
-MailSenderValidatorAutoConfiguration
-
-javadoc
-
-MessageSourceAutoConfiguration
-
-javadoc
-
-MongoAutoConfiguration
-
-javadoc
-
-MongoDataAutoConfiguration
-
-javadoc
-
-MongoRepositoriesAutoConfiguration
-
-javadoc
-
-MultipartAutoConfiguration
-
-javadoc
-
-MustacheAutoConfiguration
-
-javadoc
-
-Neo4jDataAutoConfiguration
-
-javadoc
-
-Neo4jRepositoriesAutoConfiguration
-
-javadoc
-
-OAuth2AutoConfiguration
-
-javadoc
-
-PersistenceExceptionTranslationAutoConfiguration
-
-javadoc
-
-ProjectInfoAutoConfiguration
-
-javadoc
-
-PropertyPlaceholderAutoConfiguration
-
-javadoc
-
-RabbitAutoConfiguration
-
-javadoc
-
-ReactorAutoConfiguration
-
-javadoc
-
-RedisAutoConfiguration
-
-javadoc
-
-RedisRepositoriesAutoConfiguration
-
-javadoc
-
-RepositoryRestMvcAutoConfiguration
-
-javadoc
-
-SecurityAutoConfiguration
-
-javadoc
-
-SecurityFilterAutoConfiguration
-
-javadoc
-
-SendGridAutoConfiguration
-
-javadoc
+If you refer to a property that has been detected automatically, the description, default value and deprecation information are overridden if specified. If the manual property declaration is not identified in the current module, it is added as a brand new property.
-ServerPropertiesAutoConfiguration
+The format of the `additional-spring-configuration-metadata.json` file is exactly the same as the regular `spring-configuration-metadata.json`. The additional properties file is optional, if you don’t have any additional properties, simply don’t add it.
+
+## Appendix C. Auto-configuration classes
+
+Here is a list of all auto-configuration classes provided by Spring Boot with links to documentation and source code. Remember to also look at the autoconfig report in your application for more details of which features are switched on. (start the app with `--debug` or `-Ddebug`, or in an Actuator application use the `autoconfig`endpoint).
+
+## C.1 From the “spring-boot-autoconfigure” module
+
+The following auto-configuration classes are from the `spring-boot-autoconfigure` module:
+
+| Configuration Class | Links |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [`ActiveMQAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jms/activemq/ActiveMQAutoConfiguration.html) |
+| [`AopAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/aop/AopAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/aop/AopAutoConfiguration.html) |
+| [`ArtemisAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/artemis/ArtemisAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jms/artemis/ArtemisAutoConfiguration.html) |
+| [`BatchAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/batch/BatchAutoConfiguration.html) |
+| [`CacheAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cache/CacheAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/cache/CacheAutoConfiguration.html) |
+| [`CassandraAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cassandra/CassandraAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/cassandra/CassandraAutoConfiguration.html) |
+| [`CassandraDataAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/cassandra/CassandraDataAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/cassandra/CassandraDataAutoConfiguration.html) |
+| [`CassandraRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/cassandra/CassandraRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/cassandra/CassandraRepositoriesAutoConfiguration.html) |
+| [`CloudAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/cloud/CloudAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/cloud/CloudAutoConfiguration.html) |
+| [`ConfigurationPropertiesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/ConfigurationPropertiesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/context/ConfigurationPropertiesAutoConfiguration.html) |
+| [`CouchbaseAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/couchbase/CouchbaseAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/couchbase/CouchbaseAutoConfiguration.html) |
+| [`CouchbaseDataAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/couchbase/CouchbaseDataAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/couchbase/CouchbaseDataAutoConfiguration.html) |
+| [`CouchbaseRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/couchbase/CouchbaseRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/couchbase/CouchbaseRepositoriesAutoConfiguration.html) |
+| [`DataSourceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jdbc/DataSourceAutoConfiguration.html) |
+| [`DataSourceTransactionManagerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/DataSourceTransactionManagerAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jdbc/DataSourceTransactionManagerAutoConfiguration.html) |
+| [`DeviceDelegatingViewResolverAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mobile/DeviceDelegatingViewResolverAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mobile/DeviceDelegatingViewResolverAutoConfiguration.html) |
+| [`DeviceResolverAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mobile/DeviceResolverAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mobile/DeviceResolverAutoConfiguration.html) |
+| [`DispatcherServletAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/DispatcherServletAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/DispatcherServletAutoConfiguration.html) |
+| [`ElasticsearchAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchAutoConfiguration.html) |
+| [`ElasticsearchDataAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchDataAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchDataAutoConfiguration.html) |
+| [`ElasticsearchRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/elasticsearch/ElasticsearchRepositoriesAutoConfiguration.html) |
+| [`EmbeddedLdapAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/ldap/embedded/EmbeddedLdapAutoConfiguration.html) |
+| [`EmbeddedMongoAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mongo/embedded/EmbeddedMongoAutoConfiguration.html) |
+| [`EmbeddedServletContainerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/EmbeddedServletContainerAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/EmbeddedServletContainerAutoConfiguration.html) |
+| [`ErrorMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ErrorMvcAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/ErrorMvcAutoConfiguration.html) |
+| [`FacebookAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/FacebookAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/social/FacebookAutoConfiguration.html) |
+| [`FallbackWebSecurityAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/FallbackWebSecurityAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/security/FallbackWebSecurityAutoConfiguration.html) |
+| [`FlywayAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/flyway/FlywayAutoConfiguration.html) |
+| [`FreeMarkerAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/freemarker/FreeMarkerAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/freemarker/FreeMarkerAutoConfiguration.html) |
+| [`GroovyTemplateAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/groovy/template/GroovyTemplateAutoConfiguration.html) |
+| [`GsonAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/gson/GsonAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/gson/GsonAutoConfiguration.html) |
+| [`H2ConsoleAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/h2/H2ConsoleAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/h2/H2ConsoleAutoConfiguration.html) |
+| [`HazelcastAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/hazelcast/HazelcastAutoConfiguration.html) |
+| [`HazelcastJpaDependencyAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hazelcast/HazelcastJpaDependencyAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/hazelcast/HazelcastJpaDependencyAutoConfiguration.html) |
+| [`HibernateJpaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/orm/jpa/HibernateJpaAutoConfiguration.html) |
+| [`HttpEncodingAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/HttpEncodingAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/HttpEncodingAutoConfiguration.html) |
+| [`HttpMessageConvertersAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/HttpMessageConvertersAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/HttpMessageConvertersAutoConfiguration.html) |
+| [`HypermediaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/hateoas/HypermediaAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/hateoas/HypermediaAutoConfiguration.html) |
+| [`IntegrationAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/integration/IntegrationAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/integration/IntegrationAutoConfiguration.html) |
+| [`JacksonAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jackson/JacksonAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jackson/JacksonAutoConfiguration.html) |
+| [`JdbcTemplateAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jdbc/JdbcTemplateAutoConfiguration.html) |
+| [`JerseyAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jersey/JerseyAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jersey/JerseyAutoConfiguration.html) |
+| [`JestAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/elasticsearch/jest/JestAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/elasticsearch/jest/JestAutoConfiguration.html) |
+| [`JmsAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JmsAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jms/JmsAutoConfiguration.html) |
+| [`JmxAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jmx/JmxAutoConfiguration.html) |
+| [`JndiConnectionFactoryAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jms/JndiConnectionFactoryAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jms/JndiConnectionFactoryAutoConfiguration.html) |
+| [`JndiDataSourceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/JndiDataSourceAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jdbc/JndiDataSourceAutoConfiguration.html) |
+| [`JooqAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jooq/JooqAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jooq/JooqAutoConfiguration.html) |
+| [`JpaRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/jpa/JpaRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/jpa/JpaRepositoriesAutoConfiguration.html) |
+| [`JtaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/jta/JtaAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/transaction/jta/JtaAutoConfiguration.html) |
+| [`KafkaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/kafka/KafkaAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/kafka/KafkaAutoConfiguration.html) |
+| [`LdapAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/ldap/LdapAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/ldap/LdapAutoConfiguration.html) |
+| [`LdapDataAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/ldap/LdapDataAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/ldap/LdapDataAutoConfiguration.html) |
+| [`LdapRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/ldap/LdapRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/ldap/LdapRepositoriesAutoConfiguration.html) |
+| [`LinkedInAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/LinkedInAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/social/LinkedInAutoConfiguration.html) |
+| [`LiquibaseAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/liquibase/LiquibaseAutoConfiguration.html) |
+| [`MailSenderAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailSenderAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mail/MailSenderAutoConfiguration.html) |
+| [`MailSenderValidatorAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mail/MailSenderValidatorAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mail/MailSenderValidatorAutoConfiguration.html) |
+| [`MessageSourceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/MessageSourceAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/context/MessageSourceAutoConfiguration.html) |
+| [`MongoAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mongo/MongoAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mongo/MongoAutoConfiguration.html) |
+| [`MongoDataAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/mongo/MongoDataAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/mongo/MongoDataAutoConfiguration.html) |
+| [`MongoRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/mongo/MongoRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/mongo/MongoRepositoriesAutoConfiguration.html) |
+| [`MultipartAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/MultipartAutoConfiguration.html) |
+| [`MustacheAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mustache/MustacheAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mustache/MustacheAutoConfiguration.html) |
+| [`Neo4jDataAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jDataAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/neo4j/Neo4jDataAutoConfiguration.html) |
+| [`Neo4jRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/neo4j/Neo4jRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/neo4j/Neo4jRepositoriesAutoConfiguration.html) |
+| [`OAuth2AutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/oauth2/OAuth2AutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/security/oauth2/OAuth2AutoConfiguration.html) |
+| [`PersistenceExceptionTranslationAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/dao/PersistenceExceptionTranslationAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/dao/PersistenceExceptionTranslationAutoConfiguration.html) |
+| [`ProjectInfoAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/info/ProjectInfoAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/info/ProjectInfoAutoConfiguration.html) |
+| [`PropertyPlaceholderAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/context/PropertyPlaceholderAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/context/PropertyPlaceholderAutoConfiguration.html) |
+| [`RabbitAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.html) |
+| [`ReactorAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/reactor/ReactorAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/reactor/ReactorAutoConfiguration.html) |
+| [`RedisAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/redis/RedisAutoConfiguration.html) |
+| [`RedisRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/redis/RedisRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/redis/RedisRepositoriesAutoConfiguration.html) |
+| [`RepositoryRestMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/rest/RepositoryRestMvcAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/rest/RepositoryRestMvcAutoConfiguration.html) |
+| [`SecurityAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/security/SecurityAutoConfiguration.html) |
+| [`SecurityFilterAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/security/SecurityFilterAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/security/SecurityFilterAutoConfiguration.html) |
+| [`SendGridAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/sendgrid/SendGridAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/sendgrid/SendGridAutoConfiguration.html) |
+| [`ServerPropertiesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/ServerPropertiesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/ServerPropertiesAutoConfiguration.html) |
+| [`SessionAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/session/SessionAutoConfiguration.html) |
+| [`SitePreferenceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/mobile/SitePreferenceAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/mobile/SitePreferenceAutoConfiguration.html) |
+| [`SocialWebAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/SocialWebAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/social/SocialWebAutoConfiguration.html) |
+| [`SolrAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/solr/SolrAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/solr/SolrAutoConfiguration.html) |
+| [`SolrRepositoriesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/solr/SolrRepositoriesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/solr/SolrRepositoriesAutoConfiguration.html) |
+| [`SpringApplicationAdminJmxAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/admin/SpringApplicationAdminJmxAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/admin/SpringApplicationAdminJmxAutoConfiguration.html) |
+| [`SpringDataWebAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/data/web/SpringDataWebAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/data/web/SpringDataWebAutoConfiguration.html) |
+| [`ThymeleafAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/thymeleaf/ThymeleafAutoConfiguration.html) |
+| [`TransactionAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/transaction/TransactionAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/transaction/TransactionAutoConfiguration.html) |
+| [`TwitterAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/social/TwitterAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/social/TwitterAutoConfiguration.html) |
+| [`ValidationAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/validation/ValidationAutoConfiguration.html) |
+| [`WebClientAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebClientAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/WebClientAutoConfiguration.html) |
+| [`WebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/web/WebMvcAutoConfiguration.html) |
+| [`WebServicesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/webservices/WebServicesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/webservices/WebServicesAutoConfiguration.html) |
+| [`WebSocketAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/websocket/WebSocketAutoConfiguration.html) |
+| [`WebSocketMessagingAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/websocket/WebSocketMessagingAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/websocket/WebSocketMessagingAutoConfiguration.html) |
+| [`XADataSourceAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/jdbc/XADataSourceAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/autoconfigure/jdbc/XADataSourceAutoConfiguration.html) |
+
+## C.2 From the “spring-boot-actuator” module
+
+The following auto-configuration classes are from the `spring-boot-actuator` module:
+
+| Configuration Class | Links |
+| ------------------------------------------------------------ | ------------------------------------------------------------ |
+| [`AuditAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/AuditAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/AuditAutoConfiguration.html) |
+| [`CacheStatisticsAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CacheStatisticsAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/CacheStatisticsAutoConfiguration.html) |
+| [`CloudFoundryActuatorAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/cloudfoundry/CloudFoundryActuatorAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/cloudfoundry/CloudFoundryActuatorAutoConfiguration.html) |
+| [`CrshAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/CrshAutoConfiguration.html) |
+| [`EndpointAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/EndpointAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/EndpointAutoConfiguration.html) |
+| [`EndpointMBeanExportAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/EndpointMBeanExportAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/EndpointMBeanExportAutoConfiguration.html) |
+| [`EndpointWebMvcAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/EndpointWebMvcAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/EndpointWebMvcAutoConfiguration.html) |
+| [`HealthIndicatorAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/HealthIndicatorAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/HealthIndicatorAutoConfiguration.html) |
+| [`InfoContributorAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/InfoContributorAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/InfoContributorAutoConfiguration.html) |
+| [`JolokiaAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/JolokiaAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/JolokiaAutoConfiguration.html) |
+| [`ManagementServerPropertiesAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementServerPropertiesAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/ManagementServerPropertiesAutoConfiguration.html) |
+| [`ManagementWebSecurityAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/ManagementWebSecurityAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/ManagementWebSecurityAutoConfiguration.html) |
+| [`MetricExportAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricExportAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/MetricExportAutoConfiguration.html) |
+| [`MetricFilterAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricFilterAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/MetricFilterAutoConfiguration.html) |
+| [`MetricRepositoryAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/MetricRepositoryAutoConfiguration.html) |
+| [`MetricsChannelAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricsChannelAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/MetricsChannelAutoConfiguration.html) |
+| [`MetricsDropwizardAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/MetricsDropwizardAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/MetricsDropwizardAutoConfiguration.html) |
+| [`PublicMetricsAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/PublicMetricsAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/PublicMetricsAutoConfiguration.html) |
+| [`TraceRepositoryAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/TraceRepositoryAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/TraceRepositoryAutoConfiguration.html) |
+| [`TraceWebFilterAutoConfiguration`](https://github.com/spring-projects/spring-boot/tree/1.5.x/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/autoconfigure/TraceWebFilterAutoConfiguration.java) | [javadoc](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/api/org/springframework/boot/actuate/autoconfigure/TraceWebFilterAutoConfiguration.html) |
+
+## Appendix D. Test auto-configuration annotations
+
+Here is a table of the various `@…Test` annotations that can be used to test slices of your application and the auto-configuration that they import by default:
+
+| Test slice | Imported auto-configuration |
+| ----------------- | ------------------------------------------------------------ |
+| `@DataJpaTest` | `org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration``org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration``org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration``org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration``org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration``org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration``org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration``org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration``org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration``org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration``org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManagerAutoConfiguration` |
+| `@DataMongoTest` | `org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration``org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration``org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration``org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration``org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration` |
+| `@JdbcTest` | `org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration``org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration``org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration``org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration``org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration``org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration``org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration``org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration` |
+| `@JsonTest` | `org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration``org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration``org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration``org.springframework.boot.test.autoconfigure.json.JsonTestersAutoConfiguration` |
+| `@RestClientTest` | `org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration``org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration``org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration``org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration``org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration``org.springframework.boot.test.autoconfigure.web.client.MockRestServiceServerAutoConfiguration``org.springframework.boot.test.autoconfigure.web.client.WebClientRestTemplateAutoConfiguration` |
+| `@WebMvcTest` | `org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration``org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration``org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration``org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration``org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration``org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration``org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration``org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration``org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration``org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration``org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration``org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration``org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration``org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration``org.springframework.boot.test.autoconfigure.web.servlet.MockMvcAutoConfiguration``org.springframework.boot.test.autoconfigure.web.servlet.MockMvcSecurityAutoConfiguration``org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebClientAutoConfiguration``org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebDriverAutoConfiguration` |
+
+## Appendix E. The executable jar format
+
+The `spring-boot-loader` modules allows Spring Boot to support executable jar and war files. If you’re using the Maven or Gradle plugin, executable jars are automatically generated and you generally won’t need to know the details of how they work.
-javadoc
+If you need to create executable jars from a different build system, or if you are just curious about the underlying technology, this section provides some background.
-SessionAutoConfiguration
+## E.1 Nested JARs
-javadoc
+Java does not provide any standard way to load nested jar files (i.e. jar files that are themselves contained within a jar). This can be problematic if you are looking to distribute a self-contained application that you can just run from the command line without unpacking.
-SitePreferenceAutoConfiguration
+To solve this problem, many developers use “shaded” jars. A shaded jar simply packages all classes, from all jars, into a single 'uber jar'. The problem with shaded jars is that it becomes hard to see which libraries you are actually using in your application. It can also be problematic if the same filename is used (but with different content) in multiple jars. Spring Boot takes a different approach and allows you to actually nest jars directly.
-javadoc
+### E.1.1 The executable jar file structure
-SocialWebAutoConfiguration
+Spring Boot Loader compatible jar files should be structured in the following way:
-javadoc
+```
+example.jar
+ |
+ +-META-INF
+ | +-MANIFEST.MF
+ +-org
+ | +-springframework
+ | +-boot
+ | +-loader
+ | +-
+ +-BOOT-INF
+ +-classes
+ | +-mycompany
+ | +-project
+ | +-YourClasses.class
+ +-lib
+ +-dependency1.jar
+ +-dependency2.jar
-SolrAutoConfiguration
+```
-javadoc
+Application classes should be placed in a nested `BOOT-INF/classes` directory. Dependencies should be placed in a nested `BOOT-INF/lib` directory.
-SolrRepositoriesAutoConfiguration
+### E.1.2 The executable war file structure
-javadoc
+Spring Boot Loader compatible war files should be structured in the following way:
-SpringApplicationAdminJmxAutoConfiguration
+```
+example.war
+ |
+ +-META-INF
+ | +-MANIFEST.MF
+ +-org
+ | +-springframework
+ | +-boot
+ | +-loader
+ | +-
+ +-WEB-INF
+ +-classes
+ | +-com
+ | +-mycompany
+ | +-project
+ | +-YourClasses.class
+ +-lib
+ | +-dependency1.jar
+ | +-dependency2.jar
+ +-lib-provided
+ +-servlet-api.jar
+ +-dependency3.jar
-javadoc
+```
-SpringDataWebAutoConfiguration
+Dependencies should be placed in a nested `WEB-INF/lib` directory. Any dependencies that are required when running embedded but are not required when deploying to a traditional web container should be placed in `WEB-INF/lib-provided`.
-javadoc
+## E.2 Spring Boot’s “JarFile” class
-ThymeleafAutoConfiguration
+The core class used to support loading nested jars is `org.springframework.boot.loader.jar.JarFile`. It allows you to load jar content from a standard jar file, or from nested child jar data. When first loaded, the location of each `JarEntry` is mapped to a physical file offset of the outer jar:
-javadoc
+```
+myapp.jar
++-------------------+-------------------------+
+| /BOOT-INF/classes | /BOOT-INF/lib/mylib.jar |
+|+-----------------+||+-----------+----------+|
+|| A.class ||| B.class | C.class ||
+|+-----------------+||+-----------+----------+|
++-------------------+-------------------------+
+ ^ ^ ^
+ 0063 3452 3980
-TransactionAutoConfiguration
+```
-javadoc
+The example above shows how `A.class` can be found in `/BOOT-INF/classes` in `myapp.jar` position `0063`. `B.class` from the nested jar can actually be found in `myapp.jar` position `3452` and `C.class` is at position `3980`.
-TwitterAutoConfiguration
+Armed with this information, we can load specific nested entries by simply seeking to the appropriate part of the outer jar. We don’t need to unpack the archive and we don’t need to read all entry data into memory.
-javadoc
+### E.2.1 Compatibility with the standard Java “JarFile”
-ValidationAutoConfiguration
+Spring Boot Loader strives to remain compatible with existing code and libraries. `org.springframework.boot.loader.jar.JarFile` extends from `java.util.jar.JarFile` and should work as a drop-in replacement. The `getURL()` method will return a `URL` that opens a `java.net.JarURLConnection`compatible connection and can be used with Java’s `URLClassLoader`.
-javadoc
+## E.3 Launching executable jars
-WebClientAutoConfiguration
+The `org.springframework.boot.loader.Launcher` class is a special bootstrap class that is used as an executable jars main entry point. It is the actual `Main-Class` in your jar file and it’s used to setup an appropriate `URLClassLoader` and ultimately call your `main()` method.
-javadoc
+There are 3 launcher subclasses (`JarLauncher`, `WarLauncher` and `PropertiesLauncher`). Their purpose is to load resources (`.class` files etc.) from nested jar files or war files in directories (as opposed to explicitly on the classpath). In the case of `JarLauncher` and `WarLauncher` the nested paths are fixed. `JarLauncher` looks in `BOOT-INF/lib/` and `WarLauncher` looks in `WEB-INF/lib/` and `WEB-INF/lib-provided/` so you just add extra jars in those locations if you want more. The `PropertiesLauncher` looks in `BOOT-INF/lib/` in your application archive by default, but you can add additional locations by setting an environment variable `LOADER_PATH` or `loader.path` in `loader.properties` (comma-separated list of directories, archives, or directories within archives).
-WebMvcAutoConfiguration
+### E.3.1 Launcher manifest
-javadoc
+You need to specify an appropriate `Launcher` as the `Main-Class` attribute of `META-INF/MANIFEST.MF`. The actual class that you want to launch (i.e. the class that you wrote that contains a `main` method) should be specified in the `Start-Class` attribute.
-WebServicesAutoConfiguration
+For example, here is a typical `MANIFEST.MF` for an executable jar file:
-javadoc
+```
+Main-Class: org.springframework.boot.loader.JarLauncher
+Start-Class: com.mycompany.project.MyApplication
-WebSocketAutoConfiguration
+```
-javadoc
+For a war file, it would be:
-WebSocketMessagingAutoConfiguration
+```
+Main-Class: org.springframework.boot.loader.WarLauncher
+Start-Class: com.mycompany.project.MyApplication
-javadoc
+```
-XADataSourceAutoConfiguration
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| You do not need to specify `Class-Path` entries in your manifest file, the classpath will be deduced from the nested jars. |
-javadoc
+### E.3.2 Exploded archives
-C.2 From the “spring-boot-actuator” module
-The following auto-configuration classes are from the spring-boot-actuator module:
+Certain PaaS implementations may choose to unpack archives before they run. For example, Cloud Foundry operates in this way. You can run an unpacked archive by simply starting the appropriate launcher:
-Configuration Class Links
-AuditAutoConfiguration
+```
+$ unzip -q myapp.jar
+$ java org.springframework.boot.loader.JarLauncher
-javadoc
+```
-CacheStatisticsAutoConfiguration
+## E.4 PropertiesLauncher Features
-javadoc
+`PropertiesLauncher` has a few special features that can be enabled with external properties (System properties, environment variables, manifest entries or`loader.properties`).
-CloudFoundryActuatorAutoConfiguration
+| ![[Note]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/note.png) |
+| ------------------------------------------------------------ |
+| `PropertiesLauncher` supports loading properties from `loader.properties` and also (for historic reasons) `application.properties`. We recommend using `loader.properties` exclusively, as support for `application.properties` is deprecated and may be removed in the future. |
-javadoc
+| Key | Purpose |
+| ------------------------ | ------------------------------------------------------------ |
+| `loader.path` | Comma-separated Classpath, e.g. `lib,${HOME}/app/lib`. Earlier entries take precedence, just like a regular `-classpath`on the `javac` command line. |
+| `loader.home` | Used to resolve relative paths in `loader.path`. E.g. `loader.path=lib` then `${loader.home}/lib` is a classpath location (along with all jar files in that directory). Also used to locate a `loader.properties` file. Example `/opt/app` (defaults to `${user.dir}`). |
+| `loader.args` | Default arguments for the main method (space separated) |
+| `loader.main` | Name of main class to launch, e.g. `com.app.Application`. |
+| `loader.config.name` | Name of properties file, e.g. `launcher` (defaults to `loader`). |
+| `loader.config.location` | Path to properties file, e.g. `classpath:loader.properties` (defaults to `loader.properties`). |
+| `loader.system` | Boolean flag to indicate that all properties should be added to System properties (defaults to `false`) |
-CrshAutoConfiguration
+When specified as environment variables or manifest entries, the following names should be used:
-javadoc
+| Key | Manifest entry | Environment variable |
+| ------------------------ | ------------------------ | ------------------------ |
+| `loader.path` | `Loader-Path` | `LOADER_PATH` |
+| `loader.home` | `Loader-Home` | `LOADER_HOME` |
+| `loader.args` | `Loader-Args` | `LOADER_ARGS` |
+| `loader.main` | `Start-Class` | `LOADER_MAIN` |
+| `loader.config.location` | `Loader-Config-Location` | `LOADER_CONFIG_LOCATION` |
+| `loader.system` | `Loader-System` | `LOADER_SYSTEM` |
+
+| ![[Tip]](https://docs.spring.io/spring-boot/docs/1.5.7.BUILD-SNAPSHOT/reference/htmlsingle/images/tip.png) |
+| ------------------------------------------------------------ |
+| Build plugins automatically move the `Main-Class` attribute to `Start-Class` when the fat jar is built. If you are using that, specify the name of the class to launch using the `Main-Class` attribute and leave out `Start-Class`. |
+
+- `loader.properties` are searched for in `loader.home` then in the root of the classpath, then in `classpath:/BOOT-INF/classes`. The first location that exists is used.
+- `loader.home` is only the directory location of an additional properties file (overriding the default) as long as `loader.config.location` is not specified.
+- `loader.path` can contain directories (scanned recursively for jar and zip files), archive paths, a directory within an archive that is scanned for jar files (for example, `dependencies.jar!/lib`), or wildcard patterns (for the default JVM behavior). Archive paths can be relative to `loader.home`, or anywhere in the file system with a `jar:file:` prefix.
+- `loader.path` (if empty) defaults to `BOOT-INF/lib` (meaning a local directory or a nested one if running from an archive). Because of this `PropertiesLauncher` behaves the same as `JarLauncher` when no additional configuration is provided.
+- `loader.path` can not be used to configure the location of `loader.properties` (the classpath used to search for the latter is the JVM classpath when `PropertiesLauncher` is launched).
+- Placeholder replacement is done from System and environment variables plus the properties file itself on all values before use.
+- The search order for properties (where it makes sense to look in more than one place) is env vars, system properties, `loader.properties`, exploded archive manifest, archive manifest.
+
+## E.5 Executable jar restrictions
-EndpointAutoConfiguration
+There are a number of restrictions that you need to consider when working with a Spring Boot Loader packaged application.
-javadoc
+### E.5.1 Zip entry compression
-EndpointMBeanExportAutoConfiguration
+The `ZipEntry` for a nested jar must be saved using the `ZipEntry.STORED` method. This is required so that we can seek directly to individual content within the nested jar. The content of the nested jar file itself can still be compressed, as can any other entries in the outer jar.
-javadoc
+### E.5.2 System ClassLoader
-EndpointWebMvcAutoConfiguration
+Launched applications should use `Thread.getContextClassLoader()` when loading classes (most libraries and frameworks will do this by default). Trying to load nested jar classes via `ClassLoader.getSystemClassLoader()` will fail. Please be aware that `java.util.Logging` always uses the system classloader, for this reason you should consider a different logging implementation.
-javadoc
+## E.6 Alternative single jar solutions
-HealthIndicatorAutoConfiguration
+If the above restrictions mean that you cannot use Spring Boot Loader the following alternatives could be considered:
-javadoc
+- [Maven Shade Plugin](https://maven.apache.org/plugins/maven-shade-plugin/)
+- [JarClassLoader](http://www.jdotsoft.com/JarClassLoader.php)
+- [OneJar](http://one-jar.sourceforge.net/)
-InfoContributorAutoConfiguration
+## Appendix F. Dependency versions
-javadoc
-
-JolokiaAutoConfiguration
-
-javadoc
-
-ManagementServerPropertiesAutoConfiguration
-
-javadoc
-
-ManagementWebSecurityAutoConfiguration
-
-javadoc
-
-MetricExportAutoConfiguration
-
-javadoc
-
-MetricFilterAutoConfiguration
-
-javadoc
-
-MetricRepositoryAutoConfiguration
-
-javadoc
-
-MetricsChannelAutoConfiguration
-
-javadoc
-
-MetricsDropwizardAutoConfiguration
-
-javadoc
-
-PublicMetricsAutoConfiguration
-
-javadoc
-
-TraceRepositoryAutoConfiguration
-
-javadoc
-
-TraceWebFilterAutoConfiguration
-
-javadoc
-
-Appendix D. Test auto-configuration annotations
-Here is a table of the various @…Test annotations that can be used to test slices of your application and the auto-configuration that they import by default:
-
-Test slice Imported auto-configuration
-@DataJpaTest
-
-org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration org.springframework.boot.autoconfigure.orm.jpa.HibernateJpaAutoConfiguration org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration org.springframework.boot.test.autoconfigure.orm.jpa.TestEntityManagerAutoConfiguration
-
-@DataMongoTest
-
-org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration org.springframework.boot.autoconfigure.data.mongo.MongoDataAutoConfiguration org.springframework.boot.autoconfigure.data.mongo.MongoRepositoriesAutoConfiguration org.springframework.boot.autoconfigure.mongo.MongoAutoConfiguration org.springframework.boot.autoconfigure.mongo.embedded.EmbeddedMongoAutoConfiguration
-
-@JdbcTest
-
-org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration org.springframework.boot.autoconfigure.flyway.FlywayAutoConfiguration org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration org.springframework.boot.autoconfigure.jdbc.DataSourceTransactionManagerAutoConfiguration org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration org.springframework.boot.autoconfigure.liquibase.LiquibaseAutoConfiguration org.springframework.boot.autoconfigure.transaction.TransactionAutoConfiguration org.springframework.boot.test.autoconfigure.jdbc.TestDatabaseAutoConfiguration
-
-@JsonTest
-
-org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration org.springframework.boot.test.autoconfigure.json.JsonTestersAutoConfiguration
-
-@RestClientTest
-
-org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration org.springframework.boot.autoconfigure.web.WebClientAutoConfiguration org.springframework.boot.test.autoconfigure.web.client.MockRestServiceServerAutoConfiguration org.springframework.boot.test.autoconfigure.web.client.WebClientRestTemplateAutoConfiguration
-
-@WebMvcTest
-
-org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration org.springframework.boot.autoconfigure.freemarker.FreeMarkerAutoConfiguration org.springframework.boot.autoconfigure.groovy.template.GroovyTemplateAutoConfiguration org.springframework.boot.autoconfigure.gson.GsonAutoConfiguration org.springframework.boot.autoconfigure.hateoas.HypermediaAutoConfiguration org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration org.springframework.boot.autoconfigure.mustache.MustacheAutoConfiguration org.springframework.boot.autoconfigure.thymeleaf.ThymeleafAutoConfiguration org.springframework.boot.autoconfigure.validation.ValidationAutoConfiguration org.springframework.boot.autoconfigure.web.ErrorMvcAutoConfiguration org.springframework.boot.autoconfigure.web.HttpMessageConvertersAutoConfiguration org.springframework.boot.autoconfigure.web.ServerPropertiesAutoConfiguration org.springframework.boot.autoconfigure.web.WebMvcAutoConfiguration org.springframework.boot.test.autoconfigure.web.servlet.MockMvcAutoConfiguration org.springframework.boot.test.autoconfigure.web.servlet.MockMvcSecurityAutoConfiguration org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebClientAutoConfiguration org.springframework.boot.test.autoconfigure.web.servlet.MockMvcWebDriverAutoConfiguration
-
-Appendix E. The executable jar format
-The spring-boot-loader modules allows Spring Boot to support executable jar and war files. If you’re using the Maven or Gradle plugin, executable jars are automatically generated and you generally won’t need to know the details of how they work.
-
-If you need to create executable jars from a different build system, or if you are just curious about the underlying technology, this section provides some background.
-
-E.1 Nested JARs
-Java does not provide any standard way to load nested jar files (i.e. jar files that are themselves contained within a jar). This can be problematic if you are looking to distribute a self-contained application that you can just run from the command line without unpacking.
-
-To solve this problem, many developers use “shaded” jars. A shaded jar simply packages all classes, from all jars, into a single 'uber jar'. The problem with shaded jars is that it becomes hard to see which libraries you are actually using in your application. It can also be problematic if the same filename is used (but with different content) in multiple jars. Spring Boot takes a different approach and allows you to actually nest jars directly.
-
-E.1.1 The executable jar file structure
-Spring Boot Loader compatible jar files should be structured in the following way:
-
-example.jar
- |
- +-META-INF
- | +-MANIFEST.MF
- +-org
- | +-springframework
- | +-boot
- | +-loader
- | +-
- +-BOOT-INF
- +-classes
- | +-mycompany
- | +-project
- | +-YourClasses.class
- +-lib
- +-dependency1.jar
- +-dependency2.jar
-Application classes should be placed in a nested BOOT-INF/classes directory. Dependencies should be placed in a nested BOOT-INF/lib directory.
-
-E.1.2 The executable war file structure
-Spring Boot Loader compatible war files should be structured in the following way:
-
-example.war
- |
- +-META-INF
- | +-MANIFEST.MF
- +-org
- | +-springframework
- | +-boot
- | +-loader
- | +-
- +-WEB-INF
- +-classes
- | +-com
- | +-mycompany
- | +-project
- | +-YourClasses.class
- +-lib
- | +-dependency1.jar
- | +-dependency2.jar
- +-lib-provided
- +-servlet-api.jar
- +-dependency3.jar
-Dependencies should be placed in a nested WEB-INF/lib directory. Any dependencies that are required when running embedded but are not required when deploying to a traditional web container should be placed in WEB-INF/lib-provided.
-
-E.2 Spring Boot’s “JarFile” class
-The core class used to support loading nested jars is org.springframework.boot.loader.jar.JarFile. It allows you to load jar content from a standard jar file, or from nested child jar data. When first loaded, the location of each JarEntry is mapped to a physical file offset of the outer jar:
-
-myapp.jar
-+-------------------+-------------------------+
-| /BOOT-INF/classes | /BOOT-INF/lib/mylib.jar |
-|+-----------------+||+-----------+----------+|
-|| A.class ||| B.class | C.class ||
-|+-----------------+||+-----------+----------+|
-+-------------------+-------------------------+
- ^ ^ ^
- 0063 3452 3980
-The example above shows how A.class can be found in /BOOT-INF/classes in myapp.jar position 0063. B.class from the nested jar can actually be found in myapp.jar position 3452 and C.class is at position 3980.
-
-Armed with this information, we can load specific nested entries by simply seeking to the appropriate part of the outer jar. We don’t need to unpack the archive and we don’t need to read all entry data into memory.
-
-E.2.1 Compatibility with the standard Java “JarFile”
-Spring Boot Loader strives to remain compatible with existing code and libraries. org.springframework.boot.loader.jar.JarFile extends from java.util.jar.JarFile and should work as a drop-in replacement. The getURL() method will return a URL that opens a java.net.JarURLConnection compatible connection and can be used with Java’s URLClassLoader.
-
-E.3 Launching executable jars
-The org.springframework.boot.loader.Launcher class is a special bootstrap class that is used as an executable jars main entry point. It is the actual Main-Class in your jar file and it’s used to setup an appropriate URLClassLoader and ultimately call your main() method.
-
-There are 3 launcher subclasses (JarLauncher, WarLauncher and PropertiesLauncher). Their purpose is to load resources (.class files etc.) from nested jar files or war files in directories (as opposed to explicitly on the classpath). In the case of JarLauncher and WarLauncher the nested paths are fixed. JarLauncher looks in BOOT-INF/lib/ and WarLauncher looks in WEB-INF/lib/ and WEB-INF/lib-provided/ so you just add extra jars in those locations if you want more. The PropertiesLauncher looks in BOOT-INF/lib/ in your application archive by default, but you can add additional locations by setting an environment variable LOADER_PATH or loader.path in loader.properties (comma-separated list of directories, archives, or directories within archives).
-
-E.3.1 Launcher manifest
-You need to specify an appropriate Launcher as the Main-Class attribute of META-INF/MANIFEST.MF. The actual class that you want to launch (i.e. the class that you wrote that contains a main method) should be specified in the Start-Class attribute.
-
-For example, here is a typical MANIFEST.MF for an executable jar file:
-
-Main-Class: org.springframework.boot.loader.JarLauncher
-Start-Class: com.mycompany.project.MyApplication
-For a war file, it would be:
-
-Main-Class: org.springframework.boot.loader.WarLauncher
-Start-Class: com.mycompany.project.MyApplication
-[Note]
-You do not need to specify Class-Path entries in your manifest file, the classpath will be deduced from the nested jars.
-
-E.3.2 Exploded archives
-Certain PaaS implementations may choose to unpack archives before they run. For example, Cloud Foundry operates in this way. You can run an unpacked archive by simply starting the appropriate launcher:
-
-$ unzip -q myapp.jar
-$ java org.springframework.boot.loader.JarLauncher
-E.4 PropertiesLauncher Features
-PropertiesLauncher has a few special features that can be enabled with external properties (System properties, environment variables, manifest entries or loader.properties).
-
-[Note]
-PropertiesLauncher supports loading properties from loader.properties and also (for historic reasons) application.properties. We recommend using loader.properties exclusively, as support for application.properties is deprecated and may be removed in the future.
-
-Key Purpose
-loader.path
-
-Comma-separated Classpath, e.g. lib,${HOME}/app/lib. Earlier entries take precedence, just like a regular -classpath on the javac command line.
-
-loader.home
-
-Used to resolve relative paths in loader.path. E.g. loader.path=lib then ${loader.home}/lib is a classpath location (along with all jar files in that directory). Also used to locate a loader.properties file. Example /opt/app (defaults to ${user.dir}).
-
-loader.args
-
-Default arguments for the main method (space separated)
-
-loader.main
-
-Name of main class to launch, e.g. com.app.Application.
-
-loader.config.name
-
-Name of properties file, e.g. launcher (defaults to loader).
-
-loader.config.location
-
-Path to properties file, e.g. classpath:loader.properties (defaults to loader.properties).
-
-loader.system
-
-Boolean flag to indicate that all properties should be added to System properties (defaults to false)
-
-When specified as environment variables or manifest entries, the following names should be used:
-
-Key Manifest entry Environment variable
-loader.path
-
-Loader-Path
-
-LOADER_PATH
-
-loader.home
-
-Loader-Home
-
-LOADER_HOME
-
-loader.args
-
-Loader-Args
-
-LOADER_ARGS
-
-loader.main
-
-Start-Class
-
-LOADER_MAIN
-
-loader.config.location
-
-Loader-Config-Location
-
-LOADER_CONFIG_LOCATION
-
-loader.system
-
-Loader-System
-
-LOADER_SYSTEM
-
-[Tip]
-Build plugins automatically move the Main-Class attribute to Start-Class when the fat jar is built. If you are using that, specify the name of the class to launch using the Main-Class attribute and leave out Start-Class.
-
-loader.properties are searched for in loader.home then in the root of the classpath, then in classpath:/BOOT-INF/classes. The first location that exists is used.
-loader.home is only the directory location of an additional properties file (overriding the default) as long as loader.config.location is not specified.
-loader.path can contain directories (scanned recursively for jar and zip files), archive paths, a directory within an archive that is scanned for jar files (for example, dependencies.jar!/lib), or wildcard patterns (for the default JVM behavior). Archive paths can be relative to loader.home, or anywhere in the file system with a jar:file: prefix.
-loader.path (if empty) defaults to BOOT-INF/lib (meaning a local directory or a nested one if running from an archive). Because of this PropertiesLauncher behaves the same as JarLauncher when no additional configuration is provided.
-loader.path can not be used to configure the location of loader.properties (the classpath used to search for the latter is the JVM classpath when PropertiesLauncher is launched).
-Placeholder replacement is done from System and environment variables plus the properties file itself on all values before use.
-The search order for properties (where it makes sense to look in more than one place) is env vars, system properties, loader.properties, exploded archive manifest, archive manifest.
-E.5 Executable jar restrictions
-There are a number of restrictions that you need to consider when working with a Spring Boot Loader packaged application.
-
-E.5.1 Zip entry compression
-The ZipEntry for a nested jar must be saved using the ZipEntry.STORED method. This is required so that we can seek directly to individual content within the nested jar. The content of the nested jar file itself can still be compressed, as can any other entries in the outer jar.
-
-E.5.2 System ClassLoader
-Launched applications should use Thread.getContextClassLoader() when loading classes (most libraries and frameworks will do this by default). Trying to load nested jar classes via ClassLoader.getSystemClassLoader() will fail. Please be aware that java.util.Logging always uses the system classloader, for this reason you should consider a different logging implementation.
-
-E.6 Alternative single jar solutions
-If the above restrictions mean that you cannot use Spring Boot Loader the following alternatives could be considered:
-
-Maven Shade Plugin
-JarClassLoader
-OneJar
-Appendix F. Dependency versions
The table below provides details of all of the dependency versions that are provided by Spring Boot in its CLI, Maven dependency management and Gradle plugin. When you declare a dependency on one of these artifacts without declaring a version the version that is listed in the table will be used.
-Group ID Artifact ID Version
-antlr
-
-antlr
-
-2.7.7
-
-ch.qos.logback
-
-logback-access
-
-1.1.11
-
-ch.qos.logback
-
-logback-classic
-
-1.1.11
-
-ch.qos.logback
-
-logback-core
-
-1.1.11
-
-com.atomikos
-
-transactions-jdbc
-
-3.9.3
-
-com.atomikos
-
-transactions-jms
-
-3.9.3
-
-com.atomikos
-
-transactions-jta
-
-3.9.3
-
-com.couchbase.client
-
-couchbase-spring-cache
-
-2.1.0
-
-com.couchbase.client
-
-java-client
-
-2.3.7
-
-com.datastax.cassandra
-
-cassandra-driver-core
-
-3.1.4
-
-com.datastax.cassandra
-
-cassandra-driver-mapping
-
-3.1.4
-
-com.fasterxml
-
-classmate
-
-1.3.4
-
-com.fasterxml.jackson.core
-
-jackson-annotations
-
-2.8.0
-
-com.fasterxml.jackson.core
-
-jackson-core
-
-2.8.10
-
-com.fasterxml.jackson.core
-
-jackson-databind
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-avro
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-cbor
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-csv
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-ion
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-properties
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-protobuf
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-smile
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-xml
-
-2.8.10
-
-com.fasterxml.jackson.dataformat
-
-jackson-dataformat-yaml
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-guava
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-hibernate3
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-hibernate4
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-hibernate5
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-hppc
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-jaxrs
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-jdk8
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-joda
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-json-org
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-jsr310
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-jsr353
-
-2.8.10
-
-com.fasterxml.jackson.datatype
-
-jackson-datatype-pcollections
-
-2.8.10
-
-com.fasterxml.jackson.jaxrs
-
-jackson-jaxrs-base
-
-2.8.10
-
-com.fasterxml.jackson.jaxrs
-
-jackson-jaxrs-cbor-provider
-
-2.8.10
-
-com.fasterxml.jackson.jaxrs
-
-jackson-jaxrs-json-provider
-
-2.8.10
-
-com.fasterxml.jackson.jaxrs
-
-jackson-jaxrs-smile-provider
-
-2.8.10
-
-com.fasterxml.jackson.jaxrs
-
-jackson-jaxrs-xml-provider
-
-2.8.10
-
-com.fasterxml.jackson.jaxrs
-
-jackson-jaxrs-yaml-provider
-
-2.8.10
-
-com.fasterxml.jackson.jr
-
-jackson-jr-all
-
-2.8.10
-
-com.fasterxml.jackson.jr
-
-jackson-jr-objects
-
-2.8.10
-
-com.fasterxml.jackson.jr
-
-jackson-jr-retrofit2
-
-2.8.10
-
-com.fasterxml.jackson.jr
-
-jackson-jr-stree
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-afterburner
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-guice
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-jaxb-annotations
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-jsonSchema
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-kotlin
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-mrbean
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-osgi
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-parameter-names
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-paranamer
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-scala_2.10
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-scala_2.11
-
-2.8.10
-
-com.fasterxml.jackson.module
-
-jackson-module-scala_2.12
-
-2.8.10
-
-com.gemstone.gemfire
-
-gemfire
-
-8.2.4
-
-com.github.ben-manes.caffeine
-
-caffeine
-
-2.3.5
-
-com.github.mxab.thymeleaf.extras
-
-thymeleaf-extras-data-attribute
-
-1.3
-
-com.google.appengine
-
-appengine-api-1.0-sdk
-
-1.9.56
-
-com.google.code.gson
-
-gson
-
-2.8.1
-
-com.googlecode.json-simple
-
-json-simple
-
-1.1.1
-
-com.h2database
-
-h2
-
-1.4.196
-
-com.hazelcast
-
-hazelcast
-
-3.7.8
-
-com.hazelcast
-
-hazelcast-client
-
-3.7.8
-
-com.hazelcast
-
-hazelcast-hibernate4
-
-3.7.1
-
-com.hazelcast
-
-hazelcast-hibernate5
-
-1.1.3
-
-com.hazelcast
-
-hazelcast-spring
-
-3.7.8
-
-com.jayway.jsonpath
-
-json-path
-
-2.2.0
-
-com.jayway.jsonpath
-
-json-path-assert
-
-2.2.0
-
-com.microsoft.sqlserver
-
-mssql-jdbc
-
-6.1.0.jre7
-
-com.querydsl
-
-querydsl-apt
-
-4.1.4
-
-com.querydsl
-
-querydsl-collections
-
-4.1.4
-
-com.querydsl
-
-querydsl-core
-
-4.1.4
-
-com.querydsl
-
-querydsl-jpa
-
-4.1.4
-
-com.querydsl
-
-querydsl-mongodb
-
-4.1.4
-
-com.samskivert
-
-jmustache
-
-1.13
-
-com.sendgrid
-
-sendgrid-java
-
-2.2.2
-
-com.sun.mail
-
-javax.mail
-
-1.5.6
-
-com.timgroup
-
-java-statsd-client
-
-3.1.0
-
-com.unboundid
-
-unboundid-ldapsdk
-
-3.2.1
-
-com.zaxxer
-
-HikariCP
-
-2.5.1
-
-com.zaxxer
-
-HikariCP-java6
-
-2.3.13
-
-com.zaxxer
-
-HikariCP-java7
-
-2.4.13
-
-commons-beanutils
-
-commons-beanutils
-
-1.9.3
-
-commons-codec
-
-commons-codec
-
-1.10
-
-commons-collections
-
-commons-collections
-
-3.2.2
-
-commons-dbcp
-
-commons-dbcp
-
-1.4
-
-commons-digester
-
-commons-digester
-
-2.1
-
-commons-pool
-
-commons-pool
-
-1.6
-
-de.flapdoodle.embed
-
-de.flapdoodle.embed.mongo
-
-1.50.5
-
-dom4j
-
-dom4j
-
-1.6.1
-
-io.dropwizard.metrics
-
-metrics-core
-
-3.1.5
-
-io.dropwizard.metrics
-
-metrics-ganglia
-
-3.1.5
-
-io.dropwizard.metrics
-
-metrics-graphite
-
-3.1.5
-
-io.dropwizard.metrics
-
-metrics-servlets
-
-3.1.5
-
-io.projectreactor
-
-reactor-bus
-
-2.0.8.RELEASE
-
-io.projectreactor
-
-reactor-core
-
-2.0.8.RELEASE
-
-io.projectreactor
-
-reactor-groovy
-
-2.0.8.RELEASE
-
-io.projectreactor
-
-reactor-groovy-extensions
-
-2.0.8.RELEASE
-
-io.projectreactor
-
-reactor-logback
-
-2.0.8.RELEASE
-
-io.projectreactor
-
-reactor-net
-
-2.0.8.RELEASE
-
-io.projectreactor
-
-reactor-stream
-
-2.0.8.RELEASE
-
-io.projectreactor.spring
-
-reactor-spring-context
-
-2.0.7.RELEASE
-
-io.projectreactor.spring
-
-reactor-spring-core
-
-2.0.7.RELEASE
-
-io.projectreactor.spring
-
-reactor-spring-messaging
-
-2.0.7.RELEASE
-
-io.projectreactor.spring
-
-reactor-spring-webmvc
-
-2.0.7.RELEASE
-
-io.searchbox
-
-jest
-
-2.0.4
-
-io.undertow
-
-undertow-core
-
-1.4.20.Final
-
-io.undertow
-
-undertow-servlet
-
-1.4.20.Final
-
-io.undertow
-
-undertow-websockets-jsr
-
-1.4.20.Final
-
-javax.cache
-
-cache-api
-
-1.0.0
-
-javax.jms
-
-jms-api
-
-1.1-rev-1
-
-javax.mail
-
-javax.mail-api
-
-1.5.6
-
-javax.servlet
-
-javax.servlet-api
-
-3.1.0
-
-javax.servlet
-
-jstl
-
-1.2
-
-javax.transaction
-
-javax.transaction-api
-
-1.2
-
-javax.validation
-
-validation-api
-
-1.1.0.Final
-
-jaxen
-
-jaxen
-
-1.1.6
-
-joda-time
-
-joda-time
-
-2.9.9
-
-junit
-
-junit
-
-4.12
-
-mysql
-
-mysql-connector-java
-
-5.1.44
-
-net.java.dev.jna
-
-jna
-
-4.2.2
-
-net.sf.ehcache
-
-ehcache
-
-2.10.4
-
-net.sourceforge.htmlunit
-
-htmlunit
-
-2.21
-
-net.sourceforge.jtds
-
-jtds
-
-1.3.1
-
-net.sourceforge.nekohtml
-
-nekohtml
-
-1.9.22
-
-nz.net.ultraq.thymeleaf
-
-thymeleaf-layout-dialect
-
-1.4.0
-
-org.apache.activemq
-
-activemq-amqp
-
-5.14.5
-
-org.apache.activemq
-
-activemq-blueprint
-
-5.14.5
-
-org.apache.activemq
-
-activemq-broker
-
-5.14.5
-
-org.apache.activemq
-
-activemq-camel
-
-5.14.5
-
-org.apache.activemq
-
-activemq-client
-
-5.14.5
-
-org.apache.activemq
-
-activemq-console
-
-5.14.5
-
-org.apache.activemq
-
-activemq-http
-
-5.14.5
-
-org.apache.activemq
-
-activemq-jaas
-
-5.14.5
-
-org.apache.activemq
-
-activemq-jdbc-store
-
-5.14.5
-
-org.apache.activemq
-
-activemq-jms-pool
-
-5.14.5
-
-org.apache.activemq
-
-activemq-kahadb-store
-
-5.14.5
-
-org.apache.activemq
-
-activemq-karaf
-
-5.14.5
-
-org.apache.activemq
-
-activemq-leveldb-store
-
-5.14.5
-
-org.apache.activemq
-
-activemq-log4j-appender
-
-5.14.5
-
-org.apache.activemq
-
-activemq-mqtt
-
-5.14.5
-
-org.apache.activemq
-
-activemq-openwire-generator
-
-5.14.5
-
-org.apache.activemq
-
-activemq-openwire-legacy
-
-5.14.5
-
-org.apache.activemq
-
-activemq-osgi
-
-5.14.5
-
-org.apache.activemq
-
-activemq-partition
-
-5.14.5
-
-org.apache.activemq
-
-activemq-pool
-
-5.14.5
-
-org.apache.activemq
-
-activemq-ra
-
-5.14.5
-
-org.apache.activemq
-
-activemq-run
-
-5.14.5
-
-org.apache.activemq
-
-activemq-runtime-config
-
-5.14.5
-
-org.apache.activemq
-
-activemq-shiro
-
-5.14.5
-
-org.apache.activemq
-
-activemq-spring
-
-5.14.5
-
-org.apache.activemq
-
-activemq-stomp
-
-5.14.5
-
-org.apache.activemq
-
-activemq-web
-
-5.14.5
-
-org.apache.activemq
-
-artemis-amqp-protocol
-
-1.5.5
-
-org.apache.activemq
-
-artemis-commons
-
-1.5.5
-
-org.apache.activemq
-
-artemis-core-client
-
-1.5.5
-
-org.apache.activemq
-
-artemis-jms-client
-
-1.5.5
-
-org.apache.activemq
-
-artemis-jms-server
-
-1.5.5
-
-org.apache.activemq
-
-artemis-journal
-
-1.5.5
-
-org.apache.activemq
-
-artemis-native
-
-1.5.5
-
-org.apache.activemq
-
-artemis-selector
-
-1.5.5
-
-org.apache.activemq
-
-artemis-server
-
-1.5.5
-
-org.apache.activemq
-
-artemis-service-extensions
-
-1.5.5
-
-org.apache.commons
-
-commons-dbcp2
-
-2.1.1
-
-org.apache.commons
-
-commons-pool2
-
-2.4.2
-
-org.apache.derby
-
-derby
-
-10.13.1.1
-
-org.apache.httpcomponents
-
-httpasyncclient
-
-4.1.3
-
-org.apache.httpcomponents
-
-httpclient
-
-4.5.3
-
-org.apache.httpcomponents
-
-httpcore
-
-4.4.6
-
-org.apache.httpcomponents
-
-httpmime
-
-4.5.3
-
-org.apache.logging.log4j
-
-log4j-1.2-api
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-api
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-api-scala_2.10
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-api-scala_2.11
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-core
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-flume-ng
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-iostreams
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-jcl
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-jmx-gui
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-jul
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-liquibase
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-nosql
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-slf4j-impl
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-taglib
-
-2.7
-
-org.apache.logging.log4j
-
-log4j-web
-
-2.7
-
-org.apache.solr
-
-solr-solrj
-
-5.5.4
-
-org.apache.tomcat
-
-tomcat-jdbc
-
-8.5.20
-
-org.apache.tomcat
-
-tomcat-jsp-api
-
-8.5.20
-
-org.apache.tomcat.embed
-
-tomcat-embed-core
-
-8.5.20
-
-org.apache.tomcat.embed
-
-tomcat-embed-el
-
-8.5.20
-
-org.apache.tomcat.embed
-
-tomcat-embed-jasper
-
-8.5.20
-
-org.apache.tomcat.embed
-
-tomcat-embed-websocket
-
-8.5.20
-
-org.aspectj
-
-aspectjrt
-
-1.8.10
-
-org.aspectj
-
-aspectjtools
-
-1.8.10
-
-org.aspectj
-
-aspectjweaver
-
-1.8.10
-
-org.assertj
-
-assertj-core
-
-2.6.0
-
-org.codehaus.btm
-
-btm
-
-2.1.4
-
-org.codehaus.groovy
-
-groovy
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-all
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-ant
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-bsf
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-console
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-docgenerator
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-groovydoc
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-groovysh
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-jmx
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-json
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-jsr223
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-nio
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-servlet
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-sql
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-swing
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-templates
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-test
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-testng
-
-2.4.12
-
-org.codehaus.groovy
-
-groovy-xml
-
-2.4.12
-
-org.codehaus.janino
-
-janino
-
-2.7.8
-
-org.crashub
-
-crash.cli
-
-1.3.2
-
-org.crashub
-
-crash.connectors.ssh
-
-1.3.2
-
-org.crashub
-
-crash.connectors.telnet
-
-1.3.2
-
-org.crashub
-
-crash.embed.spring
-
-1.3.2
-
-org.crashub
-
-crash.plugins.cron
-
-1.3.2
-
-org.crashub
-
-crash.plugins.mail
-
-1.3.2
-
-org.crashub
-
-crash.shell
-
-1.3.2
-
-org.eclipse.jetty
-
-apache-jsp
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-apache-jstl
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-annotations
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-client
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-continuation
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-deploy
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-http
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-http-spi
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-infinispan
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-io
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-jaas
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-jaspi
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-jmx
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-jndi
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-nosql
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-plus
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-proxy
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-quickstart
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-rewrite
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-runner
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-security
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-server
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-servlet
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-servlets
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-spring
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-start
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-util
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-util-ajax
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-webapp
-
-9.4.6.v20170531
-
-org.eclipse.jetty
-
-jetty-xml
-
-9.4.6.v20170531
-
-org.eclipse.jetty.http2
-
-http2-client
-
-9.4.6.v20170531
-
-org.eclipse.jetty.http2
-
-http2-common
-
-9.4.6.v20170531
-
-org.eclipse.jetty.http2
-
-http2-hpack
-
-9.4.6.v20170531
-
-org.eclipse.jetty.http2
-
-http2-server
-
-9.4.6.v20170531
-
-org.eclipse.jetty.orbit
-
-javax.servlet.jsp
-
-2.2.0.v201112011158
-
-org.eclipse.jetty.websocket
-
-javax-websocket-client-impl
-
-9.4.6.v20170531
-
-org.eclipse.jetty.websocket
-
-javax-websocket-server-impl
-
-9.4.6.v20170531
-
-org.eclipse.jetty.websocket
-
-websocket-client
-
-9.4.6.v20170531
-
-org.eclipse.jetty.websocket
-
-websocket-server
-
-9.4.6.v20170531
-
-org.eclipse.jetty.websocket
-
-websocket-servlet
-
-9.4.6.v20170531
-
-org.ehcache
-
-ehcache
-
-3.2.3
-
-org.ehcache
-
-ehcache-clustered
-
-3.2.3
-
-org.ehcache
-
-ehcache-transactions
-
-3.2.3
-
-org.elasticsearch
-
-elasticsearch
-
-2.4.6
-
-org.firebirdsql.jdbc
-
-jaybird-jdk16
-
-2.2.13
-
-org.firebirdsql.jdbc
-
-jaybird-jdk17
-
-2.2.13
-
-org.firebirdsql.jdbc
-
-jaybird-jdk18
-
-2.2.13
-
-org.flywaydb
-
-flyway-core
-
-3.2.1
-
-org.freemarker
-
-freemarker
-
-2.3.26-incubating
-
-org.glassfish
-
-javax.el
-
-3.0.0
-
-org.glassfish.jersey.bundles.repackaged
-
-jersey-guava
-
-2.25.1
-
-org.glassfish.jersey.containers
-
-jersey-container-servlet
-
-2.25.1
-
-org.glassfish.jersey.containers
-
-jersey-container-servlet-core
-
-2.25.1
-
-org.glassfish.jersey.core
-
-jersey-client
-
-2.25.1
-
-org.glassfish.jersey.core
-
-jersey-common
-
-2.25.1
-
-org.glassfish.jersey.core
-
-jersey-server
-
-2.25.1
-
-org.glassfish.jersey.ext
-
-jersey-bean-validation
-
-2.25.1
-
-org.glassfish.jersey.ext
-
-jersey-entity-filtering
-
-2.25.1
-
-org.glassfish.jersey.ext
-
-jersey-spring3
-
-2.25.1
-
-org.glassfish.jersey.media
-
-jersey-media-jaxb
-
-2.25.1
-
-org.glassfish.jersey.media
-
-jersey-media-json-jackson
-
-2.25.1
-
-org.glassfish.jersey.media
-
-jersey-media-multipart
-
-2.25.1
-
-org.hamcrest
-
-hamcrest-core
-
-1.3
-
-org.hamcrest
-
-hamcrest-library
-
-1.3
-
-org.hibernate
-
-hibernate-core
-
-5.0.12.Final
-
-org.hibernate
-
-hibernate-ehcache
-
-5.0.12.Final
-
-org.hibernate
-
-hibernate-entitymanager
-
-5.0.12.Final
-
-org.hibernate
-
-hibernate-envers
-
-5.0.12.Final
-
-org.hibernate
-
-hibernate-java8
-
-5.0.12.Final
-
-org.hibernate
-
-hibernate-jpamodelgen
-
-5.0.12.Final
-
-org.hibernate
-
-hibernate-validator
-
-5.3.5.Final
-
-org.hibernate
-
-hibernate-validator-annotation-processor
-
-5.3.5.Final
-
-org.hsqldb
-
-hsqldb
-
-2.3.5
-
-org.infinispan
-
-infinispan-jcache
-
-8.2.8.Final
-
-org.infinispan
-
-infinispan-spring4-common
-
-8.2.8.Final
-
-org.infinispan
-
-infinispan-spring4-embedded
-
-8.2.8.Final
-
-org.javassist
-
-javassist
-
-3.21.0-GA
-
-org.jboss
-
-jboss-transaction-spi
-
-7.6.0.Final
-
-org.jboss.logging
-
-jboss-logging
-
-3.3.1.Final
-
-org.jboss.narayana.jta
-
-jdbc
-
-5.5.30.Final
-
-org.jboss.narayana.jta
-
-jms
-
-5.5.30.Final
-
-org.jboss.narayana.jta
-
-jta
-
-5.5.30.Final
-
-org.jboss.narayana.jts
-
-narayana-jts-integration
-
-5.5.30.Final
-
-org.jdom
-
-jdom2
-
-2.0.6
-
-org.jolokia
-
-jolokia-core
-
-1.3.7
-
-org.jooq
-
-jooq
-
-3.9.5
-
-org.jooq
-
-jooq-codegen
-
-3.9.5
-
-org.jooq
-
-jooq-meta
-
-3.9.5
-
-org.json
-
-json
-
-20140107
-
-org.liquibase
-
-liquibase-core
-
-3.5.3
-
-org.mariadb.jdbc
-
-mariadb-java-client
-
-1.5.9
-
-org.mockito
-
-mockito-core
-
-1.10.19
-
-org.mongodb
-
-mongodb-driver
-
-3.4.3
-
-org.mongodb
-
-mongo-java-driver
-
-3.4.3
-
-org.mortbay.jasper
-
-apache-el
-
-8.0.33
-
-org.neo4j
-
-neo4j-ogm-api
-
-2.1.5
-
-org.neo4j
-
-neo4j-ogm-compiler
-
-2.1.5
-
-org.neo4j
-
-neo4j-ogm-core
-
-2.1.5
-
-org.neo4j
-
-neo4j-ogm-http-driver
-
-2.1.5
-
-org.postgresql
-
-postgresql
-
-9.4.1212.jre7
-
-org.projectlombok
-
-lombok
-
-1.16.18
-
-org.seleniumhq.selenium
-
-htmlunit-driver
-
-2.21
-
-org.seleniumhq.selenium
-
-selenium-api
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-chrome-driver
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-firefox-driver
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-ie-driver
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-java
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-remote-driver
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-safari-driver
-
-2.53.1
-
-org.seleniumhq.selenium
-
-selenium-support
-
-2.53.1
-
-org.skyscreamer
-
-jsonassert
-
-1.4.0
-
-org.slf4j
-
-jcl-over-slf4j
-
-1.7.25
-
-org.slf4j
-
-jul-to-slf4j
-
-1.7.25
-
-org.slf4j
-
-log4j-over-slf4j
-
-1.7.25
-
-org.slf4j
-
-slf4j-api
-
-1.7.25
-
-org.slf4j
-
-slf4j-jdk14
-
-1.7.25
-
-org.slf4j
-
-slf4j-log4j12
-
-1.7.25
-
-org.slf4j
-
-slf4j-simple
-
-1.7.25
-
-org.spockframework
-
-spock-core
-
-1.0-groovy-2.4
-
-org.spockframework
-
-spock-spring
-
-1.0-groovy-2.4
-
-org.springframework
-
-spring-aop
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-aspects
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-beans
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-context
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-context-support
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-core
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-expression
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-instrument
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-instrument-tomcat
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-jdbc
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-jms
-
-4.3.11.RELEASE
-
-org.springframework
-
-springloaded
-
-1.2.8.RELEASE
-
-org.springframework
-
-spring-messaging
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-orm
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-oxm
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-test
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-tx
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-web
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-webmvc
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-webmvc-portlet
-
-4.3.11.RELEASE
-
-org.springframework
-
-spring-websocket
-
-4.3.11.RELEASE
-
-org.springframework.amqp
-
-spring-amqp
-
-1.7.4.RELEASE
-
-org.springframework.amqp
-
-spring-rabbit
-
-1.7.4.RELEASE
-
-org.springframework.batch
-
-spring-batch-core
-
-3.0.8.RELEASE
-
-org.springframework.batch
-
-spring-batch-infrastructure
-
-3.0.8.RELEASE
-
-org.springframework.batch
-
-spring-batch-integration
-
-3.0.8.RELEASE
-
-org.springframework.batch
-
-spring-batch-test
-
-3.0.8.RELEASE
-
-org.springframework.boot
-
-spring-boot
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-actuator
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-actuator-docs
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-autoconfigure
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-autoconfigure-processor
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-configuration-metadata
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-configuration-processor
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-devtools
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-loader
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-loader-tools
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-activemq
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-actuator
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-amqp
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-aop
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-artemis
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-batch
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-cache
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-cloud-connectors
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-cassandra
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-couchbase
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-elasticsearch
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-gemfire
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-jpa
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-ldap
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-mongodb
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-neo4j
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-redis
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-rest
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-data-solr
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-freemarker
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-groovy-templates
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-hateoas
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-integration
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jdbc
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jersey
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jetty
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jooq
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jta-atomikos
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jta-bitronix
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-jta-narayana
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-log4j2
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-logging
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-mail
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-mobile
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-mustache
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-remote-shell
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-security
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-social-facebook
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-social-linkedin
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-social-twitter
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-test
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-thymeleaf
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-tomcat
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-undertow
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-validation
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-web
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-web-services
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-starter-websocket
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-test
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.boot
-
-spring-boot-test-autoconfigure
-
-1.5.7.BUILD-SNAPSHOT
-
-org.springframework.cloud
-
-spring-cloud-cloudfoundry-connector
-
-1.2.4.RELEASE
-
-org.springframework.cloud
-
-spring-cloud-core
-
-1.2.4.RELEASE
-
-org.springframework.cloud
-
-spring-cloud-heroku-connector
-
-1.2.4.RELEASE
-
-org.springframework.cloud
-
-spring-cloud-localconfig-connector
-
-1.2.4.RELEASE
-
-org.springframework.cloud
-
-spring-cloud-spring-service-connector
-
-1.2.4.RELEASE
-
-org.springframework.data
-
-spring-cql
-
-1.5.7.RELEASE
-
-org.springframework.data
-
-spring-data-cassandra
-
-1.5.7.RELEASE
-
-org.springframework.data
-
-spring-data-commons
-
-1.13.7.RELEASE
-
-org.springframework.data
-
-spring-data-couchbase
-
-2.2.7.RELEASE
-
-org.springframework.data
-
-spring-data-elasticsearch
-
-2.1.7.RELEASE
-
-org.springframework.data
-
-spring-data-envers
-
-1.1.7.RELEASE
-
-org.springframework.data
-
-spring-data-gemfire
-
-1.9.7.RELEASE
-
-org.springframework.data
-
-spring-data-jpa
-
-1.11.7.RELEASE
-
-org.springframework.data
-
-spring-data-keyvalue
-
-1.2.7.RELEASE
-
-org.springframework.data
-
-spring-data-ldap
-
-1.0.7.RELEASE
-
-org.springframework.data
-
-spring-data-mongodb
-
-1.10.7.RELEASE
-
-org.springframework.data
-
-spring-data-mongodb-cross-store
-
-1.10.7.RELEASE
-
-org.springframework.data
-
-spring-data-mongodb-log4j
-
-1.10.7.RELEASE
-
-org.springframework.data
-
-spring-data-neo4j
-
-4.2.7.RELEASE
-
-org.springframework.data
-
-spring-data-redis
-
-1.8.7.RELEASE
-
-org.springframework.data
-
-spring-data-rest-core
-
-2.6.7.RELEASE
-
-org.springframework.data
-
-spring-data-rest-hal-browser
-
-2.6.7.RELEASE
-
-org.springframework.data
-
-spring-data-rest-webmvc
-
-2.6.7.RELEASE
-
-org.springframework.data
-
-spring-data-solr
-
-2.1.7.RELEASE
-
-org.springframework.hateoas
-
-spring-hateoas
-
-0.23.0.RELEASE
-
-org.springframework.integration
-
-spring-integration-amqp
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-core
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-event
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-feed
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-file
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-ftp
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-gemfire
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-groovy
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-http
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-ip
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-java-dsl
-
-1.2.3.RELEASE
-
-org.springframework.integration
-
-spring-integration-jdbc
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-jms
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-jmx
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-jpa
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-mail
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-mongodb
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-mqtt
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-redis
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-rmi
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-scripting
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-security
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-sftp
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-stomp
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-stream
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-syslog
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-test
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-twitter
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-websocket
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-ws
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-xml
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-xmpp
-
-4.3.12.RELEASE
-
-org.springframework.integration
-
-spring-integration-zookeeper
-
-4.3.12.RELEASE
-
-org.springframework.kafka
-
-spring-kafka
-
-1.1.6.RELEASE
-
-org.springframework.kafka
-
-spring-kafka-test
-
-1.1.6.RELEASE
-
-org.springframework.ldap
-
-spring-ldap-core
-
-2.3.1.RELEASE
-
-org.springframework.ldap
-
-spring-ldap-core-tiger
-
-2.3.1.RELEASE
-
-org.springframework.ldap
-
-spring-ldap-ldif-batch
-
-2.3.1.RELEASE
-
-org.springframework.ldap
-
-spring-ldap-ldif-core
-
-2.3.1.RELEASE
-
-org.springframework.ldap
-
-spring-ldap-odm
-
-2.3.1.RELEASE
-
-org.springframework.ldap
-
-spring-ldap-test
-
-2.3.1.RELEASE
-
-org.springframework.mobile
-
-spring-mobile-device
-
-1.1.5.RELEASE
-
-org.springframework.plugin
-
-spring-plugin-core
-
-1.2.0.RELEASE
-
-org.springframework.plugin
-
-spring-plugin-metadata
-
-1.2.0.RELEASE
-
-org.springframework.restdocs
-
-spring-restdocs-core
-
-1.1.3.RELEASE
-
-org.springframework.restdocs
-
-spring-restdocs-mockmvc
-
-1.1.3.RELEASE
-
-org.springframework.restdocs
-
-spring-restdocs-restassured
-
-1.1.3.RELEASE
-
-org.springframework.retry
-
-spring-retry
-
-1.2.1.RELEASE
-
-org.springframework.security
-
-spring-security-acl
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-aspects
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-cas
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-config
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-core
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-crypto
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-data
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-jwt
-
-1.0.8.RELEASE
-
-org.springframework.security
-
-spring-security-ldap
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-messaging
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-openid
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-remoting
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-taglibs
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-test
-
-4.2.3.RELEASE
-
-org.springframework.security
-
-spring-security-web
-
-4.2.3.RELEASE
-
-org.springframework.security.oauth
-
-spring-security-oauth
-
-2.0.14.RELEASE
-
-org.springframework.security.oauth
-
-spring-security-oauth2
-
-2.0.14.RELEASE
-
-org.springframework.session
-
-spring-session
-
-1.3.1.RELEASE
-
-org.springframework.session
-
-spring-session-data-gemfire
-
-1.3.1.RELEASE
-
-org.springframework.session
-
-spring-session-data-mongo
-
-1.3.1.RELEASE
-
-org.springframework.session
-
-spring-session-data-redis
-
-1.3.1.RELEASE
-
-org.springframework.session
-
-spring-session-hazelcast
-
-1.3.1.RELEASE
-
-org.springframework.session
-
-spring-session-jdbc
-
-1.3.1.RELEASE
-
-org.springframework.social
-
-spring-social-config
-
-1.1.4.RELEASE
-
-org.springframework.social
-
-spring-social-core
-
-1.1.4.RELEASE
-
-org.springframework.social
-
-spring-social-facebook
-
-2.0.3.RELEASE
-
-org.springframework.social
-
-spring-social-facebook-web
-
-2.0.3.RELEASE
-
-org.springframework.social
-
-spring-social-linkedin
-
-1.0.2.RELEASE
-
-org.springframework.social
-
-spring-social-security
-
-1.1.4.RELEASE
-
-org.springframework.social
-
-spring-social-twitter
-
-1.1.2.RELEASE
-
-org.springframework.social
-
-spring-social-web
-
-1.1.4.RELEASE
-
-org.springframework.ws
-
-spring-ws-core
-
-2.4.0.RELEASE
-
-org.springframework.ws
-
-spring-ws-security
-
-2.4.0.RELEASE
-
-org.springframework.ws
-
-spring-ws-support
-
-2.4.0.RELEASE
-
-org.springframework.ws
-
-spring-ws-test
-
-2.4.0.RELEASE
-
-org.thymeleaf
-
-thymeleaf
-
-2.1.5.RELEASE
-
-org.thymeleaf
-
-thymeleaf-spring4
-
-2.1.5.RELEASE
-
-org.thymeleaf.extras
-
-thymeleaf-extras-conditionalcomments
-
-2.1.2.RELEASE
-
-org.thymeleaf.extras
-
-thymeleaf-extras-java8time
-
-2.1.0.RELEASE
-
-org.thymeleaf.extras
-
-thymeleaf-extras-springsecurity4
-
-2.1.3.RELEASE
-
-org.webjars
-
-hal-browser
-
-9f96c74
-
-org.webjars
-
-webjars-locator
-
-0.32-1
-
-org.xerial
-
-sqlite-jdbc
-
-3.15.1
-
-org.yaml
-
-snakeyaml
-
-1.17
-
-redis.clients
-
-jedis
-
-2.9.0
-
-wsdl4j
-
-wsdl4j
-
-1.6.3
-
-xml-apis
-
-xml-apis
-
-1.4.01
-
-
+| Group ID | Artifact ID | Version |
+| ----------------------------------------- | ------------------------------------------ | -------------------- |
+| `antlr` | `antlr` | 2.7.7 |
+| `ch.qos.logback` | `logback-access` | 1.1.11 |
+| `ch.qos.logback` | `logback-classic` | 1.1.11 |
+| `ch.qos.logback` | `logback-core` | 1.1.11 |
+| `com.atomikos` | `transactions-jdbc` | 3.9.3 |
+| `com.atomikos` | `transactions-jms` | 3.9.3 |
+| `com.atomikos` | `transactions-jta` | 3.9.3 |
+| `com.couchbase.client` | `couchbase-spring-cache` | 2.1.0 |
+| `com.couchbase.client` | `java-client` | 2.3.7 |
+| `com.datastax.cassandra` | `cassandra-driver-core` | 3.1.4 |
+| `com.datastax.cassandra` | `cassandra-driver-mapping` | 3.1.4 |
+| `com.fasterxml` | `classmate` | 1.3.4 |
+| `com.fasterxml.jackson.core` | `jackson-annotations` | 2.8.0 |
+| `com.fasterxml.jackson.core` | `jackson-core` | 2.8.10 |
+| `com.fasterxml.jackson.core` | `jackson-databind` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-avro` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-cbor` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-csv` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-ion` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-properties` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-protobuf` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-smile` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-xml` | 2.8.10 |
+| `com.fasterxml.jackson.dataformat` | `jackson-dataformat-yaml` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-guava` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-hibernate3` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-hibernate4` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-hibernate5` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-hppc` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-jaxrs` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-jdk8` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-joda` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-json-org` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-jsr310` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-jsr353` | 2.8.10 |
+| `com.fasterxml.jackson.datatype` | `jackson-datatype-pcollections` | 2.8.10 |
+| `com.fasterxml.jackson.jaxrs` | `jackson-jaxrs-base` | 2.8.10 |
+| `com.fasterxml.jackson.jaxrs` | `jackson-jaxrs-cbor-provider` | 2.8.10 |
+| `com.fasterxml.jackson.jaxrs` | `jackson-jaxrs-json-provider` | 2.8.10 |
+| `com.fasterxml.jackson.jaxrs` | `jackson-jaxrs-smile-provider` | 2.8.10 |
+| `com.fasterxml.jackson.jaxrs` | `jackson-jaxrs-xml-provider` | 2.8.10 |
+| `com.fasterxml.jackson.jaxrs` | `jackson-jaxrs-yaml-provider` | 2.8.10 |
+| `com.fasterxml.jackson.jr` | `jackson-jr-all` | 2.8.10 |
+| `com.fasterxml.jackson.jr` | `jackson-jr-objects` | 2.8.10 |
+| `com.fasterxml.jackson.jr` | `jackson-jr-retrofit2` | 2.8.10 |
+| `com.fasterxml.jackson.jr` | `jackson-jr-stree` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-afterburner` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-guice` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-jaxb-annotations` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-jsonSchema` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-kotlin` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-mrbean` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-osgi` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-parameter-names` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-paranamer` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-scala_2.10` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-scala_2.11` | 2.8.10 |
+| `com.fasterxml.jackson.module` | `jackson-module-scala_2.12` | 2.8.10 |
+| `com.gemstone.gemfire` | `gemfire` | 8.2.4 |
+| `com.github.ben-manes.caffeine` | `caffeine` | 2.3.5 |
+| `com.github.mxab.thymeleaf.extras` | `thymeleaf-extras-data-attribute` | 1.3 |
+| `com.google.appengine` | `appengine-api-1.0-sdk` | 1.9.56 |
+| `com.google.code.gson` | `gson` | 2.8.1 |
+| `com.googlecode.json-simple` | `json-simple` | 1.1.1 |
+| `com.h2database` | `h2` | 1.4.196 |
+| `com.hazelcast` | `hazelcast` | 3.7.8 |
+| `com.hazelcast` | `hazelcast-client` | 3.7.8 |
+| `com.hazelcast` | `hazelcast-hibernate4` | 3.7.1 |
+| `com.hazelcast` | `hazelcast-hibernate5` | 1.1.3 |
+| `com.hazelcast` | `hazelcast-spring` | 3.7.8 |
+| `com.jayway.jsonpath` | `json-path` | 2.2.0 |
+| `com.jayway.jsonpath` | `json-path-assert` | 2.2.0 |
+| `com.microsoft.sqlserver` | `mssql-jdbc` | 6.1.0.jre7 |
+| `com.querydsl` | `querydsl-apt` | 4.1.4 |
+| `com.querydsl` | `querydsl-collections` | 4.1.4 |
+| `com.querydsl` | `querydsl-core` | 4.1.4 |
+| `com.querydsl` | `querydsl-jpa` | 4.1.4 |
+| `com.querydsl` | `querydsl-mongodb` | 4.1.4 |
+| `com.samskivert` | `jmustache` | 1.13 |
+| `com.sendgrid` | `sendgrid-java` | 2.2.2 |
+| `com.sun.mail` | `javax.mail` | 1.5.6 |
+| `com.timgroup` | `java-statsd-client` | 3.1.0 |
+| `com.unboundid` | `unboundid-ldapsdk` | 3.2.1 |
+| `com.zaxxer` | `HikariCP` | 2.5.1 |
+| `com.zaxxer` | `HikariCP-java6` | 2.3.13 |
+| `com.zaxxer` | `HikariCP-java7` | 2.4.13 |
+| `commons-beanutils` | `commons-beanutils` | 1.9.3 |
+| `commons-codec` | `commons-codec` | 1.10 |
+| `commons-collections` | `commons-collections` | 3.2.2 |
+| `commons-dbcp` | `commons-dbcp` | 1.4 |
+| `commons-digester` | `commons-digester` | 2.1 |
+| `commons-pool` | `commons-pool` | 1.6 |
+| `de.flapdoodle.embed` | `de.flapdoodle.embed.mongo` | 1.50.5 |
+| `dom4j` | `dom4j` | 1.6.1 |
+| `io.dropwizard.metrics` | `metrics-core` | 3.1.5 |
+| `io.dropwizard.metrics` | `metrics-ganglia` | 3.1.5 |
+| `io.dropwizard.metrics` | `metrics-graphite` | 3.1.5 |
+| `io.dropwizard.metrics` | `metrics-servlets` | 3.1.5 |
+| `io.projectreactor` | `reactor-bus` | 2.0.8.RELEASE |
+| `io.projectreactor` | `reactor-core` | 2.0.8.RELEASE |
+| `io.projectreactor` | `reactor-groovy` | 2.0.8.RELEASE |
+| `io.projectreactor` | `reactor-groovy-extensions` | 2.0.8.RELEASE |
+| `io.projectreactor` | `reactor-logback` | 2.0.8.RELEASE |
+| `io.projectreactor` | `reactor-net` | 2.0.8.RELEASE |
+| `io.projectreactor` | `reactor-stream` | 2.0.8.RELEASE |
+| `io.projectreactor.spring` | `reactor-spring-context` | 2.0.7.RELEASE |
+| `io.projectreactor.spring` | `reactor-spring-core` | 2.0.7.RELEASE |
+| `io.projectreactor.spring` | `reactor-spring-messaging` | 2.0.7.RELEASE |
+| `io.projectreactor.spring` | `reactor-spring-webmvc` | 2.0.7.RELEASE |
+| `io.searchbox` | `jest` | 2.0.4 |
+| `io.undertow` | `undertow-core` | 1.4.20.Final |
+| `io.undertow` | `undertow-servlet` | 1.4.20.Final |
+| `io.undertow` | `undertow-websockets-jsr` | 1.4.20.Final |
+| `javax.cache` | `cache-api` | 1.0.0 |
+| `javax.jms` | `jms-api` | 1.1-rev-1 |
+| `javax.mail` | `javax.mail-api` | 1.5.6 |
+| `javax.servlet` | `javax.servlet-api` | 3.1.0 |
+| `javax.servlet` | `jstl` | 1.2 |
+| `javax.transaction` | `javax.transaction-api` | 1.2 |
+| `javax.validation` | `validation-api` | 1.1.0.Final |
+| `jaxen` | `jaxen` | 1.1.6 |
+| `joda-time` | `joda-time` | 2.9.9 |
+| `junit` | `junit` | 4.12 |
+| `mysql` | `mysql-connector-java` | 5.1.44 |
+| `net.java.dev.jna` | `jna` | 4.2.2 |
+| `net.sf.ehcache` | `ehcache` | 2.10.4 |
+| `net.sourceforge.htmlunit` | `htmlunit` | 2.21 |
+| `net.sourceforge.jtds` | `jtds` | 1.3.1 |
+| `net.sourceforge.nekohtml` | `nekohtml` | 1.9.22 |
+| `nz.net.ultraq.thymeleaf` | `thymeleaf-layout-dialect` | 1.4.0 |
+| `org.apache.activemq` | `activemq-amqp` | 5.14.5 |
+| `org.apache.activemq` | `activemq-blueprint` | 5.14.5 |
+| `org.apache.activemq` | `activemq-broker` | 5.14.5 |
+| `org.apache.activemq` | `activemq-camel` | 5.14.5 |
+| `org.apache.activemq` | `activemq-client` | 5.14.5 |
+| `org.apache.activemq` | `activemq-console` | 5.14.5 |
+| `org.apache.activemq` | `activemq-http` | 5.14.5 |
+| `org.apache.activemq` | `activemq-jaas` | 5.14.5 |
+| `org.apache.activemq` | `activemq-jdbc-store` | 5.14.5 |
+| `org.apache.activemq` | `activemq-jms-pool` | 5.14.5 |
+| `org.apache.activemq` | `activemq-kahadb-store` | 5.14.5 |
+| `org.apache.activemq` | `activemq-karaf` | 5.14.5 |
+| `org.apache.activemq` | `activemq-leveldb-store` | 5.14.5 |
+| `org.apache.activemq` | `activemq-log4j-appender` | 5.14.5 |
+| `org.apache.activemq` | `activemq-mqtt` | 5.14.5 |
+| `org.apache.activemq` | `activemq-openwire-generator` | 5.14.5 |
+| `org.apache.activemq` | `activemq-openwire-legacy` | 5.14.5 |
+| `org.apache.activemq` | `activemq-osgi` | 5.14.5 |
+| `org.apache.activemq` | `activemq-partition` | 5.14.5 |
+| `org.apache.activemq` | `activemq-pool` | 5.14.5 |
+| `org.apache.activemq` | `activemq-ra` | 5.14.5 |
+| `org.apache.activemq` | `activemq-run` | 5.14.5 |
+| `org.apache.activemq` | `activemq-runtime-config` | 5.14.5 |
+| `org.apache.activemq` | `activemq-shiro` | 5.14.5 |
+| `org.apache.activemq` | `activemq-spring` | 5.14.5 |
+| `org.apache.activemq` | `activemq-stomp` | 5.14.5 |
+| `org.apache.activemq` | `activemq-web` | 5.14.5 |
+| `org.apache.activemq` | `artemis-amqp-protocol` | 1.5.5 |
+| `org.apache.activemq` | `artemis-commons` | 1.5.5 |
+| `org.apache.activemq` | `artemis-core-client` | 1.5.5 |
+| `org.apache.activemq` | `artemis-jms-client` | 1.5.5 |
+| `org.apache.activemq` | `artemis-jms-server` | 1.5.5 |
+| `org.apache.activemq` | `artemis-journal` | 1.5.5 |
+| `org.apache.activemq` | `artemis-native` | 1.5.5 |
+| `org.apache.activemq` | `artemis-selector` | 1.5.5 |
+| `org.apache.activemq` | `artemis-server` | 1.5.5 |
+| `org.apache.activemq` | `artemis-service-extensions` | 1.5.5 |
+| `org.apache.commons` | `commons-dbcp2` | 2.1.1 |
+| `org.apache.commons` | `commons-pool2` | 2.4.2 |
+| `org.apache.derby` | `derby` | 10.13.1.1 |
+| `org.apache.httpcomponents` | `httpasyncclient` | 4.1.3 |
+| `org.apache.httpcomponents` | `httpclient` | 4.5.3 |
+| `org.apache.httpcomponents` | `httpcore` | 4.4.6 |
+| `org.apache.httpcomponents` | `httpmime` | 4.5.3 |
+| `org.apache.logging.log4j` | `log4j-1.2-api` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-api` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-api-scala_2.10` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-api-scala_2.11` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-core` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-flume-ng` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-iostreams` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-jcl` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-jmx-gui` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-jul` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-liquibase` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-nosql` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-slf4j-impl` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-taglib` | 2.7 |
+| `org.apache.logging.log4j` | `log4j-web` | 2.7 |
+| `org.apache.solr` | `solr-solrj` | 5.5.4 |
+| `org.apache.tomcat` | `tomcat-jdbc` | 8.5.20 |
+| `org.apache.tomcat` | `tomcat-jsp-api` | 8.5.20 |
+| `org.apache.tomcat.embed` | `tomcat-embed-core` | 8.5.20 |
+| `org.apache.tomcat.embed` | `tomcat-embed-el` | 8.5.20 |
+| `org.apache.tomcat.embed` | `tomcat-embed-jasper` | 8.5.20 |
+| `org.apache.tomcat.embed` | `tomcat-embed-websocket` | 8.5.20 |
+| `org.aspectj` | `aspectjrt` | 1.8.10 |
+| `org.aspectj` | `aspectjtools` | 1.8.10 |
+| `org.aspectj` | `aspectjweaver` | 1.8.10 |
+| `org.assertj` | `assertj-core` | 2.6.0 |
+| `org.codehaus.btm` | `btm` | 2.1.4 |
+| `org.codehaus.groovy` | `groovy` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-all` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-ant` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-bsf` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-console` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-docgenerator` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-groovydoc` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-groovysh` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-jmx` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-json` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-jsr223` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-nio` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-servlet` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-sql` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-swing` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-templates` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-test` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-testng` | 2.4.12 |
+| `org.codehaus.groovy` | `groovy-xml` | 2.4.12 |
+| `org.codehaus.janino` | `janino` | 2.7.8 |
+| `org.crashub` | `crash.cli` | 1.3.2 |
+| `org.crashub` | `crash.connectors.ssh` | 1.3.2 |
+| `org.crashub` | `crash.connectors.telnet` | 1.3.2 |
+| `org.crashub` | `crash.embed.spring` | 1.3.2 |
+| `org.crashub` | `crash.plugins.cron` | 1.3.2 |
+| `org.crashub` | `crash.plugins.mail` | 1.3.2 |
+| `org.crashub` | `crash.shell` | 1.3.2 |
+| `org.eclipse.jetty` | `apache-jsp` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `apache-jstl` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-annotations` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-client` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-continuation` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-deploy` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-http` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-http-spi` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-infinispan` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-io` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-jaas` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-jaspi` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-jmx` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-jndi` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-nosql` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-plus` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-proxy` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-quickstart` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-rewrite` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-runner` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-security` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-server` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-servlet` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-servlets` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-spring` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-start` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-util` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-util-ajax` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-webapp` | 9.4.6.v20170531 |
+| `org.eclipse.jetty` | `jetty-xml` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.http2` | `http2-client` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.http2` | `http2-common` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.http2` | `http2-hpack` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.http2` | `http2-server` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.orbit` | `javax.servlet.jsp` | 2.2.0.v201112011158 |
+| `org.eclipse.jetty.websocket` | `javax-websocket-client-impl` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.websocket` | `javax-websocket-server-impl` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.websocket` | `websocket-client` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.websocket` | `websocket-server` | 9.4.6.v20170531 |
+| `org.eclipse.jetty.websocket` | `websocket-servlet` | 9.4.6.v20170531 |
+| `org.ehcache` | `ehcache` | 3.2.3 |
+| `org.ehcache` | `ehcache-clustered` | 3.2.3 |
+| `org.ehcache` | `ehcache-transactions` | 3.2.3 |
+| `org.elasticsearch` | `elasticsearch` | 2.4.6 |
+| `org.firebirdsql.jdbc` | `jaybird-jdk16` | 2.2.13 |
+| `org.firebirdsql.jdbc` | `jaybird-jdk17` | 2.2.13 |
+| `org.firebirdsql.jdbc` | `jaybird-jdk18` | 2.2.13 |
+| `org.flywaydb` | `flyway-core` | 3.2.1 |
+| `org.freemarker` | `freemarker` | 2.3.26-incubating |
+| `org.glassfish` | `javax.el` | 3.0.0 |
+| `org.glassfish.jersey.bundles.repackaged` | `jersey-guava` | 2.25.1 |
+| `org.glassfish.jersey.containers` | `jersey-container-servlet` | 2.25.1 |
+| `org.glassfish.jersey.containers` | `jersey-container-servlet-core` | 2.25.1 |
+| `org.glassfish.jersey.core` | `jersey-client` | 2.25.1 |
+| `org.glassfish.jersey.core` | `jersey-common` | 2.25.1 |
+| `org.glassfish.jersey.core` | `jersey-server` | 2.25.1 |
+| `org.glassfish.jersey.ext` | `jersey-bean-validation` | 2.25.1 |
+| `org.glassfish.jersey.ext` | `jersey-entity-filtering` | 2.25.1 |
+| `org.glassfish.jersey.ext` | `jersey-spring3` | 2.25.1 |
+| `org.glassfish.jersey.media` | `jersey-media-jaxb` | 2.25.1 |
+| `org.glassfish.jersey.media` | `jersey-media-json-jackson` | 2.25.1 |
+| `org.glassfish.jersey.media` | `jersey-media-multipart` | 2.25.1 |
+| `org.hamcrest` | `hamcrest-core` | 1.3 |
+| `org.hamcrest` | `hamcrest-library` | 1.3 |
+| `org.hibernate` | `hibernate-core` | 5.0.12.Final |
+| `org.hibernate` | `hibernate-ehcache` | 5.0.12.Final |
+| `org.hibernate` | `hibernate-entitymanager` | 5.0.12.Final |
+| `org.hibernate` | `hibernate-envers` | 5.0.12.Final |
+| `org.hibernate` | `hibernate-java8` | 5.0.12.Final |
+| `org.hibernate` | `hibernate-jpamodelgen` | 5.0.12.Final |
+| `org.hibernate` | `hibernate-validator` | 5.3.5.Final |
+| `org.hibernate` | `hibernate-validator-annotation-processor` | 5.3.5.Final |
+| `org.hsqldb` | `hsqldb` | 2.3.5 |
+| `org.infinispan` | `infinispan-jcache` | 8.2.8.Final |
+| `org.infinispan` | `infinispan-spring4-common` | 8.2.8.Final |
+| `org.infinispan` | `infinispan-spring4-embedded` | 8.2.8.Final |
+| `org.javassist` | `javassist` | 3.21.0-GA |
+| `org.jboss` | `jboss-transaction-spi` | 7.6.0.Final |
+| `org.jboss.logging` | `jboss-logging` | 3.3.1.Final |
+| `org.jboss.narayana.jta` | `jdbc` | 5.5.30.Final |
+| `org.jboss.narayana.jta` | `jms` | 5.5.30.Final |
+| `org.jboss.narayana.jta` | `jta` | 5.5.30.Final |
+| `org.jboss.narayana.jts` | `narayana-jts-integration` | 5.5.30.Final |
+| `org.jdom` | `jdom2` | 2.0.6 |
+| `org.jolokia` | `jolokia-core` | 1.3.7 |
+| `org.jooq` | `jooq` | 3.9.5 |
+| `org.jooq` | `jooq-codegen` | 3.9.5 |
+| `org.jooq` | `jooq-meta` | 3.9.5 |
+| `org.json` | `json` | 20140107 |
+| `org.liquibase` | `liquibase-core` | 3.5.3 |
+| `org.mariadb.jdbc` | `mariadb-java-client` | 1.5.9 |
+| `org.mockito` | `mockito-core` | 1.10.19 |
+| `org.mongodb` | `mongodb-driver` | 3.4.3 |
+| `org.mongodb` | `mongo-java-driver` | 3.4.3 |
+| `org.mortbay.jasper` | `apache-el` | 8.0.33 |
+| `org.neo4j` | `neo4j-ogm-api` | 2.1.5 |
+| `org.neo4j` | `neo4j-ogm-compiler` | 2.1.5 |
+| `org.neo4j` | `neo4j-ogm-core` | 2.1.5 |
+| `org.neo4j` | `neo4j-ogm-http-driver` | 2.1.5 |
+| `org.postgresql` | `postgresql` | 9.4.1212.jre7 |
+| `org.projectlombok` | `lombok` | 1.16.18 |
+| `org.seleniumhq.selenium` | `htmlunit-driver` | 2.21 |
+| `org.seleniumhq.selenium` | `selenium-api` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-chrome-driver` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-firefox-driver` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-ie-driver` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-java` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-remote-driver` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-safari-driver` | 2.53.1 |
+| `org.seleniumhq.selenium` | `selenium-support` | 2.53.1 |
+| `org.skyscreamer` | `jsonassert` | 1.4.0 |
+| `org.slf4j` | `jcl-over-slf4j` | 1.7.25 |
+| `org.slf4j` | `jul-to-slf4j` | 1.7.25 |
+| `org.slf4j` | `log4j-over-slf4j` | 1.7.25 |
+| `org.slf4j` | `slf4j-api` | 1.7.25 |
+| `org.slf4j` | `slf4j-jdk14` | 1.7.25 |
+| `org.slf4j` | `slf4j-log4j12` | 1.7.25 |
+| `org.slf4j` | `slf4j-simple` | 1.7.25 |
+| `org.spockframework` | `spock-core` | 1.0-groovy-2.4 |
+| `org.spockframework` | `spock-spring` | 1.0-groovy-2.4 |
+| `org.springframework` | `spring-aop` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-aspects` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-beans` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-context` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-context-support` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-core` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-expression` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-instrument` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-instrument-tomcat` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-jdbc` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-jms` | 4.3.11.RELEASE |
+| `org.springframework` | `springloaded` | 1.2.8.RELEASE |
+| `org.springframework` | `spring-messaging` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-orm` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-oxm` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-test` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-tx` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-web` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-webmvc` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-webmvc-portlet` | 4.3.11.RELEASE |
+| `org.springframework` | `spring-websocket` | 4.3.11.RELEASE |
+| `org.springframework.amqp` | `spring-amqp` | 1.7.4.RELEASE |
+| `org.springframework.amqp` | `spring-rabbit` | 1.7.4.RELEASE |
+| `org.springframework.batch` | `spring-batch-core` | 3.0.8.RELEASE |
+| `org.springframework.batch` | `spring-batch-infrastructure` | 3.0.8.RELEASE |
+| `org.springframework.batch` | `spring-batch-integration` | 3.0.8.RELEASE |
+| `org.springframework.batch` | `spring-batch-test` | 3.0.8.RELEASE |
+| `org.springframework.boot` | `spring-boot` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-actuator` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-actuator-docs` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-autoconfigure` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-autoconfigure-processor` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-configuration-metadata` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-configuration-processor` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-devtools` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-loader` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-loader-tools` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-activemq` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-actuator` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-amqp` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-aop` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-artemis` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-batch` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-cache` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-cloud-connectors` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-cassandra` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-couchbase` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-elasticsearch` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-gemfire` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-jpa` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-ldap` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-mongodb` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-neo4j` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-redis` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-rest` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-data-solr` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-freemarker` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-groovy-templates` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-hateoas` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-integration` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jdbc` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jersey` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jetty` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jooq` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jta-atomikos` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jta-bitronix` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-jta-narayana` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-log4j2` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-logging` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-mail` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-mobile` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-mustache` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-remote-shell` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-security` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-social-facebook` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-social-linkedin` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-social-twitter` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-test` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-thymeleaf` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-tomcat` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-undertow` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-validation` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-web` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-web-services` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-starter-websocket` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-test` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.boot` | `spring-boot-test-autoconfigure` | 1.5.7.BUILD-SNAPSHOT |
+| `org.springframework.cloud` | `spring-cloud-cloudfoundry-connector` | 1.2.4.RELEASE |
+| `org.springframework.cloud` | `spring-cloud-core` | 1.2.4.RELEASE |
+| `org.springframework.cloud` | `spring-cloud-heroku-connector` | 1.2.4.RELEASE |
+| `org.springframework.cloud` | `spring-cloud-localconfig-connector` | 1.2.4.RELEASE |
+| `org.springframework.cloud` | `spring-cloud-spring-service-connector` | 1.2.4.RELEASE |
+| `org.springframework.data` | `spring-cql` | 1.5.7.RELEASE |
+| `org.springframework.data` | `spring-data-cassandra` | 1.5.7.RELEASE |
+| `org.springframework.data` | `spring-data-commons` | 1.13.7.RELEASE |
+| `org.springframework.data` | `spring-data-couchbase` | 2.2.7.RELEASE |
+| `org.springframework.data` | `spring-data-elasticsearch` | 2.1.7.RELEASE |
+| `org.springframework.data` | `spring-data-envers` | 1.1.7.RELEASE |
+| `org.springframework.data` | `spring-data-gemfire` | 1.9.7.RELEASE |
+| `org.springframework.data` | `spring-data-jpa` | 1.11.7.RELEASE |
+| `org.springframework.data` | `spring-data-keyvalue` | 1.2.7.RELEASE |
+| `org.springframework.data` | `spring-data-ldap` | 1.0.7.RELEASE |
+| `org.springframework.data` | `spring-data-mongodb` | 1.10.7.RELEASE |
+| `org.springframework.data` | `spring-data-mongodb-cross-store` | 1.10.7.RELEASE |
+| `org.springframework.data` | `spring-data-mongodb-log4j` | 1.10.7.RELEASE |
+| `org.springframework.data` | `spring-data-neo4j` | 4.2.7.RELEASE |
+| `org.springframework.data` | `spring-data-redis` | 1.8.7.RELEASE |
+| `org.springframework.data` | `spring-data-rest-core` | 2.6.7.RELEASE |
+| `org.springframework.data` | `spring-data-rest-hal-browser` | 2.6.7.RELEASE |
+| `org.springframework.data` | `spring-data-rest-webmvc` | 2.6.7.RELEASE |
+| `org.springframework.data` | `spring-data-solr` | 2.1.7.RELEASE |
+| `org.springframework.hateoas` | `spring-hateoas` | 0.23.0.RELEASE |
+| `org.springframework.integration` | `spring-integration-amqp` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-core` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-event` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-feed` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-file` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-ftp` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-gemfire` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-groovy` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-http` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-ip` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-java-dsl` | 1.2.3.RELEASE |
+| `org.springframework.integration` | `spring-integration-jdbc` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-jms` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-jmx` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-jpa` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-mail` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-mongodb` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-mqtt` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-redis` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-rmi` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-scripting` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-security` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-sftp` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-stomp` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-stream` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-syslog` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-test` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-twitter` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-websocket` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-ws` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-xml` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-xmpp` | 4.3.12.RELEASE |
+| `org.springframework.integration` | `spring-integration-zookeeper` | 4.3.12.RELEASE |
+| `org.springframework.kafka` | `spring-kafka` | 1.1.6.RELEASE |
+| `org.springframework.kafka` | `spring-kafka-test` | 1.1.6.RELEASE |
+| `org.springframework.ldap` | `spring-ldap-core` | 2.3.1.RELEASE |
+| `org.springframework.ldap` | `spring-ldap-core-tiger` | 2.3.1.RELEASE |
+| `org.springframework.ldap` | `spring-ldap-ldif-batch` | 2.3.1.RELEASE |
+| `org.springframework.ldap` | `spring-ldap-ldif-core` | 2.3.1.RELEASE |
+| `org.springframework.ldap` | `spring-ldap-odm` | 2.3.1.RELEASE |
+| `org.springframework.ldap` | `spring-ldap-test` | 2.3.1.RELEASE |
+| `org.springframework.mobile` | `spring-mobile-device` | 1.1.5.RELEASE |
+| `org.springframework.plugin` | `spring-plugin-core` | 1.2.0.RELEASE |
+| `org.springframework.plugin` | `spring-plugin-metadata` | 1.2.0.RELEASE |
+| `org.springframework.restdocs` | `spring-restdocs-core` | 1.1.3.RELEASE |
+| `org.springframework.restdocs` | `spring-restdocs-mockmvc` | 1.1.3.RELEASE |
+| `org.springframework.restdocs` | `spring-restdocs-restassured` | 1.1.3.RELEASE |
+| `org.springframework.retry` | `spring-retry` | 1.2.1.RELEASE |
+| `org.springframework.security` | `spring-security-acl` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-aspects` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-cas` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-config` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-core` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-crypto` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-data` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-jwt` | 1.0.8.RELEASE |
+| `org.springframework.security` | `spring-security-ldap` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-messaging` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-openid` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-remoting` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-taglibs` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-test` | 4.2.3.RELEASE |
+| `org.springframework.security` | `spring-security-web` | 4.2.3.RELEASE |
+| `org.springframework.security.oauth` | `spring-security-oauth` | 2.0.14.RELEASE |
+| `org.springframework.security.oauth` | `spring-security-oauth2` | 2.0.14.RELEASE |
+| `org.springframework.session` | `spring-session` | 1.3.1.RELEASE |
+| `org.springframework.session` | `spring-session-data-gemfire` | 1.3.1.RELEASE |
+| `org.springframework.session` | `spring-session-data-mongo` | 1.3.1.RELEASE |
+| `org.springframework.session` | `spring-session-data-redis` | 1.3.1.RELEASE |
+| `org.springframework.session` | `spring-session-hazelcast` | 1.3.1.RELEASE |
+| `org.springframework.session` | `spring-session-jdbc` | 1.3.1.RELEASE |
+| `org.springframework.social` | `spring-social-config` | 1.1.4.RELEASE |
+| `org.springframework.social` | `spring-social-core` | 1.1.4.RELEASE |
+| `org.springframework.social` | `spring-social-facebook` | 2.0.3.RELEASE |
+| `org.springframework.social` | `spring-social-facebook-web` | 2.0.3.RELEASE |
+| `org.springframework.social` | `spring-social-linkedin` | 1.0.2.RELEASE |
+| `org.springframework.social` | `spring-social-security` | 1.1.4.RELEASE |
+| `org.springframework.social` | `spring-social-twitter` | 1.1.2.RELEASE |
+| `org.springframework.social` | `spring-social-web` | 1.1.4.RELEASE |
+| `org.springframework.ws` | `spring-ws-core` | 2.4.0.RELEASE |
+| `org.springframework.ws` | `spring-ws-security` | 2.4.0.RELEASE |
+| `org.springframework.ws` | `spring-ws-support` | 2.4.0.RELEASE |
+| `org.springframework.ws` | `spring-ws-test` | 2.4.0.RELEASE |
+| `org.thymeleaf` | `thymeleaf` | 2.1.5.RELEASE |
+| `org.thymeleaf` | `thymeleaf-spring4` | 2.1.5.RELEASE |
+| `org.thymeleaf.extras` | `thymeleaf-extras-conditionalcomments` | 2.1.2.RELEASE |
+| `org.thymeleaf.extras` | `thymeleaf-extras-java8time` | 2.1.0.RELEASE |
+| `org.thymeleaf.extras` | `thymeleaf-extras-springsecurity4` | 2.1.3.RELEASE |
+| `org.webjars` | `hal-browser` | 9f96c74 |
+| `org.webjars` | `webjars-locator` | 0.32-1 |
+| `org.xerial` | `sqlite-jdbc` | 3.15.1 |
+| `org.yaml` | `snakeyaml` | 1.17 |
+| `redis.clients` | `jedis` | 2.9.0 |
+| `wsdl4j` | `wsdl4j` | 1.6.3 |
+| `xml-apis` | `xml-apis` | 1.4.01 |