Package org.jumpmind.symmetric

Class AbstractSymmetricEngine

java.lang.Object

org.jumpmind.symmetric.AbstractSymmetricEngine

All Implemented Interfaces:

ISymmetricEngine

Direct Known Subclasses:

ClientSymmetricEngine

public abstract class AbstractSymmetricEngine
extends Object
implements ISymmetricEngine

Field Summary

Fields

Modifier and Type	Field	Description
protected IAcknowledgeService	acknowledgeService
protected IBandwidthService	bandwidthService
protected ICacheManager	cacheManager
protected IClusterService	clusterService
protected IConcurrentConnectionManager	concurrentConnectionManager
protected IConfigurationService	configurationService
protected IContextService	contextService
protected IDataExtractorService	dataExtractorService
protected IDataLoaderService	dataLoaderService
protected IDataService	dataService
protected String	deploymentSubType
protected String	deploymentType
protected IExtensionService	extensionService
protected IDataExtractorService	fileSyncExtractorService
protected IFileSyncService	fileSyncService
protected IGroupletService	groupletService
protected IIncomingBatchService	incomingBatchService
protected IInitialLoadService	initialLoadService
protected IJobManager	jobManager
protected Date	lastRestartTime
protected ILoadFilterService	loadFilterService
protected INodeCommunicationService	nodeCommunicationService
protected INodeService	nodeService
protected IOfflinePullService	offlinePullService
protected IOfflinePushService	offlinePushService
protected ITransportManager	offlineTransportManager
protected IOutgoingBatchService	outgoingBatchService
protected ParameterService	parameterService
protected IDatabasePlatform	platform
protected ITypedPropertiesFactory	propertiesFactory
protected IPullService	pullService
protected IPurgeService	purgeService
protected IPushService	pushService
protected boolean	registerEngine
protected IRegistrationService	registrationService
protected IRouterService	routerService
protected ISecurityService	securityService
protected ISequenceService	sequenceService
protected IStagingManager	stagingManager
protected IStatisticManager	statisticManager
protected IStatisticService	statisticService
protected ISymmetricDialect	symmetricDialect
protected ITransformService	transformService
protected ITransportManager	transportManager
protected ITriggerRouterService	triggerRouterService
protected IUpdateService	updateService

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractSymmetricEngine(boolean registerEngine)

Method Summary

