Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AbstractAuditListener - Class in org.springframework.boot.actuate.audit.listener
-
Abstract
ApplicationListener
to handleAuditApplicationEvent
s. - AbstractAuditListener() - Constructor for class org.springframework.boot.actuate.audit.listener.AbstractAuditListener
- AbstractAuthenticationAuditListener - Class in org.springframework.boot.actuate.security
- AbstractAuthenticationAuditListener() - Constructor for class org.springframework.boot.actuate.security.AbstractAuthenticationAuditListener
- AbstractAuthorizationAuditListener - Class in org.springframework.boot.actuate.security
-
Abstract
ApplicationListener
to expose Spring Securityauthorization denied
andauthorization granted
events asAuditEvent
s. - AbstractAuthorizationAuditListener() - Constructor for class org.springframework.boot.actuate.security.AbstractAuthorizationAuditListener
- AbstractDiscoveredEndpoint<O> - Class in org.springframework.boot.actuate.endpoint.annotation
-
Abstract base class for
endpoints
discovered by aEndpointDiscoverer
. - AbstractDiscoveredEndpoint(EndpointDiscoverer<?, ?>, Object, EndpointId, Access, Collection<? extends O>) - Constructor for class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredEndpoint
-
Create a new
AbstractDiscoveredEndpoint
instance. - AbstractDiscoveredOperation - Class in org.springframework.boot.actuate.endpoint.annotation
-
Abstract base class for
endpoints operations
discovered by aEndpointDiscoverer
. - AbstractDiscoveredOperation(DiscoveredOperationMethod, OperationInvoker) - Constructor for class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation
-
Create a new
AbstractDiscoveredOperation
instance. - AbstractExposableEndpoint<O> - Class in org.springframework.boot.actuate.endpoint
-
Abstract base class for
ExposableEndpoint
implementations. - AbstractExposableEndpoint(EndpointId, Access, Collection<? extends O>) - Constructor for class org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint
-
Create a new
AbstractExposableEndpoint
instance. - Access - Enum Class in org.springframework.boot.actuate.endpoint
-
Permitted level of access to an endpoint and its operations.
- accessFor(EndpointId, Access) - Method in interface org.springframework.boot.actuate.endpoint.EndpointAccessResolver
-
Resolves the permitted level of access for the endpoint with the given
endpointId
anddefaultAccess
. - add(AuditEvent) - Method in interface org.springframework.boot.actuate.audit.AuditEventRepository
-
Log an event.
- add(AuditEvent) - Method in class org.springframework.boot.actuate.audit.InMemoryAuditEventRepository
- add(HttpExchange) - Method in interface org.springframework.boot.actuate.web.exchanges.HttpExchangeRepository
-
Adds an
HttpExchange
instance to the repository. - add(HttpExchange) - Method in class org.springframework.boot.actuate.web.exchanges.InMemoryHttpExchangeRepository
- add(S, Status) - Method in interface org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator.StatusMappings
-
Add a new status mapping .
- addDefaultStatus(Status) - Method in interface org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator.StatusMappings
-
Add the status that should be used if no explicit mapping is defined.
- AdditionalHealthEndpointPath - Class in org.springframework.boot.actuate.health
-
Value object that represents an additional path for a
HealthEndpointGroup
. - AdditionalPathsMapper - Interface in org.springframework.boot.actuate.endpoint.web
-
Strategy interface used to provide a mapping between an endpoint ID and any additional paths where it will be exposed.
- afterPropertiesSet() - Method in class org.springframework.boot.actuate.endpoint.jmx.JmxEndpointExporter
- aggregateDescriptors(ApiVersion, Map<String, HealthDescriptor>, StatusAggregator, boolean, Set<String>) - Method in class org.springframework.boot.actuate.health.HealthEndpoint
- aggregateDescriptors(ApiVersion, Map<String, HealthDescriptor>, StatusAggregator, boolean, Set<String>) - Method in class org.springframework.boot.actuate.health.HealthEndpointWebExtension
- aggregateDescriptors(ApiVersion, Map<String, Mono<? extends HealthDescriptor>>, StatusAggregator, boolean, Set<String>) - Method in class org.springframework.boot.actuate.health.ReactiveHealthEndpointWebExtension
- ALL_REMAINING - Enum constant in enum class org.springframework.boot.actuate.endpoint.annotation.Selector.Match
-
Capture all remaining times.
- ALWAYS - Enum constant in enum class org.springframework.boot.actuate.endpoint.Show
-
Always show the item in the response.
- ApiVersion - Enum Class in org.springframework.boot.actuate.endpoint
-
API versions supported for the actuator API.
- appendFields(ToStringCreator) - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredEndpoint
- appendFields(ToStringCreator) - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation
- apply(EndpointId, OperationType, OperationParameters, OperationInvoker) - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationInvokerAdvisor
-
Apply additional functionality to the given invoker.
- apply(EndpointId, OperationType, OperationParameters, OperationInvoker) - Method in class org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvokerAdvisor
- apply(SanitizableData) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Apply the sanitizing function to the given data.
- applyUnlessFiltered(SanitizableData) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Apply the sanitizing function as long as the filter passes or there is no filter.
- AuditApplicationEvent - Class in org.springframework.boot.actuate.audit.listener
-
Spring
ApplicationEvent
to encapsulateAuditEvent
s. - AuditApplicationEvent(String, String, String...) - Constructor for class org.springframework.boot.actuate.audit.listener.AuditApplicationEvent
-
Create a new
AuditApplicationEvent
that wraps a newly createdAuditEvent
. - AuditApplicationEvent(String, String, Map<String, Object>) - Constructor for class org.springframework.boot.actuate.audit.listener.AuditApplicationEvent
-
Create a new
AuditApplicationEvent
that wraps a newly createdAuditEvent
. - AuditApplicationEvent(Instant, String, String, Map<String, Object>) - Constructor for class org.springframework.boot.actuate.audit.listener.AuditApplicationEvent
-
Create a new
AuditApplicationEvent
that wraps a newly createdAuditEvent
. - AuditApplicationEvent(AuditEvent) - Constructor for class org.springframework.boot.actuate.audit.listener.AuditApplicationEvent
-
Create a new
AuditApplicationEvent
that wraps the specifiedAuditEvent
. - AuditEvent - Class in org.springframework.boot.actuate.audit
-
A value object representing an audit event: at a particular time, a particular user or agent carried out an action of a particular type.
- AuditEvent(String, String, String...) - Constructor for class org.springframework.boot.actuate.audit.AuditEvent
-
Create a new audit event for the current time from data provided as name-value pairs.
- AuditEvent(String, String, Map<String, Object>) - Constructor for class org.springframework.boot.actuate.audit.AuditEvent
-
Create a new audit event for the current time.
- AuditEvent(Instant, String, String, Map<String, Object>) - Constructor for class org.springframework.boot.actuate.audit.AuditEvent
-
Create a new audit event.
- AuditEventRepository - Interface in org.springframework.boot.actuate.audit
-
Repository for
AuditEvent
s. - AuditEventsEndpoint - Class in org.springframework.boot.actuate.audit
-
@Endpoint
to expose audit events. - AuditEventsEndpoint(AuditEventRepository) - Constructor for class org.springframework.boot.actuate.audit.AuditEventsEndpoint
- AuditEventsEndpoint.AuditEventsDescriptor - Class in org.springframework.boot.actuate.audit
-
Description of an application's
audit events
. - AuditListener - Class in org.springframework.boot.actuate.audit.listener
-
The default
AbstractAuditListener
implementation. - AuditListener(AuditEventRepository) - Constructor for class org.springframework.boot.actuate.audit.listener.AuditListener
- AUTHENTICATION_FAILURE - Static variable in class org.springframework.boot.actuate.security.AuthenticationAuditListener
-
Authentication failure event type.
- AUTHENTICATION_SUCCESS - Static variable in class org.springframework.boot.actuate.security.AuthenticationAuditListener
-
Authentication success event type.
- AUTHENTICATION_SWITCH - Static variable in class org.springframework.boot.actuate.security.AuthenticationAuditListener
-
Authentication switch event type.
- AuthenticationAuditListener - Class in org.springframework.boot.actuate.security
-
Default implementation of
AbstractAuthenticationAuditListener
. - AuthenticationAuditListener() - Constructor for class org.springframework.boot.actuate.security.AuthenticationAuditListener
- AUTHORIZATION_FAILURE - Static variable in class org.springframework.boot.actuate.security.AuthorizationAuditListener
-
Authorization failure event type.
- AUTHORIZATION_HEADER - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include authorization header (if any).
- AuthorizationAuditListener - Class in org.springframework.boot.actuate.security
-
Default implementation of
AbstractAuthorizationAuditListener
. - AuthorizationAuditListener() - Constructor for class org.springframework.boot.actuate.security.AuthorizationAuditListener
- AvailabilityStateHealthIndicator - Class in org.springframework.boot.actuate.availability
-
A
HealthIndicator
that checks a specificAvailabilityState
of the application. - AvailabilityStateHealthIndicator(ApplicationAvailability, Class<S>, Consumer<AvailabilityStateHealthIndicator.StatusMappings<S>>) - Constructor for class org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator
-
Create a new
AvailabilityStateHealthIndicator
instance. - AvailabilityStateHealthIndicator.StatusMappings<S> - Interface in org.springframework.boot.actuate.availability
-
Callback used to add status mappings.
B
- beans() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint
- BeansEndpoint - Class in org.springframework.boot.actuate.beans
-
@Endpoint
to expose details of an application's beans, grouped by application context. - BeansEndpoint(ConfigurableApplicationContext) - Constructor for class org.springframework.boot.actuate.beans.BeansEndpoint
-
Creates a new
BeansEndpoint
that will describe the beans in the givencontext
and all of its ancestors. - BeansEndpoint.BeanDescriptor - Class in org.springframework.boot.actuate.beans
-
Description of a bean.
- BeansEndpoint.BeansDescriptor - Class in org.springframework.boot.actuate.beans
-
Description of an application's beans.
- BeansEndpoint.ContextBeansDescriptor - Class in org.springframework.boot.actuate.beans
-
Description of an application context beans.
- build() - Method in class org.springframework.boot.actuate.info.Info.Builder
-
Create a new
Info
instance based on the state of this builder. - Builder() - Constructor for class org.springframework.boot.actuate.info.Info.Builder
- BuildInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that exposesBuildProperties
. - BuildInfoContributor(BuildProperties) - Constructor for class org.springframework.boot.actuate.info.BuildInfoContributor
- byAccess(EndpointAccessResolver) - Static method in interface org.springframework.boot.actuate.endpoint.OperationFilter
-
Return an
OperationFilter
that filters based on the allowedaccess
as determined by anaccess resolver
.
C
- CachingOperationInvoker - Class in org.springframework.boot.actuate.endpoint.invoker.cache
-
An
OperationInvoker
that caches the response of an operation with a configurable time to live. - CachingOperationInvokerAdvisor - Class in org.springframework.boot.actuate.endpoint.invoker.cache
-
OperationInvokerAdvisor
to optionally provide result caching support. - CachingOperationInvokerAdvisor(Function<EndpointId, Long>) - Constructor for class org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvokerAdvisor
- canResolve(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.InvocationContext
-
Returns whether the context is capable of resolving an argument of the given
type
. - canResolve(Class<?>) - Method in interface org.springframework.boot.actuate.endpoint.OperationArgumentResolver
-
Return whether an argument of the given
type
can be resolved. - canResolve(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.ProducibleOperationArgumentResolver
- cap(Access) - Method in enum class org.springframework.boot.actuate.endpoint.Access
-
Cap access to a maximum permitted.
- changeProperties(SerializationConfig, BeanDescription, List<BeanPropertyWriter>) - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.GenericSerializerModifier
- CompositeHealthDescriptor - Class in org.springframework.boot.actuate.health
-
Description of health that is composed of other
health descriptors
. - configurationProperties() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint
- configurationProperties(SecurityContext) - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpointWebExtension
- ConfigurationPropertiesReportEndpoint - Class in org.springframework.boot.actuate.context.properties
-
@Endpoint
to expose application properties from@ConfigurationProperties
annotated beans. - ConfigurationPropertiesReportEndpoint(Iterable<SanitizingFunction>, Show) - Constructor for class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint
- ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptor - Class in org.springframework.boot.actuate.context.properties
-
Description of a
@ConfigurationProperties
bean. - ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesDescriptor - Class in org.springframework.boot.actuate.context.properties
-
Description of an application's
@ConfigurationProperties
beans. - ConfigurationPropertiesReportEndpoint.ContextConfigurationPropertiesDescriptor - Class in org.springframework.boot.actuate.context.properties
-
Description of an application context's
@ConfigurationProperties
beans. - ConfigurationPropertiesReportEndpoint.GenericSerializerModifier - Class in org.springframework.boot.actuate.context.properties
-
BeanSerializerModifier
to return only relevant configuration properties. - ConfigurationPropertiesReportEndpointWebExtension - Class in org.springframework.boot.actuate.context.properties
- ConfigurationPropertiesReportEndpointWebExtension(ConfigurationPropertiesReportEndpoint, Show, Set<String>) - Constructor for class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpointWebExtension
- configurationPropertiesWithPrefix(String) - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint
- configurationPropertiesWithPrefix(SecurityContext, String) - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpointWebExtension
- configureJsonMapper(JsonMapper.Builder) - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint
-
Configure Jackson's
JsonMapper
to be used to serialize the@ConfigurationProperties
objects into aMap
structure. - configureLogLevel(String, LogLevel) - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint
- CONTENT_TYPE_004 - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat
-
Prometheus text version 0.0.4.
- CONTENT_TYPE_OPENMETRICS_100 - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat
-
OpenMetrics text version 1.0.0.
- CONTENT_TYPE_PROTOBUF - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat
-
Prometheus metrics protobuf.
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.BuildInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.EnvironmentInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.GitInfoContributor
- contribute(Info.Builder) - Method in interface org.springframework.boot.actuate.info.InfoContributor
-
Contributes additional details using the specified
Builder
. - contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.JavaInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.MapInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.OsInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.ProcessInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.SimpleInfoContributor
- contribute(Info.Builder) - Method in class org.springframework.boot.actuate.info.SslInfoContributor
- ControllerEndpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.
- ControllerEndpointDiscoverer - Class in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
support - ControllerEndpointDiscoverer(ApplicationContext, List<PathMapper>, Collection<EndpointFilter<ExposableControllerEndpoint>>) - Constructor for class org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer
-
Deprecated.Create a new
ControllerEndpointDiscoverer
instance. - ControllerEndpointsSupplier - Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.3 in favor of
@Endpoint
and@WebEndpoint
support - ConversionServiceParameterValueMapper - Class in org.springframework.boot.actuate.endpoint.invoke.convert
-
ParameterValueMapper
backed by aConversionService
. - ConversionServiceParameterValueMapper() - Constructor for class org.springframework.boot.actuate.endpoint.invoke.convert.ConversionServiceParameterValueMapper
-
Create a new
ConversionServiceParameterValueMapper
instance. - ConversionServiceParameterValueMapper(ConversionService) - Constructor for class org.springframework.boot.actuate.endpoint.invoke.convert.ConversionServiceParameterValueMapper
-
Create a new
ConversionServiceParameterValueMapper
instance backed by a specific conversion service. - convert(String) - Method in class org.springframework.boot.actuate.endpoint.invoke.convert.IsoOffsetDateTimeConverter
- COOKIE_HEADERS - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include "Cookie" header (if any) in request headers and "Set-Cookie" (if any) in response headers.
- copyIfSet(Properties, String) - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Copy the specified key to the target
Properties
if it is set. - createEndpoint(Object, EndpointId, Access, Collection<O>) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Factory method called to create the
endpoint
. - createEndpoint(Object, EndpointId, Access, Collection<JmxOperation>) - Method in class org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointDiscoverer
- createEndpoint(Object, EndpointId, Access, Collection<Operation>) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer
-
Deprecated.
- createEndpoint(Object, EndpointId, Access, Collection<Operation>) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointDiscoverer
-
Deprecated.
- createEndpoint(Object, EndpointId, Access, Collection<WebOperation>) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointDiscoverer
- createHeapDumper() - Method in class org.springframework.boot.actuate.management.HeapDumpWebEndpoint
-
Factory method used to create the
HeapDumpWebEndpoint.HeapDumper
. - createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Factory method to create an
endpoint operation
. - createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker) - Method in class org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointDiscoverer
- createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer
-
Deprecated.
- createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointDiscoverer
-
Deprecated.
- createOperation(EndpointId, DiscoveredOperationMethod, OperationInvoker) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointDiscoverer
- createOperationKey(O) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Create an
EndpointDiscoverer.OperationKey
for the given operation. - createOperationKey(JmxOperation) - Method in class org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointDiscoverer
- createOperationKey(Operation) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer
-
Deprecated.
- createOperationKey(Operation) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointDiscoverer
-
Deprecated.
- createOperationKey(WebOperation) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointDiscoverer
- createSubPath(String) - Method in class org.springframework.boot.actuate.endpoint.web.EndpointMapping
D
- DEFAULT - Static variable in class org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes
-
Default
EndpointMediaTypes
for this version of Spring Boot. - DEFAULT - Static variable in interface org.springframework.boot.actuate.health.HttpCodeStatusMapper
-
An
HttpCodeStatusMapper
instance using default mappings. - DEFAULT_SUPPORTED_TYPES - Static variable in interface org.springframework.boot.actuate.endpoint.jackson.EndpointObjectMapper
-
The default supported types.
- defaultAccess() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.Endpoint
-
Level of access to the endpoint that is permitted by default.
- defaultAccess() - Element in annotation interface org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpoint
-
Level of access to the endpoint that is permitted by default.
- defaultAccess() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpoint
-
Deprecated.Level of access to the endpoint that is permitted by default.
- defaultAccess() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint
-
Deprecated.Level of access to the endpoint that is permitted by default.
- defaultAccess() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpoint
-
Deprecated.Level of access to the endpoint that is permitted by default.
- defaultAccess() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.WebEndpoint
-
Level of access to the endpoint that is permitted by default.
- defaultIncludes() - Static method in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Return the default
Include
. - DELETE - Enum constant in enum class org.springframework.boot.actuate.endpoint.OperationType
-
A delete operation.
- DELETE - Enum constant in enum class org.springframework.boot.actuate.endpoint.web.WebEndpointHttpMethod
-
An HTTP DELETE request.
- DELETE - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation
-
Perform a DELETE before shutdown.
- DeleteOperation - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Identifies a method on an
@Endpoint
as being a delete operation. - describeMappings(ApplicationContext) - Method in interface org.springframework.boot.actuate.web.mappings.MappingDescriptionProvider
-
Produce the descriptions of the mappings identified by this provider in the given
context
. - destroy() - Method in class org.springframework.boot.actuate.endpoint.jmx.JmxEndpointExporter
- DiscoveredEndpoint<O> - Interface in org.springframework.boot.actuate.endpoint.annotation
-
An
endpoint
discovered by anEndpointDiscoverer
. - DiscoveredOperationMethod - Class in org.springframework.boot.actuate.endpoint.annotation
-
An
OperationMethod
discovered by anEndpointDiscoverer
. - DiscoveredOperationMethod(Method, OperationType, AnnotationAttributes) - Constructor for class org.springframework.boot.actuate.endpoint.annotation.DiscoveredOperationMethod
- DiscovererEndpointFilter - Class in org.springframework.boot.actuate.endpoint.annotation
-
EndpointFilter
the matches based on theEndpointDiscoverer
the created the endpoint. - DiscovererEndpointFilter(Class<? extends EndpointDiscoverer<?, ?>>) - Constructor for class org.springframework.boot.actuate.endpoint.annotation.DiscovererEndpointFilter
-
Create a new
DiscovererEndpointFilter
instance. - DiskSpaceHealthIndicator - Class in org.springframework.boot.actuate.system
-
A
HealthIndicator
that checks available disk space and reports a status ofStatus.DOWN
when it drops below a configurable threshold. - DiskSpaceHealthIndicator(File, DataSize) - Constructor for class org.springframework.boot.actuate.system.DiskSpaceHealthIndicator
-
Create a new
DiskSpaceHealthIndicator
instance. - doHealthCheck(Health.Builder) - Method in class org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator
- doHealthCheck(Health.Builder) - Method in class org.springframework.boot.actuate.ssl.SslHealthIndicator
- doHealthCheck(Health.Builder) - Method in class org.springframework.boot.actuate.system.DiskSpaceHealthIndicator
- dumpHeap(Boolean) - Method in interface org.springframework.boot.actuate.management.HeapDumpWebEndpoint.HeapDumper
-
Dump the current heap to a file.
- dumpHeap(Boolean) - Method in class org.springframework.boot.actuate.management.HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper
E
- endpoint() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.EndpointExtension
-
The class of the endpoint to extend.
- endpoint() - Element in annotation interface org.springframework.boot.actuate.endpoint.jmx.annotation.EndpointJmxExtension
-
The
endpoint
class to which this JMX extension relates. - endpoint() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.EndpointWebExtension
-
The
endpoint
class to which this Web extension relates. - Endpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Identifies a type as being an actuator endpoint that provides information about the running application.
- EndpointAccessResolver - Interface in org.springframework.boot.actuate.endpoint
-
Resolver for the permitted level of
access
to an endpoint. - EndpointConverter - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Qualifier for beans that are needed to convert
@Endpoint
input parameters. - EndpointDiscoverer<E,
O> - Class in org.springframework.boot.actuate.endpoint.annotation -
A Base for
EndpointsSupplier
implementations that discover@Endpoint
beans and@EndpointExtension
beans in an application context. - EndpointDiscoverer(ApplicationContext, ParameterValueMapper, Collection<OperationInvokerAdvisor>, Collection<EndpointFilter<E>>, Collection<OperationFilter<O>>) - Constructor for class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Create a new
EndpointDiscoverer
instance. - EndpointDiscoverer.OperationKey - Class in org.springframework.boot.actuate.endpoint.annotation
-
A key generated for an
Operation
based on specific criteria from the actual operation implementation. - EndpointExtension - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Annotation primarily used as a meta-annotation to indicate that an annotation provides extension support for an endpoint.
- EndpointFilter<E> - Interface in org.springframework.boot.actuate.endpoint
-
Strategy class that can be used to filter
endpoints
. - EndpointId - Class in org.springframework.boot.actuate.endpoint
-
An identifier for an actuator endpoint.
- EndpointJmxExtension - Annotation Interface in org.springframework.boot.actuate.endpoint.jmx.annotation
-
Identifies a type as being a JMX-specific extension of an
@Endpoint
. - EndpointLinksResolver - Class in org.springframework.boot.actuate.endpoint.web
-
A resolver for
links
to web endpoints. - EndpointLinksResolver(Collection<? extends ExposableEndpoint<?>>) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointLinksResolver
-
Creates a new
EndpointLinksResolver
that will resolve links to the givenendpoints
. - EndpointLinksResolver(Collection<? extends ExposableEndpoint<?>>, String) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointLinksResolver
-
Creates a new
EndpointLinksResolver
that will resolve links to the givenendpoints
that are exposed beneath the givenbasePath
. - EndpointMapping - Class in org.springframework.boot.actuate.endpoint.web
-
A value object for the base mapping for endpoints.
- EndpointMapping(String) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointMapping
-
Creates a new
EndpointMapping
using the givenpath
. - EndpointMBean - Class in org.springframework.boot.actuate.endpoint.jmx
-
Adapter to expose a
JMX endpoint
as aDynamicMBean
. - EndpointMediaTypes - Class in org.springframework.boot.actuate.endpoint.web
-
Media types that are, by default, produced and consumed by an endpoint.
- EndpointMediaTypes(String...) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes
- EndpointMediaTypes(List<String>) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes
- EndpointMediaTypes(List<String>, List<String>) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes
- EndpointObjectMapper - Interface in org.springframework.boot.actuate.endpoint.jackson
-
Interface used to supply the
ObjectMapper
that should be used when serializing endpoint results. - EndpointObjectNameFactory - Interface in org.springframework.boot.actuate.endpoint.jmx
-
A factory to create an
ObjectName
for anEndpointMBean
. - EndpointServlet - Class in org.springframework.boot.actuate.endpoint.web
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
- EndpointServlet(Servlet) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointServlet
-
Deprecated.
- EndpointServlet(Class<? extends Servlet>) - Constructor for class org.springframework.boot.actuate.endpoint.web.EndpointServlet
-
Deprecated.
- EndpointsSupplier<E> - Interface in org.springframework.boot.actuate.endpoint
-
Provides access to a collection of
endpoints
. - EndpointWebExtension - Annotation Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Identifies a type as being a Web-specific extension of an
@Endpoint
. - environment(String) - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint
- environment(SecurityContext, String) - Method in class org.springframework.boot.actuate.env.EnvironmentEndpointWebExtension
- EnvironmentEndpoint - Class in org.springframework.boot.actuate.env
-
@Endpoint
to exposeenvironment
information. - EnvironmentEndpoint(Environment, Iterable<SanitizingFunction>, Show) - Constructor for class org.springframework.boot.actuate.env.EnvironmentEndpoint
- EnvironmentEndpoint.EnvironmentDescriptor - Class in org.springframework.boot.actuate.env
-
Description of an
Environment
. - EnvironmentEndpoint.EnvironmentEntryDescriptor - Class in org.springframework.boot.actuate.env
-
Description of an entry of the
Environment
. - EnvironmentEndpoint.PropertySourceDescriptor - Class in org.springframework.boot.actuate.env
-
Description of a
PropertySource
. - EnvironmentEndpoint.PropertySourceEntryDescriptor - Class in org.springframework.boot.actuate.env
-
Description of a particular entry of
PropertySource
. - EnvironmentEndpoint.PropertySummaryDescriptor - Class in org.springframework.boot.actuate.env
-
Description of a particular entry of the
Environment
. - EnvironmentEndpoint.PropertyValueDescriptor - Class in org.springframework.boot.actuate.env
-
Description of a property's value, including its origin if available.
- EnvironmentEndpointWebExtension - Class in org.springframework.boot.actuate.env
-
@EndpointWebExtension
for theEnvironmentEndpoint
. - EnvironmentEndpointWebExtension(EnvironmentEndpoint, Show, Set<String>) - Constructor for class org.springframework.boot.actuate.env.EnvironmentEndpointWebExtension
- environmentEntry(String) - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint
- environmentEntry(SecurityContext, String) - Method in class org.springframework.boot.actuate.env.EnvironmentEndpointWebExtension
- EnvironmentInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that provides all environment entries prefixed with info. - EnvironmentInfoContributor(ConfigurableEnvironment) - Constructor for class org.springframework.boot.actuate.info.EnvironmentInfoContributor
- equals(Object) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer.OperationKey
- equals(Object) - Method in class org.springframework.boot.actuate.endpoint.EndpointId
- equals(Object) - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
- equals(Object) - Method in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
- equals(Object) - Method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
- equals(Object) - Method in class org.springframework.boot.actuate.info.Info
- events(String, OffsetDateTime, String) - Method in class org.springframework.boot.actuate.audit.AuditEventsEndpoint
- ExposableControllerEndpoint - Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.3 in favor of
@Endpoint
and@WebEndpoint
support - ExposableEndpoint<O> - Interface in org.springframework.boot.actuate.endpoint
-
Information describing an endpoint that can be exposed in some technology specific way.
- ExposableJmxEndpoint - Interface in org.springframework.boot.actuate.endpoint.jmx
-
Information describing an endpoint that can be exposed over JMX.
- ExposableServletEndpoint - Interface in org.springframework.boot.actuate.endpoint.web
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
- ExposableWebEndpoint - Interface in org.springframework.boot.actuate.endpoint.web
-
Information describing an endpoint that can be exposed over the web.
- extractContent(PropertySource<?>) - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Extract the raw content based on the specified
PropertySource
.
F
- filter() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.EndpointExtension
-
The filter class used to determine when the extension applies.
- filter() - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return an optional filter that determines if the sanitizing function applies.
- FilteredEndpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Annotation that can be used on an
@Endpoint
to implement implicit filtering. - find(String, Instant, String) - Method in interface org.springframework.boot.actuate.audit.AuditEventRepository
-
Find audit events of specified type relating to the specified principal that occurred
after
the time provided. - find(String, Instant, String) - Method in class org.springframework.boot.actuate.audit.InMemoryAuditEventRepository
- findAll() - Method in interface org.springframework.boot.actuate.web.exchanges.HttpExchangeRepository
-
Find all
HttpExchange
instances contained in the repository. - findAll() - Method in class org.springframework.boot.actuate.web.exchanges.InMemoryHttpExchangeRepository
- finish(Clock, RecordableHttpResponse, Supplier<Principal>, Supplier<String>, Set<Include>) - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Started
-
Finish the request and return a new
HttpExchange
instance. - finish(Clock, RecordableHttpResponse, Supplier<Principal>, Supplier<String>, Include...) - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Started
-
Finish the request and return a new
HttpExchange
instance. - finish(RecordableHttpResponse, Supplier<Principal>, Supplier<String>, Set<Include>) - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Started
-
Finish the request and return a new
HttpExchange
instance. - finish(RecordableHttpResponse, Supplier<Principal>, Supplier<String>, Include...) - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Started
-
Finish the request and return a new
HttpExchange
instance. - from(String) - Static method in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
-
Factory method to create a new
WebServerNamespace
from a value. - from(String) - Static method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
-
Creates an
AdditionalHealthEndpointPath
from the given input. - fromPropertyValue(String) - Static method in class org.springframework.boot.actuate.endpoint.EndpointId
-
Factory method to create a new
EndpointId
from a property value. - FULL - Enum constant in enum class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor.Mode
-
Expose all available data, including custom properties.
G
- generateContent() - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Extract the content to contribute to the info endpoint.
- GenericSerializerModifier() - Constructor for class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.GenericSerializerModifier
- get() - Method in interface org.springframework.boot.actuate.endpoint.jackson.EndpointObjectMapper
-
Return the
ObjectMapper
that should be used to serializeOperationResponseBody
endpoint results. - get(int) - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameters
-
Return the parameter at the specified index.
- get(String) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroups
-
Return the group with the specified name or
null
if the name is not known. - get(String) - Method in class org.springframework.boot.actuate.info.Info
- get(String, Class<T>) - Method in class org.springframework.boot.actuate.info.Info
- get(AdditionalHealthEndpointPath) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroups
-
Return the group with the specified additional path or
null
if no group with that path is found. - GET - Enum constant in enum class org.springframework.boot.actuate.endpoint.web.WebEndpointHttpMethod
-
An HTTP GET request.
- getActiveProfiles() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentDescriptor
- getActiveProfiles() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentEntryDescriptor
- getAdditional() - Method in class org.springframework.boot.actuate.sbom.SbomProperties
- getAdditionalPath() - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroup
-
Return an additional path that can be used to map the health group to an alternative location.
- getAdditionalPaths(EndpointId, WebServerNamespace) - Method in interface org.springframework.boot.actuate.endpoint.web.AdditionalPathsMapper
-
Resolve the additional paths for the specified
endpointId
and web server namespace. - getAdditionalPaths(WebServerNamespace) - Method in interface org.springframework.boot.actuate.endpoint.web.PathMappedEndpoint
-
Return any additional paths (relative to the context) for the given
WebServerNamespace
. - getAdditionalPaths(WebServerNamespace, EndpointId) - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the additional paths for each mapped endpoint.
- getAggregateStatus(Set<Status>) - Method in class org.springframework.boot.actuate.health.SimpleStatusAggregator
- getAggregateStatus(Set<Status>) - Method in interface org.springframework.boot.actuate.health.StatusAggregator
-
Return the aggregate status for the given set of statuses.
- getAggregateStatus(Status...) - Method in interface org.springframework.boot.actuate.health.StatusAggregator
-
Return the aggregate status for the given set of statuses.
- getAliases() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.BeanDescriptor
- getAllPaths() - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the full paths for each mapped endpoint (excluding additional paths).
- getAllRootPaths() - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the root paths for each mapped endpoint (excluding additional paths).
- getAllWithAdditionalPath(WebServerNamespace) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroups
-
Return all the groups with an additional path on the specified
WebServerNamespace
. - getAnnotation(Class<T>) - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameter
-
Returns this element's annotation for the specified type if such an annotation is present, else null.
- getApplication() - Method in class org.springframework.boot.actuate.sbom.SbomProperties
- getArguments() - Method in class org.springframework.boot.actuate.endpoint.InvocationContext
-
Return the invocation arguments.
- getAttribute(String) - Method in class org.springframework.boot.actuate.endpoint.jmx.EndpointMBean
- getAttributes(String[]) - Method in class org.springframework.boot.actuate.endpoint.jmx.EndpointMBean
- getAuditEvent() - Method in class org.springframework.boot.actuate.audit.listener.AuditApplicationEvent
-
Get the audit event.
- getBasePath() - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the base path for the endpoints.
- getBeans() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.ContextBeansDescriptor
- getBeans() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.ContextConfigurationPropertiesDescriptor
- getBody() - Method in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Returns the body for the response.
- getClassName() - Method in class org.springframework.boot.actuate.web.mappings.HandlerMethodDescription
- getComponents() - Method in class org.springframework.boot.actuate.health.CompositeHealthDescriptor
- getConfiguredLevel() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggerLevelsDescriptor
- getConsumed() - Method in class org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes
-
Returns the media types consumed by an endpoint.
- getConsumes() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
-
Returns the media types that the operation consumes.
- getContentType() - Method in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Returns the content type of the response.
- getContexts() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.BeansDescriptor
- getContexts() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesDescriptor
- getContexts() - Method in class org.springframework.boot.actuate.web.mappings.MappingsEndpoint.ApplicationMappingsDescriptor
- getController() - Method in interface org.springframework.boot.actuate.endpoint.web.annotation.ExposableControllerEndpoint
-
Deprecated.Return the source controller that contains
@RequestMapping
methods. - getCron() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.ScheduledTasksDescriptor
- getCustom() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.ScheduledTasksDescriptor
- getData() - Method in class org.springframework.boot.actuate.audit.AuditEvent
-
Returns the event data.
- getDefault() - Static method in interface org.springframework.boot.actuate.health.StatusAggregator
-
Return
StatusAggregator
instance using default ordering rules. - getDefaultAccess() - Method in class org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint
- getDefaultAccess() - Method in interface org.springframework.boot.actuate.endpoint.ExposableEndpoint
-
Returns the access to the endpoint that is permitted by default.
- getDefaultProfiles() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentDescriptor
- getDefaultProfiles() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentEntryDescriptor
- getDependencies() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.BeanDescriptor
- getDescription() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperation
-
Returns the description of the operation.
- getDescription() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperationParameter
-
Return the description of the parameter or
null
if none is available. - getDescriptor() - Method in class org.springframework.boot.actuate.web.mappings.HandlerMethodDescription
- getDetails() - Method in class org.springframework.boot.actuate.health.CompositeHealthDescriptor
- getDetails() - Method in class org.springframework.boot.actuate.health.IndicatedHealthDescriptor
- getDetails() - Method in class org.springframework.boot.actuate.info.Info
-
Return the content.
- getEffectiveLevel() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.SingleLoggerLevelsDescriptor
- getEndpoint(EndpointId) - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the
PathMappedEndpoint
with the given ID ornull
if the endpoint cannot be found. - getEndpointBean() - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredEndpoint
- getEndpointBean() - Method in interface org.springframework.boot.actuate.endpoint.annotation.DiscoveredEndpoint
-
Return the source bean that was used to construct the
DiscoveredEndpoint
. - getEndpointId() - Method in class org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint
- getEndpointId() - Method in interface org.springframework.boot.actuate.endpoint.ExposableEndpoint
-
Return the endpoint ID.
- getEndpoints() - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
- getEndpoints() - Method in interface org.springframework.boot.actuate.endpoint.EndpointsSupplier
-
Return the provided endpoints.
- getEndpointServlet() - Method in interface org.springframework.boot.actuate.endpoint.web.ExposableServletEndpoint
-
Deprecated.Return details of the servlet that should be registered.
- getEndpointType() - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
- getEvents() - Method in class org.springframework.boot.actuate.audit.AuditEventsEndpoint.AuditEventsDescriptor
- getException() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.LastExecution
- getExchanges() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchangesEndpoint.HttpExchangesDescriptor
- getExpression() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.CronTaskDescriptor
- getFixedDelay() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.ScheduledTasksDescriptor
- getFixedRate() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.ScheduledTasksDescriptor
- getGroups() - Method in class org.springframework.boot.actuate.health.SystemHealthDescriptor
- getGroups() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggersDescriptor
- getHeaders() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Request
-
Return the request headers.
- getHeaders() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Response
-
Return the response headers.
- getHeaders() - Method in interface org.springframework.boot.actuate.web.exchanges.RecordableHttpRequest
-
Returns a modifiable copy of the headers of the request.
- getHeaders() - Method in interface org.springframework.boot.actuate.web.exchanges.RecordableHttpResponse
-
Returns a modifiable copy of the headers of the response.
- getHref() - Method in class org.springframework.boot.actuate.endpoint.web.Link
-
Returns the href of the link.
- getHttpCodeStatusMapper() - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroup
-
Returns the
HttpCodeStatusMapper
that should be used for this group. - getHttpMethod() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
-
Returns the HTTP method for the operation.
- getId() - Method in interface org.springframework.boot.actuate.endpoint.web.WebOperation
-
Returns the ID of the operation that uniquely identifies it within its endpoint.
- getId() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Session
-
Return the ID of the session.
- getInitialDelay() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.IntervalTaskDescriptor
- getInputs() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptor
- getInterval() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.IntervalTaskDescriptor
- getKey() - Method in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Return the key of the data.
- getLastExecution() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.TaskDescriptor
- getLevels() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggersDescriptor
- getLocation() - Method in class org.springframework.boot.actuate.sbom.SbomProperties.Sbom
- getLoggers() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggersDescriptor
- getLowerCaseKey() - Method in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Return the key as a lowercase value.
- getMappingName() - Method in interface org.springframework.boot.actuate.web.mappings.MappingDescriptionProvider
-
Returns the name of the mappings described by this provider.
- getMappings() - Method in class org.springframework.boot.actuate.web.mappings.MappingsEndpoint.ContextMappingsDescriptor
- getMatchAllRemainingPathSegmentsVariable() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
-
Returns the name of the variable used to catch all remaining path segments
null
. - getMBeanInfo() - Method in class org.springframework.boot.actuate.endpoint.jmx.EndpointMBean
- getMediaType() - Method in class org.springframework.boot.actuate.sbom.SbomProperties.Sbom
- getMembers() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.GroupLoggerLevelsDescriptor
- getMessage() - Method in class org.springframework.boot.actuate.context.ShutdownEndpoint.ShutdownDescriptor
- getMessage() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.ExceptionInfo
- getMethod() - Method in class org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod
-
Return the source Java method.
- getMethod() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Request
-
Return the HTTP method requested.
- getMethod() - Method in interface org.springframework.boot.actuate.web.exchanges.RecordableHttpRequest
-
Returns the method (GET, POST, etc.) of the request.
- getMissingParameters() - Method in exception class org.springframework.boot.actuate.endpoint.invoke.MissingParametersException
-
Returns the parameters that were missing.
- getMode() - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Return the mode that should be used to expose the content.
- getName() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameter
-
Returns the parameter name.
- getName() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperation
-
Returns the name of the operation.
- getName() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperationParameter
-
Return the name of the operation parameter.
- getName() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySourceDescriptor
- getName() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySourceEntryDescriptor
- getName() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Principal
-
Return the name of the principal.
- getName() - Method in class org.springframework.boot.actuate.web.mappings.HandlerMethodDescription
- getName(LogLevel) - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggerLevelsDescriptor
- getNames() - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroups
-
Return the names of any additional groups.
- getNamespace() - Method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
-
Returns the
WebServerNamespace
associated with this path. - getNestedMap(Map<String, Object>, String) - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Return the nested map with the specified key or empty map if the specified map contains no mapping for the key.
- getNextExecution() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.TaskDescriptor
- getObjectName(ExposableJmxEndpoint) - Method in interface org.springframework.boot.actuate.endpoint.jmx.EndpointObjectNameFactory
-
Generate an
ObjectName
for the specifiedendpoint
. - getOperationMethod() - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation
- getOperations() - Method in class org.springframework.boot.actuate.endpoint.AbstractExposableEndpoint
- getOperations() - Method in interface org.springframework.boot.actuate.endpoint.ExposableEndpoint
-
Returns the operations of the endpoint.
- getOperationType() - Method in class org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod
-
Return the operation type.
- getOrigin() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertyValueDescriptor
- getOriginParents() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertyValueDescriptor
- getOutputType() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperation
-
Returns the type of the output of the operation.
- getParameter() - Method in exception class org.springframework.boot.actuate.endpoint.invoke.ParameterMappingException
-
Return the parameter being mapped.
- getParameterCount() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameters
-
Return the total number of parameters.
- getParameters() - Method in class org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod
-
Return the operation parameters.
- getParameters() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperation
-
Returns the parameters the operation expects in the order that they should be provided.
- getParentId() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.ContextBeansDescriptor
- getParentId() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.ContextConfigurationPropertiesDescriptor
- getParentId() - Method in class org.springframework.boot.actuate.web.mappings.MappingsEndpoint.ContextMappingsDescriptor
- getPath() - Method in class org.springframework.boot.actuate.endpoint.web.EndpointMapping
-
Returns the path to which endpoints should be mapped.
- getPath() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
-
Returns the path for the operation.
- getPath(EndpointId) - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the full path for the endpoint with the given ID or
null
if the endpoint cannot be found. - getPrefix() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptor
- getPrimary() - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroups
-
Return the primary group used by the endpoint.
- getPrincipal() - Method in class org.springframework.boot.actuate.audit.AuditEvent
-
Returns the user principal responsible for the event or an empty String if the principal is not available.
- getPrincipal() - Method in interface org.springframework.boot.actuate.endpoint.SecurityContext
-
Return the currently authenticated
Principal
ornull
. - getPrincipal() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Returns the principal.
- getProduced() - Method in class org.springframework.boot.actuate.endpoint.web.EndpointMediaTypes
-
Returns the media types produced by an endpoint.
- getProducedMimeType() - Method in enum class org.springframework.boot.actuate.endpoint.ApiVersion
- getProducedMimeType() - Method in interface org.springframework.boot.actuate.endpoint.Producible
-
Mime type that can be produced.
- getProducedMimeType() - Method in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat
- getProduces() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
-
Returns the media types that the operation produces.
- getProducesMediaTypes() - Method in class org.springframework.boot.actuate.endpoint.annotation.DiscoveredOperationMethod
- getProperties() - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint.ConfigurationPropertiesBeanDescriptor
- getProperties() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySourceDescriptor
- getProperties() - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Return the properties that this instance manages.
- getProperty() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentEntryDescriptor
- getProperty() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySourceEntryDescriptor
- getPropertySource() - Method in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Return the property source that provided the data or
null
If the data was not from aPropertySource
. - getPropertySources() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentDescriptor
- getPropertySources() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.EnvironmentEntryDescriptor
- getPublisher() - Method in class org.springframework.boot.actuate.security.AbstractAuthenticationAuditListener
- getPublisher() - Method in class org.springframework.boot.actuate.security.AbstractAuthorizationAuditListener
- getReason() - Method in exception class org.springframework.boot.actuate.endpoint.InvalidEndpointRequestException
-
Return the reason explaining why the request is invalid, potentially
null
. - getRemoteAddress() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Request
-
Return the remote address that made the request.
- getRemoteAddress() - Method in interface org.springframework.boot.actuate.web.exchanges.RecordableHttpRequest
-
Returns the remote address from which the request was sent, if available.
- getRequest() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Returns the request that started the exchange.
- getRequestPredicate() - Method in interface org.springframework.boot.actuate.endpoint.web.WebOperation
-
Returns the predicate for requests that can be handled by this operation.
- getResource() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.BeanDescriptor
- getResponse() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Returns the response that completed the exchange.
- getRootPath() - Method in interface org.springframework.boot.actuate.endpoint.web.PathMappedEndpoint
-
Return the root path of the endpoint (relative to the context and base path) that exposes it.
- getRootPath(List<PathMapper>, EndpointId) - Static method in interface org.springframework.boot.actuate.endpoint.web.PathMapper
-
Resolve the root path for the specified
endpointId
from the given path mappers. - getRootPath(EndpointId) - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Return the root path for the endpoint with the given ID or
null
if the endpoint cannot be found. - getRootPath(EndpointId) - Method in interface org.springframework.boot.actuate.endpoint.web.PathMapper
-
Resolve the root path for the specified
endpointId
. - getRunnable() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.TaskDescriptor
- getScope() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.BeanDescriptor
- getSession() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Returns the session details.
- getSource() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySummaryDescriptor
- getSpringBootVersion() - Method in class org.springframework.boot.actuate.startup.StartupEndpoint.StartupDescriptor
- getState(ApplicationAvailability) - Method in class org.springframework.boot.actuate.availability.AvailabilityStateHealthIndicator
-
Return the current availability state.
- getState(ApplicationAvailability) - Method in class org.springframework.boot.actuate.availability.LivenessStateHealthIndicator
- getState(ApplicationAvailability) - Method in class org.springframework.boot.actuate.availability.ReadinessStateHealthIndicator
- getStatus() - Method in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Returns the status for the response.
- getStatus() - Method in class org.springframework.boot.actuate.health.CompositeHealthDescriptor
- getStatus() - Method in class org.springframework.boot.actuate.health.HealthDescriptor
-
Return the status of the component.
- getStatus() - Method in class org.springframework.boot.actuate.health.IndicatedHealthDescriptor
- getStatus() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.LastExecution
- getStatus() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Response
-
Return the status code of the response.
- getStatus() - Method in interface org.springframework.boot.actuate.web.exchanges.RecordableHttpResponse
-
The status of the response.
- getStatusAggregator() - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroup
-
Returns the status aggregator that should be used for this group.
- getStatusCode(Status) - Method in interface org.springframework.boot.actuate.health.HttpCodeStatusMapper
-
Return the HTTP status code that corresponds to the given
health status
. - getStatusCode(Status) - Method in class org.springframework.boot.actuate.health.SimpleHttpCodeStatusMapper
- getSupportedTypes() - Method in interface org.springframework.boot.actuate.endpoint.jackson.EndpointObjectMapper
-
Return the types that this endpoint mapper supports.
- getTarget() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.RunnableDescriptor
- getThreads() - Method in class org.springframework.boot.actuate.management.ThreadDumpEndpoint.ThreadDumpDescriptor
- getTime() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.LastExecution
- getTime() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.NextExecution
- getTimeline() - Method in class org.springframework.boot.actuate.startup.StartupEndpoint.StartupDescriptor
- getTimestamp() - Method in class org.springframework.boot.actuate.audit.AuditEvent
-
Returns the date/time that the event was logged.
- getTimestamp() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Returns the instant that the exchange started.
- getTimeTaken() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Returns the total time taken for the exchange.
- getTimeToLive() - Method in class org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvoker
-
Return the maximum time in milliseconds that a response can be cached.
- getTrigger() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.CustomTriggerTaskDescriptor
- getType() - Method in class org.springframework.boot.actuate.audit.AuditEvent
-
Returns the type of event.
- getType() - Method in class org.springframework.boot.actuate.beans.BeansEndpoint.BeanDescriptor
- getType() - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation
- getType() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameter
-
Returns the parameter type.
- getType() - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperationParameter
-
Return the type of the operation parameter.
- getType() - Method in interface org.springframework.boot.actuate.endpoint.Operation
-
Returns the
type
of the operation. - getType() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.ExceptionInfo
- getUri() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchange.Request
-
Return the URI requested.
- getUri() - Method in interface org.springframework.boot.actuate.web.exchanges.RecordableHttpRequest
-
Returns the URI of the request.
- getValue() - Method in exception class org.springframework.boot.actuate.endpoint.invoke.ParameterMappingException
-
Return the value being mapped.
- getValue() - Method in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Return the value of the data.
- getValue() - Method in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
-
Return the value of the namespace.
- getValue() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySummaryDescriptor
- getValue() - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertyValueDescriptor
- getValue() - Method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
-
Returns the value corresponding to this path.
- GitInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that exposesGitProperties
. - GitInfoContributor(GitProperties) - Constructor for class org.springframework.boot.actuate.info.GitInfoContributor
- GitInfoContributor(GitProperties, InfoPropertiesInfoContributor.Mode) - Constructor for class org.springframework.boot.actuate.info.GitInfoContributor
- GroupLoggerLevelsDescriptor(LogLevel, List<String>) - Constructor for class org.springframework.boot.actuate.logging.LoggersEndpoint.GroupLoggerLevelsDescriptor
H
- HandlerMethodDescription - Class in org.springframework.boot.actuate.web.mappings
-
A description of a
HandlerMethod
. - HandlerMethodDescription(HandlerMethod) - Constructor for class org.springframework.boot.actuate.web.mappings.HandlerMethodDescription
- hashCode() - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer.OperationKey
- hashCode() - Method in class org.springframework.boot.actuate.endpoint.EndpointId
- hashCode() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
- hashCode() - Method in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
- hashCode() - Method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
- hashCode() - Method in class org.springframework.boot.actuate.info.Info
- hasMandatoryParameter() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameters
-
Return if any of the contained parameters are
mandatory
. - hasNamespace(WebServerNamespace) - Method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
-
Returns
true
if this path has the givenWebServerNamespace
. - hasParameters() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameters
-
Return
true
if there is at least one parameter. - health() - Method in class org.springframework.boot.actuate.health.HealthEndpoint
- health(ApiVersion, WebServerNamespace, SecurityContext) - Method in class org.springframework.boot.actuate.health.HealthEndpointWebExtension
- health(ApiVersion, WebServerNamespace, SecurityContext) - Method in class org.springframework.boot.actuate.health.ReactiveHealthEndpointWebExtension
- health(ApiVersion, WebServerNamespace, SecurityContext, boolean, String...) - Method in class org.springframework.boot.actuate.health.HealthEndpointWebExtension
- health(ApiVersion, WebServerNamespace, SecurityContext, boolean, String...) - Method in class org.springframework.boot.actuate.health.ReactiveHealthEndpointWebExtension
- health(ApiVersion, WebServerNamespace, SecurityContext, String...) - Method in class org.springframework.boot.actuate.health.HealthEndpointWebExtension
- health(ApiVersion, WebServerNamespace, SecurityContext, String...) - Method in class org.springframework.boot.actuate.health.ReactiveHealthEndpointWebExtension
- HealthDescriptor - Class in org.springframework.boot.actuate.health
-
Description of health including a status.
- HealthDescriptor() - Constructor for class org.springframework.boot.actuate.health.HealthDescriptor
- HealthEndpoint - Class in org.springframework.boot.actuate.health
-
@Endpoint
to expose application health information. - HealthEndpoint(HealthContributorRegistry, ReactiveHealthContributorRegistry, HealthEndpointGroups, Duration) - Constructor for class org.springframework.boot.actuate.health.HealthEndpoint
-
Create a new
HealthEndpoint
instance. - HealthEndpointGroup - Interface in org.springframework.boot.actuate.health
-
A logical grouping of
health contributors
that can be exposed by theHealthEndpoint
. - HealthEndpointGroups - Interface in org.springframework.boot.actuate.health
-
A collection of
groups
for use with a health endpoint. - HealthEndpointGroupsPostProcessor - Interface in org.springframework.boot.actuate.health
-
Hook that allows for custom modification of
HealthEndpointGroups
— for example, automatically adding additional auto-configured groups. - HealthEndpointWebExtension - Class in org.springframework.boot.actuate.health
-
@EndpointWebExtension
for theHealthEndpoint
. - HealthEndpointWebExtension(HealthContributorRegistry, ReactiveHealthContributorRegistry, HealthEndpointGroups, Duration) - Constructor for class org.springframework.boot.actuate.health.HealthEndpointWebExtension
-
Create a new
HealthEndpointWebExtension
instance. - healthForPath(String...) - Method in class org.springframework.boot.actuate.health.HealthEndpoint
- heapDump(Boolean) - Method in class org.springframework.boot.actuate.management.HeapDumpWebEndpoint
- HeapDumperUnavailableException(String, Throwable) - Constructor for exception class org.springframework.boot.actuate.management.HeapDumpWebEndpoint.HeapDumperUnavailableException
- HeapDumpWebEndpoint - Class in org.springframework.boot.actuate.management
-
Web
@Endpoint
to expose heap dumps. - HeapDumpWebEndpoint() - Constructor for class org.springframework.boot.actuate.management.HeapDumpWebEndpoint
- HeapDumpWebEndpoint(long) - Constructor for class org.springframework.boot.actuate.management.HeapDumpWebEndpoint
- HeapDumpWebEndpoint.HeapDumper - Interface in org.springframework.boot.actuate.management
-
Strategy interface used to dump the heap to a file.
- HeapDumpWebEndpoint.HeapDumperUnavailableException - Exception Class in org.springframework.boot.actuate.management
-
Exception to be thrown if the
HeapDumpWebEndpoint.HeapDumper
cannot be created. - HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper - Class in org.springframework.boot.actuate.management
-
HeapDumpWebEndpoint.HeapDumper
that usescom.sun.management.HotSpotDiagnosticMXBean
, available on Oracle and OpenJDK, to dump the heap to a file. - HotSpotDiagnosticMXBeanHeapDumper() - Constructor for class org.springframework.boot.actuate.management.HeapDumpWebEndpoint.HotSpotDiagnosticMXBeanHeapDumper
- HttpCodeStatusMapper - Interface in org.springframework.boot.actuate.health
-
Strategy used to map a
health status
to an HTTP status code. - HttpExchange - Class in org.springframework.boot.actuate.web.exchanges
-
An HTTP request and response exchange.
- HttpExchange(Instant, HttpExchange.Request, HttpExchange.Response, HttpExchange.Principal, HttpExchange.Session, Duration) - Constructor for class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Primarily for use by
HttpExchangeRepository
implementations when recreating an exchange from a persistent store. - HttpExchange.Principal - Class in org.springframework.boot.actuate.web.exchanges
-
Principal associated with an HTTP request-response exchange.
- HttpExchange.Request - Class in org.springframework.boot.actuate.web.exchanges
-
The request that started the exchange.
- HttpExchange.Response - Class in org.springframework.boot.actuate.web.exchanges
-
The response that finished the exchange.
- HttpExchange.Session - Class in org.springframework.boot.actuate.web.exchanges
-
The session associated with the exchange.
- HttpExchange.Started - Class in org.springframework.boot.actuate.web.exchanges
-
A started request that when
finished
will return a newHttpExchange
instance. - HttpExchangeRepository - Interface in org.springframework.boot.actuate.web.exchanges
-
A repository for
HttpExchange
instances. - httpExchanges() - Method in class org.springframework.boot.actuate.web.exchanges.HttpExchangesEndpoint
- HttpExchangesEndpoint - Class in org.springframework.boot.actuate.web.exchanges
-
@Endpoint
to exposeHttpExchange
information. - HttpExchangesEndpoint(HttpExchangeRepository) - Constructor for class org.springframework.boot.actuate.web.exchanges.HttpExchangesEndpoint
-
Create a new
HttpExchangesEndpoint
instance. - HttpExchangesEndpoint.HttpExchangesDescriptor - Class in org.springframework.boot.actuate.web.exchanges
-
Description of an application's
HttpExchange
entries.
I
- id() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.Endpoint
-
The id of the endpoint (must follow
EndpointId
rules). - id() - Element in annotation interface org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpoint
-
The id of the endpoint.
- id() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpoint
-
Deprecated.The id of the endpoint.
- id() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint
-
Deprecated.The id of the endpoint.
- id() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpoint
-
Deprecated.The id of the endpoint.
- id() - Element in annotation interface org.springframework.boot.actuate.endpoint.web.annotation.WebEndpoint
-
The id of the endpoint.
- ID - Static variable in class org.springframework.boot.actuate.health.HealthEndpoint
-
Health endpoint id.
- ifKeyContains(String...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key contains any of the given values (ignoring case).
- ifKeyEndsWith(String...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key ends with any of the given values (ignoring case).
- ifKeyEquals(String...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key is equal to any of the given values (ignoring case).
- ifKeyMatches(String...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key matches any of the given regex patterns (ignoring case).
- ifKeyMatches(Predicate<String>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key matches any of the given predicate.
- ifKeyMatches(List<Predicate<String>>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key matches any of the given predicates.
- ifKeyMatches(Pattern...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key matches any of the given patterns.
- ifKeyMatchesIgnoringCase(BiPredicate<String, String>, String...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data key and any of the values match the given predicate.
- ifLikelyCredential() - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data is likely to contain a credential.
- ifLikelySensitive() - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data is likely to contain a sensitive value.
- ifLikelySensitiveProperty() - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data is likely to contain a sensitive property value.
- ifLikelyUri() - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data is likely to contain a URI.
- ifMatches(Predicate<SanitizableData>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data matches the given predicate.
- ifMatches(List<Predicate<SanitizableData>>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data matches any of the given predicates.
- ifValueMatches(Predicate<Object>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data value matches the given predicate.
- ifValueMatches(List<Predicate<Object>>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data value matches any of the given predicates.
- ifValueStringMatches(String...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data string value matches any of the given regex patterns (ignoring case).
- ifValueStringMatches(Predicate<String>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data string value matches the given predicate.
- ifValueStringMatches(List<Predicate<String>>) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data string value matches any of the given predicates.
- ifValueStringMatches(Pattern...) - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data string value matches any of the given patterns.
- ifVcapServices() - Method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Return a new function with a filter that also applies if the data is for VCAP services.
- Include - Enum Class in org.springframework.boot.actuate.web.exchanges
-
Include options for HTTP exchanges.
- IndicatedHealthDescriptor - Class in org.springframework.boot.actuate.health
-
Description of health obtained from a
HealthIndicator
orReactiveHealthIndicator
. - info() - Method in class org.springframework.boot.actuate.info.InfoEndpoint
- Info - Class in org.springframework.boot.actuate.info
-
Carries information of the application.
- Info.Builder - Class in org.springframework.boot.actuate.info
-
Builder for creating immutable
Info
instances. - InfoContributor - Interface in org.springframework.boot.actuate.info
-
Contributes additional info details.
- InfoEndpoint - Class in org.springframework.boot.actuate.info
-
@Endpoint
to expose arbitrary application information. - InfoEndpoint(List<InfoContributor>) - Constructor for class org.springframework.boot.actuate.info.InfoEndpoint
-
Create a new
InfoEndpoint
instance. - InfoPropertiesInfoContributor<T> - Class in org.springframework.boot.actuate.info
-
A base
InfoContributor
to expose anInfoProperties
. - InfoPropertiesInfoContributor(T, InfoPropertiesInfoContributor.Mode) - Constructor for class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
- InfoPropertiesInfoContributor.Mode - Enum Class in org.springframework.boot.actuate.info
-
Defines how properties should be exposed.
- InMemoryAuditEventRepository - Class in org.springframework.boot.actuate.audit
-
In-memory
AuditEventRepository
implementation. - InMemoryAuditEventRepository() - Constructor for class org.springframework.boot.actuate.audit.InMemoryAuditEventRepository
- InMemoryAuditEventRepository(int) - Constructor for class org.springframework.boot.actuate.audit.InMemoryAuditEventRepository
- InMemoryHttpExchangeRepository - Class in org.springframework.boot.actuate.web.exchanges
-
In-memory implementation of
HttpExchangeRepository
. - InMemoryHttpExchangeRepository() - Constructor for class org.springframework.boot.actuate.web.exchanges.InMemoryHttpExchangeRepository
- IntervalTaskDescriptor(ScheduledTask, ScheduledTasksEndpoint.TaskType, IntervalTask) - Constructor for class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.IntervalTaskDescriptor
- IntervalTaskDescriptor(ScheduledTask, ScheduledTasksEndpoint.TaskType, TriggerTask, PeriodicTrigger) - Constructor for class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.IntervalTaskDescriptor
- InvalidEndpointRequestException - Exception Class in org.springframework.boot.actuate.endpoint
-
Indicate that an endpoint request is invalid.
- InvalidEndpointRequestException(String, String) - Constructor for exception class org.springframework.boot.actuate.endpoint.InvalidEndpointRequestException
- InvalidEndpointRequestException(String, String, Throwable) - Constructor for exception class org.springframework.boot.actuate.endpoint.InvalidEndpointRequestException
- InvocationContext - Class in org.springframework.boot.actuate.endpoint
-
The context for the
invocation of an operation
. - InvocationContext(SecurityContext, Map<String, Object>, OperationArgumentResolver...) - Constructor for class org.springframework.boot.actuate.endpoint.InvocationContext
-
Creates a new context for an operation being invoked by the given
securityContext
with the given availablearguments
. - invoke(String, Object[], String[]) - Method in class org.springframework.boot.actuate.endpoint.jmx.EndpointMBean
- invoke(InvocationContext) - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation
- invoke(InvocationContext) - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationInvoker
-
Invoke the underlying operation using the given
context
. - invoke(InvocationContext) - Method in class org.springframework.boot.actuate.endpoint.invoke.reflect.ReflectiveOperationInvoker
- invoke(InvocationContext) - Method in class org.springframework.boot.actuate.endpoint.invoker.cache.CachingOperationInvoker
- invoke(InvocationContext) - Method in interface org.springframework.boot.actuate.endpoint.Operation
-
Invoke the underlying operation using the given
context
. - isBlocking() - Method in interface org.springframework.boot.actuate.endpoint.web.WebOperation
-
Returns if the underlying operation is blocking.
- isDefault() - Method in interface org.springframework.boot.actuate.endpoint.Producible
-
Return if this enum value should be used as the default value when an accept header of */* is provided, or if the
Accept
header is missing. - isEndpointTypeExposed(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Determine if an endpoint bean should be exposed.
- isEndpointTypeExposed(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer
-
Deprecated.
- isEndpointTypeExposed(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointDiscoverer
-
Deprecated.
- isExtensionTypeExposed(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Determine if an extension bean should be exposed.
- isInvocable(E) - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer
-
Returns whether the endpoint is invocable and should be included in the discovered endpoints.
- isInvocable(ExposableControllerEndpoint) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ControllerEndpointDiscoverer
-
Deprecated.
- isInvocable(ExposableServletEndpoint) - Method in class org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointDiscoverer
-
Deprecated.
- isMandatory() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameter
-
Return if the parameter is mandatory (does not accept null values).
- isMember(String) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroup
-
Returns
true
if the given contributor is a member of this group. - IsoOffsetDateTimeConverter - Class in org.springframework.boot.actuate.endpoint.invoke.convert
- IsoOffsetDateTimeConverter() - Constructor for class org.springframework.boot.actuate.endpoint.invoke.convert.IsoOffsetDateTimeConverter
- isShown(boolean) - Method in enum class org.springframework.boot.actuate.endpoint.Show
-
Return if data should be shown when no
SecurityContext
is available. - isShown(SecurityContext, Collection<String>) - Method in enum class org.springframework.boot.actuate.endpoint.Show
-
Return if data should be shown.
- isTemplated() - Method in class org.springframework.boot.actuate.endpoint.web.Link
-
Returns whether the
href
is templated. - isUserInRole(String) - Method in interface org.springframework.boot.actuate.endpoint.SecurityContext
-
Returns
true
if the currently authenticated user is in the givenrole
, or false otherwise. - iterator() - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
J
- JacksonJmxOperationResponseMapper - Class in org.springframework.boot.actuate.endpoint.jmx
-
JmxOperationResponseMapper
that delegates to a JacksonObjectMapper
to return a JSON response. - JacksonJmxOperationResponseMapper(ObjectMapper) - Constructor for class org.springframework.boot.actuate.endpoint.jmx.JacksonJmxOperationResponseMapper
- JavaInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that exposesJavaInfo
. - JavaInfoContributor() - Constructor for class org.springframework.boot.actuate.info.JavaInfoContributor
- JmxEndpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.jmx.annotation
-
Identifies a type as being an endpoint that is only exposed over JMX.
- JmxEndpointDiscoverer - Class in org.springframework.boot.actuate.endpoint.jmx.annotation
- JmxEndpointDiscoverer(ApplicationContext, ParameterValueMapper, Collection<OperationInvokerAdvisor>, Collection<EndpointFilter<ExposableJmxEndpoint>>, Collection<OperationFilter<JmxOperation>>) - Constructor for class org.springframework.boot.actuate.endpoint.jmx.annotation.JmxEndpointDiscoverer
-
Create a new
JmxEndpointDiscoverer
instance. - JmxEndpointExporter - Class in org.springframework.boot.actuate.endpoint.jmx
-
Exports
JMX endpoints
to aMBeanServer
. - JmxEndpointExporter(MBeanServer, EndpointObjectNameFactory, JmxOperationResponseMapper, Collection<? extends ExposableJmxEndpoint>) - Constructor for class org.springframework.boot.actuate.endpoint.jmx.JmxEndpointExporter
- JmxEndpointsSupplier - Interface in org.springframework.boot.actuate.endpoint.jmx
- JmxOperation - Interface in org.springframework.boot.actuate.endpoint.jmx
-
An operation on a JMX endpoint.
- JmxOperationParameter - Interface in org.springframework.boot.actuate.endpoint.jmx
-
Describes the parameters of an operation on a JMX endpoint.
- JmxOperationResponseMapper - Interface in org.springframework.boot.actuate.endpoint.jmx
-
Maps an operation's response to a JMX-friendly form.
L
- LATEST - Static variable in enum class org.springframework.boot.actuate.endpoint.ApiVersion
-
The latest API version.
- Link - Class in org.springframework.boot.actuate.endpoint.web
-
Details for a link in a HAL-formatted response.
- Link(String) - Constructor for class org.springframework.boot.actuate.endpoint.web.Link
-
Creates a new
Link
with the givenhref
. - LivenessStateHealthIndicator - Class in org.springframework.boot.actuate.availability
-
A
HealthIndicator
that checks theLivenessState
of the application. - LivenessStateHealthIndicator(ApplicationAvailability) - Constructor for class org.springframework.boot.actuate.availability.LivenessStateHealthIndicator
- logFile() - Method in class org.springframework.boot.actuate.logging.LogFileWebEndpoint
- LogFileWebEndpoint - Class in org.springframework.boot.actuate.logging
-
Web
@Endpoint
that provides access to an application's log file. - LogFileWebEndpoint(LogFile, File) - Constructor for class org.springframework.boot.actuate.logging.LogFileWebEndpoint
- loggerLevels(String) - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint
- LoggerLevelsDescriptor(LogLevel) - Constructor for class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggerLevelsDescriptor
- loggers() - Method in class org.springframework.boot.actuate.logging.LoggersEndpoint
- LoggersDescriptor(NavigableSet<LogLevel>, Map<String, LoggersEndpoint.LoggerLevelsDescriptor>, Map<String, LoggersEndpoint.GroupLoggerLevelsDescriptor>) - Constructor for class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggersDescriptor
- LoggersEndpoint - Class in org.springframework.boot.actuate.logging
-
@Endpoint
to expose a collection ofLoggerConfiguration
s. - LoggersEndpoint(LoggingSystem, LoggerGroups) - Constructor for class org.springframework.boot.actuate.logging.LoggersEndpoint
-
Create a new
LoggersEndpoint
instance. - LoggersEndpoint.GroupLoggerLevelsDescriptor - Class in org.springframework.boot.actuate.logging
-
Description of levels configured for a given group logger.
- LoggersEndpoint.LoggerLevelsDescriptor - Class in org.springframework.boot.actuate.logging
-
Description of levels configured for a given logger.
- LoggersEndpoint.LoggersDescriptor - Class in org.springframework.boot.actuate.logging
-
Description of loggers.
- LoggersEndpoint.SingleLoggerLevelsDescriptor - Class in org.springframework.boot.actuate.logging
-
Description of levels configured for a given single logger.
- LOGOUT_SUCCESS - Static variable in class org.springframework.boot.actuate.security.AuthenticationAuditListener
-
Logout success event type.
M
- MANAGEMENT - Static variable in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
-
WebServerNamespace
that represents the management server. - MapInfoContributor - Class in org.springframework.boot.actuate.info
-
A simple
InfoContributor
that exposes a map. - MapInfoContributor(Map<String, Object>) - Constructor for class org.springframework.boot.actuate.info.MapInfoContributor
- mapParameterValue(OperationParameter, Object) - Method in class org.springframework.boot.actuate.endpoint.invoke.convert.ConversionServiceParameterValueMapper
- mapParameterValue(OperationParameter, Object) - Method in interface org.springframework.boot.actuate.endpoint.invoke.ParameterValueMapper
-
Map the specified
input
parameter to the givenparameterType
. - MappingDescriptionProvider - Interface in org.springframework.boot.actuate.web.mappings
-
A
MappingDescriptionProvider
provides aList
of mapping descriptions through implementation-specific introspection of an application context. - mappings() - Method in class org.springframework.boot.actuate.web.mappings.MappingsEndpoint
- MappingsEndpoint - Class in org.springframework.boot.actuate.web.mappings
-
@Endpoint
to expose HTTP request mappings. - MappingsEndpoint(Collection<MappingDescriptionProvider>, ApplicationContext) - Constructor for class org.springframework.boot.actuate.web.mappings.MappingsEndpoint
- MappingsEndpoint.ApplicationMappingsDescriptor - Class in org.springframework.boot.actuate.web.mappings
-
Description of an application's request mappings.
- MappingsEndpoint.ContextMappingsDescriptor - Class in org.springframework.boot.actuate.web.mappings
-
Description of an application context's request mappings.
- mapResponse(Object) - Method in class org.springframework.boot.actuate.endpoint.jmx.JacksonJmxOperationResponseMapper
- mapResponse(Object) - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperationResponseMapper
-
Map the operation's response so that it can be consumed by a JMX compliant client.
- mapResponseType(Class<?>) - Method in class org.springframework.boot.actuate.endpoint.jmx.JacksonJmxOperationResponseMapper
- mapResponseType(Class<?>) - Method in interface org.springframework.boot.actuate.endpoint.jmx.JmxOperationResponseMapper
-
Map the response type to its JMX compliant counterpart.
- match() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.Selector
-
The match type that should be used for the selection.
- match(E) - Method in interface org.springframework.boot.actuate.endpoint.EndpointFilter
-
Return
true
if the filter matches. - match(DiscoveredEndpoint<?>) - Method in class org.springframework.boot.actuate.endpoint.annotation.DiscovererEndpointFilter
- match(O, EndpointId, Access) - Method in interface org.springframework.boot.actuate.endpoint.OperationFilter
-
Return
true
if the filter matches. - MissingParametersException - Exception Class in org.springframework.boot.actuate.endpoint.invoke
-
RuntimeException
thrown when an endpoint invocation does not contain required parameters. - MissingParametersException(Set<OperationParameter>) - Constructor for exception class org.springframework.boot.actuate.endpoint.invoke.MissingParametersException
N
- NEVER - Enum constant in enum class org.springframework.boot.actuate.endpoint.Show
-
Never show the item in the response.
- NextExecution(Instant) - Constructor for class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.NextExecution
- NONE - Enum constant in enum class org.springframework.boot.actuate.endpoint.Access
-
No access to the endpoint is permitted.
- NONE - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation
-
Don't perform any shutdown operation.
- NONE - Static variable in interface org.springframework.boot.actuate.endpoint.invoke.ParameterValueMapper
-
A
ParameterValueMapper
that does nothing. - NONE - Static variable in interface org.springframework.boot.actuate.endpoint.SecurityContext
-
Empty security context.
- NONE - Static variable in class org.springframework.boot.actuate.logging.LoggersEndpoint.LoggersDescriptor
-
Empty description.
O
- of(Class<T>, Supplier<? extends T>) - Static method in interface org.springframework.boot.actuate.endpoint.OperationArgumentResolver
-
Factory method that creates an
OperationArgumentResolver
for a specific type using aSupplier
. - of(String) - Static method in class org.springframework.boot.actuate.endpoint.EndpointId
-
Factory method to create a new
EndpointId
of the specified value. - of(Map<K, V>) - Static method in interface org.springframework.boot.actuate.endpoint.OperationResponseBody
- of(SanitizingFunction) - Static method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Helper method that can be used working with a sanitizingFunction as a lambda.
- of(WebServerNamespace, String) - Static method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
-
Creates an
AdditionalHealthEndpointPath
from the givenWebServerNamespace
and value. - of(HealthEndpointGroup, Map<String, HealthEndpointGroup>) - Static method in interface org.springframework.boot.actuate.health.HealthEndpointGroups
-
Factory method to create a
HealthEndpointGroups
instance. - of(Environment, String) - Static method in class org.springframework.boot.actuate.endpoint.EndpointId
-
Factory method to create a new
EndpointId
of the specified value. - onApplicationEvent(AuditApplicationEvent) - Method in class org.springframework.boot.actuate.audit.listener.AbstractAuditListener
- onApplicationEvent(AbstractAuthenticationEvent) - Method in class org.springframework.boot.actuate.security.AuthenticationAuditListener
- onApplicationEvent(AuthorizationEvent) - Method in class org.springframework.boot.actuate.security.AuthorizationAuditListener
- onAuditEvent(AuditEvent) - Method in class org.springframework.boot.actuate.audit.listener.AbstractAuditListener
- onAuditEvent(AuditEvent) - Method in class org.springframework.boot.actuate.audit.listener.AuditListener
- onStartup(ServletContext) - Method in class org.springframework.boot.actuate.endpoint.web.ServletEndpointRegistrar
-
Deprecated.
- Operation - Interface in org.springframework.boot.actuate.endpoint
-
An operation on an
endpoint
. - OperationArgumentResolver - Interface in org.springframework.boot.actuate.endpoint
-
Resolver for an argument of an
Operation
. - OperationFilter<O> - Interface in org.springframework.boot.actuate.endpoint
-
Strategy class that can be used to filter
operations
. - OperationInvoker - Interface in org.springframework.boot.actuate.endpoint.invoke
-
Interface to perform an operation invocation.
- OperationInvokerAdvisor - Interface in org.springframework.boot.actuate.endpoint.invoke
-
Allows additional functionality to be applied to an
OperationInvoker
. - OperationKey(Object, Supplier<String>) - Constructor for class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer.OperationKey
-
Create a new
EndpointDiscoverer.OperationKey
instance. - OperationMethod - Class in org.springframework.boot.actuate.endpoint.invoke.reflect
-
Information describing an operation method on an endpoint method.
- OperationMethod(Method, OperationType) - Constructor for class org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod
-
Deprecated, for removal: This API element is subject to removal in a future version.since 4.0.0 for removal in 4.2.0 in favor of
OperationMethod(Method, OperationType, Predicate)
- OperationMethod(Method, OperationType, Predicate<Parameter>) - Constructor for class org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod
-
Create a new
OperationMethod
instance. - OperationParameter - Interface in org.springframework.boot.actuate.endpoint.invoke
-
A single operation parameter.
- OperationParameters - Interface in org.springframework.boot.actuate.endpoint.invoke
-
A collection of
operation parameters
. - OperationResponseBody - Interface in org.springframework.boot.actuate.endpoint
-
Tagging interface used to indicate that an operation result is intended to be returned in the body of the response.
- OperationType - Enum Class in org.springframework.boot.actuate.endpoint
-
An enumeration of the different types of operation supported by an endpoint.
- OptionalParameter - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Annotation that indicates that an operation parameter is optional.
- org.springframework.boot.actuate.audit - package org.springframework.boot.actuate.audit
-
Core actuator auditing classes.
- org.springframework.boot.actuate.audit.listener - package org.springframework.boot.actuate.audit.listener
-
Actuator auditing listeners.
- org.springframework.boot.actuate.availability - package org.springframework.boot.actuate.availability
-
Actuator support for application availability concerns.
- org.springframework.boot.actuate.beans - package org.springframework.boot.actuate.beans
-
Actuator support relating to Spring Beans.
- org.springframework.boot.actuate.context - package org.springframework.boot.actuate.context
-
Actuator support relating to Spring Context.
- org.springframework.boot.actuate.context.properties - package org.springframework.boot.actuate.context.properties
-
Actuator support relating to external configuration properties.
- org.springframework.boot.actuate.endpoint - package org.springframework.boot.actuate.endpoint
-
Endpoint support.
- org.springframework.boot.actuate.endpoint.annotation - package org.springframework.boot.actuate.endpoint.annotation
-
Annotation support for actuator endpoints.
- org.springframework.boot.actuate.endpoint.invoke - package org.springframework.boot.actuate.endpoint.invoke
-
Interfaces and classes relating to invoking operation methods.
- org.springframework.boot.actuate.endpoint.invoke.convert - package org.springframework.boot.actuate.endpoint.invoke.convert
-
Converter support for actuator endpoints.
- org.springframework.boot.actuate.endpoint.invoke.reflect - package org.springframework.boot.actuate.endpoint.invoke.reflect
-
Endpoint reflection support.
- org.springframework.boot.actuate.endpoint.invoker.cache - package org.springframework.boot.actuate.endpoint.invoker.cache
-
Caching support for actuator endpoints.
- org.springframework.boot.actuate.endpoint.jackson - package org.springframework.boot.actuate.endpoint.jackson
-
Jackson support classes for actuator endpoints.
- org.springframework.boot.actuate.endpoint.jmx - package org.springframework.boot.actuate.endpoint.jmx
-
JMX support for actuator endpoints.
- org.springframework.boot.actuate.endpoint.jmx.annotation - package org.springframework.boot.actuate.endpoint.jmx.annotation
-
Annotation support for actuator JMX endpoints.
- org.springframework.boot.actuate.endpoint.web - package org.springframework.boot.actuate.endpoint.web
-
Web support for actuator endpoints.
- org.springframework.boot.actuate.endpoint.web.annotation - package org.springframework.boot.actuate.endpoint.web.annotation
-
Annotation support for actuator web endpoints.
- org.springframework.boot.actuate.env - package org.springframework.boot.actuate.env
-
Actuator support for Spring Framework's
Environment
. - org.springframework.boot.actuate.health - package org.springframework.boot.actuate.health
-
Actuator health indicator and endpoints.
- org.springframework.boot.actuate.info - package org.springframework.boot.actuate.info
-
Classes for application info.
- org.springframework.boot.actuate.logging - package org.springframework.boot.actuate.logging
-
Actuator support for logging.
- org.springframework.boot.actuate.management - package org.springframework.boot.actuate.management
-
Actuator support for JVM management.
- org.springframework.boot.actuate.metrics.export.prometheus - package org.springframework.boot.actuate.metrics.export.prometheus
-
Actuator support for exporting metrics to Prometheus.
- org.springframework.boot.actuate.sbom - package org.springframework.boot.actuate.sbom
-
Actuator support for SBOMs.
- org.springframework.boot.actuate.scheduling - package org.springframework.boot.actuate.scheduling
-
Actuator scheduling support.
- org.springframework.boot.actuate.security - package org.springframework.boot.actuate.security
-
Actuator support for security.
- org.springframework.boot.actuate.ssl - package org.springframework.boot.actuate.ssl
-
Actuator support for ssl concerns.
- org.springframework.boot.actuate.startup - package org.springframework.boot.actuate.startup
-
Actuator support for
ApplicationStartup
. - org.springframework.boot.actuate.system - package org.springframework.boot.actuate.system
-
Actuator support for system-related concerns.
- org.springframework.boot.actuate.web.exchanges - package org.springframework.boot.actuate.web.exchanges
-
Actuator HTTP exchanges support.
- org.springframework.boot.actuate.web.mappings - package org.springframework.boot.actuate.web.mappings
-
Actuator web request mappings support.
- OsInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that exposesOsInfo
. - OsInfoContributor() - Constructor for class org.springframework.boot.actuate.info.OsInfoContributor
P
- ParameterMappingException - Exception Class in org.springframework.boot.actuate.endpoint.invoke
-
A
ParameterMappingException
is thrown when a failure occurs duringoperation parameter mapping
. - ParameterMappingException(OperationParameter, Object, Throwable) - Constructor for exception class org.springframework.boot.actuate.endpoint.invoke.ParameterMappingException
-
Creates a new
ParameterMappingException
for a failure that occurred when trying to map the giveninput
to the giventype
. - ParameterValueMapper - Interface in org.springframework.boot.actuate.endpoint.invoke
-
Maps parameter values to the required type when invoking an endpoint.
- PathMappedEndpoint - Interface in org.springframework.boot.actuate.endpoint.web
-
Interface that can be implemented by an
ExposableEndpoint
that is mapped to a root web path. - PathMappedEndpoints - Class in org.springframework.boot.actuate.endpoint.web
-
A collection of
path mapped endpoints
. - PathMappedEndpoints(String, Collection<EndpointsSupplier<?>>) - Constructor for class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Create a new
PathMappedEndpoints
instance for the given suppliers. - PathMappedEndpoints(String, EndpointsSupplier<?>) - Constructor for class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Create a new
PathMappedEndpoints
instance for the given supplier. - PathMapper - Interface in org.springframework.boot.actuate.endpoint.web
-
Strategy interface used to provide a mapping between an endpoint ID and the root path where it will be exposed.
- POST - Enum constant in enum class org.springframework.boot.actuate.endpoint.web.WebEndpointHttpMethod
-
An HTTP POST request.
- POST - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation
-
Perform a POST before shutdown.
- postProcessContent(Map<String, Object>) - Method in class org.springframework.boot.actuate.info.BuildInfoContributor
- postProcessContent(Map<String, Object>) - Method in class org.springframework.boot.actuate.info.GitInfoContributor
-
Post-process the content to expose.
- postProcessContent(Map<String, Object>) - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Post-process the content to expose.
- postProcessHealthEndpointGroups(HealthEndpointGroups) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroupsPostProcessor
-
Post-process the given
HealthEndpointGroups
instance. - Principal(String) - Constructor for class org.springframework.boot.actuate.web.exchanges.HttpExchange.Principal
-
Creates a
Principal
. - PRINCIPAL - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include the principal.
- ProcessInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that exposesProcessInfo
. - ProcessInfoContributor() - Constructor for class org.springframework.boot.actuate.info.ProcessInfoContributor
- produces() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.DeleteOperation
-
The media type of the result of the operation.
- produces() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.ReadOperation
-
The media type of the result of the operation.
- produces() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.WriteOperation
-
The media type of the result of the operation.
- producesFrom() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.DeleteOperation
-
The media types of the result of the operation.
- producesFrom() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.ReadOperation
-
The media types of the result of the operation.
- producesFrom() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.WriteOperation
-
The media types of the result of the operation.
- Producible<E> - Interface in org.springframework.boot.actuate.endpoint
-
Interface that can be implemented by any
Enum
that represents a finite set of producible mime-types. - ProducibleOperationArgumentResolver - Class in org.springframework.boot.actuate.endpoint
- ProducibleOperationArgumentResolver(Supplier<List<String>>) - Constructor for class org.springframework.boot.actuate.endpoint.ProducibleOperationArgumentResolver
-
Create a new
ProducibleOperationArgumentResolver
instance. - PrometheusOutputFormat - Enum Class in org.springframework.boot.actuate.metrics.export.prometheus
-
A
Producible
enum for supported Prometheus formats. - PrometheusPushGatewayManager - Class in org.springframework.boot.actuate.metrics.export.prometheus
-
Class that can be used to manage the pushing of metrics to a
Prometheus PushGateway
. - PrometheusPushGatewayManager(PushGateway, Duration, PrometheusPushGatewayManager.ShutdownOperation) - Constructor for class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager
-
Create a new
PrometheusPushGatewayManager
instance. - PrometheusPushGatewayManager.ShutdownOperation - Enum Class in org.springframework.boot.actuate.metrics.export.prometheus
-
The operation that should be performed on shutdown.
- PrometheusScrapeEndpoint - Class in org.springframework.boot.actuate.metrics.export.prometheus
-
@Endpoint
that outputs metrics in a format that can be scraped by the Prometheus server. - PrometheusScrapeEndpoint(PrometheusRegistry, Properties) - Constructor for class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusScrapeEndpoint
-
Creates a new
PrometheusScrapeEndpoint
. - PropertySummaryDescriptor(String, Object) - Constructor for class org.springframework.boot.actuate.env.EnvironmentEndpoint.PropertySummaryDescriptor
- publish(AuditEvent) - Method in class org.springframework.boot.actuate.security.AbstractAuthenticationAuditListener
- publish(AuditEvent) - Method in class org.springframework.boot.actuate.security.AbstractAuthorizationAuditListener
- PUT - Enum constant in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation
-
Perform a PUT before shutdown.
R
- ReactiveHealthEndpointWebExtension - Class in org.springframework.boot.actuate.health
-
Reactive
@EndpointWebExtension
for theHealthEndpoint
. - ReactiveHealthEndpointWebExtension(ReactiveHealthContributorRegistry, HealthContributorRegistry, HealthEndpointGroups, Duration) - Constructor for class org.springframework.boot.actuate.health.ReactiveHealthEndpointWebExtension
-
Create a new
ReactiveHealthEndpointWebExtension
instance. - READ - Enum constant in enum class org.springframework.boot.actuate.endpoint.OperationType
-
A read operation.
- READ_ONLY - Enum constant in enum class org.springframework.boot.actuate.endpoint.Access
-
Read-only access to the endpoint is permitted.
- ReadinessStateHealthIndicator - Class in org.springframework.boot.actuate.availability
-
A
HealthIndicator
that checks theReadinessState
of the application. - ReadinessStateHealthIndicator(ApplicationAvailability) - Constructor for class org.springframework.boot.actuate.availability.ReadinessStateHealthIndicator
- ReadOperation - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Identifies a method on an
@Endpoint
as being a read operation. - RecordableHttpRequest - Interface in org.springframework.boot.actuate.web.exchanges
-
The recordable parts of an HTTP request used when creating an
HttpExchange
. - RecordableHttpResponse - Interface in org.springframework.boot.actuate.web.exchanges
-
The recordable parts of an HTTP response used when creating an
HttpExchange
. - ReflectiveOperationInvoker - Class in org.springframework.boot.actuate.endpoint.invoke.reflect
-
An
OperationInvoker
that invokes an operation using reflection. - ReflectiveOperationInvoker(Object, OperationMethod, ParameterValueMapper) - Constructor for class org.springframework.boot.actuate.endpoint.invoke.reflect.ReflectiveOperationInvoker
-
Creates a new
ReflectiveOperationInvoker
that will invoke the givenmethod
on the giventarget
. - registerConverter(ConverterRegistry) - Static method in class org.springframework.boot.actuate.endpoint.invoke.convert.IsoOffsetDateTimeConverter
- REMOTE_ADDRESS - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include the remote address from the request.
- replaceValue(Map<String, Object>, String, Object) - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Replace the
value
for the specified key if the value is notnull
. - Request(URI, String, String, Map<String, List<String>>) - Constructor for class org.springframework.boot.actuate.web.exchanges.HttpExchange.Request
-
Creates a fully-configured
Request
instance. - REQUEST_HEADERS - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include request headers.
- resolve(Class<T>) - Method in interface org.springframework.boot.actuate.endpoint.OperationArgumentResolver
-
Resolves an argument of the given
type
. - resolve(Class<T>) - Method in class org.springframework.boot.actuate.endpoint.ProducibleOperationArgumentResolver
- resolveArgument(Class<T>) - Method in class org.springframework.boot.actuate.endpoint.InvocationContext
-
Resolves an argument with the given
argumentType
. - resolveLinks(String) - Method in class org.springframework.boot.actuate.endpoint.web.EndpointLinksResolver
-
Resolves links to the known endpoints based on a request with the given
requestUrl
. - Response(int, Map<String, List<String>>) - Constructor for class org.springframework.boot.actuate.web.exchanges.HttpExchange.Response
-
Creates a fully-configured
Response
instance. - RESPONSE_HEADERS - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include response headers.
- RestControllerEndpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
S
- SanitizableData - Class in org.springframework.boot.actuate.endpoint
-
Value object that represents the data that can be used by a
SanitizingFunction
. - SanitizableData(PropertySource<?>, String, Object) - Constructor for class org.springframework.boot.actuate.endpoint.SanitizableData
-
Create a new
SanitizableData
instance. - sanitize(SanitizableData, boolean) - Method in class org.springframework.boot.actuate.endpoint.Sanitizer
-
Sanitize the value from the given
SanitizableData
using the availableSanitizingFunction
s. - SANITIZED_VALUE - Static variable in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Represents a sanitized value.
- Sanitizer - Class in org.springframework.boot.actuate.endpoint
-
Strategy that should be used by endpoint implementations to sanitize potentially sensitive keys.
- Sanitizer() - Constructor for class org.springframework.boot.actuate.endpoint.Sanitizer
-
Create a new
Sanitizer
instance. - Sanitizer(Iterable<SanitizingFunction>) - Constructor for class org.springframework.boot.actuate.endpoint.Sanitizer
-
Create a new
Sanitizer
instance with sanitizing functions. - sanitizeValue() - Static method in interface org.springframework.boot.actuate.endpoint.SanitizingFunction
-
Factory method to return a
SanitizingFunction
that sanitizes the value. - SanitizingFunction - Interface in org.springframework.boot.actuate.endpoint
-
Function that takes a
SanitizableData
and applies sanitization to the value, if necessary. - Sbom() - Constructor for class org.springframework.boot.actuate.sbom.SbomProperties.Sbom
- SbomEndpoint - Class in org.springframework.boot.actuate.sbom
-
@Endpoint
to expose an SBOM. - SbomEndpoint(SbomProperties, ResourceLoader) - Constructor for class org.springframework.boot.actuate.sbom.SbomEndpoint
- SbomEndpointWebExtension - Class in org.springframework.boot.actuate.sbom
-
@EndpointWebExtension
for theSbomEndpoint
. - SbomEndpointWebExtension(SbomEndpoint, SbomProperties) - Constructor for class org.springframework.boot.actuate.sbom.SbomEndpointWebExtension
- SbomProperties - Class in org.springframework.boot.actuate.sbom
-
Configuration properties for the SBOM endpoint.
- SbomProperties() - Constructor for class org.springframework.boot.actuate.sbom.SbomProperties
- SbomProperties.Sbom - Class in org.springframework.boot.actuate.sbom
- scheduledTasks() - Method in class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint
- ScheduledTasksEndpoint - Class in org.springframework.boot.actuate.scheduling
-
@Endpoint
to expose information about an application's scheduled tasks. - ScheduledTasksEndpoint(Collection<ScheduledTaskHolder>) - Constructor for class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint
- ScheduledTasksEndpoint.CronTaskDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of a
CronTask
or aTriggerTask
with aCronTrigger
. - ScheduledTasksEndpoint.CustomTriggerTaskDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of a
TriggerTask
with a customTrigger
. - ScheduledTasksEndpoint.ExceptionInfo - Class in org.springframework.boot.actuate.scheduling
- ScheduledTasksEndpoint.FixedDelayTaskDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of a
FixedDelayTask
or aTriggerTask
with a fixed-delayPeriodicTrigger
. - ScheduledTasksEndpoint.FixedRateTaskDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of a
FixedRateTask
or aTriggerTask
with a fixed-ratePeriodicTrigger
. - ScheduledTasksEndpoint.IntervalTaskDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of an
IntervalTask
. - ScheduledTasksEndpoint.LastExecution - Class in org.springframework.boot.actuate.scheduling
- ScheduledTasksEndpoint.NextExecution - Class in org.springframework.boot.actuate.scheduling
- ScheduledTasksEndpoint.RunnableDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of a
Task's
Runnable
. - ScheduledTasksEndpoint.ScheduledTasksDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Description of an application's scheduled
Tasks
. - ScheduledTasksEndpoint.TaskDescriptor - Class in org.springframework.boot.actuate.scheduling
-
Base class for descriptions of a
Task
. - scrape(PrometheusOutputFormat, Set<String>) - Method in class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusScrapeEndpoint
- SecurityContext - Interface in org.springframework.boot.actuate.endpoint
-
Security context in which an endpoint is being invoked.
- Selector - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
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. - Selector.Match - Enum Class in org.springframework.boot.actuate.endpoint.annotation
-
Match types that can be used with the
@Selector
. - SERVER - Static variable in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
-
WebServerNamespace
that represents the main server. - ServletEndpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
- ServletEndpointDiscoverer - Class in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
- ServletEndpointDiscoverer(ApplicationContext, List<PathMapper>, Collection<EndpointFilter<ExposableServletEndpoint>>) - Constructor for class org.springframework.boot.actuate.endpoint.web.annotation.ServletEndpointDiscoverer
-
Deprecated.Create a new
ServletEndpointDiscoverer
instance. - ServletEndpointRegistrar - Class in org.springframework.boot.actuate.endpoint.web
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
support - ServletEndpointRegistrar(String, Collection<ExposableServletEndpoint>) - Constructor for class org.springframework.boot.actuate.endpoint.web.ServletEndpointRegistrar
-
Deprecated.
- ServletEndpointRegistrar(String, Collection<ExposableServletEndpoint>, EndpointAccessResolver) - Constructor for class org.springframework.boot.actuate.endpoint.web.ServletEndpointRegistrar
-
Deprecated.
- ServletEndpointsSupplier - Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Deprecated, for removal: This API element is subject to removal in a future version.since 3.3.0 in favor of
@Endpoint
and@WebEndpoint
- Session(String) - Constructor for class org.springframework.boot.actuate.web.exchanges.HttpExchange.Session
-
Creates a
Session
. - SESSION_ID - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include the session ID.
- setAdditional(Map<String, SbomProperties.Sbom>) - Method in class org.springframework.boot.actuate.sbom.SbomProperties
- setApplicationContext(ApplicationContext) - Method in class org.springframework.boot.actuate.context.properties.ConfigurationPropertiesReportEndpoint
- setApplicationContext(ApplicationContext) - Method in class org.springframework.boot.actuate.context.ShutdownEndpoint
- setApplicationEventPublisher(ApplicationEventPublisher) - Method in class org.springframework.boot.actuate.security.AbstractAuthenticationAuditListener
- setApplicationEventPublisher(ApplicationEventPublisher) - Method in class org.springframework.boot.actuate.security.AbstractAuthorizationAuditListener
- setAttribute(Attribute) - Method in class org.springframework.boot.actuate.endpoint.jmx.EndpointMBean
- setAttributes(AttributeList) - Method in class org.springframework.boot.actuate.endpoint.jmx.EndpointMBean
- setBeanClassLoader(ClassLoader) - Method in class org.springframework.boot.actuate.endpoint.jmx.JmxEndpointExporter
- setCapacity(int) - Method in class org.springframework.boot.actuate.audit.InMemoryAuditEventRepository
-
Set the capacity of this event repository.
- setCapacity(int) - Method in class org.springframework.boot.actuate.web.exchanges.InMemoryHttpExchangeRepository
-
Set the capacity of the in-memory repository.
- setLocation(String) - Method in class org.springframework.boot.actuate.sbom.SbomProperties.Sbom
- setMediaType(MimeType) - Method in class org.springframework.boot.actuate.sbom.SbomProperties.Sbom
- setReverse(boolean) - Method in class org.springframework.boot.actuate.web.exchanges.InMemoryHttpExchangeRepository
-
Flag to say that the repository lists exchanges in reverse order.
- Show - Enum Class in org.springframework.boot.actuate.endpoint
-
Options for showing data in endpoint responses.
- showComponents(SecurityContext) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroup
-
Returns if
health components
should be shown in the response. - showDetails(SecurityContext) - Method in interface org.springframework.boot.actuate.health.HealthEndpointGroup
-
Returns if
health details
should be shown in the response. - shutdown() - Method in class org.springframework.boot.actuate.context.ShutdownEndpoint
- shutdown() - Method in class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager
-
Shutdown the manager, running any
PrometheusPushGatewayManager.ShutdownOperation
. - ShutdownEndpoint - Class in org.springframework.boot.actuate.context
-
@Endpoint
to shutdown theApplicationContext
. - ShutdownEndpoint() - Constructor for class org.springframework.boot.actuate.context.ShutdownEndpoint
- ShutdownEndpoint.ShutdownDescriptor - Class in org.springframework.boot.actuate.context
-
Description of the shutdown.
- SIMPLE - Enum constant in enum class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor.Mode
-
Expose a pre-defined set of core settings only.
- SimpleHttpCodeStatusMapper - Class in org.springframework.boot.actuate.health
-
Simple
HttpCodeStatusMapper
backed by map ofstatus code
to HTTP status code. - SimpleHttpCodeStatusMapper() - Constructor for class org.springframework.boot.actuate.health.SimpleHttpCodeStatusMapper
-
Create a new
SimpleHttpCodeStatusMapper
instance using default mappings. - SimpleHttpCodeStatusMapper(Map<String, Integer>) - Constructor for class org.springframework.boot.actuate.health.SimpleHttpCodeStatusMapper
-
Create a new
SimpleHttpCodeStatusMapper
with the specified mappings. - SimpleInfoContributor - Class in org.springframework.boot.actuate.info
-
A simple
InfoContributor
that exposes a single detail. - SimpleInfoContributor(String, Object) - Constructor for class org.springframework.boot.actuate.info.SimpleInfoContributor
- SimpleStatusAggregator - Class in org.springframework.boot.actuate.health
-
StatusAggregator
backed by an ordered status list. - SimpleStatusAggregator() - Constructor for class org.springframework.boot.actuate.health.SimpleStatusAggregator
- SimpleStatusAggregator(String...) - Constructor for class org.springframework.boot.actuate.health.SimpleStatusAggregator
- SimpleStatusAggregator(List<String>) - Constructor for class org.springframework.boot.actuate.health.SimpleStatusAggregator
- SimpleStatusAggregator(Status...) - Constructor for class org.springframework.boot.actuate.health.SimpleStatusAggregator
- SINGLE - Enum constant in enum class org.springframework.boot.actuate.endpoint.annotation.Selector.Match
-
Capture a single item.
- SingleLoggerLevelsDescriptor(LoggerConfiguration) - Constructor for class org.springframework.boot.actuate.logging.LoggersEndpoint.SingleLoggerLevelsDescriptor
- SslHealthIndicator - Class in org.springframework.boot.actuate.ssl
-
HealthIndicator
that checks the certificates the application uses and reportsStatus.OUT_OF_SERVICE
when a certificate is invalid. - SslHealthIndicator(SslInfo, Duration) - Constructor for class org.springframework.boot.actuate.ssl.SslHealthIndicator
- SslInfoContributor - Class in org.springframework.boot.actuate.info
-
An
InfoContributor
that exposesSslInfo
. - SslInfoContributor(SslInfo) - Constructor for class org.springframework.boot.actuate.info.SslInfoContributor
- start(Clock, RecordableHttpRequest) - Static method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Start a new
HttpExchange.Started
from the given source request. - start(RecordableHttpRequest) - Static method in class org.springframework.boot.actuate.web.exchanges.HttpExchange
-
Start a new
HttpExchange.Started
from the given source request. - startup() - Method in class org.springframework.boot.actuate.startup.StartupEndpoint
- StartupEndpoint - Class in org.springframework.boot.actuate.startup
-
@Endpoint
to expose the timeline of theapplication startup
. - StartupEndpoint(BufferingApplicationStartup) - Constructor for class org.springframework.boot.actuate.startup.StartupEndpoint
-
Creates a new
StartupEndpoint
that will describe the timeline of buffered application startup events. - StartupEndpoint.StartupDescriptor - Class in org.springframework.boot.actuate.startup
-
Description of an application startup.
- startupSnapshot() - Method in class org.springframework.boot.actuate.startup.StartupEndpoint
- STATUS_BAD_REQUEST - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
400 Bad Request
. - STATUS_INTERNAL_SERVER_ERROR - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
500 Internal Server Error
. - STATUS_NO_CONTENT - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
204 No Content
. - STATUS_NOT_FOUND - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
404 Not Found
. - STATUS_OK - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
200 OK
. - STATUS_SERVICE_UNAVAILABLE - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
503 Service Unavailable
. - STATUS_TOO_MANY_REQUESTS - Static variable in class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
429 Too Many Requests
. - StatusAggregator - Interface in org.springframework.boot.actuate.health
-
Strategy used to aggregate
Status
instances. - stream() - Method in interface org.springframework.boot.actuate.endpoint.invoke.OperationParameters
-
Return a stream of the contained parameters.
- stream() - Method in class org.springframework.boot.actuate.endpoint.web.PathMappedEndpoints
-
Stream all
path mapped endpoints
. - stringifyIfNecessary(Object) - Method in class org.springframework.boot.actuate.env.EnvironmentEndpoint
- SystemHealthDescriptor - Class in org.springframework.boot.actuate.health
-
Description of overall system health.
T
- TaskDescriptor(ScheduledTask, ScheduledTasksEndpoint.TaskType) - Constructor for class org.springframework.boot.actuate.scheduling.ScheduledTasksEndpoint.TaskDescriptor
- textThreadDump() - Method in class org.springframework.boot.actuate.management.ThreadDumpEndpoint
- threadDump() - Method in class org.springframework.boot.actuate.management.ThreadDumpEndpoint
- ThreadDumpEndpoint - Class in org.springframework.boot.actuate.management
-
@Endpoint
to expose thread info. - ThreadDumpEndpoint() - Constructor for class org.springframework.boot.actuate.management.ThreadDumpEndpoint
- ThreadDumpEndpoint.ThreadDumpDescriptor - Class in org.springframework.boot.actuate.management
-
Description of a thread dump.
- TIME_TAKEN - Enum constant in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Include the time taken to service the request.
- toLowerCaseString() - Method in class org.springframework.boot.actuate.endpoint.EndpointId
-
Return a lower-case version of the endpoint ID.
- toPropertySource() - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Return the
PropertySource
to use based on the chosenInfoPropertiesInfoContributor.Mode
. - toSimplePropertySource() - Method in class org.springframework.boot.actuate.info.BuildInfoContributor
- toSimplePropertySource() - Method in class org.springframework.boot.actuate.info.GitInfoContributor
- toSimplePropertySource() - Method in class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor
-
Return a
PropertySource
for theSIMPLE
mode. - toString() - Method in class org.springframework.boot.actuate.audit.AuditEvent
- toString() - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredEndpoint
- toString() - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredOperation
- toString() - Method in class org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer.OperationKey
- toString() - Method in class org.springframework.boot.actuate.endpoint.EndpointId
- toString() - Method in class org.springframework.boot.actuate.endpoint.invoke.reflect.OperationMethod
- toString() - Method in class org.springframework.boot.actuate.endpoint.invoke.reflect.ReflectiveOperationInvoker
- toString() - Method in class org.springframework.boot.actuate.endpoint.web.Link
- toString() - Method in class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
- toString() - Method in class org.springframework.boot.actuate.endpoint.web.WebServerNamespace
- toString() - Method in class org.springframework.boot.actuate.health.AdditionalHealthEndpointPath
- toString() - Method in class org.springframework.boot.actuate.info.Info
U
- UNRESTRICTED - Enum constant in enum class org.springframework.boot.actuate.endpoint.Access
-
Unrestricted access to the endpoint is permitted.
V
- V2 - Enum constant in enum class org.springframework.boot.actuate.endpoint.ApiVersion
-
Version 2 (supported by Spring Boot 2.0+).
- V3 - Enum constant in enum class org.springframework.boot.actuate.endpoint.ApiVersion
-
Version 3 (supported by Spring Boot 2.2+).
- value() - Element in annotation interface org.springframework.boot.actuate.endpoint.annotation.FilteredEndpoint
-
The filter class to use.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.endpoint.Access
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.endpoint.annotation.Selector.Match
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.endpoint.ApiVersion
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.endpoint.OperationType
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.endpoint.Show
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.endpoint.web.WebEndpointHttpMethod
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor.Mode
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.springframework.boot.actuate.endpoint.Access
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.endpoint.annotation.Selector.Match
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.endpoint.ApiVersion
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.endpoint.OperationType
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.endpoint.Show
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.endpoint.web.WebEndpointHttpMethod
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.info.InfoPropertiesInfoContributor.Mode
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusOutputFormat
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.metrics.export.prometheus.PrometheusPushGatewayManager.ShutdownOperation
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class org.springframework.boot.actuate.web.exchanges.Include
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- wasDiscoveredBy(Class<? extends EndpointDiscoverer<?, ?>>) - Method in class org.springframework.boot.actuate.endpoint.annotation.AbstractDiscoveredEndpoint
- wasDiscoveredBy(Class<? extends EndpointDiscoverer<?, ?>>) - Method in interface org.springframework.boot.actuate.endpoint.annotation.DiscoveredEndpoint
-
Return
true
if the endpoint was discovered by the specified discoverer. - WebEndpoint - Annotation Interface in org.springframework.boot.actuate.endpoint.web.annotation
-
Identifies a type as being an endpoint that is only exposed over HTTP.
- WebEndpointDiscoverer - Class in org.springframework.boot.actuate.endpoint.web.annotation
- WebEndpointDiscoverer(ApplicationContext, ParameterValueMapper, EndpointMediaTypes, List<PathMapper>, List<AdditionalPathsMapper>, Collection<OperationInvokerAdvisor>, Collection<EndpointFilter<ExposableWebEndpoint>>, Collection<OperationFilter<WebOperation>>) - Constructor for class org.springframework.boot.actuate.endpoint.web.annotation.WebEndpointDiscoverer
-
Create a new
WebEndpointDiscoverer
instance. - WebEndpointHttpMethod - Enum Class in org.springframework.boot.actuate.endpoint.web
-
An enumeration of HTTP methods supported by web endpoint operations.
- WebEndpointResponse<T> - Class in org.springframework.boot.actuate.endpoint.web
-
A
WebEndpointResponse
can be returned by an operation on a@EndpointWebExtension
to provide additional, web-specific information such as the HTTP status code. - WebEndpointResponse() - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with no body and a 200 (OK) status. - WebEndpointResponse(int) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with no body and the givenstatus
. - WebEndpointResponse(T) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with the given body and a 200 (OK) status. - WebEndpointResponse(T, int) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with the given body and status. - WebEndpointResponse(T, int, MimeType) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with the given body and status. - WebEndpointResponse(T, Producible<?>) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with the given body and content type and a 200 (OK) status. - WebEndpointResponse(T, MimeType) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebEndpointResponse
-
Creates a new
WebEndpointResponse
with the given body and content type and a 200 (OK) status. - WebEndpointsSupplier - Interface in org.springframework.boot.actuate.endpoint.web
- WebOperation - Interface in org.springframework.boot.actuate.endpoint.web
-
An operation on a web endpoint.
- WebOperationRequestPredicate - Class in org.springframework.boot.actuate.endpoint.web
-
A predicate for a request to an operation on a web endpoint.
- WebOperationRequestPredicate(String, WebEndpointHttpMethod, Collection<String>, Collection<String>) - Constructor for class org.springframework.boot.actuate.endpoint.web.WebOperationRequestPredicate
-
Creates a new
OperationRequestPredicate
. - WebServerNamespace - Class in org.springframework.boot.actuate.endpoint.web
-
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).
- WHEN_AUTHORIZED - Enum constant in enum class org.springframework.boot.actuate.endpoint.Show
-
Show the item in the response when accessed by an authorized user.
- withDetail(String, Object) - Method in class org.springframework.boot.actuate.info.Info.Builder
-
Record detail using given
key
andvalue
. - withDetails(Map<String, Object>) - Method in class org.springframework.boot.actuate.info.Info.Builder
-
Record several details.
- withInitParameter(String, String) - Method in class org.springframework.boot.actuate.endpoint.web.EndpointServlet
-
Deprecated.
- withInitParameters(Map<String, String>) - Method in class org.springframework.boot.actuate.endpoint.web.EndpointServlet
-
Deprecated.
- withLoadOnStartup(int) - Method in class org.springframework.boot.actuate.endpoint.web.EndpointServlet
-
Deprecated.Sets the
loadOnStartup
priority that will be set on Servlet registration. - withSanitizedValue() - Method in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Return a new
SanitizableData
instance with sanitized value. - withValue(Object) - Method in class org.springframework.boot.actuate.endpoint.SanitizableData
-
Return a new
SanitizableData
instance with a different value. - WRITE - Enum constant in enum class org.springframework.boot.actuate.endpoint.OperationType
-
A write operation.
- WriteOperation - Annotation Interface in org.springframework.boot.actuate.endpoint.annotation
-
Identifies a method on an
@Endpoint
as being a write operation.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
@Endpoint
and@WebEndpoint