Package org.jumpmind.symmetric

Interface ISymmetricEngine

All Known Implementing Classes:
AbstractSymmetricEngine, ClientSymmetricEngine, ServerSymmetricEngine
public interface ISymmetricEngine

  • Method Details

    • stop

      void stop()

    • destroy

      void destroy()

    • uninstall

      void uninstall()

    • getSyncUrl

      String getSyncUrl()
      Returns:
      the URL that represents this engine

    • getProperties

      Properties getProperties()
      Get a list of configured properties for Symmetric. Read-only.

    • getEngineName

      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

      String reloadNode(String nodeId, String createBy)
      Queue up an initial load or a reload to a node.
      Parameters:
      createBy - TODO

    • sendSQL

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

    • push

      RemoteNodeStatuses push()
      Will perform a push the same way the PushJob would have.
      Returns:
      RemoteNodeStatuses
      See Also:

    • syncTriggers

      boolean syncTriggers()
      Call this to resync triggers
      See Also:

    • forceTriggerRebuild

      boolean 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:

    • 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:

    • 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(String groupId, String externalId)
      Open up registration for node to attach.
      See Also:

    • reOpenRegistration

      void reOpenRegistration(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(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

      ISecurityService getSecurityService()

    • getStatisticService

      IStatisticService getStatisticService()

    • getTriggerRouterService

      ITriggerRouterService getTriggerRouterService()

    • getGroupletService

      IGroupletService getGroupletService()

    • getStatisticManager

      IStatisticManager getStatisticManager()

    • getDeploymentType

      String getDeploymentType()

    • getDeploymentSubType

      String getDeploymentSubType()

    • getConcurrentConnectionManager

      IConcurrentConnectionManager getConcurrentConnectionManager()

    • getTransformService

      ITransformService getTransformService()

    • getLoadFilterService

      ILoadFilterService getLoadFilterService()

    • getInitialLoadService

      IInitialLoadService getInitialLoadService()

    • getTransportManager

      ITransportManager getTransportManager()

    • getNodeCommunicationService

      INodeCommunicationService getNodeCommunicationService()

    • getSequenceService

      ISequenceService getSequenceService()

    • getTablePrefix

      String getTablePrefix()

    • getLog

      org.slf4j.Logger getLog()

    • getExtensionService

      IExtensionService getExtensionService()

    • getStagingManager

      IStagingManager getStagingManager()

    • getSqlTemplate

      ISqlTemplate getSqlTemplate()

    • getFileSyncService

      IFileSyncService getFileSyncService()

    • getContextService

      IContextService getContextService()

    • getUpdateService

      IUpdateService getUpdateService()

    • getLastRestartTime

      Date getLastRestartTime()

    • getDataSource

      <T> T getDataSource()

    • getDatabasePlatform

      IDatabasePlatform getDatabasePlatform()

    • snapshot

      File snapshot(IProgressListener listener)

    • listSnapshots

      List<File> listSnapshots()

    • getNodeId

      String getNodeId()

    • getLastException

      Throwable getLastException()

    • getLastExceptionMessage

      String getLastExceptionMessage()

    • getEngineDescription

      String getEngineDescription(String mesage)

    • getCacheManager

      ICacheManager getCacheManager()