Modifier and Type	Method	Description
protected void	autoConfigRegistrationServer()
protected IFileSyncService	buildFileSyncService()
protected INodeCommunicationService	buildNodeCommunicationService()
protected IRouterService	buildRouterService()
protected boolean	buildTablesFromDdlUtilXmlIfProvided()
protected Node	checkSystemIntegrity(Node node)
void	clearCaches()
protected IClusterService	createClusterService()
protected abstract IDatabasePlatform	createDatabasePlatform(TypedProperties properties)
protected abstract IExtensionService	createExtensionService()
protected abstract IJobManager	createJobManager()
protected abstract IStagingManager	createStagingManager()
protected abstract IStatisticManager	createStatisticManager()
protected abstract ISymmetricDialect	createSymmetricDialect()
protected ISymmetricDialect	createTargetDialect()
protected abstract ITypedPropertiesFactory	createTypedPropertiesFactory()
void	destroy()
static ISymmetricEngine	findEngineByName(String name)	Locate a StandaloneSymmetricEngine in the same JVM
static ISymmetricEngine	findEngineByNodeId(String nodeId)
static ISymmetricEngine	findEngineByUrl(String url)	Locate a StandaloneSymmetricEngine in the same JVM
static List<ISymmetricEngine>	findEngines()
boolean	forceTriggerRebuild()	Call this to force all triggers to be rebuilt
IAcknowledgeService	getAcknowledgeService()
IBandwidthService	getBandwidthService()
ICacheManager	getCacheManager()
IClusterService	getClusterService()
IConcurrentConnectionManager	getConcurrentConnectionManager()
IConfigurationService	getConfigurationService()
IContextService	getContextService()
IDatabasePlatform	getDatabasePlatform()
IDataExtractorService	getDataExtractorService()
IDataLoaderService	getDataLoaderService()
IDataService	getDataService()
<T> T	getDataSource()
String	getDeploymentSubType()
String	getDeploymentType()
String	getEngineDescription(String msg)
String	getEngineName()
IExtensionService	getExtensionService()
IDataExtractorService	getFileSyncExtractorService()
IFileSyncService	getFileSyncService()
IGroupletService	getGroupletService()
IIncomingBatchService	getIncomingBatchService()
IInitialLoadService	getInitialLoadService()
IJobManager	getJobManager()
Throwable	getLastException()
String	getLastExceptionMessage()
Date	getLastRestartTime()
ILoadFilterService	getLoadFilterService()
org.slf4j.Logger	getLog()
INodeCommunicationService	getNodeCommunicationService()
String	getNodeId()
INodeService	getNodeService()
NodeStatus	getNodeStatus()	Get the current status of this node.
IOfflinePullService	getOfflinePullService()
IOfflinePushService	getOfflinePushService()
ITransportManager	getOfflineTransportManager()
IOutgoingBatchService	getOutgoingBatchService()
IParameterService	getParameterService()
Properties	getProperties()	Get a list of configured properties for Symmetric.
IPullService	getPullService()
IPurgeService	getPurgeService()
IPushService	getPushService()
IRegistrationService	getRegistrationService()
IRouterService	getRouterService()
ISecurityService	getSecurityService()
protected abstract SecurityServiceFactory.SecurityServiceType	getSecurityServiceType()
ISequenceService	getSequenceService()
ISqlTemplate	getSqlTemplate()
IStagingManager	getStagingManager()
IStatisticManager	getStatisticManager()
IStatisticService	getStatisticService()
ISymmetricDialect	getSymmetricDialect()
String	getSyncUrl()
String	getTablePrefix()
ISymmetricDialect	getTargetDialect()
ITransformService	getTransformService()
ITransportManager	getTransportManager()
ITriggerRouterService	getTriggerRouterService()
IUpdateService	getUpdateService()
protected boolean	hasSoftwareVersionChanged()
void	heartbeat(boolean force)	Push a copy of the node onto the push queue so the SymmetricDS node 'checks' in with it's root node.
protected void	init()
boolean	isConfigured()	Will check to see if this instance of SymmetricDS is configured with the required properties for a node to operate.
boolean	isInitialized()
boolean	isRegistered()	Check to see if this node has been registered.
boolean	isStarted()	Check to see if this node has been started.
boolean	isStarting()	Check to see if this node is starting.
protected boolean	loadFromScriptIfProvided()	Give the end user the option to provide a script that will load a registration server with an initial SymmetricDS setup.
void	openRegistration(String nodeGroupId, String externalId)	Open up registration for node to attach.
RemoteNodeStatuses	pull()	Will perform a pull the same way the PullJob would have.
void	purge()	This can be called to do a purge.
RemoteNodeStatuses	push()	Will perform a push the same way the PushJob would have.
protected void	registerSymDSDriver(TypedProperties engineProperties)
String	reloadNode(String nodeId, String createBy)	Queue up an initial load or a reload to a node.
void	removeAndCleanupNode(String nodeId)
void	reOpenRegistration(String nodeId)
void	route()	Route captured data the same way the RouterJob would have.
String	sendSQL(String nodeId, String catalogName, String schemaName, String tableName, String sql)
void	setDeploymentSubType(String deploymentSubType)
void	setDeploymentType(String deploymentType)
void	setup()	Will setup the SymmetricDS tables, if not already setup and if the engine is configured to do so.
void	setupDatabase(boolean force)	Attempt to configure the database objects that support SymmetricDS.
boolean	start()	Must be called to start SymmetricDS.
boolean	start(boolean startJobs)
void	stop()
boolean	syncTriggers()	Call this to resync triggers
String	toString()
void	uninstall()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jumpmind.symmetric.ISymmetricEngine

listSnapshots, snapshot

Field Details

deploymentType

protected String deploymentType

deploymentSubType

protected String deploymentSubType

propertiesFactory

protected ITypedPropertiesFactory propertiesFactory

platform

protected IDatabasePlatform platform

securityService

protected ISecurityService securityService

parameterService

protected ParameterService parameterService

symmetricDialect

protected ISymmetricDialect symmetricDialect

nodeService

protected INodeService nodeService

configurationService

