/*
* JBoss, Home of Professional Open Source
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags.
* See the copyright.txt in the distribution for a
* full listing of individual contributors.
* This copyrighted material is made available to anyone wishing to use,
* modify, copy, or redistribute it subject to the terms and conditions
* of the GNU Lesser General Public License, v. 2.1.
* This program is distributed in the hope that it will be useful, but WITHOUT A
* WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
* PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public License,
* v.2.1 along with this distribution; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
* MA 02110-1301, USA.
*
* (C) 2005-2006,
* @author JBoss Inc.
*/
/*
* Copyright (C) 1999-2001 by HP Bluestone Software, Inc. All rights Reserved.
*
* HP Arjuna Labs,
* Newcastle upon Tyne,
* Tyne and Wear,
* UK.
*
* $Id: RecoveryModule.java 2342 2006-03-30 13:06:17Z $
*/
package com.arjuna.ats.arjuna.recovery ;
/**
* Interface for Recovery manager plug-in module.
* RecoveryModules are registered via the properties mechanisms.
* The periodicWorkFirstPass of each module is called, then RecoveryManager
* waits for the time interval RECOVERY_BACKOFF_PERIOD (seconds), then the
* periodicWorkSecondPass of each module are called.
* The RecoveryManager then waits for period PERIODIC_RECOVERY_PERIOD (seconds)
* before starting the first pass again
* The backoff period between the first and second pass is intended to allow
* transactions that were in-flight during the first pass to be completed normally,
* without requiring the status of each one to be checked. The recovery period
* will typically be appreciably longer.
*/
public interface RecoveryModule
{
/**
* Called by the RecoveryManager at start up, and then
* PERIODIC_RECOVERY_PERIOD seconds after the completion, for all RecoveryModules,
* of the second pass
*/
public void periodicWorkFirstPass ();
/**
* Called by the RecoveryManager RECOVERY_BACKOFF_PERIOD seconds
* after the completion of the first pass
*/
public void periodicWorkSecondPass ();
}