/**
*
* Copyright 2004 The Apache Software Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* 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.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.geronimo.transaction.log;
import java.io.IOException;
import java.util.Collection;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import javax.transaction.xa.Xid;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.geronimo.gbean.GBeanInfo;
import org.apache.geronimo.gbean.GBeanInfoBuilder;
import org.apache.geronimo.gbean.GBeanLifecycle;
import org.apache.geronimo.system.serverinfo.ServerInfo;
import org.apache.geronimo.transaction.manager.LogException;
import org.apache.geronimo.transaction.manager.Recovery;
import org.apache.geronimo.transaction.manager.TransactionBranchInfo;
import org.apache.geronimo.transaction.manager.TransactionBranchInfoImpl;
import org.apache.geronimo.transaction.manager.TransactionLog;
import org.apache.geronimo.transaction.manager.XidFactory;
import org.apache.geronimo.j2ee.j2eeobjectnames.NameFactory;
import org.objectweb.howl.log.Configuration;
import org.objectweb.howl.log.LogClosedException;
import org.objectweb.howl.log.LogConfigurationException;
import org.objectweb.howl.log.LogFileOverflowException;
import org.objectweb.howl.log.LogRecord;
import org.objectweb.howl.log.LogRecordSizeException;
import org.objectweb.howl.log.LogRecordType;
import org.objectweb.howl.log.ReplayListener;
import org.objectweb.howl.log.xa.XACommittingTx;
import org.objectweb.howl.log.xa.XALogRecord;
import org.objectweb.howl.log.xa.XALogger;
/**
* @version $Rev: 406493 $ $Date: 2006-05-15 03:14:11 +0200 (Mon, 15 May 2006) $
*/
public class HOWLLog implements TransactionLog, GBeanLifecycle {
// static final byte PREPARE = 1;
//these are used as debugging aids only
private static final byte COMMIT = 2;
private static final byte ROLLBACK = 3;
static final String[] TYPE_NAMES = {null, "PREPARE", "COMMIT", "ROLLBACK"};
private static final Log log = LogFactory.getLog(HOWLLog.class);
private final ServerInfo serverInfo;
private String logFileDir;
private final XidFactory xidFactory;
private final XALogger logger;
private final Configuration configuration = new Configuration();
private boolean started = false;
private HashMap recovered;
public HOWLLog(String bufferClassName,
int bufferSize,
boolean checksumEnabled,
int flushSleepTimeMilliseconds,
String logFileDir,
String logFileExt,
String logFileName,
int maxBlocksPerFile,
int maxBuffers,
int maxLogFiles,
int minBuffers,
int threadsWaitingForceThreshold,
XidFactory xidFactory,
ServerInfo serverInfo) throws IOException, LogConfigurationException {
this.serverInfo = serverInfo;
setBufferClassName(bufferClassName);
setBufferSizeKBytes(bufferSize);
setChecksumEnabled(checksumEnabled);
setFlushSleepTimeMilliseconds(flushSleepTimeMilliseconds);
//setLogFileDir(logFileDir);
this.logFileDir = logFileDir;
setLogFileExt(logFileExt);
setLogFileName(logFileName);
setMaxBlocksPerFile(maxBlocksPerFile);
setMaxBuffers(maxBuffers);
setMaxLogFiles(maxLogFiles);
setMinBuffers(minBuffers);
setThreadsWaitingForceThreshold(threadsWaitingForceThreshold);
this.xidFactory = xidFactory;
this.logger = new XALogger(configuration);
}
public String getLogFileDir() {
return logFileDir;
}
public void setLogFileDir(String logDir) {
this.logFileDir = logDir;
if (started) {
configuration.setLogFileDir(serverInfo.resolveServerPath(logDir));
}
}
public String getLogFileExt() {
return configuration.getLogFileExt();
}
public void setLogFileExt(String logFileExt) {
configuration.setLogFileExt(logFileExt);
}
public String getLogFileName() {
return configuration.getLogFileName();
}
public void setLogFileName(String logFileName) {
configuration.setLogFileName(logFileName);
}
public boolean isChecksumEnabled() {
return configuration.isChecksumEnabled();
}
public void setChecksumEnabled(boolean checksumOption) {
configuration.setChecksumEnabled(checksumOption);
}
public int getBufferSizeKBytes() {
return configuration.getBufferSize();
}
public void setBufferSizeKBytes(int bufferSize) throws LogConfigurationException {
configuration.setBufferSize(bufferSize);
}
public String getBufferClassName() {
return configuration.getBufferClassName();
}
public void setBufferClassName(String bufferClassName) {
configuration.setBufferClassName(bufferClassName);
}
public int getMaxBuffers() {
return configuration.getMaxBuffers();
}
public void setMaxBuffers(int maxBuffers) throws LogConfigurationException {
configuration.setMaxBuffers(maxBuffers);
}
public int getMinBuffers() {
return configuration.getMinBuffers();
}
public void setMinBuffers(int minBuffers) throws LogConfigurationException {
configuration.setMinBuffers(minBuffers);
}
public int getFlushSleepTimeMilliseconds() {
return configuration.getFlushSleepTime();
}
public void setFlushSleepTimeMilliseconds(int flushSleepTime) {
configuration.setFlushSleepTime(flushSleepTime);
}
public int getThreadsWaitingForceThreshold() {
return configuration.getThreadsWaitingForceThreshold();
}
public void setThreadsWaitingForceThreshold(int threadsWaitingForceThreshold) {
configuration.setThreadsWaitingForceThreshold(threadsWaitingForceThreshold == -1 ? Integer.MAX_VALUE : threadsWaitingForceThreshold);
}
public int getMaxBlocksPerFile() {
return configuration.getMaxBlocksPerFile();
}
public void setMaxBlocksPerFile(int maxBlocksPerFile) {
configuration.setMaxBlocksPerFile(maxBlocksPerFile == -1 ? Integer.MAX_VALUE : maxBlocksPerFile);
}
public int getMaxLogFiles() {
return configuration.getMaxLogFiles();
}
public void setMaxLogFiles(int maxLogFiles) {
configuration.setMaxLogFiles(maxLogFiles);
}
public ServerInfo getServerInfo() {
return serverInfo;
}
public void doStart() throws Exception {
started = true;
setLogFileDir(logFileDir);
log.debug("Initiating transaction manager recovery");
recovered = new HashMap();
logger.open(null);
ReplayListener replayListener = new GeronimoReplayListener(xidFactory, recovered);
logger.replayActiveTx(replayListener);
log.debug("In doubt transactions recovered from log");
}
public void doStop() throws Exception {
started = false;
logger.close();
recovered = null;
}
public void doFail() {
}
public void begin(Xid xid) throws LogException {
}
public Object prepare(Xid xid, List branches) throws LogException {
int branchCount = branches.size();
byte[][] data = new byte[3 + 2 * branchCount][];
data[0] = intToBytes(xid.getFormatId());
data[1] = xid.getGlobalTransactionId();
data[2] = xid.getBranchQualifier();
int i = 3;
for (Iterator iterator = branches.iterator(); iterator.hasNext();) {
TransactionBranchInfo transactionBranchInfo = (TransactionBranchInfo) iterator.next();
data[i++] = transactionBranchInfo.getBranchXid().getBranchQualifier();
data[i++] = transactionBranchInfo.getResourceName().getBytes();
}
try {
XACommittingTx committingTx = logger.putCommit(data);
return committingTx;
} catch (LogClosedException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (LogRecordSizeException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (LogFileOverflowException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (InterruptedException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (IOException e) {
throw new LogException(e);
}
}
public void commit(Xid xid, Object logMark) throws LogException {
//the data is theoretically unnecessary but is included to help with debugging and because HOWL currently requires it.
byte[][] data = new byte[4][];
data[0] = new byte[]{COMMIT};
data[1] = intToBytes(xid.getFormatId());
data[2] = xid.getGlobalTransactionId();
data[3] = xid.getBranchQualifier();
try {
logger.putDone(data, (XACommittingTx) logMark);
// logger.putDone(null, (XACommittingTx) logMark);
} catch (LogClosedException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (LogRecordSizeException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (LogFileOverflowException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (InterruptedException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (IOException e) {
throw new LogException(e);
}
}
public void rollback(Xid xid, Object logMark) throws LogException {
//the data is theoretically unnecessary but is included to help with debugging and because HOWL currently requires it.
byte[][] data = new byte[4][];
data[0] = new byte[]{ROLLBACK};
data[1] = intToBytes(xid.getFormatId());
data[2] = xid.getGlobalTransactionId();
data[3] = xid.getBranchQualifier();
try {
logger.putDone(data, (XACommittingTx) logMark);
// logger.putDone(null, (XACommittingTx) logMark);
} catch (LogClosedException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (LogRecordSizeException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (LogFileOverflowException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (InterruptedException e) {
throw (IllegalStateException) new IllegalStateException().initCause(e);
} catch (IOException e) {
throw new LogException(e);
}
}
public Collection recover(XidFactory xidFactory) throws LogException {
log.debug("Initiating transaction manager recovery");
Map recovered = new HashMap();
ReplayListener replayListener = new GeronimoReplayListener(xidFactory, recovered);
logger.replayActiveTx(replayListener);
log.debug("In doubt transactions recovered from log");
return recovered.values();
}
public String getXMLStats() {
return logger.getStats();
}
public int getAverageForceTime() {
return 0;//logger.getAverageForceTime();
}
public int getAverageBytesPerForce() {
return 0;//logger.getAverageBytesPerForce();
}
private byte[] intToBytes(int formatId) {
byte[] buffer = new byte[4];
buffer[0] = (byte) (formatId >> 24);
buffer[1] = (byte) (formatId >> 16);
buffer[2] = (byte) (formatId >> 8);
buffer[3] = (byte) (formatId >> 0);
return buffer;
}
private int bytesToInt(byte[] buffer) {
return ((int) buffer[0]) << 24 + ((int) buffer[1]) << 16 + ((int) buffer[2]) << 8 + ((int) buffer[3]) << 0;
}
private class GeronimoReplayListener implements ReplayListener {
private final XidFactory xidFactory;
private final Map recoveredTx;
public GeronimoReplayListener(XidFactory xidFactory, Map recoveredTx) {
this.xidFactory = xidFactory;
this.recoveredTx = recoveredTx;
}
public void onRecord(LogRecord plainlr) {
XALogRecord lr = (XALogRecord) plainlr;
short recordType = lr.type;
XACommittingTx tx = lr.getTx();
if (recordType == LogRecordType.XACOMMIT) {
byte[][] data = tx.getRecord();
assert data[0].length == 4;
int formatId = bytesToInt(data[1]);
byte[] globalId = data[1];
byte[] branchId = data[2];
Xid masterXid = xidFactory.recover(formatId, globalId, branchId);
Recovery.XidBranchesPair xidBranchesPair = new Recovery.XidBranchesPair(masterXid, tx);
recoveredTx.put(masterXid, xidBranchesPair);
log.debug("recovered prepare record for master xid: " + masterXid);
for (int i = 3; i < data.length; i += 2) {
byte[] branchBranchId = data[i];
String name = new String(data[i + 1]);
Xid branchXid = xidFactory.recover(formatId, globalId, branchBranchId);
TransactionBranchInfoImpl branchInfo = new TransactionBranchInfoImpl(branchXid, name);
xidBranchesPair.addBranch(branchInfo);
log.debug("recovered branch for resource manager, branchId " + name + ", " + branchXid);
}
} else {
if(recordType != LogRecordType.END_OF_LOG) { // This value crops up every time the server is started
log.warn("Received unexpected log record: " + lr +" ("+recordType+")");
}
}
}
public void onError(org.objectweb.howl.log.LogException exception) {
log.error("Error during recovery: ", exception);
}
public LogRecord getLogRecord() {
//TODO justify this size estimate
return new LogRecord(10 * 2 * Xid.MAXBQUALSIZE);
}
}
public static final GBeanInfo GBEAN_INFO;
static {
GBeanInfoBuilder infoFactory = GBeanInfoBuilder.createStatic(HOWLLog.class, NameFactory.TRANSACTION_LOG);
infoFactory.addAttribute("bufferClassName", String.class, true);
infoFactory.addAttribute("bufferSizeKBytes", Integer.TYPE, true);
infoFactory.addAttribute("checksumEnabled", Boolean.TYPE, true);
infoFactory.addAttribute("flushSleepTimeMilliseconds", Integer.TYPE, true);
infoFactory.addAttribute("logFileDir", String.class, true);
infoFactory.addAttribute("logFileExt", String.class, true);
infoFactory.addAttribute("logFileName", String.class, true);
infoFactory.addAttribute("maxBlocksPerFile", Integer.TYPE, true);
infoFactory.addAttribute("maxBuffers", Integer.TYPE, true);
infoFactory.addAttribute("maxLogFiles", Integer.TYPE, true);
infoFactory.addAttribute("minBuffers", Integer.TYPE, true);
infoFactory.addAttribute("threadsWaitingForceThreshold", Integer.TYPE, true);
infoFactory.addReference("XidFactory", XidFactory.class, NameFactory.XID_FACTORY);
infoFactory.addReference("ServerInfo", ServerInfo.class, NameFactory.GERONIMO_SERVICE);
infoFactory.addInterface(TransactionLog.class);
infoFactory.setConstructor(new String[]{
"bufferClassName",
"bufferSizeKBytes",
"checksumEnabled",
"flushSleepTimeMilliseconds",
"logFileDir",
"logFileExt",
"logFileName",
"maxBlocksPerFile",
"maxBuffers",
"maxLogFiles",
"minBuffers",
"threadsWaitingForceThreshold",
"XidFactory",
"ServerInfo"});
GBEAN_INFO = infoFactory.getBeanInfo();
}
public static GBeanInfo getGBeanInfo() {
return GBEAN_INFO;
}
}