protected IConfigurationService configurationService

bandwidthService

protected IBandwidthService bandwidthService

statisticService

protected IStatisticService statisticService

statisticManager

protected IStatisticManager statisticManager

concurrentConnectionManager

protected IConcurrentConnectionManager concurrentConnectionManager

transportManager

protected ITransportManager transportManager

offlineTransportManager

protected ITransportManager offlineTransportManager

clusterService

protected IClusterService clusterService

purgeService

protected IPurgeService purgeService

transformService

protected ITransformService transformService

initialLoadService

protected IInitialLoadService initialLoadService

loadFilterService

protected ILoadFilterService loadFilterService

triggerRouterService

protected ITriggerRouterService triggerRouterService

outgoingBatchService

protected IOutgoingBatchService outgoingBatchService

dataService

protected IDataService dataService

routerService

protected IRouterService routerService

dataExtractorService

protected IDataExtractorService dataExtractorService

fileSyncExtractorService

protected IDataExtractorService fileSyncExtractorService

registrationService

protected IRegistrationService registrationService

dataLoaderService

protected IDataLoaderService dataLoaderService

incomingBatchService

protected IIncomingBatchService incomingBatchService

acknowledgeService

protected IAcknowledgeService acknowledgeService

pushService

protected IPushService pushService

pullService

protected IPullService pullService

offlinePushService

protected IOfflinePushService offlinePushService

offlinePullService

protected IOfflinePullService offlinePullService

jobManager

protected IJobManager jobManager

sequenceService

protected ISequenceService sequenceService

extensionService

protected IExtensionService extensionService

groupletService

protected IGroupletService groupletService

stagingManager

protected IStagingManager stagingManager

nodeCommunicationService

protected INodeCommunicationService nodeCommunicationService

fileSyncService

protected IFileSyncService fileSyncService

contextService

protected IContextService contextService

updateService

protected IUpdateService updateService

cacheManager

protected ICacheManager cacheManager

lastRestartTime

protected Date lastRestartTime

registerEngine

protected boolean registerEngine

Constructor Details

AbstractSymmetricEngine

protected AbstractSymmetricEngine(boolean registerEngine)

Method Details

createTypedPropertiesFactory

protected abstract ITypedPropertiesFactory createTypedPropertiesFactory()

createDatabasePlatform

protected abstract IDatabasePlatform createDatabasePlatform(TypedProperties properties)

findEngines

public static List<ISymmetricEngine> findEngines()

findEngineByUrl

public static ISymmetricEngine findEngineByUrl(String url)

Locate a StandaloneSymmetricEngine in the same JVM

findEngineByName

public static ISymmetricEngine findEngineByName(String name)

Locate a StandaloneSymmetricEngine in the same JVM

findEngineByNodeId

public static ISymmetricEngine findEngineByNodeId(String nodeId)

setDeploymentType

public void setDeploymentType(String deploymentType)

setDeploymentSubType

public void setDeploymentSubType(String deploymentSubType)

getSecurityServiceType

protected abstract SecurityServiceFactory.SecurityServiceType getSecurityServiceType()

init

protected void init()

registerSymDSDriver

protected void registerSymDSDriver(TypedProperties engineProperties)

createClusterService

protected IClusterService createClusterService()

buildRouterService

protected IRouterService buildRouterService()

buildFileSyncService

protected IFileSyncService buildFileSyncService()

buildNodeCommunicationService

protected INodeCommunicationService buildNodeCommunicationService()

createStagingManager

protected abstract IStagingManager createStagingManager()

createStatisticManager

protected abstract IStatisticManager createStatisticManager()

createSymmetricDialect

protected abstract ISymmetricDialect createSymmetricDialect()

createTargetDialect

protected ISymmetricDialect createTargetDialect()

createExtensionService

protected abstract IExtensionService createExtensionService()

createJobManager

protected abstract IJobManager createJobManager()

getSyncUrl

public String getSyncUrl()

Specified by:

getSyncUrl in interface ISymmetricEngine

Returns:

the URL that represents this engine

getProperties

public Properties getProperties()

Description copied from interface: ISymmetricEngine

Get a list of configured properties for Symmetric. Read-only.

Specified by:

getProperties in interface ISymmetricEngine

getEngineName

public String getEngineName()

