com.mulesoft.mule.runtime.gw.api.agent

Interface HealthCheck

public interface HealthCheck

Runtime HealthCheck service to be used by Mule Agent

Method Summary

Modifier and Type	Method and Description
org.mule.runtime.api.healthcheck.HealthCheckValidator	getApiValidator(Long apiId) Adapter for Mule API health check validator interface by API
org.mule.runtime.api.healthcheck.HealthCheckValidator	getValidator(String applicationName) Adapter for Mule API health check validator interface by application
boolean	isApplicationTrafficAllowed(String applicationName) Checks if all GateKeeper handled APIs belonging to a given application are unblocked
boolean	isInstanceTrafficAllowed() Checks if all GateKeeper handled APIs are unblocked

Method Detail

isInstanceTrafficAllowed

boolean isInstanceTrafficAllowed()

Checks if all GateKeeper handled APIs are unblocked

Returns:

true if all current APIs are unblocked

isApplicationTrafficAllowed

boolean isApplicationTrafficAllowed(String applicationName)

Checks if all GateKeeper handled APIs belonging to a given application are unblocked

Parameters:

applicationName -

Returns:

true if all the application APIs are unblocked

getValidator

org.mule.runtime.api.healthcheck.HealthCheckValidator getValidator(String applicationName)

Adapter for Mule API health check validator interface by application

Parameters:

applicationName - application to check health status

Returns:

a validator instance for a particular application

getApiValidator

org.mule.runtime.api.healthcheck.HealthCheckValidator getApiValidator(Long apiId)

Adapter for Mule API health check validator interface by API

Parameters:

apiId - API to check health status

Returns:

a validator instance for a particular API