/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package com.sun.enterprise.transaction.jts;
import java.util.*;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.transaction.xa.XAResource;
import com.sun.enterprise.config.serverbeans.TransactionService;
import com.sun.enterprise.util.i18n.StringManager;
import com.sun.logging.LogDomains;
import com.sun.enterprise.transaction.api.JavaEETransactionManager;
import com.sun.enterprise.transaction.api.ResourceRecoveryManager;
import com.sun.enterprise.transaction.api.RecoveryResourceRegistry;
import com.sun.enterprise.transaction.spi.RecoveryResourceListener;
import com.sun.enterprise.transaction.spi.RecoveryResourceHandler;
import com.sun.enterprise.transaction.spi.RecoveryEventListener;
import com.sun.enterprise.transaction.JavaEETransactionManagerSimplified;
import com.sun.jts.CosTransactions.DelegatedRecoveryManager;
import com.sun.jts.CosTransactions.Configuration;
import com.sun.jts.CosTransactions.RecoveryManager;
import org.jvnet.hk2.annotations.*;
import org.jvnet.hk2.component.Habitat;
import org.jvnet.hk2.component.PostConstruct;
/**
* Resource recovery manager to recover transactions.
*
* @author Jagadish Ramu
*/
@Service
public class ResourceRecoveryManagerImpl implements PostConstruct, ResourceRecoveryManager {
@Inject
private TransactionService txnService;
@Inject
private Habitat habitat;
private JavaEETransactionManager txMgr;
private Collection<RecoveryResourceHandler> recoveryResourceHandlers;
private RecoveryResourceRegistry recoveryListenersRegistry;
private static Logger _logger =
LogDomains.getLogger(JavaEETransactionManagerSimplified.class,
LogDomains.JTA_LOGGER);
private static StringManager localStrings =
StringManager.getManager(JavaEETransactionManagerSimplified.class);
private volatile boolean lazyRecovery = false;
private volatile boolean configured = false;
// Externally registered (ie not via habitat.getAllByContract) ResourceHandlers
private static List externallyRegisteredRecoveryResourceHandlers = new ArrayList();
public void postConstruct() {
if (configured) {
_logger.log(Level.WARNING, "", new IllegalStateException());
return;
}
// Recover XA resources if the auto-recovery flag in tx service is set to true
recoverXAResources();
}
/**
* recover incomplete transactions
* @param delegated indicates whether delegated recovery is needed
* @param logPath transaction log directory path
* @return boolean indicating the status of transaction recovery
* @throws Exception when unable to recover
*/
public boolean recoverIncompleteTx(boolean delegated, String logPath) throws Exception {
return recoverIncompleteTx(delegated, logPath,
((delegated)? null : Configuration.getPropertyValue(Configuration.INSTANCE_NAME)), false);
}
/**
* recover incomplete transactions
* @param delegated indicates whether delegated recovery is needed
* @param logPath transaction log directory path
* @param instance the name of the instance for which delegated recovery is performed, null if unknown.
* @param notifyRecoveryListeners specifies whether recovery listeners are to be notified
* @return boolean indicating the status of transaction recovery
* @throws Exception when unable to recover
*/
public boolean recoverIncompleteTx(boolean delegated, String logPath, String instance,
boolean notifyRecoveryListeners) throws Exception {
boolean result = false;
Map<RecoveryResourceHandler, Vector> handlerToXAResourcesMap = null;
try {
if (_logger.isLoggable(Level.FINE)) {
_logger.log(Level.FINE, "Performing recovery of incomplete Tx...");
}
configure();
if (notifyRecoveryListeners) {
beforeRecovery(delegated, instance);
}
Vector xaresList = new Vector();
//TODO V3 will handle ThirdPartyXAResources also (v2 is not so). Is this fine ?
handlerToXAResourcesMap = getAllRecoverableResources(xaresList);
int size = xaresList.size();
XAResource[] xaresArray = new XAResource[size];
for (int i = 0; i < size; i++) {
xaresArray[i] = (XAResource) xaresList.elementAt(i);
}
if (_logger.isLoggable(Level.FINE)) {
String msg = localStrings.getStringWithDefault("xaresource.recovering",
"Recovering {0} XA resources...", new Object[] {String.valueOf(size)});
_logger.log(Level.FINE, msg);
}
if (!delegated) {
RecoveryManager.recoverIncompleteTx(xaresArray);
result = true;
} else {
result = DelegatedRecoveryManager.delegated_recover(logPath, xaresArray);
}
return result;
} catch (Exception ex1) {
_logger.log(Level.WARNING, "xaresource.recover_error", ex1);
throw ex1;
} finally {
try {
closeAllResources(handlerToXAResourcesMap);
} catch (Exception ex1) {
_logger.log(Level.WARNING, "xaresource.recover_error", ex1);
}
if (notifyRecoveryListeners) {
afterRecovery(result, delegated, instance);
}
}
}
/**
* close all resources provided using their handlers
* @param resourcesToHandlers map that holds handlers and their resources
*/
private void closeAllResources(Map<RecoveryResourceHandler, Vector> resourcesToHandlers) {
if (resourcesToHandlers != null) {
Set<Map.Entry<RecoveryResourceHandler, Vector>> entries = resourcesToHandlers.entrySet();
for (Map.Entry<RecoveryResourceHandler, Vector> entry : entries) {
RecoveryResourceHandler handler = entry.getKey();
Vector resources = entry.getValue();
handler.closeConnections(resources);
}
}
}
/**
* get all recoverable resources
* @param xaresList xa resources
* @return recovery-handlers and their resources
*/
private Map<RecoveryResourceHandler, Vector> getAllRecoverableResources(Vector xaresList) {
Map<RecoveryResourceHandler, Vector> resourcesToHandlers =
new HashMap<RecoveryResourceHandler, Vector>();
for (RecoveryResourceHandler handler : recoveryResourceHandlers) {
//TODO V3 FINE LOG
Vector resources = new Vector();
handler.loadXAResourcesAndItsConnections(xaresList, resources);
resourcesToHandlers.put(handler, resources);
}
return resourcesToHandlers;
}
/**
* recover the xa-resources
* @param force boolean to indicate if it has to be forced.
*/
public void recoverXAResources(boolean force) {
if (force) {
try {
if (!Boolean.valueOf(txnService.getAutomaticRecovery())) {
return;
}
if (_logger.isLoggable(Level.FINE)) {
_logger.log(Level.FINE, "ejbserver.recovery",
"Perform recovery of XAResources...");
}
configure();
Vector xaresList = new Vector();
Map<RecoveryResourceHandler, Vector> resourcesToHandler =
getAllRecoverableResources(xaresList);
int size = xaresList.size();
XAResource[] xaresArray = new XAResource[size];
for (int i = 0; i < size; i++) {
xaresArray[i] = (XAResource) xaresList.elementAt(i);
}
resourceRecoveryStarted();
if (_logger.isLoggable(Level.FINE)) {
String msg = localStrings.getStringWithDefault("xaresource.recovering",
"Recovering {0} XA resources...", new Object[]{String.valueOf(size)});
_logger.log(Level.FINE, msg);
}
txMgr.recover(xaresArray);
resourceRecoveryCompleted();
closeAllResources(resourcesToHandler);
} catch (Exception ex) {
_logger.log(Level.SEVERE, "xaresource.recover_error", ex);
}
}
}
/**
* notifies the resource listeners that recovery has started
*/
private void resourceRecoveryStarted() {
Set<RecoveryResourceListener> listeners =
recoveryListenersRegistry.getListeners();
for (RecoveryResourceListener rrl : listeners) {
rrl.recoveryStarted();
}
}
/**
* notifies the resource listeners that recovery has completed
*/
private void resourceRecoveryCompleted() {
Set<RecoveryResourceListener> listeners =
recoveryListenersRegistry.getListeners();
for (RecoveryResourceListener rrl : listeners) {
rrl.recoveryCompleted();
}
}
/**
* notifies the event listeners that recovery is about to start
*/
private void beforeRecovery(boolean delegated, String instance) {
Set<RecoveryEventListener> listeners =
recoveryListenersRegistry.getEventListeners();
for (RecoveryEventListener erl : listeners) {
try {
erl.beforeRecovery(delegated, instance);
} catch (Throwable e) {
_logger.log(Level.WARNING, "", e);
_logger.log(Level.WARNING, "jts.before_recovery_excep", e);
}
}
}
/**
* notifies the event listeners that all recovery operations are completed
*/
private void afterRecovery(boolean success, boolean delegated, String instance) {
Set<RecoveryEventListener> listeners =
recoveryListenersRegistry.getEventListeners();
for (RecoveryEventListener erl : listeners) {
try {
erl.afterRecovery(success, delegated, instance);
} catch (Throwable e) {
_logger.log(Level.WARNING, "", e);
_logger.log(Level.WARNING, "jts.after_recovery_excep", e);
}
}
}
/**
* to enable lazy recovery, setting lazy to "true" will
*
* @param lazy boolean
*/
public void setLazyRecovery(boolean lazy) {
lazyRecovery = lazy;
}
/**
* to recover xa resources
*/
public void recoverXAResources() {
recoverXAResources(!lazyRecovery);
}
private void configure() {
if (configured) {
return;
}
recoveryResourceHandlers = new ArrayList(habitat.getAllByContract(RecoveryResourceHandler.class));
recoveryResourceHandlers.addAll(externallyRegisteredRecoveryResourceHandlers);
txMgr = habitat.getByContract(JavaEETransactionManager.class);
recoveryListenersRegistry = habitat.getComponent(RecoveryResourceRegistry.class);
if (recoveryListenersRegistry == null) throw new IllegalStateException();
RecoveryManager.startTransactionRecoveryFence();
configured = true;
}
public static void registerRecoveryResourceHandler(final XAResource xaResource) {
RecoveryResourceHandler recoveryResourceHandler =
new RecoveryResourceHandler() {
public void loadXAResourcesAndItsConnections(List xaresList, List connList) {
xaresList.add(xaResource);
}
public void closeConnections(List connList) {
;
}
};
externallyRegisteredRecoveryResourceHandlers.add(recoveryResourceHandler);
}
}