Specified by:

getEngineName in interface ISymmetricEngine

Returns:

The lower case representation of the engine name as setup in the symmetric.properties file. We always use a lower case representation because there are times the engine name is used in triggers at which point you can lose the original case representation.

setup

public void setup()

Description copied from interface: ISymmetricEngine

Will setup the SymmetricDS tables, if not already setup and if the engine is configured to do so.

Specified by:

setup in interface ISymmetricEngine

setupDatabase

public void setupDatabase(boolean force)

Description copied from interface: ISymmetricEngine

Attempt to configure the database objects that support SymmetricDS. If they are out of date this method will attempt to alter the tables to bring them up to date.

Specified by:

setupDatabase in interface ISymmetricEngine

Parameters:

force - forces this action to be run regardless of the parameter settings

hasSoftwareVersionChanged

protected boolean hasSoftwareVersionChanged()

autoConfigRegistrationServer

protected void autoConfigRegistrationServer()

buildTablesFromDdlUtilXmlIfProvided

protected boolean buildTablesFromDdlUtilXmlIfProvided()

loadFromScriptIfProvided

protected boolean loadFromScriptIfProvided()

Give the end user the option to provide a script that will load a registration server with an initial SymmetricDS setup. Look first on the file system, then in the classpath for the SQL file.

Returns:

true if the script was executed

start

public boolean start()

Description copied from interface: ISymmetricEngine

Must be called to start SymmetricDS.

Specified by:

start in interface ISymmetricEngine

Returns:

true if successfully started

start

public boolean start(boolean startJobs)

Specified by:

start in interface ISymmetricEngine

checkSystemIntegrity

protected Node checkSystemIntegrity(Node node)

getEngineDescription

public String getEngineDescription(String msg)

Specified by:

getEngineDescription in interface ISymmetricEngine

uninstall

public void uninstall()

Specified by:

uninstall in interface ISymmetricEngine

stop

public void stop()

Specified by:

stop in interface ISymmetricEngine

destroy

public void destroy()

Specified by:

destroy in interface ISymmetricEngine

reloadNode

public String reloadNode(String nodeId,
 String createBy)

Description copied from interface: ISymmetricEngine

Queue up an initial load or a reload to a node.

Specified by:

reloadNode in interface ISymmetricEngine

createBy - TODO

sendSQL

public String sendSQL(String nodeId,
 String catalogName,
 String schemaName,
 String tableName,
 String sql)

Specified by:

sendSQL in interface ISymmetricEngine

push

public RemoteNodeStatuses push()

Description copied from interface: ISymmetricEngine

Will perform a push the same way the PushJob would have.

Specified by:

push in interface ISymmetricEngine

Returns:

RemoteNodeStatuses

See Also:

• IPushService.pushData(boolean)

syncTriggers

public boolean syncTriggers()

Description copied from interface: ISymmetricEngine

Call this to resync triggers

Specified by:

syncTriggers in interface ISymmetricEngine

See Also:

• ITriggerRouterService.syncTriggers()

forceTriggerRebuild

public boolean forceTriggerRebuild()

Description copied from interface: ISymmetricEngine

Call this to force all triggers to be rebuilt

Specified by:

forceTriggerRebuild in interface ISymmetricEngine

See Also:

• ITriggerRouterService#forceTriggerRebuild()

getNodeStatus

public NodeStatus getNodeStatus()

Description copied from interface: ISymmetricEngine

Get the current status of this node.

Specified by:

getNodeStatus in interface ISymmetricEngine

Returns:

NodeStatus

removeAndCleanupNode

public void removeAndCleanupNode(String nodeId)

Specified by:

removeAndCleanupNode in interface ISymmetricEngine

pull

public RemoteNodeStatuses pull()

Description copied from interface: ISymmetricEngine

Will perform a pull the same way the PullJob would have.

Specified by:

pull in interface ISymmetricEngine

Returns:

RemoteNodeStatuses

See Also:

• IPullService.pullData(boolean)

route

public void route()

Description copied from interface: ISymmetricEngine

Route captured data the same way the RouterJob would have.

Specified by:

route in interface ISymmetricEngine

purge

public void purge()

Description copied from interface: ISymmetricEngine

