com.atomikos.icatch.CompositeCoordinator Maven / Gradle / Ivy
/**
* Copyright (C) 2000-2010 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.icatch;
/**
*
*
*A CompositeCoordinator represents the per-server work done
*as part of the same termination scope.
*
*
*/
public interface CompositeCoordinator extends java.io.Serializable
{
/**
*Get the identifier for this coordinator.
*
*@return String The coordinator id.
*For imported transactions, this will be the
*id of the top-level or root transaction. For
*subtransactions, this will be an independent id.
*/
public String getCoordinatorId();
/**
*Get the recovery coordinator instance for this one.
*
*@return RecoveryCoordinator The recovery coordinator.
*/
public RecoveryCoordinator getRecoveryCoordinator();
/**
*Get the tags that were set for this coordinator.
*
*@return HeuristicMessage[] The tags set.
*These serve as a summary of the local work
*towards remote client TMs (that way, these
*do not have to see ALL local heuristic messages,
*but rather get a relevant summary).
*The participant proxy for a local coordinator
*returns these tags as its heuristic messages.
*/
public HeuristicMessage[] getTags();
/**
* Checks whether the instance is recoverable
* in the active state. Although active recoverability requires
* more logging overhead, some protocols may need this capability.
*
* @return Boolean True iff recoverable in active state.
* Null if this information is not available (for imported instances).
* By default, this is false.
*/
public Boolean isRecoverableWhileActive();
/**
* Sets this coordinator to be recoverable
* while active. Ideally, this method is called
* before any participants are added
* (otherwise, some participants may have been added
* and not recovered due to an intermediate crash).
*
* This operation may not be unavailable for imported
* coordinators, but it should always work for
* locally created (sub)transactions.
*
*
* NOTE: active recoverability is inherited by
* any subtransactions that are created afterwards.
*/
public void setRecoverableWhileActive()
throws UnsupportedOperationException;
}