Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Provide a way to opt-in to endpoint enablement

Browse Source 
Update AbstractEndpoint so that the `enable` property is optional and
when it not specified the `endpoints.enabled` property will be used.

This allows users to switch the way that endpoints are enabled. Rather
than opting-out specific endpoint enablement the `endpoints.enabled`
property can be set to `false` and specific endpoints can be opted-in.

Fixes gh-2102
This commit is contained in:
Phillip Webb
2014-12-10 12:31:32 -08:00
parent 3e2433c842
commit a27217ae43
9 changed files with 111 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
spring-boot-docs/src/main/asciidoc/production-ready-features.adoc
View File

@@ -135,6 +135,16 @@ of the `beans` endpoint and also enables `shutdown`.
NOTE: The prefix ‟`endpoints` + `.` + `name`” is used to uniquely identify the endpoint
that is being configured.
By default, all endpoints except for `shutdown` are enabled. If you prefer to
specifically "`opt-in`" endpoint enablement you can use the `endpoints.enabled` property.
For example, the following will disable _all_ endpoints except for `info`:
[source,properties,indent=0]
----
endpoints.enabled=false
endpoints.info.enabled=true
----
[[production-ready-health]]
@@ -394,6 +404,10 @@ in your `application.properties`:
management.security.role=SUPERUSER
----
TIP: If you don't use Spring Security and your HTTP endpoints are exposed publicly,
you should carefully consider which endpoints you enable. See
<<production-ready-customizing-endpoints>> for details of how you can set
`endpoints.enabled` to `false` then "`opt-in`" only specific endpoints.
[[production-ready-customizing-management-server-context-path]]