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.Permitted level of access to an endpoint and its operations.
Value object that represents an additional path for a
HealthEndpointGroup
.Strategy interface used to provide a mapping between an endpoint ID and any additional
paths where it will be exposed.
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
.A
HealthIndicator
that checks a specific AvailabilityState
of the
application.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
.An
OperationInvoker
that caches the response of an operation with a
configurable time to live.OperationInvokerAdvisor
to optionally provide result caching support.Description of health that is composed of other
health
descriptors
.@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.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
supportDeprecated, for removal: This API element is subject to removal in a future version.
since 3.3.3 in favor of
@Endpoint
and @WebEndpoint
supportParameterValueMapper
backed by a ConversionService
.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.Identifies a type as being an actuator endpoint that provides information about the
running application.
Resolver for the permitted level of
access
to an endpoint.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
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.Deprecated, for removal: This API element is subject to removal in a future version.
since 3.3.3 in favor of
@Endpoint
and @WebEndpoint
supportInformation 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.An
InfoContributor
that exposes GitProperties
.A description of a
HandlerMethod
.Description of health including a status.
@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
.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.Include options for HTTP exchanges.
Description of health obtained from a
HealthIndicator
or
ReactiveHealthIndicator
.Carries information of the application.
Builder for creating immutable
Info
instances.Contributes additional info details.
@Endpoint
to expose arbitrary application information.A base
InfoContributor
to expose an InfoProperties
.Defines how properties should be exposed.
In-memory
AuditEventRepository
implementation.In-memory implementation of
HttpExchangeRepository
.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
.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.
Details for a link in a
HAL-formatted
response.
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.
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.
RuntimeException
thrown when an endpoint invocation does not contain required
parameters.An operation on an
endpoint
.Resolver for an argument of an
Operation
.Strategy class that can be used to filter
operations
.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.
Annotation that indicates that an operation parameter is optional.
An
InfoContributor
that exposes OsInfo
.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.
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.Reactive
@EndpointWebExtension
for the
HealthEndpoint
.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
.An
OperationInvoker
that invokes an operation using reflection.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
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.HealthIndicator
that checks the certificates the application uses and reports
Status.OUT_OF_SERVICE
when a certificate is invalid.An
InfoContributor
that exposes SslInfo
.@Endpoint
to expose the timeline of the
application startup
.Description of an application startup.
Strategy used to aggregate
Status
instances.Description of overall system health.
@Endpoint
to expose thread info.Description of a thread dump.
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.An operation on a web endpoint.
A predicate for a request to an operation on a web endpoint.
A web server namespace used for disambiguation when multiple web servers are running in
the same application (for example a management context running on a different port).
Identifies a method on an
@Endpoint
as being a write operation.
@Endpoint
and@WebEndpoint