Package org.jumpmind.symmetric

Class ClientSymmetricEngine

java.lang.Object

org.jumpmind.symmetric.AbstractSymmetricEngine

org.jumpmind.symmetric.ClientSymmetricEngine

All Implemented Interfaces:

ISymmetricEngine

Direct Known Subclasses:

ServerSymmetricEngine

public class ClientSymmetricEngine
extends AbstractSymmetricEngine

Represents the client portion of a SymmetricDS engine. This class can be used to embed SymmetricDS into another application.

Field Summary

Fields

Modifier and Type	Field	Description
protected DataSource	dataSource
static final String	DEPLOYMENT_TYPE_CLIENT
protected Properties	properties
protected File	propertiesFile
protected org.springframework.context.ApplicationContext	springContext

Fields inherited from class org.jumpmind.symmetric.AbstractSymmetricEngine

acknowledgeService, bandwidthService, cacheManager, clusterService, concurrentConnectionManager, configurationService, contextService, dataExtractorService, dataLoaderService, dataService, deploymentSubType, deploymentType, extensionService, fileSyncExtractorService, fileSyncService, groupletService, incomingBatchService, initialLoadService, jobManager, lastRestartTime, loadFilterService, nodeCommunicationService, nodeService, offlinePullService, offlinePushService, offlineTransportManager, outgoingBatchService, parameterService, platform, propertiesFactory, pullService, purgeService, pushService, registerEngine, registrationService, routerService, securityService, sequenceService, stagingManager, statisticManager, statisticService, symmetricDialect, transformService, transportManager, triggerRouterService, updateService

Constructor Summary

Constructors

Constructor	Description
ClientSymmetricEngine()
ClientSymmetricEngine(boolean registerEngine)
ClientSymmetricEngine(File propertiesFile)
ClientSymmetricEngine(File propertiesFile, boolean registerEngine)
ClientSymmetricEngine(File propertiesFile, org.springframework.context.ApplicationContext springContext)
ClientSymmetricEngine(Properties properties)
ClientSymmetricEngine(Properties properties, boolean registerEngine)
ClientSymmetricEngine(DataSource dataSource, Properties properties, boolean registerEngine)
ClientSymmetricEngine(DataSource dataSource, org.springframework.context.ApplicationContext springContext, Properties properties, boolean registerEngine)

Method Summary

Modifier and Type	Method	Description
void	clearCaches()
static org.apache.commons.dbcp2.BasicDataSource	createBasicDataSource(File propsFile)
protected IDatabasePlatform	createDatabasePlatform(TypedProperties properties)
static IDatabasePlatform	createDatabasePlatform(org.springframework.context.ApplicationContext springContext, TypedProperties properties, DataSource dataSource, boolean waitOnAvailableDatabase)
static IDatabasePlatform	createDatabasePlatform(org.springframework.context.ApplicationContext springContext, TypedProperties properties, DataSource dataSource, boolean waitOnAvailableDatabase, boolean isLoadOnly, boolean isLogBased)
protected IExtensionService	createExtensionService()
protected IJobManager	createJobManager()
protected static SqlTemplateSettings	createSqlTemplateSettings(TypedProperties properties)
protected IStagingManager	createStagingManager()
protected IStatisticManager	createStatisticManager()
protected ISymmetricDialect	createSymmetricDialect()
protected ISymmetricDialect	createTargetDialect()
protected ITypedPropertiesFactory	createTypedPropertiesFactory()
void	destroy()
protected SecurityServiceFactory.SecurityServiceType	getSecurityServiceType()
org.springframework.context.ApplicationContext	getSpringContext()
protected void	init()
List<File>	listSnapshots()
protected final void	setDeploymentSubTypeByProperties(Properties properties)
File	snapshot(IProgressListener listener)
boolean	start()	Must be called to start SymmetricDS.
void	stop()
protected static void	waitForAvailableDatabase(DataSource dataSource)

Methods inherited from class org.jumpmind.symmetric.AbstractSymmetricEngine

autoConfigRegistrationServer, buildFileSyncService, buildNodeCommunicationService, buildRouterService, buildTablesFromDdlUtilXmlIfProvided, checkSystemIntegrity, createClusterService, findEngineByName, findEngineByNodeId, findEngineByUrl, findEngines, forceTriggerRebuild, getAcknowledgeService, getBandwidthService, getCacheManager, getClusterService, getConcurrentConnectionManager, getConfigurationService, getContextService, getDatabasePlatform, getDataExtractorService, getDataLoaderService, getDataService, getDataSource, getDeploymentSubType, getDeploymentType, getEngineDescription, getEngineName, getExtensionService, getFileSyncExtractorService, getFileSyncService, getGroupletService, getIncomingBatchService, getInitialLoadService, getJobManager, getLastException, getLastExceptionMessage, getLastRestartTime, getLoadFilterService, getLog, getNodeCommunicationService, getNodeId, getNodeService, getNodeStatus, getOfflinePullService, getOfflinePushService, getOfflineTransportManager, getOutgoingBatchService, getParameterService, getProperties, getPullService, getPurgeService, getPushService, getRegistrationService, getRouterService, getSecurityService, getSequenceService, getSqlTemplate, getStagingManager, getStatisticManager, getStatisticService, getSymmetricDialect, getSyncUrl, getTablePrefix, getTargetDialect, getTransformService, getTransportManager, getTriggerRouterService, getUpdateService, hasSoftwareVersionChanged, heartbeat, isConfigured, isInitialized, isRegistered, isStarted, isStarting, loadFromScriptIfProvided, openRegistration, pull, purge, push, registerSymDSDriver, reloadNode, removeAndCleanupNode, reOpenRegistration, route, sendSQL, setDeploymentSubType, setDeploymentType, setup, setupDatabase, start, syncTriggers, toString, uninstall

