com.unboundid.directory.sdk.sync.types

Interface SyncServerContext

All Superinterfaces:

ServerContext

@NotExtensible
 @ThreadSafety(level=INTERFACE_THREADSAFE)
public interface SyncServerContext
extends ServerContext

This interface may be used to obtain information about the Data Sync Server in which an extension is running.

Method Summary

Modifier and Type

Method and Description

Entry

applyMaps(Entry sourceEntry, java.util.Collection<java.lang.String> dnMapNames, java.util.Collection<java.lang.String> attributeMapNames, java.util.Set<java.lang.String> autoMappedSrcAttributes, java.util.Set<java.lang.String> excludedAutoMapAttributes, java.util.Set<java.lang.String> excludedAutoMapAttributeRegex) Returns an entry that has had the DN and attributes mapped according to the maps specified by dnMapNames and attributeMapNames.

Methods inherited from interface com.unboundid.directory.sdk.common.types.ServerContext

createEMailAttachment, createEMailMessage, createThread, createValueConstructor, debugCaught, debugEnabled, debugError, debugInfo, debugThrown, debugVerbose, debugWarning, deregisterAllMonitorProviders, deregisterChangeListener, deregisterDiskSpaceConsumer, deregisterMonitorProvider, deregisterShutdownListener, deregisterSupportedControlOID, getBasicProductName, getClientConnection, getClientRootConnection, getCompactProductName, getEncryptedOutputStream, getEncryptedOutputStream, getEncryptionSettingsDefinition, getEncryptionSettingsDefinitions, getFullProductName, getFullVendorName, getFullVersion, getGroup, getGroupsForUser, getInstanceName, getInternalConnection, getInternalRootConnection, getLDAPExternalServerConnection, getLDAPExternalServerConnectionPool, getLocation, getMajorVersionNumber, getMinorVersionNumber, getObscuredValue, getPackageName, getPassphraseFromPassphraseProvider, getPatchVersionNumber, getPointVersionNumber, getPossiblyCompressedAndEncryptedInputStream, getPossiblyCompressedAndEncryptedInputStream, getPreferredEncryptionSettingsDefinition, getPrivilegeNames, getSchema, getServerRoot, getShortVendorName, getSourceRevision, getStartTime, getStartupID, getStartupUUID, getToolExecutor, getVersionNumber, getVersionQualifier, hasPrivilege, isDirectoryFunctionalityAvailable, isDirectoryProxyFunctionalityAvailable, isRunning, isShuttingDown, isStarting, isSyncFunctionalityAvailable, isTraceMessageLoggable, logMessage, logTraceMessage, logTraceMessage, registerChangeListener, registerDiskSpaceConsumer, registerMonitorProvider, registerShutdownListener, registerSupportedControlOID, reloadHTTPConnectionHandlerCertificates, sendAlert, sendAlert, sendDegradedAlertNotification, sendUnavailableAlertNotification

Method Detail

applyMaps

Entry applyMaps(Entry sourceEntry,
                java.util.Collection<java.lang.String> dnMapNames,
                java.util.Collection<java.lang.String> attributeMapNames,
                java.util.Set<java.lang.String> autoMappedSrcAttributes,
                java.util.Set<java.lang.String> excludedAutoMapAttributes,
                java.util.Set<java.lang.String> excludedAutoMapAttributeRegex)
         throws LDAPException

Returns an entry that has had the DN and attributes mapped according to the maps specified by dnMapNames and attributeMapNames.

Parameters:

sourceEntry - The source entry to map.

dnMapNames - The names of the DN maps in the configuration that should be applied. This list can be empty if no DN maps should be applied. Multiple DN maps can be specified if source DNs might match different DN patterns. The most specific patterns should be specified first.

attributeMapNames - The names of the attribute maps in the configuration that should be applied. This list can be empty if no attribute mappings should be applied. This parameter works in conjunction with the autoMappedSrcAttributes and excludedAutoMapAttributes parameters.

autoMappedSrcAttributes - The set of source attribute names that should be automatically mapped to a destination attribute with the same name. You can use the special values '-all-' to auto-map every Sync Source attribute, and '-none-' to not auto-map any Sync Source attributes.

excludedAutoMapAttributes - The set of source attribute names that should not be automatically mapped to a destination attribute with the same name.

excludedAutoMapAttributeRegex - A set of regular expressions that match source attribute names that should not be automatically mapped to a destination attribute with the same name.

Returns:

An entry that has had the DN and attributes mapped according to the information given above.

Throws:

LDAPException - If the mapping fails.