/*
* Copyright (c) 2013 GraphAware
*
* This file is part of GraphAware.
*
* GraphAware is free software: you can redistribute it and/or modify it under the terms of
* the GNU General Public License as published by the Free Software Foundation, either
* version 3 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of
* the GNU General Public License along with this program. If not, see
* <http://www.gnu.org/licenses/>.
*/
package com.graphaware.runtime;
import com.graphaware.runtime.config.RuntimeConfiguration;
import com.graphaware.runtime.manager.TxDrivenModuleManager;
import com.graphaware.runtime.module.RuntimeModule;
import com.graphaware.runtime.module.TxDrivenModule;
import com.graphaware.tx.event.improved.api.LazyTransactionData;
import org.neo4j.graphdb.NotFoundException;
import org.neo4j.graphdb.event.TransactionData;
import org.neo4j.graphdb.event.TransactionEventHandler;
import java.util.Map;
import java.util.Set;
/**
* {@link BaseGraphAwareRuntime} that registers itself as a Neo4j {@link org.neo4j.graphdb.event.TransactionEventHandler},
* translates {@link org.neo4j.graphdb.event.TransactionData} into {@link com.graphaware.tx.event.improved.api.ImprovedTransactionData}
* and lets registered {@link com.graphaware.runtime.module.TxDrivenModule}s deal with the data before each transaction
* commits, in the order the modules were registered.
*
* @param <T> implementation of {@link com.graphaware.runtime.module.TxDrivenModule} that this runtime supports.
*/
public abstract class TxDrivenRuntime<T extends TxDrivenModule> extends BaseGraphAwareRuntime implements TransactionEventHandler<Map<String, Object>> {
/**
* Create a new instance.
*
* @param configuration config.
*/
protected TxDrivenRuntime(RuntimeConfiguration configuration) {
super(configuration);
}
/**
* Get the manager for {@link TxDrivenModule}s.
*
* @return module manager.
*/
protected abstract TxDrivenModuleManager<T> getTxDrivenModuleManager();
/**
* {@inheritDoc}
*/
@Override
protected void checkNotAlreadyRegistered(RuntimeModule module) {
getTxDrivenModuleManager().checkNotAlreadyRegistered(module);
}
/**
* {@inheritDoc}
*/
@Override
public Map<String, Object> beforeCommit(TransactionData data) throws Exception {
LazyTransactionData transactionData = new LazyTransactionData(data);
if (!isStarted(transactionData)) {
return null;
}
return getTxDrivenModuleManager().beforeCommit(transactionData);
}
/**
* {@inheritDoc}
*/
@Override
public final void afterCommit(TransactionData data, Map<String, Object> states) {
if (states == null) {
return;
}
getTxDrivenModuleManager().afterCommit(states);
}
/**
* {@inheritDoc}
*/
@Override
public final void afterRollback(TransactionData data, Map<String, Object> states) {
if (states == null) {
return;
}
getTxDrivenModuleManager().afterRollback(states);
}
/**
* {@inheritDoc}
*/
@Override
public <M extends RuntimeModule> M getModule(String moduleId, Class<M> clazz) throws NotFoundException {
M module = getTxDrivenModuleManager().getModule(moduleId, clazz);
if (module == null) {
throw new NotFoundException("No module of type " + clazz.getName() + " with ID " + moduleId + " has been registered");
}
return module;
}
/**
* {@inheritDoc}
*/
@Override
protected Set<String> loadMetadata() {
return getTxDrivenModuleManager().loadMetadata();
}
/**
* {@inheritDoc}
*/
@Override
protected void cleanupMetadata(Set<String> usedModules) {
getTxDrivenModuleManager().cleanupMetadata(usedModules);
}
/**
* {@inheritDoc}
*/
@Override
protected void startModules(boolean skipLoadingMetadata) {
super.startModules(skipLoadingMetadata);
getTxDrivenModuleManager().startModules();
}
/**
* {@inheritDoc}
*/
@Override
protected void shutdownModules() {
getTxDrivenModuleManager().shutdownModules();
}
}