Methods inherited from class java.lang.Object

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

Field Details

DEPLOYMENT_TYPE_CLIENT

public static final String DEPLOYMENT_TYPE_CLIENT

See Also:

• Constant Field Values

propertiesFile

protected File propertiesFile

properties

protected Properties properties

dataSource

protected DataSource dataSource

springContext

protected org.springframework.context.ApplicationContext springContext

Constructor Details

ClientSymmetricEngine

public ClientSymmetricEngine(DataSource dataSource,
 org.springframework.context.ApplicationContext springContext,
 Properties properties,
 boolean registerEngine)

Parameters:

dataSource - If not null, SymmetricDS will use this provided datasource instead of creating it's own.

springContext - If not null, SymmetricDS will use this provided Spring context instead of creating it's own.

properties - Properties to use for configuration.

registerEngine - Whether to store a reference to this engine in a local static map.

ClientSymmetricEngine

public ClientSymmetricEngine(DataSource dataSource,
 Properties properties,
 boolean registerEngine)

ClientSymmetricEngine

public ClientSymmetricEngine(File propertiesFile,
 boolean registerEngine)

ClientSymmetricEngine

public ClientSymmetricEngine(File propertiesFile)

ClientSymmetricEngine

public ClientSymmetricEngine(File propertiesFile,
 org.springframework.context.ApplicationContext springContext)

ClientSymmetricEngine

public ClientSymmetricEngine(Properties properties,
 boolean registerEngine)

ClientSymmetricEngine

public ClientSymmetricEngine(Properties properties)

ClientSymmetricEngine

public ClientSymmetricEngine()

ClientSymmetricEngine

public ClientSymmetricEngine(boolean registerEngine)

Method Details

setDeploymentSubTypeByProperties

protected final void setDeploymentSubTypeByProperties(Properties properties)

getSecurityServiceType

protected SecurityServiceFactory.SecurityServiceType getSecurityServiceType()

Specified by:

getSecurityServiceType in class AbstractSymmetricEngine

init

protected void init()

Overrides:

init in class AbstractSymmetricEngine

start

public boolean start()

Description copied from interface: ISymmetricEngine

Must be called to start SymmetricDS.

Specified by:

start in interface ISymmetricEngine

Overrides:

start in class AbstractSymmetricEngine

Returns:

true if successfully started

stop

public void stop()

Specified by:

stop in interface ISymmetricEngine

Overrides:

stop in class AbstractSymmetricEngine

createBasicDataSource

public static org.apache.commons.dbcp2.BasicDataSource createBasicDataSource(File propsFile)

createSymmetricDialect

protected ISymmetricDialect createSymmetricDialect()

Specified by:

createSymmetricDialect in class AbstractSymmetricEngine

createTargetDialect

protected ISymmetricDialect createTargetDialect()

Overrides:

createTargetDialect in class AbstractSymmetricEngine

createDatabasePlatform

protected IDatabasePlatform createDatabasePlatform(TypedProperties properties)

Specified by:

createDatabasePlatform in class AbstractSymmetricEngine

createDatabasePlatform

public static IDatabasePlatform createDatabasePlatform(org.springframework.context.ApplicationContext springContext,
 TypedProperties properties,
 DataSource dataSource,
 boolean waitOnAvailableDatabase)

createDatabasePlatform

public static IDatabasePlatform createDatabasePlatform(org.springframework.context.ApplicationContext springContext,
 TypedProperties properties,
 DataSource dataSource,
 boolean waitOnAvailableDatabase,
 boolean isLoadOnly,
 boolean isLogBased)

createSqlTemplateSettings

protected static SqlTemplateSettings createSqlTemplateSettings(TypedProperties properties)

createExtensionService

protected IExtensionService createExtensionService()

Specified by:

createExtensionService in class AbstractSymmetricEngine

createJobManager

protected IJobManager createJobManager()

Specified by:

createJobManager in class AbstractSymmetricEngine

createStagingManager

protected IStagingManager createStagingManager()

Specified by:

createStagingManager in class AbstractSymmetricEngine

createStatisticManager

protected IStatisticManager createStatisticManager()

Specified by:

createStatisticManager in class AbstractSymmetricEngine

waitForAvailableDatabase

protected static void waitForAvailableDatabase(DataSource dataSource)

createTypedPropertiesFactory

protected ITypedPropertiesFactory createTypedPropertiesFactory()

Specified by:

createTypedPropertiesFactory in class AbstractSymmetricEngine

destroy

public void destroy()

Specified by:

destroy in interface ISymmetricEngine

Overrides:

destroy in class AbstractSymmetricEngine

listSnapshots

public List<File> listSnapshots()

getSpringContext

public org.springframework.context.ApplicationContext getSpringContext()

snapshot

public File snapshot(IProgressListener listener)

clearCaches

public void clearCaches()

Specified by:

clearCaches in interface ISymmetricEngine

Overrides:

clearCaches in class AbstractSymmetricEngine