| org.jasig.portal.tools.checks.ICheck
All known Subclasses: org.jasig.portal.tools.checks.JaxpCheck, org.jasig.portal.tools.checks.TimeCheck, org.jasig.portal.tools.checks.ClassPresenceCheck, org.jasig.portal.tools.checks.Dom3Check, org.jasig.portal.tools.checks.XalanVersionCheck, org.jasig.portal.tools.checks.SpringPresenceCheck, org.jasig.portal.tools.checks.SpringBeanCheck,
ICheck | public interface ICheck (Code) | | A single runtime check that to be performed to validate an application deployment.
version: $Revision: 35833 $ $Date: 2005-05-19 18:51:40 -0700 (Thu, 19 May 2005) $ since: uPortal 2.5 |
doCheck | public CheckResult doCheck()(Code) | | 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.
a CheckResult representing the result of the check |
getDescription | public String getDescription()(Code) | | 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.
a description of what it is that the check checks. |
|
|