All Classes and Interfaces
Class
Description
Abstract
ApplicationListener
to handle AuditApplicationEvent
s.Abstract
ApplicationListener
to expose Spring Security
authorization denied
and
authorization granted
events as AuditEvent
s.Abstract base class for
endpoints
discovered by a
EndpointDiscoverer
.Abstract base class for
endpoints operations
discovered by a
EndpointDiscoverer
.Abstract base class for
ExposableEndpoint
implementations.Base
HealthIndicator
implementations that encapsulates creation of
Health
instance and error handling.Base class for binding Jetty metrics in response to an
ApplicationStartedEvent
.Base
ReactiveHealthIndicator
implementations that encapsulates creation of
Health
instance and error handling.A custom
HandlerMapping
that makes web endpoints available over HTTP using
Spring WebFlux.An
OperationInvoker
that performs the invocation of a blocking operation on
a separate thread using Reactor's bounded
elastic scheduler
.Reactive handler providing actuator links at the root endpoint.
A reactive web operation that can be handled by WebFlux.
A custom
HandlerMapping
that makes web endpoints
available over HTTP using Spring MVC.Handler providing actuator links at the root endpoint.
A servlet web operation that can be handled by Spring MVC.
Value object that represents an additional path for a
HealthEndpointGroup
.A custom
HandlerMapping
that allows health groups to be mapped to an additional
path.A custom
HandlerMapping
that allows health groups to be mapped to an additional
path.API versions supported for the actuator API.
Spring
ApplicationEvent
to encapsulate AuditEvent
s.A value object representing an audit event: at a particular time, a particular user or
agent carried out an action of a particular type.
Repository for
AuditEvent
s.@Endpoint
to expose audit events.Description of an application's
audit events
.The default
AbstractAuditListener
implementation.Default implementation of
AbstractAuthenticationAuditListener
.Default implementation of
AbstractAuthorizationAuditListener
.Strategy that can be used to apply
Timers
automatically instead of using
@Timed
.A
HealthIndicator
that checks a specific AvailabilityState
of the
application.AvailabilityStateHealthIndicator.StatusMappings<S extends org.springframework.boot.availability.AvailabilityState>
Callback used to add status mappings.
@Endpoint
to expose details of an application's beans, grouped by
application context.Description of a bean.
Description of an application's beans.
Description of an application context beans.
An
InfoContributor
that exposes BuildProperties
.CacheMeterBinderProvider
implementation for cache2k.CacheMeterBinderProvider<C extends org.springframework.cache.Cache>
Provide a
MeterBinder
based on a Cache
.Register supported
Cache
to a MeterRegistry
.@Endpoint
to expose available caches
.Description of a
Cache
.Description of a
Cache
entry.Description of a
CacheManager
.Description of the caches.
@EndpointWebExtension
for the CachesEndpoint
.An
OperationInvoker
that caches the response of an operation with a
configurable time to live.OperationInvokerAdvisor
to optionally provide result caching support.CacheMeterBinderProvider
implementation for Caffeine.Simple implementation of a
HealthIndicator
returning status information for
Cassandra data stores.Simple implementation of a
ReactiveHealthIndicator
returning status information
for Cassandra data stores.A
HealthComponent
that is composed of other HealthComponent
instances.A
HealthContributor
that is composed of other HealthContributor
instances.A
ReactiveHealthContributor
that is composed of other
ReactiveHealthContributor
instances.@Endpoint
to expose application properties from
@ConfigurationProperties
annotated beans.Description of a
@ConfigurationProperties
bean.Description of an application's
@ConfigurationProperties
beans.Description of an application context's
@ConfigurationProperties
beans.BeanSerializerModifier
to return only relevant configuration properties.A
HealthIndicator
to validate a R2DBC ConnectionFactory
.A
MeterBinder
for a ConnectionPool
.A mutable registry of health endpoint contributors (either
HealthContributor
or
ReactiveHealthContributor
).Deprecated, for removal: This API element is subject to removal in a future version.
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
supportHandlerMapping
that exposes @ControllerEndpoint
and
@RestControllerEndpoint
annotated endpoints over Spring
WebFlux.HandlerMapping
that exposes @ControllerEndpoint
and
@RestControllerEndpoint
annotated endpoints over Spring
MVC.ParameterValueMapper
backed by a ConversionService
.HealthIndicator
for Couchbase.A
ReactiveHealthIndicator
for Couchbase.HealthIndicator
that tests the status of a DataSource
and optionally
runs a test query.A
MeterBinder
for a DataSource
.Default
HealthContributorRegistry
implementation.Default
ReactiveHealthContributorRegistry
implementation.Default
RepositoryTagsProvider
implementation.Identifies a method on an
@Endpoint
as being a delete operation.An
endpoint
discovered by an EndpointDiscoverer
.An
OperationMethod
discovered by an EndpointDiscoverer
.EndpointFilter
the matches based on the EndpointDiscoverer
the created
the endpoint.A
HealthIndicator
that checks available disk space and reports a status of
Status.DOWN
when it drops below a configurable threshold.A
MeterBinder
that binds one or more DiskSpaceMetrics
.A description of a mapping known to a
DispatcherServlet
.Details of a
DispatcherHandler
mapping.A
MappingDescriptionProvider
that introspects the HandlerMappings
that are known to a DispatcherHandler
.A description of a mapping known to a
DispatcherServlet
.Details of a
DispatcherServlet
mapping.A
MappingDescriptionProvider
that introspects the HandlerMappings
that are known to one or more DispatcherServlets
.HealthIndicator
for an Elasticsearch cluster using a
ReactiveElasticsearchClient
.HealthIndicator
for an Elasticsearch cluster using a RestClient
.Identifies a type as being an actuator endpoint that provides information about the
running application.
Qualifier for beans that are needed to convert
@Endpoint
input
parameters.A Base for
EndpointsSupplier
implementations that discover
@Endpoint
beans and @EndpointExtension
beans
in an application context.A key generated for an
Operation
based on specific criteria from the actual
operation implementation.Annotation primarily used as a meta-annotation to indicate that an annotation provides
extension support for an endpoint.
Strategy class that can be used to filter
endpoints
.An identifier for an actuator endpoint.
Identifies a type as being a JMX-specific extension of an
@Endpoint
.A resolver for
links
to web endpoints.A value object for the base mapping for endpoints.
Adapter to expose a
JMX endpoint
as a
DynamicMBean
.Media types that are, by default, produced and consumed by an endpoint.
Interface used to supply the
ObjectMapper
that should be used when serializing
OperationResponseBody
endpoint results.A factory to create an
ObjectName
for an EndpointMBean
.Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
Provides access to a collection of
endpoints
.Identifies a type as being a Web-specific extension of an
@Endpoint
.@Endpoint
to expose environment
information.Description of an
Environment
.Description of an entry of the
Environment
.Description of a
PropertySource
.Description of a particular entry of
PropertySource
.Description of a particular entry of the
Environment
.Description of a property's value, including its origin if available.
@EndpointWebExtension
for the EnvironmentEndpoint
.An
InfoContributor
that provides all environment entries prefixed with info.Information describing an endpoint that can be exposed over Spring MVC or Spring
WebFlux.
Information describing an endpoint that can be exposed in some technology specific way.
Information describing an endpoint that can be exposed over JMX.
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
Information describing an endpoint that can be exposed over the web.
Annotation that can be used on an
@Endpoint
to implement implicit
filtering.A
RegistrationMappingDescription
derived from a FilterRegistration
.A
MappingDescriptionProvider
that describes that mappings of any Filters
registered with a ServletContext
.@Endpoint
to expose flyway info.Description of an application context's
Flyway
beans.Description of an application's
Flyway
beans.Description of a
Flyway
bean.Description of a migration performed by Flyway.
An
InfoContributor
that exposes GitProperties
.Description of a
HandlerFunction
.A description of a
HandlerMethod
.CacheMeterBinderProvider
implementation for Hazelcast.HealthIndicator
for Hazelcast.Carries information about the health of a component or subsystem.
Builder for creating immutable
Health
instances.A component that contributes data to results returned from the
HealthEndpoint
.Tagging interface for classes that contribute to
health
components
to the results returned from the HealthEndpoint
.Generate a sensible health indicator name based on its bean name.
@Endpoint
to expose application health information.A logical grouping of
health contributors
that can be exposed
by the HealthEndpoint
.A collection of
groups
for use with a health endpoint.Hook that allows for custom modification of
HealthEndpointGroups
— for
example, automatically adding additional auto-configured groups.@EndpointWebExtension
for the HealthEndpoint
.Strategy interface used to contribute
Health
to the results returned from the
HealthEndpoint
.Web
@Endpoint
to expose heap dumps.Strategy interface used to dump the heap to a file.
Exception to be thrown if the
HeapDumpWebEndpoint.HeapDumper
cannot be created.HeapDumpWebEndpoint.HeapDumper
that uses com.sun.management.HotSpotDiagnosticMXBean
,
available on Oracle and OpenJDK, to dump the heap to a file.Strategy used to map a
health status
to an HTTP status code.An HTTP request and response exchange.
Principal associated with an HTTP request-response exchange.
The request that started the exchange.
The response that finished the exchange.
The session associated with the exchange.
A started request that when
finished
will return a new
HttpExchange
instance.A repository for
HttpExchange
instances.@Endpoint
to expose HttpExchange
information.Description of an application's
HttpExchange
entries.Servlet
Filter
for recording HTTP exchanges
.A
WebFilter
for recording HTTP exchanges
.Include options for HTTP exchanges.
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.2.0 for removal in 3.4.0 in favor of the
new client and its own
Spring Boot integration.
Carries information of the application.
Builder for creating immutable
Info
instances.Contributes additional info details.
@Endpoint
to expose arbitrary application information.InfoPropertiesInfoContributor<T extends org.springframework.boot.info.InfoProperties>
A base
InfoContributor
to expose an InfoProperties
.Defines how properties should be exposed.
In-memory
AuditEventRepository
implementation.In-memory implementation of
HttpExchangeRepository
.@Endpoint
to expose the Spring Integration graph.Description of a
Graph
.Indicate that an endpoint request is invalid.
The context for the
invocation of an operation
.JmxOperationResponseMapper
that delegates to a Jackson ObjectMapper
to
return a JSON response.An
InfoContributor
that exposes JavaInfo
.CacheMeterBinderProvider
implementation for JCache.A factory for creating Jersey
Resources
for web
endpoint operations
.A factory for creating Jersey
Resources
for health groups with
additional path.AbstractJettyMetricsBinder
for JettyConnectionMetrics
.AbstractJettyMetricsBinder
for JettyServerThreadPoolMetrics
.AbstractJettyMetricsBinder
for JettySslHandshakeMetrics
.HealthIndicator
for a JMS ConnectionFactory
.Identifies a type as being an endpoint that is only exposed over JMX.
Exports
JMX endpoints
to a MBeanServer
.An operation on a JMX endpoint.
Describes the parameters of an operation on a JMX endpoint.
Maps an operation's response to a JMX-friendly form.
HealthIndicator
for configured LDAP server(s).Details for a link in a
HAL-formatted
response.
@Endpoint
to expose liquibase info.Description of a Liquibase change set.
Description of a context expression in a
LiquibaseEndpoint.ChangeSetDescriptor
.Description of an application context's
SpringLiquibase
beans.Description of a
SpringLiquibase
bean.Description of an application's
SpringLiquibase
beans.A
HealthIndicator
that checks the LivenessState
of the application.Web
@Endpoint
that provides access to an application's log file.@Endpoint
to expose a collection of LoggerConfiguration
s.Description of levels configured for a given group logger.
Description of levels configured for a given logger.
Description of loggers.
Description of levels configured for a given single logger.
HealthIndicator
for configured smtp server(s).A simple
InfoContributor
that exposes a map.A
MappingDescriptionProvider
provides a List
of mapping descriptions
through implementation-specific introspection of an application context.@Endpoint
to expose HTTP request mappings.Description of an application's request mappings.
Description of an application context's request mappings.
An
@Endpoint
for exposing the metrics held by a MeterRegistry
.A set of tags for further dimensional drill-down and their potential values.
Description of a metric.
Description of metric names.
A measurement sample combining a
statistic
and a value.Intercepts Spring Data
Repository
invocations and records metrics about
execution time and results.RuntimeException
thrown when an endpoint invocation does not contain required
parameters.Simple implementation of a
HealthIndicator
returning status information for
Mongo data stores.A
ReactiveHealthIndicator
for Mongo.A single named health endpoint contributors (either
HealthContributor
or
ReactiveHealthContributor
).A collection of named health endpoint contributors (either
HealthContributor
or
ReactiveHealthContributor
).HealthIndicator
that tests the status of a Neo4j by executing a Cypher
statement and extracting server and database information.ReactiveHealthIndicator
that tests the status of a Neo4j by executing a Cypher
statement and extracting server and database information.Exception thrown when multiple caches exist with the same name.
RestClientCustomizer
that configures the RestClient builder
to
record request observations.RestTemplateCustomizer
that configures the RestTemplate
to record
request observations.WebClientCustomizer
that configures the WebClient
to record request
observations.An operation on an
endpoint
.Resolver for an argument of an
Operation
.Interface to perform an operation invocation.
Allows additional functionality to be applied to an
OperationInvoker
.Information describing an operation method on an endpoint method.
A single operation parameter.
A collection of
operation parameters
.Tagging interface used to indicate that an operation result is intended to be returned
in the body of the response.
An enumeration of the different types of operation supported by an endpoint.
An
InfoContributor
that exposes OsInfo
.The outcome of an HTTP request.
A
ParameterMappingException
is thrown when a failure occurs during
operation parameter mapping
.Maps parameter values to the required type when invoking an endpoint.
Interface that can be implemented by an
ExposableEndpoint
that is mapped to a
root web path.A collection of
path mapped endpoints
.Strategy interface used to provide a mapping between an endpoint ID and the root path
where it will be exposed.
Default implementation of
HealthIndicator
that returns Status.UP
.An
InfoContributor
that exposes ProcessInfo
.Interface that can be implemented by any
Enum
that represents a finite set of
producible mime-types.A
Producible
enum for supported Prometheus formats.Class that can be used to manage the pushing of metrics to a
Prometheus PushGateway
.The operation that should be performed on shutdown.
@Endpoint
that outputs metrics in a format that can be scraped by the
Prometheus server.Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 for removal in 3.5.0 in favor of
PrometheusScrapeEndpoint
Endpoint
to expose Quartz Scheduler jobs and triggers.Description of a
CalendarIntervalTrigger
.Description of a
CronTrigger
.Description of a custom
Trigger
.Description of a
DailyTimeIntervalTrigger
.Description of group names.
Description of available job and trigger group names.
Description of each group identified by name.
Description of a
Quartz Job
.Description of the
jobs
in a given group.Description of a
Quartz Job
.Description of the
triggers
in a given group.Description of a
SimpleTrigger
.Base class for descriptions of a
Trigger
.@EndpointWebExtension
for the QuartzEndpoint
.Simple implementation of a
HealthIndicator
returning status information for the
RabbitMQ messaging system.A
MeterBinder
for RabbitMQ Java Client metrics.Tagging interface for classes that contribute to
health
components
to the results returned from the HealthEndpoint
.Reactive
@EndpointWebExtension
for the
HealthEndpoint
.Strategy interface used to contribute
Health
to the results returned from the
reactive variant of the HealthEndpoint
.@Endpoint
to expose information about HTTP Session
s on a
reactive stack.A
HealthIndicator
that checks the ReadinessState
of the application.Identifies a method on an
@Endpoint
as being a read operation.The recordable parts of an HTTP request used when creating an
HttpExchange
.The recordable parts of an HTTP response used when creating an
HttpExchange
.CacheMeterBinderProvider
implementation for Redis.CacheMeterBinder
for RedisCache
.Simple implementation of a
HealthIndicator
returning status information for
Redis data stores.A
ReactiveHealthIndicator
for Redis.An
OperationInvoker
that invokes an operation using reflection.RegistrationMappingDescription<T extends jakarta.servlet.Registration>
A mapping description derived from a
Registration
.Provides
Tags
for Spring Data Repository
invocations
.Description of the conditions of a
RequestMappingInfo
.Description of the conditions of a
RequestMappingInfo
.A description of a
MediaTypeExpression
in a request mapping condition.A description of a
MediaTypeExpression
in a request mapping condition.A description of a
NameValueExpression
in a request mapping condition.A description of a
NameValueExpression
in a request mapping condition.Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
Value object that represents the data that can be used by a
SanitizingFunction
.Strategy that should be used by endpoint implementations to sanitize potentially
sensitive keys.
Function that takes a
SanitizableData
and applies sanitization to the value, if
necessary.@Endpoint
to expose an SBOM.@EndpointWebExtension
for the SbomEndpoint
.Configuration properties for the SBOM endpoint.
@Endpoint
to expose information about an application's scheduled
tasks.Description of a
CronTask
or a TriggerTask
with a
CronTrigger
.Description of a
TriggerTask
with a custom Trigger
.Description of a
FixedDelayTask
or a TriggerTask
with a fixed-delay
PeriodicTrigger
.Description of a
FixedRateTask
or a TriggerTask
with a fixed-rate
PeriodicTrigger
.Description of an
IntervalTask
.Description of a
Task's
Runnable
.Description of an application's scheduled
Tasks
.Base class for descriptions of a
Task
.Security context in which an endpoint is being invoked.
A
@Selector
can be used on a parameter of an @Endpoint
method
to indicate that the parameter is used to select a subset of the endpoint's data.Match types that can be used with the
@Selector
.Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
supportDeprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 in favor of
@Endpoint
and @WebEndpoint
A mapping description derived from a
ServletRegistration
.A
MappingDescriptionProvider
that describes that mappings of any Servlets
registered with a ServletContext
.Description of user's
sessions
.A description of user's
session
exposed by sessions
endpoint.@Endpoint
to expose information about HTTP Session
s on a
Servlet stack.Options for showing data in endpoint responses.
@Endpoint
to shutdown the ApplicationContext
.Description of the shutdown.
Simple
HttpCodeStatusMapper
backed by map of status
code
to HTTP status code.A simple
InfoContributor
that exposes a single detail.StatusAggregator
backed by an ordered status list.@Endpoint
to expose the timeline of the
application startup
.Description of an application startup.
Binds application startup metrics in response to
ApplicationStartedEvent
and
ApplicationReadyEvent
.Value object to express state of a component or subsystem.
Strategy used to aggregate
Status
instances.A
HealthComponent
that represents the overall system health and the available
groups.Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.0 for removal in 3.5.0 in favor of
PrometheusOutputFormat
@Endpoint
to expose thread info.Description of a thread dump.
Utility used to obtain
@Timed
annotations from bean methods.Binds
TomcatMetrics
in response to the ApplicationStartedEvent
.Identifies a type as being an endpoint that is only exposed over HTTP.
An enumeration of HTTP methods supported by web endpoint operations.
A
WebEndpointResponse
can be returned by an operation on a
@EndpointWebExtension
to provide additional, web-specific
information such as the HTTP status code.A custom
HandlerMapping
that makes web endpoints available over HTTP using
Spring WebFlux.A custom
HandlerMapping
that makes web endpoints available over HTTP using
Spring MVC.An operation on a web endpoint.
A predicate for a request to an operation on a web endpoint.
Enumeration of server namespaces.
Identifies a method on an
@Endpoint
as being a write operation.
@Endpoint
and@WebEndpoint