com.graphaware.runtime.module.thirdparty

Class ThirdPartyIntegrationModule<ID>

java.lang.Object

com.graphaware.runtime.module.BaseRuntimeModule

com.graphaware.runtime.module.BaseTxDrivenModule<Collection<WriteOperation<?>>>

com.graphaware.runtime.module.thirdparty.ThirdPartyIntegrationModule<ID>

All Implemented Interfaces:

RuntimeModule, TxDrivenModule<Collection<WriteOperation<?>>>

Direct Known Subclasses:

WriterBasedThirdPartyIntegrationModule

public abstract class ThirdPartyIntegrationModule<ID>
extends BaseTxDrivenModule<Collection<WriteOperation<?>>>

Base-class for GraphAware Runtime Modules that wish to implement integrations with third-party systems.

Before committing, a collection of WriteOperations is built, representing all the about-to-be-committed changes in a way that allows it to be sent over the wire (no dependency on Neo4j APIs).

The collection of WriteOperations is passed into the BaseTxDrivenModule.afterCommit(Object) method after the transaction has successfully committed. The BaseTxDrivenModule.afterCommit(Object) should be overridden by sub-classes.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ThirdPartyIntegrationModule(String moduleId) Construct a new module.

Method Summary

Modifier and Type	Method and Description
Collection<WriteOperation<?>>	beforeCommit(ImprovedTransactionData transactionData) Perform the core business logic of this module before a transaction commits.
protected abstract DetachedNode<ID>	nodeRepresentation(org.neo4j.graphdb.Node node)
protected abstract DetachedRelationship<ID,? extends DetachedNode<ID>>	relationshipRepresentation(org.neo4j.graphdb.Relationship relationship)

Methods inherited from class com.graphaware.runtime.module.BaseTxDrivenModule

afterCommit, afterRollback, getConfiguration, initialize, reinitialize, shutdown, start

Methods inherited from class com.graphaware.runtime.module.BaseRuntimeModule

getId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.graphaware.runtime.module.RuntimeModule

getId

Constructor Detail

ThirdPartyIntegrationModule

protected ThirdPartyIntegrationModule(String moduleId)

Construct a new module.

Parameters:

moduleId - ID of this module. Must not be null or empty.

Method Detail

beforeCommit

public Collection<WriteOperation<?>> beforeCommit(ImprovedTransactionData transactionData)
                                           throws DeliberateTransactionRollbackException

Perform the core business logic of this module before a transaction commits. If the framework determines by looking at TxDrivenModule.getConfiguration() that the module isn't interested in this transaction, this method will not be called.

Note that in case this method throws RuntimeException (including NeedsInitializationException), TxDrivenModule.afterCommit(Object) will be called with a null argument.

Note that in case this method throws DeliberateTransactionRollbackException, TxDrivenModule.afterRollback(Object) will be called with a null argument.

Parameters:

transactionData - data about the soon-to-be-committed transaction. It is already filtered based on TxDrivenModule.getConfiguration().

Returns:

a state object (or null) that will be passed on to TxDrivenModule.afterCommit(Object) of this object. Only return null if you do nothing in TxDrivenModule.afterCommit(Object).

Throws:

DeliberateTransactionRollbackException - if the module wants to prevent the transaction from committing.

relationshipRepresentation

protected abstract DetachedRelationship<ID,? extends DetachedNode<ID>> relationshipRepresentation(org.neo4j.graphdb.Relationship relationship)

nodeRepresentation

protected abstract DetachedNode<ID> nodeRepresentation(org.neo4j.graphdb.Node node)