org.jasig.portal.tools.checks
Interface ICheck

All Known Implementing Classes:

BaseCheck, ClassPresenceCheck, MethodPresenceCheck, SpringBeanCheck, SystemPropertyCheck, TimeCheck, XalanVersionCheck

public interface ICheck

A single runtime check that to be performed to validate an application deployment.

Since:

uPortal 2.5

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Method Summary

CheckResult	doCheck() Perform an arbitrary check.
String	getDescription() Get a description of what it is the check is intended to check.

Method Detail

doCheck

CheckResult doCheck()

Perform an arbitrary check. The result of this method should be a CheckResult representing either a success or failure of the check. Implementations should catch their own exceptions and translate them into CheckResults representing failures, since the intent of this API is to translate arcane deployment issues into friendly results with remediation messages. However, the implementation of this method may throw any RuntimeException, and clients must cope with such exceptions. Cope with probably means translate it into a CheckResult representing a failure of this check. The client of a Check implementation will be less effective in translating a thrown Throwable into an intelligent CheckResult representing a failure than the Check would have been in doing this itself.

Returns:

a CheckResult representing the result of the check

getDescription

String getDescription()

Get a description of what it is the check is intended to check. Implementations of this method must always return a non-null String and should not throw anything.

Returns:

a description of what it is that the check checks.