Commit Graph

195 Commits

Author SHA1 Message Date
Andy Wilkinson 4802640399 Reference latest version of Tomcat 7 in the documentation 2015-01-26 14:42:55 +00:00
Andy Wilkinson f96adaf3ac Add some documentation about Java 6 compatibility
Document the need to use a different JTA 1.2 API jar and Tomcat 7 or
Jetty 8 if you’re running on Java 6.

Closes gh-2347
2015-01-22 16:45:46 +00:00
Andy Wilkinson ea7b5c6e3c Improve support for alternative Log4j 2 configuration file formats
This commit adds support for configuring Log4j 2 with YAML. It also
improves the existing support for configuring Log4j 2 with JSON.

Previously, Log4J2LoggingSystem returned a hard-coded list of standard
config locations that includes both JSON and XML file suffixes. Log4j 
2’s support for JSON configuration files requires Jackson’s ObjectMapper
to be on the classpath so, in its absence, the standard config locations
were incorrect.

This commit updates Log4J2LoggingSystem to return an array of standard
config locations based on what’s on the classpath. It also updates the
documentation to describe the additional dependencies that are required
to enable YAML or JSON-based configuration.

Closes gh-2239
2015-01-22 15:06:20 +00:00
Andy Wilkinson e19bfd9251 Document how to use Tomcat 7 or Jetty 8 with Gradle
Previously, the documentation only provided examples of the required
configuration for Maven users. This commit adds equivalent configuration
snippets for those using Gradle. It also removes the recommendation to
override the version of the Servlet API as this is unnecessary. The pom
files for the Jetty 8 and Tomcat 7 samples have also been updated
accordingly.

Closes gh-2346
2015-01-19 14:20:30 +00:00
Andy Wilkinson e2f2839d32 Document Tomcat compression and GzipFilter auto-configuration
Closes gh-2031
2015-01-16 12:07:29 +00:00
Andy Wilkinson 735b96dd0f Document how to configure multiple listeners when using Undertow
Closes gh-2191
2015-01-07 18:04:50 +00:00
Phillip Webb be30385e15 Add @WebIntegrationTest annotation
Add `@WebIntegrationTest` which is similar to `@IntegrationTest` and
`@WebAppConfiguration`. The annotation using Spring's `@BootstrapWith`
annotation rather than `@TestExecutionListeners` which allows it to
work when `@TestExecutionListeners` (even ServletTestExecutionListener)
are declared on the test class.

This annotation is particularly useful for TestNG users that extend
Spring's `AbstractTestNGSpringContextTests` class.

Fixes gh-2299
See gh-1956
See gh-2135
2015-01-06 21:03:48 -08:00
pauldub b865539adc Fix typo in howto.adoc 2014-12-19 15:22:28 +01:00
Hendy Irawan ba97090375 Clarify SSL "How-to" documentation
Update the SSL "How-to" documentation to make it clearer that SSL
configuration replaces the usual connector.

Closes gh-2172
See gh-2167
2014-12-17 16:13:28 -08:00
Stephane Nicoll 1b039e78e6 Documentation improvement of DataSource configuration
Closes gh-2126
2014-12-17 14:25:33 +01:00
Phillip Webb e772174019 Update reference documentation for Spring Boot 1.2
Various updates and polish to prepare the reference documentation for
Spring Boot 1.2.

Fixes gh-1903
2014-12-10 00:56:41 -08:00
Phillip Webb 119a5656e2 Update SpringBootServletInitializer ref docs
Add a hint to show that the `configure` method is now optional.

Fixes gh-2074
2014-12-10 00:49:31 -08:00
Phillip Webb b651090fcd Document how-to for Weblogic deployment
Fixes gh-2078
2014-12-07 20:11:48 -08:00
Andy Wilkinson a83f9c6311 Correct markup in documentation of how to configure Undertow 2014-11-26 10:55:33 +00:00
Andy Wilkinson 55fadf1231 Merge branch '1.1.x' 2014-11-25 13:54:06 +00:00
Andy Wilkinson 2b4eee5e53 Add a note explaining that double backslashes are unnecessary in YAML
Closes gh-1989
2014-11-25 13:52:26 +00:00
Sjoerd Mulder cc557833a4 Escape backslashes in .properties examples of setting internal-proxies
In a properties file, a backslash is used as an escape character for
the line terminator sequence to allow values to be split across
multiple lines. When a backslash is used elsewhere they're stripped
out of the property's value.

