Package org.springframework.boot.docker.compose.readiness

Interface ServiceReadinessCheck

public interface ServiceReadinessCheck

Strategy used to check if a RunningService is ready. Implementations may be registered in spring.factories. The following constructor arguments types are supported:

• ClassLoader
• Environment
• Binder

Since:

3.1.0

Author:

Moritz Halbritter, Andy Wilkinson, Phillip Webb

Method Summary

Modifier and Type	Method	Description
void	check(RunningService service)	Checks whether the given service is ready.

Method Details

check

void check(RunningService service)
    throws ServiceNotReadyException

Checks whether the given service is ready.

Parameters:

service - service to check

Throws:

ServiceNotReadyException - if the service is not ready