org.springframework.boot.actuate.autoconfigure

Class OnEndpointElementCondition

java.lang.Object

org.springframework.boot.autoconfigure.condition.SpringBootCondition

org.springframework.boot.actuate.autoconfigure.OnEndpointElementCondition

All Implemented Interfaces:

Condition

public abstract class OnEndpointElementCondition
extends SpringBootCondition

Base endpoint element condition. An element can be disabled globally through the defaults name or individually through the name of the element.

Since:

2.0.0

Author:

Stephane Nicoll, Madhura Bhave

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	OnEndpointElementCondition(String prefix, Class<? extends Annotation> annotationType)

Method Summary

Modifier and Type	Method and Description
protected ConditionOutcome	getDefaultEndpointsOutcome(ConditionContext context) Deprecated. since 2.6.0 for removal in 3.0.0 in favor of getDefaultOutcome(ConditionContext, AnnotationAttributes)
protected ConditionOutcome	getDefaultOutcome(ConditionContext context, AnnotationAttributes annotationAttributes) Return the default outcome that should be used if property is not set.
protected ConditionOutcome	getEndpointOutcome(ConditionContext context, String endpointName)
ConditionOutcome	getMatchOutcome(ConditionContext context, AnnotatedTypeMetadata metadata) Determine the outcome of the match along with suitable log output.

Methods inherited from class org.springframework.boot.autoconfigure.condition.SpringBootCondition

anyMatches, logOutcome, matches, matches

Methods inherited from class java.lang.Object

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

Constructor Detail

OnEndpointElementCondition

protected OnEndpointElementCondition(String prefix,
                                     Class<? extends Annotation> annotationType)

Method Detail

getMatchOutcome

public ConditionOutcome getMatchOutcome(ConditionContext context,
                                        AnnotatedTypeMetadata metadata)

Description copied from class: SpringBootCondition

Determine the outcome of the match along with suitable log output.

Specified by:

getMatchOutcome in class SpringBootCondition

Parameters:

context - the condition context

metadata - the annotation metadata

Returns:

the condition outcome

getEndpointOutcome

protected ConditionOutcome getEndpointOutcome(ConditionContext context,
                                              String endpointName)

getDefaultOutcome

protected ConditionOutcome getDefaultOutcome(ConditionContext context,
                                             AnnotationAttributes annotationAttributes)

Return the default outcome that should be used if property is not set. By default this method will use the <prefix>.defaults.enabled property, matching if it is true or if it is not configured.

Parameters:

context - the condition context

annotationAttributes - the annotation attributes

Returns:

the default outcome

Since:

2.6.0

getDefaultEndpointsOutcome

@Deprecated
protected ConditionOutcome getDefaultEndpointsOutcome(ConditionContext context)

Deprecated. since 2.6.0 for removal in 3.0.0 in favor of getDefaultOutcome(ConditionContext, AnnotationAttributes)

Return the default outcome that should be used.

Parameters:

context - the condition context

Returns:

the default outcome