This commit updates .properties-based examples for configuring
server.tomcat.internal-proxies to escape the backslahes so that they
are retained in the property's value at runtime.

See gh-1989
2014-11-25 13:39:25 +00:00
Andy Wilkinson efe50ebcad Document WebSocket exclusions that are required when using Jetty 8
Closes gh-1969
2014-11-24 16:59:07 +00:00
Phillip Webb 08988fd182 Update docs about Jetty 9 and Tomcat 8
Fixes gh-1951
2014-11-20 17:55:15 -08:00
Dave Syer 689d49021b Merge branch '1.1.x' 2014-11-20 12:39:17 +00:00
Brian Clozel 404153a758 Minor fixes in howto documentation re:SSL config
Fixes a couple of typos in the documentation:
* `x-forwarded-protocol` is not the standard name for this header
* `require_https` is not an existing property, but rather `require_ssl`
2014-11-20 13:27:27 +01:00
Andy Wilkinson 1864d79077 Polish Undertow contribution
Closes gh-1779
2014-11-18 21:20:34 +00:00
Andy Wilkinson 150b85e10d Merge branch '1.1.x'
Conflicts:
	spring-boot-dependencies/pom.xml
2014-11-10 11:29:21 +00:00
Andy Wilkinson a9b88d6955 Document need for ServerEndpointExporter and show its use in a sample
Traditionally, a @ServerEndpoint-annotated bean is found by a servlet
container initialiser, however Boot does not run servlet container
initialisers when an embedded container is being used. To be able to use
@ServerEndpoint in a Boot app that uses embedded Tomcat a
ServerEndpointExporter bean must be declared.

This commit updates the documentation to describe this requirement and
also updates the WebSockets sample to illustrate the use of
ServerEndpointExporter. The version of Spring Framework has been updated
to 4.0.8.BUILD-SNAPSHOT. This picks up the fix for SPR-12340.

Closes gh-1722
2014-11-10 11:27:56 +00:00
Phillip Webb 0c3911162b Polish 2014-11-06 22:48:40 -08:00
Dave Syer d210810535 Tweak docs on Maven resource filtering
Fixes gh-1816
2014-11-04 10:29:55 +00:00
Phillip Webb a973fd41f4 Polish 2014-11-03 18:49:20 -08:00
Dave Syer 9b6cb83be5 Add documentation for Servlet 2.5 and GAE
Fixes gh-1104
2014-11-03 17:04:57 +00:00
Stephane Nicoll fb0d9d2a2e Fix build failure
This commit reworks a7e1ec8 to fix the build failure and update the
documentation regarding default maven filtering option with
spring-boot-starter-parent

Fixes gh-1199
2014-11-03 14:01:51 +01:00
Phillip Webb d17b7c8195 Polish 2014-10-29 12:08:37 -07:00
Andy Wilkinson bd562c06b6 Merge branch '1.1.x' 2014-10-28 11:06:23 +00:00
Andy Wilkinson f58b8366e1 Correct the syntax that's used for smart single and double quotes
Fixes gh-1753
2014-10-28 11:03:35 +00:00
Dave Syer 6c3d490c74 Add note about springloaded configuration 2014-10-27 17:22:35 +00:00
Andy Wilkinson 7211571969 Fix some grammar issues in docs
Closes gh-1695
2014-10-13 13:18:24 +01:00
Eric Dahl 16937746a0 Fix some grammar issues in docs 2014-10-13 12:22:14 +01:00
Phillip Webb c90633aab6 Polish 2014-10-10 17:27:26 -07:00
Phillip Webb 6281070d0a Merge branch '1.1.x'
Conflicts:
	spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
2014-10-09 13:00:27 -07:00
Phillip Webb 7e842aee77 Escape `...*...` outputs using `+...*...+` 2014-10-09 12:41:39 -07:00
Phillip Webb 2303c3aea9 Fix asciidoctor 'spaces' conversion issues 2014-10-09 12:41:39 -07:00
Dave Syer 8ffe7ec4b8 Fix asciidoctor syntax problems and updgrade to asciidoctor 1.5
Points to note for authors:

* Nesting "*" in `literals` does not behave like Markdown - you have to
escape the asterisk (e.g. `foo/\*`)