This can be called to do a purge. It may be called only if the OutgoingPurgeJob has not been enabled.

Specified by:

purge in interface ISymmetricEngine

See Also:

• IPurgeService.purgeOutgoing(boolean)

isConfigured

public boolean isConfigured()

Description copied from interface: ISymmetricEngine

Will check to see if this instance of SymmetricDS is configured with the required properties for a node to operate.

Specified by:

isConfigured in interface ISymmetricEngine

heartbeat

public void heartbeat(boolean force)

Description copied from interface: ISymmetricEngine

Push a copy of the node onto the push queue so the SymmetricDS node 'checks' in with it's root node.

Specified by:

heartbeat in interface ISymmetricEngine

Parameters:

force - When force is true the heart beat will always be inserted. If it is false, the heart beat will only be inserted if the period between heart beats has expired.

openRegistration

public void openRegistration(String nodeGroupId,
 String externalId)

Description copied from interface: ISymmetricEngine

Open up registration for node to attach.

Specified by:

openRegistration in interface ISymmetricEngine

See Also:

• IRegistrationService.openRegistration(String, String)

clearCaches

public void clearCaches()

Specified by:

clearCaches in interface ISymmetricEngine

reOpenRegistration

public void reOpenRegistration(String nodeId)

Specified by:

reOpenRegistration in interface ISymmetricEngine

isRegistered

public boolean isRegistered()

Description copied from interface: ISymmetricEngine

Check to see if this node has been registered.

Specified by:

isRegistered in interface ISymmetricEngine

Returns:

true if the node is registered

isStarted

public boolean isStarted()

Description copied from interface: ISymmetricEngine

Check to see if this node has been started.

Specified by:

isStarted in interface ISymmetricEngine

Returns:

true if the node is started

isStarting

public boolean isStarting()

Description copied from interface: ISymmetricEngine

Check to see if this node is starting.

Specified by:

isStarting in interface ISymmetricEngine

Returns:

true if the node is starting

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface ISymmetricEngine

getConfigurationService

public IConfigurationService getConfigurationService()

Specified by:

getConfigurationService in interface ISymmetricEngine

getParameterService

public IParameterService getParameterService()

Specified by:

getParameterService in interface ISymmetricEngine

getNodeService

public INodeService getNodeService()

Specified by:

getNodeService in interface ISymmetricEngine

getRegistrationService

public IRegistrationService getRegistrationService()

Specified by:

getRegistrationService in interface ISymmetricEngine

getClusterService

public IClusterService getClusterService()

Specified by:

getClusterService in interface ISymmetricEngine

getPurgeService

public IPurgeService getPurgeService()

Specified by:

getPurgeService in interface ISymmetricEngine

getDataService

public IDataService getDataService()

Specified by:

getDataService in interface ISymmetricEngine

getJobManager

public IJobManager getJobManager()

Specified by:

getJobManager in interface ISymmetricEngine

getOutgoingBatchService

public IOutgoingBatchService getOutgoingBatchService()

Specified by:

getOutgoingBatchService in interface ISymmetricEngine

getAcknowledgeService

public IAcknowledgeService getAcknowledgeService()

Specified by:

getAcknowledgeService in interface ISymmetricEngine

getBandwidthService

public IBandwidthService getBandwidthService()

Specified by:

getBandwidthService in interface ISymmetricEngine

getDataExtractorService

public IDataExtractorService getDataExtractorService()

Specified by:

getDataExtractorService in interface ISymmetricEngine

getFileSyncExtractorService

public IDataExtractorService getFileSyncExtractorService()

Specified by:

getFileSyncExtractorService in interface ISymmetricEngine

getDataLoaderService

public IDataLoaderService getDataLoaderService()

Specified by:

getDataLoaderService in interface ISymmetricEngine

getIncomingBatchService

public IIncomingBatchService getIncomingBatchService()

Specified by:

getIncomingBatchService in interface ISymmetricEngine

getPullService

public IPullService getPullService()

Specified by:

getPullService in interface ISymmetricEngine

getPushService

public IPushService getPushService()

Specified by:

getPushService in interface ISymmetricEngine

getOfflinePullService

public IOfflinePullService getOfflinePullService()

Specified by:

getOfflinePullService in interface ISymmetricEngine

getOfflinePushService

