14.1.3 Endpoint Configuration

Endpoints with the endpoints prefix can be configured through their default endpoint id. If an endpoint exists with the id of foo, it can be configured through endpoints.foo. In addition, default values can be provided through the all prefix.

For example, consider the following endpoint.

FooEndpoint.java

  1. @Endpoint("foo")
  2. class FooEndpoint {
  3. ...
  4. }

By default the endpoint will be enabled. To disable the endpoint, set endpoints.foo.enabled to false. If endpoints.foo.enabled is not set at all and endpoints.all.enabled is set to false, the endpoint will be disabled.

The configuration values for the endpoint override the ones for all. If endpoints.foo.enabled is explicitly set to true and endpoints.all.enabled is explicitly set to false, the endpoint will be enabled.

For all endpoints, the following configuration values can be set.

  1. endpoints:
  2. <any endpoint id>:
  3. enabled: Boolean
  4. sensitive: Boolean
The base path for all endpoints is / by default. If you prefer the endpoints to be available under a different base path, configure endpoints.all.path. For example, if the value is set to /endpoints, the foo endpoint will be accessible at /endpoints/foo.