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

Class IncludeExcludeEndpointFilter<E extends ExposableEndpoint<?>>

java.lang.Object

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

Type Parameters:

E - the endpoint type

All Implemented Interfaces:

EndpointFilter<E>

public class IncludeExcludeEndpointFilter<E extends ExposableEndpoint<?>>
extends Object
implements EndpointFilter<E>

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

Since:

2.2.7

Author:

Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IncludeExcludeEndpointFilter.DefaultIncludes Deprecated. since 2.6.0 for removal in 3.0.0 in favor of EndpointExposure.

Constructor Summary

Constructors

Constructor and Description
IncludeExcludeEndpointFilter(Class<E> endpointType, Collection<String> include, Collection<String> exclude, IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes) Deprecated. since 2.6.0 for removal in 3.0.0 in favor of IncludeExcludeEndpointFilter(Class, Environment, String, String[])
IncludeExcludeEndpointFilter(Class<E> endpointType, Collection<String> include, Collection<String> exclude, String... defaultIncludes) Create a new IncludeExcludeEndpointFilter with specific include/exclude rules.
IncludeExcludeEndpointFilter(Class<E> endpointType, Environment environment, String prefix, IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes) Deprecated. since 2.6.0 for removal in 3.0.0 in favor of IncludeExcludeEndpointFilter(Class, Environment, String, String[])
IncludeExcludeEndpointFilter(Class<E> endpointType, Environment environment, String prefix, 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) Return true if the filter matches.
boolean	match(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

@Deprecated
public IncludeExcludeEndpointFilter(Class<E> endpointType,
                                                Environment environment,
                                                String prefix,
                                                IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes)

Deprecated. since 2.6.0 for removal in 3.0.0 in favor of IncludeExcludeEndpointFilter(Class, Environment, String, String[])

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(Class<E> endpointType,
                                    Environment environment,
                                    String prefix,
                                    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(Class<E> endpointType,
                                    Collection<String> include,
                                    Collection<String> exclude,
                                    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

@Deprecated
public IncludeExcludeEndpointFilter(Class<E> endpointType,
                                                Collection<String> include,
                                                Collection<String> exclude,
                                                IncludeExcludeEndpointFilter.DefaultIncludes defaultIncludes)

Deprecated. since 2.6.0 for removal in 3.0.0 in favor of IncludeExcludeEndpointFilter(Class, Environment, String, String[])

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)

Description copied from interface: EndpointFilter

Return true if the filter matches.

Specified by:

match in interface EndpointFilter<E extends ExposableEndpoint<?>>

Parameters:

endpoint - the endpoint to check

Returns:

true if the filter matches

match

public final boolean match(EndpointId endpointId)

Return true if the filter matches.

Parameters:

endpointId - the endpoint ID to check

Returns:

true if the filter matches

Since:

2.6.0