com.atomikos.persistence.RecoverableCoordinator Maven / Gradle / Ivy
/**
* Copyright (C) 2000-2016 Atomikos
*
* This code ("Atomikos TransactionsEssentials"), by itself,
* is being distributed under the
* Apache License, Version 2.0 ("License"), a copy of which may be found at
* http://www.atomikos.com/licenses/apache-license-2.0.txt .
* You may not use this file except in compliance with the License.
*
* While the License grants certain patent license rights,
* those patent license rights only extend to the use of
* Atomikos TransactionsEssentials by itself.
*
* This code (Atomikos TransactionsEssentials) contains certain interfaces
* in package (namespace) com.atomikos.icatch
* (including com.atomikos.icatch.Participant) which, if implemented, may
* infringe one or more patents held by Atomikos.
* It should be appreciated that you may NOT implement such interfaces;
* licensing to implement these interfaces must be obtained separately from Atomikos.
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*/
package com.atomikos.persistence;
import com.atomikos.finitestates.FSMPreEnterEventSource;
import com.atomikos.icatch.CoordinatorLogEntry;
import com.atomikos.icatch.TxState;
/**
* A type of stateful objects whose state is guaranteed to be recoverable. The
* logging is done based on PreEnter events. The guarantee offered is the
* following: IF a recoverable state is reached by the instance, then its image
* is GUARANTEED to be recoverable. The inverse does NOT hold: the fact that an
* object is recovered in some state does NOT mean that the state was reached.
* Indeed, other PreEnter listeners may still have prevented the transition in
* the last moment. However, this should not be a real problem; applications
* should take this into account.
*/
public interface RecoverableCoordinator extends FSMPreEnterEventSource
{
CoordinatorLogEntry getCoordinatorLogEntry(TxState state);
}