ISymmetricEngine (symmetric-core 3.12.x-SNAPSHOT API)

All Known Implementing Classes:

AbstractSymmetricEngine
```
public interface ISymmetricEngine
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`clearCaches()`
`void`	`destroy()`
`void`	`forceTriggerRebuild()` Call this to force all triggers to be rebuilt
`IAcknowledgeService`	`getAcknowledgeService()`
`IBandwidthService`	`getBandwidthService()`
`IClusterService`	`getClusterService()`
`IConcurrentConnectionManager`	`getConcurrentConnectionManager()`
`IConfigurationService`	`getConfigurationService()`
`IContextService`	`getContextService()`
`org.jumpmind.db.platform.IDatabasePlatform`	`getDatabasePlatform()`
`IDataExtractorService`	`getDataExtractorService()`
`IDataLoaderService`	`getDataLoaderService()`
`IDataService`	`getDataService()`
`<T> T`	`getDataSource()`
`java.lang.String`	`getDeploymentSubType()`
`java.lang.String`	`getDeploymentType()`
`java.lang.String`	`getEngineDescription(java.lang.String mesage)`
`java.lang.String`	`getEngineName()`
`IExtensionService`	`getExtensionService()`
`IDataExtractorService`	`getFileSyncExtractorService()`
`IFileSyncService`	`getFileSyncService()`
`IGroupletService`	`getGroupletService()`
`IIncomingBatchService`	`getIncomingBatchService()`
`IInitialLoadService`	`getInitialLoadService()`
`IJobManager`	`getJobManager()`
`java.lang.String`	`getLastException()`
`java.util.Date`	`getLastRestartTime()`
`ILoadFilterService`	`getLoadFilterService()`
`org.slf4j.Logger`	`getLog()`
`IMailService`	`getMailService()`
`IMonitorService`	`getMonitorService()`
`INodeCommunicationService`	`getNodeCommunicationService()`
`java.lang.String`	`getNodeId()`
`INodeService`	`getNodeService()`
`NodeStatus`	`getNodeStatus()` Get the current status of this node.
`IOfflinePullService`	`getOfflinePullService()`
`IOfflinePushService`	`getOfflinePushService()`
`IOutgoingBatchService`	`getOutgoingBatchService()`
`IParameterService`	`getParameterService()`
`java.util.Properties`	`getProperties()` Get a list of configured properties for Symmetric.
`IPullService`	`getPullService()`
`IPurgeService`	`getPurgeService()`
`IPushService`	`getPushService()`
`IRegistrationService`	`getRegistrationService()`
`IRouterService`	`getRouterService()`
`org.jumpmind.security.ISecurityService`	`getSecurityService()`
`ISequenceService`	`getSequenceService()`
`org.jumpmind.db.sql.ISqlTemplate`	`getSqlTemplate()`
`org.jumpmind.symmetric.io.stage.IStagingManager`	`getStagingManager()`
`IStatisticManager`	`getStatisticManager()`
`IStatisticService`	`getStatisticService()`
`ISymmetricDialect`	`getSymmetricDialect()`
`java.lang.String`	`getSyncUrl()`
`java.lang.String`	`getTablePrefix()`
`ISymmetricDialect`	`getTargetDialect()`
`ITransformService`	`getTransformService()`
`ITransportManager`	`getTransportManager()`
`ITriggerRouterService`	`getTriggerRouterService()`
`IUpdateService`	`getUpdateService()`
`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.
`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.
`java.util.List<java.io.File>`	`listSnapshots()`
`void`	`openRegistration(java.lang.String groupId, java.lang.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.
`java.lang.String`	`reloadNode(java.lang.String nodeId, java.lang.String createBy)` Queue up an initial load or a reload to a node.
`void`	`removeAndCleanupNode(java.lang.String nodeId)`
`void`	`reOpenRegistration(java.lang.String nodeId)`
`void`	`route()` Route captured data the same way the `RouterJob` would have.
`java.lang.String`	`sendSQL(java.lang.String nodeId, java.lang.String catalogName, java.lang.String schemaName, java.lang.String tableName, java.lang.String sql)`
`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.
`java.io.File`	`snapshot()`
`boolean`	`start()` Must be called to start SymmetricDS.
`boolean`	`start(boolean startJobs)`
`void`	`stop()`
`void`	`syncTriggers()` Call this to resync triggers
`void`	`uninstall()`

- Method Detail
  - stop
```
void stop()
```
  - destroy
```
void destroy()
```
  - uninstall
```
void uninstall()
```
  - getSyncUrl
```
java.lang.String getSyncUrl()
```
    Returns:
    
    the URL that represents this engine
  - getProperties
```
java.util.Properties getProperties()
```
    Get a list of configured properties for Symmetric. Read-only.
  - getEngineName
```
java.lang.String getEngineName()
```
    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
```
void setup()
```
    Will setup the SymmetricDS tables, if not already setup and if the engine is configured to do so.
  - start
```
boolean start()
```
    Must be called to start SymmetricDS.
    
    Returns:
    
    true if successfully started
  - start
```
boolean start(boolean startJobs)
```
  - reloadNode
```
java.lang.String reloadNode(java.lang.String nodeId,
                            java.lang.String createBy)
```
    Queue up an initial load or a reload to a node.
    
    Parameters:
    
    createBy - TODO
  - sendSQL
```
java.lang.String sendSQL(java.lang.String nodeId,
                         java.lang.String catalogName,
                         java.lang.String schemaName,
                         java.lang.String tableName,
                         java.lang.String sql)
```
  - push
```
RemoteNodeStatuses push()
```
    Will perform a push the same way the PushJob would have.
    
    Returns:
    
    RemoteNodeStatuses
    
    See Also:
    
    IPushService.pushData(boolean)
  - syncTriggers
```
void syncTriggers()
```
    Call this to resync triggers
    
    See Also:
    
    ITriggerRouterService.syncTriggers()
  - forceTriggerRebuild
```
void forceTriggerRebuild()
```
    Call this to force all triggers to be rebuilt
    
    See Also:
    
    ITriggerRouterService#forceTriggerRebuild()
  - getNodeStatus
```
NodeStatus getNodeStatus()
```
    Get the current status of this node.
    
    Returns:
    
    NodeStatus
  - pull
```
RemoteNodeStatuses pull()
```
    Will perform a pull the same way the PullJob would have.
    
    Returns:
    
    RemoteNodeStatuses
    
    See Also:
    
    IPullService.pullData(boolean)
  - route
```
void route()
```
    Route captured data the same way the RouterJob would have.
  - purge
```
void purge()
```
    This can be called to do a purge. It may be called only if the OutgoingPurgeJob has not been enabled.
    
    See Also:
    
    IPurgeService.purgeOutgoing(boolean)
  - isConfigured
```
boolean isConfigured()
```
    Will check to see if this instance of SymmetricDS is configured with the required properties for a node to operate.
  - heartbeat
```
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.
    
    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
```
void openRegistration(java.lang.String groupId,
                      java.lang.String externalId)
```
    Open up registration for node to attach.
    
    See Also:
    
    IRegistrationService.openRegistration(String, String)
  - reOpenRegistration
```
void reOpenRegistration(java.lang.String nodeId)
```
  - isRegistered
```
boolean isRegistered()
```
    Check to see if this node has been registered.
    
    Returns:
    
    true if the node is registered
  - isStarted
```
boolean isStarted()
```
    Check to see if this node has been started.
    
    Returns:
    
    true if the node is started
  - isInitialized
```
boolean isInitialized()
```
  - isStarting
```
boolean isStarting()
```
    Check to see if this node is starting.
    
    Returns:
    
    true if the node is starting
  - clearCaches
```
void clearCaches()
```
  - setupDatabase
```
void setupDatabase(boolean force)
```
    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.
    
    Parameters:
    
    force - forces this action to be run regardless of the parameter settings
  - removeAndCleanupNode
```
void removeAndCleanupNode(java.lang.String nodeId)
```
  - getConfigurationService
```
IConfigurationService getConfigurationService()
```
  - getParameterService
```
IParameterService getParameterService()
```
  - getNodeService
```
INodeService getNodeService()
```
  - getRegistrationService
```
IRegistrationService getRegistrationService()
```
  - getClusterService
```
IClusterService getClusterService()
```
  - getPurgeService
```
IPurgeService getPurgeService()
```
  - getDataService
```
IDataService getDataService()
```
  - getSymmetricDialect
```
ISymmetricDialect getSymmetricDialect()
```
  - getTargetDialect
```
ISymmetricDialect getTargetDialect()
```
  - getJobManager
```
IJobManager getJobManager()
```
  - getOutgoingBatchService
```
IOutgoingBatchService getOutgoingBatchService()
```
  - getAcknowledgeService
```
IAcknowledgeService getAcknowledgeService()
```
  - getBandwidthService
```
IBandwidthService getBandwidthService()
```
  - getDataExtractorService
```
IDataExtractorService getDataExtractorService()
```
  - getFileSyncExtractorService
```
IDataExtractorService getFileSyncExtractorService()
```
  - getDataLoaderService
```
IDataLoaderService getDataLoaderService()
```
  - getIncomingBatchService
```
IIncomingBatchService getIncomingBatchService()
```
  - getPullService
```
IPullService getPullService()
```
  - getPushService
```
IPushService getPushService()
```
  - getOfflinePullService
```
IOfflinePullService getOfflinePullService()
```
  - getOfflinePushService
```
IOfflinePushService getOfflinePushService()
```
  - getRouterService
```
IRouterService getRouterService()
```
  - getSecurityService
```
org.jumpmind.security.ISecurityService getSecurityService()
```
  - getStatisticService
```
IStatisticService getStatisticService()
```
  - getTriggerRouterService
```
ITriggerRouterService getTriggerRouterService()
```
  - getGroupletService
```
IGroupletService getGroupletService()
```
  - getStatisticManager
```
IStatisticManager getStatisticManager()
```
  - getDeploymentType
```
java.lang.String getDeploymentType()
```
  - getDeploymentSubType
```
java.lang.String getDeploymentSubType()
```
  - getConcurrentConnectionManager
```
IConcurrentConnectionManager getConcurrentConnectionManager()
```
  - getTransformService
```
ITransformService getTransformService()
```
  - getLoadFilterService
```
ILoadFilterService getLoadFilterService()
```
  - getInitialLoadService
```
IInitialLoadService getInitialLoadService()
```
  - getTransportManager
```
ITransportManager getTransportManager()
```
  - getNodeCommunicationService
```
INodeCommunicationService getNodeCommunicationService()
```
  - getSequenceService
```
ISequenceService getSequenceService()
```
  - getTablePrefix
```
java.lang.String getTablePrefix()
```
  - getLog
```
org.slf4j.Logger getLog()
```
  - getExtensionService
```
IExtensionService getExtensionService()
```
  - getMonitorService
```
IMonitorService getMonitorService()
```
  - getMailService
```
IMailService getMailService()
```
  - getStagingManager
```
org.jumpmind.symmetric.io.stage.IStagingManager getStagingManager()
```
  - getSqlTemplate
```
org.jumpmind.db.sql.ISqlTemplate getSqlTemplate()
```
  - getFileSyncService
```
IFileSyncService getFileSyncService()
```
  - getContextService
```
IContextService getContextService()
```
  - getUpdateService
```
IUpdateService getUpdateService()
```
  - getLastRestartTime
```
java.util.Date getLastRestartTime()
```
  - getDataSource
```
<T> T getDataSource()
```
  - getDatabasePlatform
```
org.jumpmind.db.platform.IDatabasePlatform getDatabasePlatform()
```
  - snapshot
```
java.io.File snapshot()
```
  - listSnapshots
```
java.util.List<java.io.File> listSnapshots()
```
  - getNodeId
```
java.lang.String getNodeId()
```
  - getLastException
```
java.lang.String getLastException()
```
  - getEngineDescription
```
java.lang.String getEngineDescription(java.lang.String mesage)
```

Interface ISymmetricEngine

Method Summary

Method Detail

stop

destroy

uninstall

getSyncUrl

getProperties

getEngineName

setup

start

start

reloadNode

sendSQL

push

syncTriggers

forceTriggerRebuild

getNodeStatus

pull

route

purge

isConfigured

heartbeat

openRegistration

reOpenRegistration

isRegistered

isStarted

isInitialized

isStarting

clearCaches

setupDatabase

removeAndCleanupNode

getConfigurationService

getParameterService

getNodeService

getRegistrationService

getClusterService

getPurgeService

getDataService

getSymmetricDialect

getTargetDialect

getJobManager

getOutgoingBatchService

getAcknowledgeService

getBandwidthService

getDataExtractorService

getFileSyncExtractorService

getDataLoaderService

getIncomingBatchService

getPullService

getPushService

getOfflinePullService

getOfflinePushService

getRouterService

getSecurityService

getStatisticService

getTriggerRouterService

getGroupletService

getStatisticManager

getDeploymentType

getDeploymentSubType

getConcurrentConnectionManager

getTransformService

getLoadFilterService

getInitialLoadService

getTransportManager

getNodeCommunicationService

getSequenceService

getTablePrefix

getLog

getExtensionService

getMonitorService

getMailService

getStagingManager

getSqlTemplate

getFileSyncService

getContextService

getUpdateService

getLastRestartTime

getDataSource