org.jasig.portal.tools.checks
Class Dom3Check

java.lang.Object
  extended by org.jasig.portal.tools.checks.Dom3Check
All Implemented Interfaces:
ICheck

public final class Dom3Check
extends java.lang.Object
implements ICheck

Checks that DOM level 3 is present. uPortal requires level 3 of the DOM (org.w3c.dom) APIs. JDK 1.4 shipped with a DOM 2 implementation of this API in its rt.jar, so deployers using JDK 1.4 must override with the JAXP 1.3 implementation of these APIs. Deployers using JDK 1.5 need do nothing as JAXP 1.3 is included in baseline JDK 1.5. This check verifies that level 3 of the APIs is available by exercising a method that exists in DOM3 but not in DOM2.

Since:
uPortal 2.5
Version:
$Revision: 1.3 $ $Date: 2005/05/25 17:55:44 $

Field Summary
protected  org.apache.commons.logging.Log log
           
 
Constructor Summary
Dom3Check()
           
 
Method Summary
 CheckResult doCheck()
          Perform an arbitrary check.
 java.lang.String getDescription()
          Get a description of what it is the check is intended to check.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

protected final org.apache.commons.logging.Log log
Constructor Detail

Dom3Check

public Dom3Check()
Method Detail

doCheck

public CheckResult doCheck()
Description copied from interface: ICheck
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.

Specified by:
doCheck in interface ICheck
Returns:
a CheckResult representing the result of the check

getDescription

public java.lang.String getDescription()
Description copied from interface: ICheck
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.

Specified by:
getDescription in interface ICheck
Returns:
a description of what it is that the check checks.