Real-Time Java AOCS Framework v1.0 API Specification

RtjAocsFramework.FailureRecovery
Class NullRecoveryAction

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.FailureRecovery.RecoveryAction
                    |
                    +--RtjAocsFramework.FailureRecovery.NullRecoveryAction
All Implemented Interfaces:
Configurable, Resettable, Telemeterable

public class NullRecoveryAction
extends RecoveryAction

A null recovery action is a dummy recovery action that takes no action.

The failure reporting mechanism foreseen by the framework requires that to each failure a recovery action be associated. Failure events that have been created without a recovery action will give rise to a failure when they are processed by the failure recovery manager. Sometimes, however, it is not possible or desirable for the AOCS developer to associate a specific recovery action to a certain failure. The null recovery action is introduced to cater for such contingencies. This is a recovery action whose implementation of method doRecovery does nothing and simply hands over to the next recovery action in the chain (if one exists).

Copyright: see the Copyright Notice.

Version:
1.0
Author:
Alessandro Pasetti (University of Konstanz)
See Also:
The Failure Recovery Framelet Document.

Field Summary
 
Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable
DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM
 
Constructor Summary
NullRecoveryAction()
           
 
Method Summary
 void doRecovery()
          Calling this method will cause the recovery action to be executed.
 
Methods inherited from class RtjAocsFramework.FailureRecovery.RecoveryAction
getNextRecoveryAction, getTelemetryImageLength, isEnabled, reset, resetConfiguration, setEnabled, setNextRecoveryAction, writeToTelemetry
 
Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject
addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, isConfigured, removeConfigurationListener, removeFailureListener, reportConfigurationEvent, reportFailure, resetStaticConfiguration, setAocsClock, setDestructionRecoveryAction, setMaxNumberOfConfigurationListeners, setMaxNumberOfFailureListeners, setSystemManager, setTelemetryFormat
 
Methods inherited from class RtjAocsFramework.BasicObjects.RootObject
getClassId, getInstanceId, setClassId
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NullRecoveryAction

public NullRecoveryAction()
Method Detail

doRecovery

public void doRecovery()
Description copied from class: RecoveryAction
Calling this method will cause the recovery action to be executed. Conceptually, this should be an abstract method. Its implementation in the base class for all recovery action simply performs the forwarding of the doRecovery() call to the next recovery action in the chain of linked recovery actions.

Overrides:
doRecovery in class RecoveryAction

Real-Time Java AOCS Framework v1.0 API Specification

Real-Time Java AOCS Framework project home page

Automatic Control Laboratory, ETH Zuerich
Physikstrasse 3
CH-8092 Zuerich, Switzerland