org.apereo.portal.health

Interface IHealthChecker

All Known Implementing Classes:

DatabaseHealthChecker, MemoryHealthChecker

public interface IHealthChecker

Interface for health checker that performs a test and either returns some useful information that will be added to a JSON response OR throws a RuntimeException if the health check should respond with a code 500. This will likely cause a loadbalancer or other service report that uPortal server is failing.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDetailIdentifier()
java.lang.String	getName()
java.util.Map<java.lang.String,java.lang.Object>	runCheck()

Method Detail

getName

@NotNull
java.lang.String getName()

getDetailIdentifier

@NotNull
java.lang.String getDetailIdentifier()

runCheck

@NotNull
java.util.Map<java.lang.String,java.lang.Object> runCheck()
                                                            throws java.lang.RuntimeException

Throws:

java.lang.RuntimeException