Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Submit feedback
Sign in / Register
Toggle navigation
S
spring-boot
Project
Project
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
DEMO
spring-boot
Commits
9907e706
Commit
9907e706
authored
Apr 16, 2014
by
Lukasz Kryger
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Minor documentation fixes
parent
283f1b16
Changes
5
Hide whitespace changes
Inline
Side-by-side
Showing
5 changed files
with
22 additions
and
22 deletions
+22
-22
build-tool-plugins.adoc
spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc
+2
-2
cloud-deployment.adoc
spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc
+7
-7
howto.adoc
spring-boot-docs/src/main/asciidoc/howto.adoc
+2
-2
production-ready-features.adoc
...oot-docs/src/main/asciidoc/production-ready-features.adoc
+1
-1
spring-boot-features.adoc
spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
+10
-10
No files found.
spring-boot-docs/src/main/asciidoc/build-tool-plugins.adoc
View file @
9907e706
...
@@ -626,10 +626,10 @@ Here is a typical example repackage:
...
@@ -626,10 +626,10 @@ Here is a typical example repackage:
[[
build
-
tool
-
plugins
-
whats
-
next
]]
[[
build
-
tool
-
plugins
-
whats
-
next
]]
==
What
to
read
next
==
What
to
read
next
If
you
r
interested
to
looking
at
how
the
build
tool
plugins
were
developed
you
can
If
you
're interested in how the build tool plugins work
you can
look at the {github-code}/spring-boot-tools[`spring-boot-tools`] module on GitHub. More
look at the {github-code}/spring-boot-tools[`spring-boot-tools`] module on GitHub. More
technical details of the <<appendix-executable-jar-format.adoc#executable-jar, executable
technical details of the <<appendix-executable-jar-format.adoc#executable-jar, executable
jar format>> are covered in the appendix.
jar format>> are covered in the appendix.
If
you
have
specific
build
related
questions
,
you
can
check
out
the
If you have specific build
-related questions
you can check out the
`<<howto.adoc#howto, how-to>>'
guides
.
`<<howto.adoc#howto, how-to>>'
guides
.
spring-boot-docs/src/main/asciidoc/cloud-deployment.adoc
View file @
9907e706
...
@@ -34,7 +34,7 @@ specified. The Cloud Foundry Java buildpack has excellent support for Spring app
...
@@ -34,7 +34,7 @@ specified. The Cloud Foundry Java buildpack has excellent support for Spring app
including Spring Boot. You can deploy stand-alone executable jar applications, as well as
including Spring Boot. You can deploy stand-alone executable jar applications, as well as
traditional `.war` packaged applications.
traditional `.war` packaged applications.
Once you've built your application (using, for example, `mvn clean
install
`) and
Once you've built your application (using, for example, `mvn clean
package
`) and
http://docs.run.pivotal.io/devguide/installcf/install-go-cli.html/[installed the `cf`
http://docs.run.pivotal.io/devguide/installcf/install-go-cli.html/[installed the `cf`
command line tool], simply answer the `cf push` command prompts as follows, substituting
command line tool], simply answer the `cf push` command prompts as follows, substituting
the path to your compiled `.jar` for mine. Be sure to have
the path to your compiled `.jar` for mine. Be sure to have
...
@@ -166,8 +166,8 @@ information (such as database credentials). See `VcapApplicationListener` Javdoc
...
@@ -166,8 +166,8 @@ information (such as database credentials). See `VcapApplicationListener` Javdoc
complete details.
complete details.
TIP: The https://github.com/spring-projects/spring-cloud[Spring Cloud] project is a better
TIP: The https://github.com/spring-projects/spring-cloud[Spring Cloud] project is a better
fit for tasks such as configuring a DataSource;
and you can also
use Spring Cloud with
fit for tasks such as configuring a DataSource;
it also lets you
use Spring Cloud with
Heroku
too!
Heroku
.
...
@@ -178,8 +178,8 @@ Heroku is another popular PaaS platform. To customize Heroku builds, you provide
...
@@ -178,8 +178,8 @@ Heroku is another popular PaaS platform. To customize Heroku builds, you provide
assigns a `port` for the Java application to use and then ensures that routing to the
assigns a `port` for the Java application to use and then ensures that routing to the
external URI works.
external URI works.
You must configure your application to listen on the correct port.
This is a breeze with
You must configure your application to listen on the correct port.
Here's the `Procfile`
Spring Boot. Here's the `Procfile`
for our starter REST application:
for our starter REST application:
[indent=0]
[indent=0]
----
----
...
@@ -250,7 +250,7 @@ This should be everything you need. The most common workflow for Heroku deployme
...
@@ -250,7 +250,7 @@ This should be everything you need. The most common workflow for Heroku deployme
* [new branch] master -> master
* [new branch] master -> master
----
----
That should be it! Your application should
be up and running on Heroku.
Your application should now
be up and running on Heroku.
...
@@ -271,7 +271,7 @@ that covers the steps that you need to follow when deploying to CloudBees.
...
@@ -271,7 +271,7 @@ that covers the steps that you need to follow when deploying to CloudBees.
Check out the http://www.cloudfoundry.com/[Cloud Foundry], https://www.heroku.com/[Heroku]
Check out the http://www.cloudfoundry.com/[Cloud Foundry], https://www.heroku.com/[Heroku]
and http://www.cloudbees.com[CloudBees] web sites for more information about the kinds of
and http://www.cloudbees.com[CloudBees] web sites for more information about the kinds of
features that a PaaS can offer. These are just three of the most popular Java PaaS
features that a PaaS can offer. These are just three of the most popular Java PaaS
providers, since Spring Boot is so amenable to cloud-based deployment you free to
providers, since Spring Boot is so amenable to cloud-based deployment you
're
free to
consider other providers as well.
consider other providers as well.
The next section goes on to cover the '<<spring-boot-cli.adoc#cli, Spring Boot CLI>>';
The next section goes on to cover the '<<spring-boot-cli.adoc#cli, Spring Boot CLI>>';
...
...
spring-boot-docs/src/main/asciidoc/howto.adoc
View file @
9907e706
...
@@ -25,7 +25,7 @@ can send us a {github-code}[pull request].
...
@@ -25,7 +25,7 @@ can send us a {github-code}[pull request].
[[howto-troubleshoot-auto-configuration]]
[[howto-troubleshoot-auto-configuration]]
=== Troubleshoot auto-configuration
=== Troubleshoot auto-configuration
The Spring Boot auto-configuration tries it
'
s best to ``do the right thing'', but
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.
sometimes things fail and it can be hard to tell why.
There is a really useful `AutoConfigurationReport` available in any Spring Boot
There is a really useful `AutoConfigurationReport` available in any Spring Boot
...
@@ -44,7 +44,7 @@ rules of thumb:
...
@@ -44,7 +44,7 @@ rules of thumb:
Actuator app look at the `autoconfig` endpoint (`/autoconfig' or the JMX equivalent) for
Actuator app look at the `autoconfig` endpoint (`/autoconfig' or the JMX equivalent) for
the same information.
the same information.
* Look for classes that are `@ConfigurationProperties` (e.g.
* Look for classes that are `@ConfigurationProperties` (e.g.
{sc-spring-boot-autoconfigure}/web/ServerProperties.{sc-ext}[`ServerProperties`]
{sc-spring-boot-autoconfigure}/web/ServerProperties.{sc-ext}[`ServerProperties`]
)
and read from there the available external configuration options. The
and read from there the available external configuration options. The
`@ConfigurationProperties` has a `name` attribute which acts as a prefix to external
`@ConfigurationProperties` has a `name` attribute which acts as a prefix to external
properties, thus `ServerProperties` has `prefix="server"` and its configuration properties
properties, thus `ServerProperties` has `prefix="server"` and its configuration properties
...
...
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View file @
9907e706
...
@@ -54,7 +54,7 @@ Actuator endpoints allow you to monitor and interact with your application. Spri
...
@@ -54,7 +54,7 @@ Actuator endpoints allow you to monitor and interact with your application. Spri
includes
a
number
of
built
-
in
endpoints
and
you
can
also
add
your
own
.
For
example
the
includes
a
number
of
built
-
in
endpoints
and
you
can
also
add
your
own
.
For
example
the
`
health
`
endpoint
provides
basic
application
health
information
.
`
health
`
endpoint
provides
basic
application
health
information
.
The
way
that
enpoints
are
exposed
will
depend
on
the
type
of
technology
that
you
choose
.
The
way
that
en
d
points
are
exposed
will
depend
on
the
type
of
technology
that
you
choose
.
Most
applications
choose
HTTP
monitoring
,
where
the
ID
of
the
endpoint
is
mapped
Most
applications
choose
HTTP
monitoring
,
where
the
ID
of
the
endpoint
is
mapped
to
a
URL
.
For
example
,
by
default
,
the
`
health
`
endpoint
will
be
mapped
to
`/
health
`.
to
a
URL
.
For
example
,
by
default
,
the
`
health
`
endpoint
will
be
mapped
to
`/
health
`.
...
...
spring-boot-docs/src/main/asciidoc/spring-boot-features.adoc
View file @
9907e706
...
@@ -863,7 +863,7 @@ and JSPs. Many other templating engines also ship their own Spring MVC integrati
...
@@ -863,7 +863,7 @@ and JSPs. Many other templating engines also ship their own Spring MVC integrati
Spring Boot includes auto-configuration support for the Thymeleaf templating engine.
Spring Boot includes auto-configuration support for the Thymeleaf templating engine.
Thymeleaf is an XML/XHTML/HTML5 template engine that can work both in web and non-web
Thymeleaf is an XML/XHTML/HTML5 template engine that can work both in web and non-web
environments. I
f allows you to create natural templates,
that can be correctly displayed
environments. I
t allows you to create natural templates
that can be correctly displayed
by browsers and therefore work also as static prototypes. Thymeleaf templates will be
by browsers and therefore work also as static prototypes. Thymeleaf templates will be
picked up automatically from `src/main/resources/templates`.
picked up automatically from `src/main/resources/templates`.
...
@@ -891,7 +891,7 @@ By default, if the context contains only a single Servlet it will be mapped to `
...
@@ -891,7 +891,7 @@ By default, if the context contains only a single Servlet it will be mapped to `
the case of multiple Servlets beans the bean name will be used as a path prefix. Filters
the case of multiple Servlets beans the bean name will be used as a path prefix. Filters
will map to `/*`.
will map to `/*`.
If convention
based mapping is not flexible enough you can use the
If convention
-
based mapping is not flexible enough you can use the
`ServletRegistrationBean` and `FilterRegistrationBean` classes for complete control. You
`ServletRegistrationBean` and `FilterRegistrationBean` classes for complete control. You
can also register items directly if your bean implements the `ServletContextInitializer`
can also register items directly if your bean implements the `ServletContextInitializer`
interface.
interface.
...
@@ -1003,8 +1003,8 @@ application you can also add `@EnableGlobalMethodSecurity` with your desired set
...
@@ -1003,8 +1003,8 @@ application you can also add `@EnableGlobalMethodSecurity` with your desired set
Additional information can be found in the {spring-security-reference}#jc-method[Spring
Additional information can be found in the {spring-security-reference}#jc-method[Spring
Security Reference].
Security Reference].
The default `AuthenticationManager` has a single user (
username ``user'' and password
The default `AuthenticationManager` has a single user (
``user'' username and random
random
, printed at INFO level when the application starts up). You can change the
password
, printed at INFO level when the application starts up). You can change the
password by providing a `security.user.password`. This and other useful properties are
password by providing a `security.user.password`. This and other useful properties are
externalized via {sc-spring-boot-autoconfigure}/security/SecurityProperties.{sc-ext}[`SecurityProperties`]
externalized via {sc-spring-boot-autoconfigure}/security/SecurityProperties.{sc-ext}[`SecurityProperties`]
(properties prefix "security").
(properties prefix "security").
...
@@ -1169,7 +1169,7 @@ relational databases. The `spring-boot-starter-data-jpa` POM provides a quick wa
...
@@ -1169,7 +1169,7 @@ relational databases. The `spring-boot-starter-data-jpa` POM provides a quick wa
started. It provides the following key dependencies:
started. It provides the following key dependencies:
* Hibernate -- One of the most popular JPA implementations.
* Hibernate -- One of the most popular JPA implementations.
* Spring Data JPA -- Makes it easy to easily implement JPA
based repositories.
* Spring Data JPA -- Makes it easy to easily implement JPA
-
based repositories.
* Spring ORMs -- Core ORM support from the Spring Framework.
* 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
TIP: We won't go into too many details of JPA or Spring Data here. You can follow the
...
@@ -1449,12 +1449,12 @@ If you extend your Maven project from the `spring-boot-starter-parent` POM, or u
...
@@ -1449,12 +1449,12 @@ If you extend your Maven project from the `spring-boot-starter-parent` POM, or u
`spring-boot-starter-test` ``Starter POM'' (in the `test` `scope`), you will find
`spring-boot-starter-test` ``Starter POM'' (in the `test` `scope`), you will find
the following provided libraries:
the following provided libraries:
* J
u
nit -- The de-facto standard for unit testing Java applications.
* J
U
nit -- The de-facto standard for unit testing Java applications.
* Hamcrest -- A library of matcher objects (also known as constraints or predicates)
* Hamcrest -- A library of matcher objects (also known as constraints or predicates)
allowing `assertThat` style JUnit assertions.
allowing `assertThat` style JUnit assertions.
* Mockito -- A Java mocking framework.
* Mockito -- A Java mocking framework.
These are common libraries that we generally find useful when writing
T
ests. You are free
These are common libraries that we generally find useful when writing
t
ests. You are free
to add additional test dependencies of your own if these don't suit your needs.
to add additional test dependencies of your own if these don't suit your needs.
...
@@ -1474,7 +1474,7 @@ The Spring Framework includes a dedicated test module for just such integration
...
@@ -1474,7 +1474,7 @@ The Spring Framework includes a dedicated test module for just such integration
You can declare a dependency directly to `org.springframework:spring-test` or use the
You can declare a dependency directly to `org.springframework:spring-test` or use the
`spring-boot-starter-test` ``Starter POM'' to pull it in transitively.
`spring-boot-starter-test` ``Starter POM'' to pull it in transitively.
If you have not use the `spring-test` module before you should start by reading the
If you have not use
d
the `spring-test` module before you should start by reading the
{spring-reference}/#testing[relevant section] of the Spring Framework reference
{spring-reference}/#testing[relevant section] of the Spring Framework reference
documentation.
documentation.
...
@@ -1606,8 +1606,8 @@ public class MyTest {
...
@@ -1606,8 +1606,8 @@ public class MyTest {
`TestRestTemplate` is a convenience subclass of Spring's `RestTemplate` that is
`TestRestTemplate` is a convenience subclass of Spring's `RestTemplate` that is
useful in integration tests. You can get a vanilla template or one that sends Basic HTTP
useful in integration tests. You can get a vanilla template or one that sends Basic HTTP
authentication (with a username and password).
And i
n either case the template will behave
authentication (with a username and password).
I
n either case the template will behave
in a
friendly way for testing,
not following redirects (so you can assert the response
in a
test-friendly way:
not following redirects (so you can assert the response
location), ignoring cookies (so the template is stateless), and not throwing exceptions
location), ignoring cookies (so the template is stateless), and not throwing exceptions
on server-side errors. It is recommended, but not mandatory, to use Apache HTTP Client
on server-side errors. It is recommended, but not mandatory, to use Apache HTTP Client
(version 4.3.2 or better), and if you have that on your classpath the `TestRestTemplate`
(version 4.3.2 or better), and if you have that on your classpath the `TestRestTemplate`
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment