gov.nist.antd.ssf
Interface FailureModule

All Known Implementing Classes:

NICFailureModule, ONICFailureModule

public interface FailureModule

This intrerface is used to allow the customisation of failure notification. When will a failure be notified to the upper layer, when is a failure detect as a failure.

 This class was developed at the National Institute of Standards and
 Technology by employees of the Federal Government in the course of
 their official duties. Pursuant to title 17 Section 105 of the United
 States Code this software is not subject to copyright protection and
 is in the public domain.

 NIST assumes no responsibility whatsoever for its use by other parties,
 and makes no guarantees, expressed or implied, about its quality,
 reliability, or any other characteristic.
 

 We would appreciate acknowledgement if the software is used.
 

 NIST ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS" CONDITION AND
 DISCLAIM ANY LIABILITY OF ANY KIND FOR ANY DAMAGES WHATSOEVER RESULTING
 FROM THE USE OF THIS SOFTWARE.
 

Author:

borchert

, rouil

Field Summary

static java.lang.String

DML_SECTION_NAME The DML secion name for the module.

Method Summary

void	assign(NIC nic) Assign the module to the passed onic.
void	config(com.renesys.raceway.DML.Configuration cfg) Configures the failure module.
EventMessage[]	processFailure(FailureInformation component) This method processes the failure notification of the passed object.
EventMessage[]	processRecovery(FailureInformation component) This method processes the failure recovery notification of the passed object.

Field Detail

DML_SECTION_NAME

public static final java.lang.String DML_SECTION_NAME

The DML secion name for the module.

See Also:

Constant Field Values

Method Detail

processFailure

public EventMessage[] processFailure(FailureInformation component)

This method processes the failure notification of the passed object. This method has to take care about logical failures that are the result of this failure.

Example:
The last Lambda in a fiber fails. The result is a logical failure (inDepthFailure) of the Fiber.

Parameters:

component - the component whose failure attribute was set to false.

Returns:

an array of messages that has to be send. If no message has to be send the array is empty.

processRecovery

public EventMessage[] processRecovery(FailureInformation component)

This method processes the failure recovery notification of the passed object. This method has to determine if the recovery process has to be started or not. This depends on the inDepthFailure of the passed Object if possible. The following components can contina the logical failure (inDepthFailure): OpticalLink, Fiber, and Lambda.

Parameters:

component - the component whose failure attribute was set to true.

Returns:

an array of messages that has to be send. If no message has to be send the array is empty.

assign

public void assign(NIC nic)
            throws IllegalAssignmentException

Assign the module to the passed onic. A module is not allowed to be assigned to more than one NIC.

Throws:

IllegalAssignmentException - if the NIC is already set.

config

public void config(com.renesys.raceway.DML.Configuration cfg)
            throws com.renesys.raceway.DML.configException

Configures the failure module.

Parameters:

cfg - The configuration instance.

Throws:

com.renesys.raceway.DML.configException - the configuration contains failures.