T
- the configuration for the synchronization provider.@PublicAPI(stability=VOLATILE, mayInstantiate=false, mayExtend=true, mayInvoke=false) public abstract class SynchronizationProvider<T extends SynchronizationProviderCfg> extends Object
Constructor and Description |
---|
SynchronizationProvider() |
Modifier and Type | Method and Description |
---|---|
void |
completeSynchronizationProvider()
Performs any necessary final initialization processing for this synchronization provider.
|
abstract void |
doPostOperation(PostOperationAddOperation addOperation)
Performs any necessary synchronization processing that may be needed after the provided add operation is
performed.
|
abstract void |
doPostOperation(PostOperationDeleteOperation deleteOperation)
Performs any necessary synchronization processing that may be needed after the provided delete operation is
performed.
|
abstract void |
doPostOperation(PostOperationModifyDNOperation modifyDNOperation)
Performs any necessary synchronization processing that may be needed after the provided modify DN operation is
performed.
|
abstract void |
doPostOperation(PostOperationModifyOperation modifyOperation)
Performs any necessary synchronization processing that may be needed after the provided modify operation is
performed.
|
abstract SynchronizationProviderResult |
doPreOperation(PreOperationAddOperation addOperation)
Performs any necessary synchronization processing that may be needed before the provided add operation is
performed.
|
abstract SynchronizationProviderResult |
doPreOperation(PreOperationDeleteOperation deleteOperation)
Performs any necessary synchronization processing that may be needed before the provided delete operation is
performed.
|
abstract SynchronizationProviderResult |
doPreOperation(PreOperationModifyDNOperation modifyDNOperation)
Performs any necessary synchronization processing that may be needed before the provided modify DN operation is
performed.
|
abstract SynchronizationProviderResult |
doPreOperation(PreOperationModifyOperation modifyOperation)
Performs any necessary synchronization processing that may be needed before the provided modify operation is
performed.
|
void |
finalizeSynchronizationProvider()
Performs any necessary finalization for this synchronization provider.
|
SynchronizationProviderResult |
handleConflictResolution(PreOperationAddOperation addOperation)
Performs any necessary synchronization processing for the operation that may be needed early on to deal with any
potential conflict resolution or updates to historical data.
|
SynchronizationProviderResult |
handleConflictResolution(PreOperationDeleteOperation deleteOperation)
Performs any necessary synchronization processing for the operation that may be needed early on to deal with any
potential conflict resolution or updates to historical data.
|
SynchronizationProviderResult |
handleConflictResolution(PreOperationModifyDNOperation modifyDNOperation)
Performs any necessary synchronization processing for the operation that may be needed early on to deal with any
potential conflict resolution or updates to historical data.
|
SynchronizationProviderResult |
handleConflictResolution(PreOperationModifyOperation modifyOperation)
Performs any necessary synchronization processing for the operation that may be needed early on to deal with any
potential conflict resolution or updates to historical data.
|
abstract void |
initializeSynchronizationProvider(ServerContext serverContext,
T config)
Performs any initialization that might be necessary for this synchronization provider.
|
boolean |
isConfigurationAcceptable(T configuration,
List<LocalizableMessage> unacceptableReasons)
Indicates whether the provided configuration is acceptable for this synchronization provider.
|
abstract void |
processSchemaChange(List<Modification> modifications)
Performs any processing that may be required whenever the server schema has been updated.
|
public abstract void initializeSynchronizationProvider(ServerContext serverContext, T config) throws ConfigException, InitializationException
serverContext
- The server context.config
- The configuration information for this synchronization provider.ConfigException
- If the provided entry does not contain a valid configuration for this synchronization provider.InitializationException
- If a problem occurs while initializing the synchronization provider that is not related to the server
configuration.public boolean isConfigurationAcceptable(T configuration, List<LocalizableMessage> unacceptableReasons)
configuration
- The synchronization provider configuration for which to make the the determination.unacceptableReasons
- A list that may be used to hold the reasons that the provided configuration is not acceptable.true
if the provided configuration is acceptable for this synchronization provider, or
false
if not.public void completeSynchronizationProvider()
public void finalizeSynchronizationProvider()
public SynchronizationProviderResult handleConflictResolution(PreOperationAddOperation addOperation) throws LdapException
addOperation
- The add operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract SynchronizationProviderResult doPreOperation(PreOperationAddOperation addOperation) throws LdapException
addOperation
- The add operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract void doPostOperation(PostOperationAddOperation addOperation) throws LdapException
addOperation
- The add operation to be processed.LdapException
- If a problem occurs during synchronization processing.public SynchronizationProviderResult handleConflictResolution(PreOperationDeleteOperation deleteOperation) throws LdapException
deleteOperation
- The delete operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract SynchronizationProviderResult doPreOperation(PreOperationDeleteOperation deleteOperation) throws LdapException
deleteOperation
- The delete operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract void doPostOperation(PostOperationDeleteOperation deleteOperation) throws LdapException
deleteOperation
- The delete operation to be processed.LdapException
- If a problem occurs during synchronization processing.public SynchronizationProviderResult handleConflictResolution(PreOperationModifyOperation modifyOperation) throws LdapException
modifyOperation
- The modify operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract SynchronizationProviderResult doPreOperation(PreOperationModifyOperation modifyOperation) throws LdapException
modifyOperation
- The modify operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract void doPostOperation(PostOperationModifyOperation modifyOperation) throws LdapException
modifyOperation
- The modify operation to be processed.LdapException
- If a problem occurs during synchronization processing.public SynchronizationProviderResult handleConflictResolution(PreOperationModifyDNOperation modifyDNOperation) throws LdapException
modifyDNOperation
- The modify DN operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract SynchronizationProviderResult doPreOperation(PreOperationModifyDNOperation modifyDNOperation) throws LdapException
modifyDNOperation
- The modify DN operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract void doPostOperation(PostOperationModifyDNOperation modifyDNOperation) throws LdapException
modifyDNOperation
- The modify DN operation to be processed.LdapException
- If a problem occurs during synchronization processing.public abstract void processSchemaChange(List<Modification> modifications)
modifications
- The set of modifications that have been made to the server schema.Copyright 2010-2022 ForgeRock AS.