com.graphaware.runtime.module.thirdparty

Class WriterBasedThirdPartyIntegrationModule<ID>

java.lang.Object

com.graphaware.runtime.module.BaseRuntimeModule

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

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

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

All Implemented Interfaces:

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

Direct Known Subclasses:

DefaultThirdPartyIntegrationModule

public abstract class WriterBasedThirdPartyIntegrationModule<ID>
extends ThirdPartyIntegrationModule<ID>

A ThirdPartyIntegrationModule that integrates with the third-party system by using a ThirdPartyWriter.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WriterBasedThirdPartyIntegrationModule(String moduleId, ThirdPartyWriter writer) Construct a new module.

Method Summary

Modifier and Type	Method and Description
void	afterCommit(Collection<WriteOperation<?>> state) Perform the core business logic of this module after a transaction commits.
void	shutdown()
void	start(org.neo4j.graphdb.GraphDatabaseService database) Start the module.

Methods inherited from class com.graphaware.runtime.module.thirdparty.ThirdPartyIntegrationModule

beforeCommit, nodeRepresentation, relationshipRepresentation

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

afterRollback, getConfiguration, initialize, reinitialize

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

WriterBasedThirdPartyIntegrationModule

protected WriterBasedThirdPartyIntegrationModule(String moduleId,
                                                 ThirdPartyWriter writer)

Construct a new module.

Parameters:

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

writer - to use for integrating with third-party system. Must not be null.

Method Detail

afterCommit

public void afterCommit(Collection<WriteOperation<?>> state)

Perform the core business logic of this module after a transaction commits.

Specified by:

afterCommit in interface TxDrivenModule<Collection<WriteOperation<?>>>

Overrides:

afterCommit in class BaseTxDrivenModule<Collection<WriteOperation<?>>>

Parameters:

state - returned by TxDrivenModule.beforeCommit(com.graphaware.tx.event.improved.api.ImprovedTransactionData). Will be null if TxDrivenModule.beforeCommit(com.graphaware.tx.event.improved.api.ImprovedTransactionData) threw an exception but the transaction still committed. This is the case for all exceptions except DeliberateTransactionRollbackException.

start

public void start(org.neo4j.graphdb.GraphDatabaseService database)

Start the module. This method must bring the module to a usable state, i.e. after it returns, the module must be able to handle multi-threaded requests. This method is guaranteed to be called exactly once every time the runtime/database starts.

Specified by:

start in interface TxDrivenModule<Collection<WriteOperation<?>>>

Overrides:

start in class BaseTxDrivenModule<Collection<WriteOperation<?>>>

Parameters:

database - to start this module against.

shutdown

public void shutdown()

Note that the implementation in this base class doesn't do anything and can be safely overridden without calling super.

Specified by:

shutdown in interface RuntimeModule

Overrides:

shutdown in class BaseTxDrivenModule<Collection<WriteOperation<?>>>