Interface EndpointExposureOutcomeContributor

public interface EndpointExposureOutcomeContributor

Contributor loaded from the spring.factories file and used by @ConditionalOnAvailableEndpoint to determine if an endpoint is exposed. If any contributor returns a matching ConditionOutcome then the endpoint is considered exposed.

Implementations may declare a constructor that accepts an Environment argument.

Since:

3.4.0

Author:

Andy Wilkinson, Phillip Webb

Method Summary

Modifier and Type	Method	Description
@Nullable ConditionOutcome	getExposureOutcome(EndpointId endpointId, Set<EndpointExposure> exposures, ConditionMessage.Builder message)	Return if the given endpoint is exposed for the given set of exposure technologies.

Method Details

getExposureOutcome

@Nullable ConditionOutcome getExposureOutcome(EndpointId endpointId,
 Set<EndpointExposure> exposures,
 ConditionMessage.Builder message)

Return if the given endpoint is exposed for the given set of exposure technologies.

Parameters:

endpointId - the endpoint ID

exposures - the exposure technologies to check

message - the condition message builder

Returns:

a matching ConditionOutcome if the endpoint is exposed or null if the contributor should not apply