org.springframework.boot.actuate.autoconfigure.endpoint.expose

Class IncludeExcludeEndpointFilter<E extends org.springframework.boot.actuate.endpoint.ExposableEndpoint<?>>

java.lang.Object

org.springframework.boot.actuate.autoconfigure.endpoint.expose.IncludeExcludeEndpointFilter<E>

Type Parameters:

E - the endpoint type

All Implemented Interfaces:

org.springframework.boot.actuate.endpoint.EndpointFilter<E>

Direct Known Subclasses:

ExposeExcludePropertyEndpointFilter

public class IncludeExcludeEndpointFilter<E extends org.springframework.boot.actuate.endpoint.ExposableEndpoint<?>>
extends java.lang.Object
implements org.springframework.boot.actuate.endpoint.EndpointFilter<E>

EndpointFilter that will filter endpoints based on include and exclude patterns.

Since:

2.2.7

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IncludeExcludeEndpointFilter.DefaultIncludes Default include patterns that can be used.

Constructor Summary

Constructors

Constructor and Description
IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType, java.util.Collection<java.lang.String> include, java.util.Collection<java.lang.String> exclude, IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes) Create a new IncludeExcludeEndpointFilter with specific include/exclude rules.
IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType, java.util.Collection<java.lang.String> include, java.util.Collection<java.lang.String> exclude, java.lang.String... defaultIncludes) Create a new IncludeExcludeEndpointFilter with specific include/exclude rules.
IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType, org.springframework.core.env.Environment environment, java.lang.String prefix, IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes) Create a new IncludeExcludeEndpointFilter with include/exclude rules bound from the Environment.
IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType, org.springframework.core.env.Environment environment, java.lang.String prefix, java.lang.String... defaultIncludes) Create a new IncludeExcludeEndpointFilter with include/exclude rules bound from the Environment.

Method Summary

Modifier and Type	Method and Description
boolean	match(E endpoint)
protected boolean	match(org.springframework.boot.actuate.endpoint.EndpointId endpointId) Return true if the filter matches.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IncludeExcludeEndpointFilter

public IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType,
                                    org.springframework.core.env.Environment environment,
                                    java.lang.String prefix,
                                    java.lang.String... defaultIncludes)

Create a new IncludeExcludeEndpointFilter with include/exclude rules bound from the Environment.

Parameters:

endpointType - the endpoint type that should be considered (other types always match)

environment - the environment containing the properties

prefix - the property prefix to bind

defaultIncludes - the default includes to use when none are specified.

IncludeExcludeEndpointFilter

public IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType,
                                    org.springframework.core.env.Environment environment,
                                    java.lang.String prefix,
                                    IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes)

Create a new IncludeExcludeEndpointFilter with include/exclude rules bound from the Environment.

Parameters:

endpointType - the endpoint type that should be considered (other types always match)

environment - the environment containing the properties

prefix - the property prefix to bind

defaultIncludes - the default includes to use when none are specified.

IncludeExcludeEndpointFilter

public IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType,
                                    java.util.Collection<java.lang.String> include,
                                    java.util.Collection<java.lang.String> exclude,
                                    java.lang.String... defaultIncludes)

Create a new IncludeExcludeEndpointFilter with specific include/exclude rules.

Parameters:

endpointType - the endpoint type that should be considered (other types always match)

include - the include patterns

exclude - the exclude patterns

defaultIncludes - the default includes to use when none are specified.

IncludeExcludeEndpointFilter

public IncludeExcludeEndpointFilter(java.lang.Class<E> endpointType,
                                    java.util.Collection<java.lang.String> include,
                                    java.util.Collection<java.lang.String> exclude,
                                    IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes)

Create a new IncludeExcludeEndpointFilter with specific include/exclude rules.

Parameters:

endpointType - the endpoint type that should be considered (other types always match)

include - the include patterns

exclude - the exclude patterns

defaultIncludes - the default includes to use when none are specified.

Method Detail

match

public boolean match(E endpoint)

Specified by:

match in interface org.springframework.boot.actuate.endpoint.EndpointFilter<E extends org.springframework.boot.actuate.endpoint.ExposableEndpoint<?>>

match

protected final boolean match(org.springframework.boot.actuate.endpoint.EndpointId endpointId)

Return true if the filter matches.

Parameters:

endpointId - the endpoint ID to check

Returns:

true if the filter matches