* Quote ligatures (why we had to use those I don't really know) are
different in asciidoctor 1.5 ('`foo`' instead of ``foo'')

Merge branch '1.1.x'

Conflicts:
	spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
	spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
2014-10-09 10:58:06 +01:00
Dave Syer 6a503d5ca9 Fix loads of asciidoc errors 2014-10-09 10:51:25 +01:00
Daniel Fullarton 1dbc94d0f7 Add a logging system, starter and sample for Log4j 2
Closes gh-1565
2014-10-08 15:30:00 +01:00
Phillip Webb 872f30e5d0 Merge branch '1.1.x'
Conflicts:
	spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/repository/redis/RedisMetricRepository.java
2014-10-06 10:29:04 -07:00
Phillip Webb 9dfbc25eaa Polish 2014-10-06 10:26:12 -07:00
Sebastien Deleuze 315213ea4e Support Jackson based XML serialization and Jackson2ObjectMapperBuilder
This commit introduces support for Jackson based XML serialization, using the
new MappingJackson2XmlHttpMessageConverter provided by Spring Framework
4.1. It is automatically activated when Jackson XML extension is detected on the
classpath.

Jackson2ObjectMapperBuilder is now used to create ObjectMapper and XmlMapper
instances with the following customized properties:
 - MapperFeature.DEFAULT_VIEW_INCLUSION is disabled
 - DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES is disabled

JodaModuleAutoConfiguration and Jsr310ModuleAutoConfiguration have been removed
since their behaviors are now handled directly by the ObjectMapper builder.

In addition to the existing @Bean of type ObjectMapper support, it is now
possible to customize Jackson based serialization properties by declaring
a @Bean of type Jackson2ObjectMapperBuilder.

Fixes gh-1237
Fixes gh-1580
Fixes gh-1644
2014-10-06 10:54:38 +01:00
Eric Dahl bbf3076d9d Fix some grammar issues in docs 2014-10-02 20:45:05 -07:00
Andy Wilkinson da90e5bc6b Merge branch '1.1.x' 2014-10-01 16:24:16 +01:00
Andy Wilkinson 8349148bbf Remove details of how to switch off RemoteIpValve: it's off by default
See gh-1631
2014-10-01 16:23:00 +01:00
Dave Syer 06fa2a9f78 Merge branch '1.1.x' 2014-10-01 15:44:16 +01:00
Dave Syer 1b8f579da2 Clarify activation of RemoteIpValve
Fixes gh-1631
2014-10-01 15:43:41 +01:00
Dave Syer 97dcd24668 Merge branch '1.1.x' 2014-09-22 12:16:21 +01:00
Dave Syer a63d0b4e16 Update docs with DispatcherType.ERROR for filters
Some frameworks handle all requests in a Filter, so you have to
explicitly register it as an ERROR dispatcher.

See gh-1272
2014-09-22 12:15:02 +01:00
Phillip Webb 62a5ce52d0 Backport Jetty/Tomcat SSL support
Fixes gh-1570
Cherry-picked from 0960908 and 258c6f1
2014-09-17 10:08:05 -07:00
Andy Wilkinson 284e7b2091 Merge branch '1.1.x' 2014-09-16 15:40:23 +01:00
Andy Wilkinson 468b6cb1f7 Add support for configuring RemoteIpValve’s internalProxies
Closes gh-1522
2014-09-16 15:40:18 +01:00
Andy Wilkinson 4b25b0e7a2 Allow Jackson features to be configured via the environment
Enhance JacksonAutoConfiguration to configure features on the
ObjectMapper it creates based on the following configuration
properties:

spring.jackson.deserialization.* = true|false
spring.jackson.generator.* = true|false
spring.jackson.mapper.* = true|false
spring.jackson.parser.* = true|false
spring.jackson.serialization.* = true|false

The final part of each property name maps onto an enum. The enums are:

deserialization: com.fasterxml.jackson.databind.DeserializationFeature
generator: com.fasterxml.jackson.core.JsonGenerator.Feature
mapper: com.fasterxml.jackson.databind.MapperFeature
parser: com.fasterxml.jackson.core.JsonParser.Feature
serialization: com.fasterxml.jackson.databind.SerializationFeature

Closes gh-1227
2014-09-16 09:59:59 +01:00
Phillip Webb 565e449d89 Merge branch '1.1.x'
Conflicts:
	spring-boot-docs/src/main/asciidoc/howto.adoc
2014-09-15 11:37:50 -07:00
Phillip Webb 5ba86a103d Polish 2014-09-15 11:35:16 -07:00
Christoph Frick 3b07e4e633 Fix typos in the documentation: though -> through
Closes gh-1510
2014-09-07 11:03:49 -05:00
Christoph Frick 5455b42d32 Fix typos in the documentation: though -> through
Closes gh-1510
2014-09-07 11:00:09 -05:00
Dave Syer 9a2f9825d1 Fix asciidoc syntax 2014-09-05 16:33:32 +01:00
Dave Syer 993c7691ec Fix recommended authentication configuration to match samples 2014-09-05 16:30:54 +01:00
Phillip Webb 35a840a396 Replace mavenCentral() with jcenter() in docs
Fixes gh-1373
2014-09-03 18:46:56 -07:00
Phillip Webb da5c36c3a9 Polish 2014-07-29 13:06:47 -07:00
Andy Wilkinson 0960908bd7 Add support for configuring SSL declaratively
Both Tomcat and Jetty can now be configured to use SSL via the
environment (typically application.properties or application.yml)

Closes #1084
2014-07-24 15:10:09 +01:00
Dave Syer a9b8563bb6 Fix typo (fixes gh-1273) 2014-07-21 14:07:29 +01:00
Andy Wilkinson 0a70bd44ed Correct the default Logback config location in the documentation
Fixes #1247
2014-07-21 11:39:43 +01:00
Phillip Webb 31014d86a4 Clarify resource filtering documentation
Fixes gh-1208
2014-07-08 00:17:00 -07:00
Phillip Webb 60e60227ad Polish doc formatting 2014-07-02 15:52:46 -07:00
Dave Syer fd757cb371 Add logging.level to application.properties
E.g.

logging.level.org.springframework: DEBUG
logging.level.org.hibernate: WARN

Fixed gh-788
2014-06-27 15:49:17 +01:00
Phillip Webb f30b962ff9 Add support for unpacking nested JARs
Update the executable JAR code to automatically unpack any entries
which include an entry comment starting `UNPACK:` to the temp folder.
The existing Maven and Gradle plugins have been updated with new
configuration options and the `spring-boot-tools` project has been
updated to write the appropriate entry comment based on a flag passed
in via the `Library` class.

This support has been added to allow libraries such a JRuby (which
assumes that `jruby-complete.jar` is always accessible as file) to work
with Spring Boot executable jars.

Fixes gh-1070
2014-06-24 00:46:56 -07:00
Phillip Webb c713c8091d Polish 2014-06-23 19:41:22 -07:00
Dave Syer 0e5201abe2 Fix typos (see gh-1135) 2014-06-23 16:51:25 +01:00
Dave Syer 542896b28f Support for non-executable JAR in addition to the repackaged one
Stretches the Gradle boot plugin a bit, so there's a sample build
in the "profile" sample. Howto docs give examples.

Fixes gh-1135
2014-06-23 11:08:58 +01:00
Tadaya Tsuyukubo 5fbe5d4120 Add how-to remote debug from Gradle
Add a section to the reference documentation "how-to" about remote
debugging a Gradle started app.

Fixes gh-1129
2014-06-20 11:58:08 -07:00
Dave Syer f83395b40c Correct docs on BeanNameViewResolver (Fixes gh-1078) 2014-06-17 10:39:27 +01:00
Dave Syer c0efd3a22e Add clarification of ddl-auto and schema.sql 2014-06-12 06:48:44 +01:00
Phillip Webb 75a202e389 Add Spring Loaded, Gradle, IntelliJ "How-To"
Fixes gh-823
2014-06-09 17:27:33 -07:00
Phillip Webb 9a5d828f52 Polish docbook formatting 2014-06-09 16:34:54 -07:00
Phillip Webb 21029d2323 Polish disable repository documentation 2014-06-09 11:31:38 -07:00
Andy Wilkinson f47b40f683 Use spring-boot-version for dependency versions in Gradle Jetty example 2014-06-09 16:45:40 +01:00
Dave Syer 39a94428d3 Add @Conditionals to permit JPA/Mongo mixed usage
I decided to go with both approaches (make the autoconfig for
repositories @ConditionalOnMissingBean(RepositoryFactoryBeanSupport),
so the first one wins; and also make them conditional on
spring.data.*.repositories.enabled=true. The ordering problem
is still there really (it's not defined which repositories will
be created by the autoconfig), so if a user is going to have
2 repository implementations on the classpath, he is going to
have to either choose one to disable, or manualy @Enable* the
other one.

Fixes gh-1042
2014-06-09 09:48:40 +01:00
Phillip Webb e032b673a2 Polish DataSourceInitialization code
Rename a few classes and methods relating to DataSourceInitialization
and update the DataSourceInitializedPublisher to check for Hibernate
settings.
2014-06-06 22:56:44 -07:00
Stephane Nicoll 593d180cf3 Add a note regarding dependency overriding
Fixes gh-958
2014-06-05 16:37:35 +02:00
Stephane Nicoll a6702f5b87 Remove reference of mvnDebug
The maven plugin now forks a process to start the application so
mvnDebug cannot be used anymore. This commit replaces the reference
of mvnDebug to a link to an example of the maven plugin.

Fixes gh-992
2014-06-03 13:52:49 +02:00
Dave Syer 49a09c807c Defer SQL initialization to fit with JPA better
Added 2 new spring.datasource.* properties ("data" like
"schema", and "deferDdl" like the "spring.jpa.hibernate.*"
flag). The SQL scripts are then run separately and the "data"
ones are triggered by a new DataSourceInitializedEvent,
which is also published by the Hibernate DDL schema export.

Fixes gh-1006
2014-06-02 13:10:50 +01:00
Phillip Webb 3d76d9d73b Merge branch '1.0.x' 2014-05-28 10:23:33 +01:00
Phillip Webb 819b3b9761 Fix JasperInitializerLifecycleListener
Update JasperInitializerLifecycleListener to call JasperInitializer as
a ServletContainerInitializer (not a ServletContextInitializer).

Fixes gh-962
See gh-919
2014-05-28 10:21:10 +01:00
Phillip Webb 0ed4afd647 Fix a couple of velocity documentation issues
Fixes gh-961
2014-05-27 16:36:05 +01:00
Phillip Webb 6381fdcb49 Polish 2014-05-26 21:48:19 +01:00
Dave Syer 32295b9bdc Add options for Flyway to have its own DataSource
Either set flyway.[url,user,password] or create a DataSource
@Bean and mark it @FlywayDataSource.

Fixes gh-807
2014-05-26 08:55:28 +01:00
Eric Dahl 3457cc4f39 Fix multiple typos in documentation, as well as "thread.deamon" typo in actuator 2014-05-22 21:18:08 -05:00
Phillip Webb 8bcda1bcbe Polish 2014-05-20 18:26:56 +01:00
Dave Syer e118515d7a Use Flyway to bind flyway.*
Since Flyway has bean properties (with getters and setters)
it can be used to bin directly to the Environment (instead of
copying all the properties into FlywayProperties).

Fixes gh-806
2014-05-20 11:28:56 +01:00
Andy Wilkinson 2378fe0900 Add support for using Velocity templates 2014-05-19 12:01:20 +01:00
Dave Syer bfbb720d0a Add docs for Groovy Templates 2014-05-16 15:28:35 +01:00
Phillip Webb 01fcf61140 Polish 2014-05-15 09:51:16 +01:00
Dave Syer 7454c4866b Support for @ConfigurationProperties in JPA
Adds JpaProperties to bind to spring.jpa.* (making those
properties easier to reason about and visible in the
/configprops endpoint).

Also allows easy configuration of multiple EntityManagerFactories via new
EntityManagerFactoryBuilder. JpaBaseConfiguration has a @Bean of that type
so users can inject it to create new or additional EntityManagerFactories.
This also simplifies the Hibernate autoconfiguration.

Also renames the DataSourceFactory to DataSourceBuilder (since that's what it
is).
2014-05-15 09:18:38 +01:00
Dave Syer b5e608f102 Remove mention of missing starters 2014-05-14 13:42:04 +01:00
Lukasz Kryger 254b175c0a Read data-{platform}.sql in addition to data.sql
Update DataSourceAutoConfiguration to read platform specific `data.sql`
files in the same way as `schema.sql` files.

Fixes gh-837
2014-05-10 22:49:49 +01:00