public IOfflinePushService getOfflinePushService()

Specified by:

getOfflinePushService in interface ISymmetricEngine

getRouterService

public IRouterService getRouterService()

Specified by:

getRouterService in interface ISymmetricEngine

getSecurityService

public ISecurityService getSecurityService()

Specified by:

getSecurityService in interface ISymmetricEngine

getStatisticService

public IStatisticService getStatisticService()

Specified by:

getStatisticService in interface ISymmetricEngine

getStatisticManager

public IStatisticManager getStatisticManager()

Specified by:

getStatisticManager in interface ISymmetricEngine

getTriggerRouterService

public ITriggerRouterService getTriggerRouterService()

Specified by:

getTriggerRouterService in interface ISymmetricEngine

getDeploymentType

public String getDeploymentType()

Specified by:

getDeploymentType in interface ISymmetricEngine

getDeploymentSubType

public String getDeploymentSubType()

Specified by:

getDeploymentSubType in interface ISymmetricEngine

getTransformService

public ITransformService getTransformService()

Specified by:

getTransformService in interface ISymmetricEngine

getLoadFilterService

public ILoadFilterService getLoadFilterService()

Specified by:

getLoadFilterService in interface ISymmetricEngine

getInitialLoadService

public IInitialLoadService getInitialLoadService()

Specified by:

getInitialLoadService in interface ISymmetricEngine

getConcurrentConnectionManager

public IConcurrentConnectionManager getConcurrentConnectionManager()

Specified by:

getConcurrentConnectionManager in interface ISymmetricEngine

getTablePrefix

public String getTablePrefix()

Specified by:

getTablePrefix in interface ISymmetricEngine

getTransportManager

public ITransportManager getTransportManager()

Specified by:

getTransportManager in interface ISymmetricEngine

getOfflineTransportManager

public ITransportManager getOfflineTransportManager()

getExtensionService

public IExtensionService getExtensionService()

Specified by:

getExtensionService in interface ISymmetricEngine

getContextService

public IContextService getContextService()

Specified by:

getContextService in interface ISymmetricEngine

getStagingManager

public IStagingManager getStagingManager()

Specified by:

getStagingManager in interface ISymmetricEngine

getSequenceService

public ISequenceService getSequenceService()

Specified by:

getSequenceService in interface ISymmetricEngine

getNodeCommunicationService

public INodeCommunicationService getNodeCommunicationService()

Specified by:

getNodeCommunicationService in interface ISymmetricEngine

getGroupletService

public IGroupletService getGroupletService()

Specified by:

getGroupletService in interface ISymmetricEngine

getLastException

public Throwable getLastException()

Specified by:

getLastException in interface ISymmetricEngine

getLastExceptionMessage

public String getLastExceptionMessage()

Specified by:

getLastExceptionMessage in interface ISymmetricEngine

getLastRestartTime

public Date getLastRestartTime()

Specified by:

getLastRestartTime in interface ISymmetricEngine

getSqlTemplate

public ISqlTemplate getSqlTemplate()

Specified by:

getSqlTemplate in interface ISymmetricEngine

getLog

public org.slf4j.Logger getLog()

Specified by:

getLog in interface ISymmetricEngine

getDataSource

public <T> T getDataSource()

Specified by:

getDataSource in interface ISymmetricEngine

getDatabasePlatform

public IDatabasePlatform getDatabasePlatform()

Specified by:

getDatabasePlatform in interface ISymmetricEngine

getFileSyncService

public IFileSyncService getFileSyncService()

Specified by:

getFileSyncService in interface ISymmetricEngine

getUpdateService

public IUpdateService getUpdateService()

Specified by:

getUpdateService in interface ISymmetricEngine

getNodeId

public String getNodeId()

Specified by:

getNodeId in interface ISymmetricEngine

getSymmetricDialect

public ISymmetricDialect getSymmetricDialect()

Specified by:

getSymmetricDialect in interface ISymmetricEngine

getTargetDialect

public ISymmetricDialect getTargetDialect()

Specified by:

getTargetDialect in interface ISymmetricEngine

toString

public String toString()

Overrides:

toString in class Object

getCacheManager

public ICacheManager getCacheManager()

Specified by:

getCacheManager in interface ISymmetricEngine