RtjAocsFramework.FailureRecovery
Class SystemResetOnConfigurationError

java.lang.Object
  |
  +--RtjAocsFramework.BasicObjects.RootObject
        |
        +--RtjAocsFramework.BasicObjects.AocsObject
              |
              +--RtjAocsFramework.FailureRecovery.RecoveryStrategy
                    |
                    +--RtjAocsFramework.FailureRecovery.SystemResetOnConfigurationError

All Implemented Interfaces:

Configurable, Resettable, Telemeterable

public class SystemResetOnConfigurationError

extends RecoveryStrategy

This recovery startegy will cause a software reset to be executed if a configuration event is detected in the configuration event repository. Configuration events are assumed to indicate a configuration error. The configuration event repository a settable configuration parameter.

Copyright: see the Copyright Notice.

Version:

1.0

Author:

Alessandro Pasetti (University of Konstanz)

See Also:

The Failure Recovery Framelet Document., SystemManager

Field Summary

Fields inherited from interface RtjAocsFramework.TelemetryManagement.Telemeterable

DEBUG_TM, LONG_TM, NORMAL_TM, NTMFORMATS, SHORT_TM

Constructor Summary

SystemResetOnConfigurationError()
This component should not be used before it is configured by loading the the configuration event repository.

Method Summary

void	doRecovery() Calling this method will cause the recovery strategy to be executed.
ConfigurationEventRepository	getConfigurationEventRepository()
int	getTelemetryImageLength() Return the length (in bits) of the telemetry image of the object.
boolean	isConfigured() Return false if some configuration data are missing.
void	resetConfiguration() Unload the configuration event repository.
void	setConfigurationEventRepository(ConfigurationEventRepository r)
void	writeToTelemetry(TelemetryStream tmStream) Direct the object to write its own state to the telemetry stream.

Methods inherited from class RtjAocsFramework.FailureRecovery.RecoveryStrategy

addRecoveryListener, fireModeEvent, getFailureEventRepository, getNextRecoveryStrategy, isEnabled, removeRecoveryListener, reset, setEnabled, setFailureEventRepository, setMaxNumberOfRecoveryListeners, setNextRecoveryStrategy

Methods inherited from class RtjAocsFramework.BasicObjects.AocsObject

addConfigurationListener, addFailureListener, finalize, getAocsClock, getConfigurationListenerList, getCycle, getDestructionRecoveryAction, getFailureListenerList, getSystemManager, getTelemetryFormat, getTime, 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

SystemResetOnConfigurationError

public SystemResetOnConfigurationError()

This component should not be used before it is configured by loading the the configuration event repository.

Method Detail

doRecovery

public void doRecovery()

Description copied from class: RecoveryStrategy

Calling this method will cause the recovery strategy to be executed. Conceptually, this should be an abstract method. Its implementation in the base class for all recovery strategies simply performs the forwarding of the doRecovery() call to the next recovery strategy in the chain of linked recovery strategies.

Overrides:

doRecovery in class RecoveryStrategy

resetConfiguration

public void resetConfiguration()

Unload the configuration event repository.

Specified by:

resetConfiguration in interface Configurable

Overrides:

resetConfiguration in class RecoveryStrategy

isConfigured

public boolean isConfigured()

Description copied from interface: Configurable

Return false if some configuration data are missing.

Typically, a false value indicates that a plug-in component is missing or that the object has not been initialized. This is a negative check only: a return value of true cannot guarantee that the object is correctly configured.

Calls to resetConfiguration on an object A are normally not propagated objects of type AocsObject that are contained or otherwise aggregated to A. The rationale for this policy is that all objects of type AocsObject implement interface configurable and therefore their configuration status should be checked externally (probably through the configuration check service of the system manager).

Specified by:

isConfigured in interface Configurable

Overrides:

isConfigured in class RecoveryStrategy

setConfigurationEventRepository

public void setConfigurationEventRepository(ConfigurationEventRepository r)

getConfigurationEventRepository

public ConfigurationEventRepository getConfigurationEventRepository()

writeToTelemetry

public void writeToTelemetry(TelemetryStream tmStream)

Description copied from interface: Telemeterable

Direct the object to write its own state to the telemetry stream.

Specified by:

writeToTelemetry in interface Telemeterable

Overrides:

writeToTelemetry in class RecoveryStrategy

getTelemetryImageLength

public int getTelemetryImageLength()

Description copied from interface: Telemeterable

Return the length (in bits) of the telemetry image of the object. This method is useful to verify that the quantity of data generated by a given object is compatible with the capacity of the telemetry channel.

Specified by:

getTelemetryImageLength in interface Telemeterable

Overrides:

getTelemetryImageLength in class RecoveryStrategy