Note: this is an abstract component that cannot be instantiated.
An JDBC Sync Source defines the source of a Sync Pipe that is a relational database accessible via JDBC.
↓Direct Subcomponents
↓Parent Component
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following JDBC Sync Sources are available in the server :
These JDBC Sync Sources inherit from the properties described below.
The JDBC Sync Source component inherits from the Sync Source
The following components have a direct aggregation relation from JDBC Sync Sources:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ java-class | ↓ max-open-connections |
| ↓ description | |
| ↓ server | |
| ↓ database-entry-type | |
| ↓ changelog-maximum-age | |
| ↓ ignore-changes-by-user |
| Description | Specifies the fully-qualified name of the Java class that provides the Sync Source implementation. |
| Default Value | None |
| Allowed Values | The fully-qualified name of a Java class that extends or implements com.unboundid.directory.sync.api.SyncSource |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | A description for this Sync Source |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the name of the JDBC External Server that should be used as the source of synchronization. |
| Default Value | None |
| Allowed Values | The DN of any JDBC External Server. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | This property lists the types of database "entries" that can be synchronized by this JDBC Sync Source. Database entries that do not match one of the types listed here will be dropped by this sync source. A database entry type is used to uniquely identify the set of data in the database that makes up an LDAP entry. It is initially set by the ScriptedJDBCSyncSource interface when a change is detected, either during real-time sync or during a resync operation. It is then used during later phases of the sync operation to determine how to process the change. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the period of time after which changelog entries are deleted automatically from the changelog table in the database. This effectively determines the value for the 'maxAgeMillis' parameter that is passed to the cleanupChangelog() method in the ScriptedJDBCSyncSource implementation (see the 'script-class' property). This implemenation may choose not to perform any deletes and simply return if you do not want the UnboundID Synchronization Server to manage the changelog table or if no such table is being used to detect changes. |
| Default Value | 3 hours |
| Allowed Values | A duration. Lower limit is 1 milliseconds. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Modifications performed by accounts with the specified user name(s) will not be synchronized. This property is particularly useful when also using the UnboundID Synchronization Server to synchronize changes to this source (i.e. bi-directional sync). In this case, a unique user account should be used by the Sync Pipe that applies changes to this source, and that user should be specified here to prevent those changes from being synchronized back to their original source. |
| Default Value | No changes are ignored. |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
max-open-connections (Advanced Property)
| Description | The maximum number of connections that the JDBC Sync Source is allowed to have open to the database at a given time. Care should be taken that the number of worker threads (specified by the num-worker-threads property on the Sync Pipe) does not exceed the number of available connections; otherwise thread starvation may occur. |
| Default Value | 30 |
| Allowed Values | An integer value. Lower limit is 1. Upper limit is 1000 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Sync Sources:
dsconfig list-sync-sources
[--property {propertyName}] ...
To view the configuration for an existing Sync Source:
dsconfig get-sync-source-prop
--source-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Sync Source:
dsconfig set-sync-source-prop
--source-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To delete an existing Sync Source:
dsconfig delete-sync-source
--source-name {name}