Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## org.jasig.portal.tools.checks
Class SpringBeanCheck

    java.lang.Object
      org.jasig.portal.tools.checks.SpringBeanCheck

All Implemented Interfaces:
  ICheck

    public class SpringBeanCheck

extends java.lang.Object
implements ICheck

Check that a particular named Spring bean is defined.

Since:
  uPortal 2.5
Version:
  $Revision: 1.5 $ $Date: 2005/05/20 01:53:14 $

Field Summary
`private java.lang.String` | `beanName`
`protected org.apache.commons.logging.Log` | `log`
`private CheckResult` | `nullBeanNameResult`
`private java.lang.String` | `requiredBeanTypeClassName`

Constructor Summary
`SpringBeanCheck(java.lang.String beanName)`
`SpringBeanCheck(java.lang.String beanName, java.lang.String requiredBeanTypeClassName)`

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

### beanName

    private final java.lang.String beanName

### requiredBeanTypeClassName

    private final java.lang.String requiredBeanTypeClassName

### nullBeanNameResult

    private CheckResult nullBeanNameResult

Constructor Detail

### SpringBeanCheck

    public SpringBeanCheck(java.lang.String beanName,
                           java.lang.String requiredBeanTypeClassName)

### SpringBeanCheck

    public SpringBeanCheck(java.lang.String beanName)

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.

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD