public class RawFiles extends com.unboundid.directory.sdk.sync.api.SyncSource implements com.unboundid.directory.sdk.common.internal.Reconfigurable<com.unboundid.directory.sdk.sync.config.SyncSourceConfig>
Modifier and Type | Field and Description |
---|---|
static String |
SORT_CRITERIA_CREATED |
static String |
SORT_CRITERIA_MODIFIED |
static String |
SORT_CRITERIA_NAME |
static String |
SORT_CRITERIA_RAW |
Constructor and Description |
---|
RawFiles() |
Modifier and Type | Method and Description |
---|---|
void |
acknowledgeCompletedOps(LinkedList<com.unboundid.directory.sdk.sync.types.SyncOperation> completedOperations)
Performs the necessary processing to deal with each completed
SyncOperation after it has been
successfully processed |
com.unboundid.ldap.sdk.ResultCode |
applyConfiguration(com.unboundid.directory.sdk.sync.config.SyncSourceConfig syncSourceConfig,
com.unboundid.util.args.ArgumentParser parser,
List<String> adminActionsRequired,
List<String> messages)
Performs the necessary processing to apply the proposed configuration, either at run time or with a restart of the
SyncSource or the server instance.
|
void |
defineConfigArguments(com.unboundid.util.args.ArgumentParser parser)
Performs the necessary processing to define the configuration arguments for the extension
|
com.unboundid.ldap.sdk.Entry |
fetchEntry(com.unboundid.directory.sdk.sync.types.SyncOperation syncOperation)
Performs the necessary processing to retrieve the file contents and create an entry
|
String |
getCurrentEndpointURL()
Performs the necessary processing to compute and return the URL for the instance of the
SyncSource |
String[] |
getExtensionDescription() |
String |
getExtensionName() |
List<com.unboundid.directory.sdk.sync.types.ChangeRecord> |
getNextBatchOfChanges(int maxChanges,
AtomicLong stillPending)
Performs the necessary processing to retrieve the next batch of files to enqueue in the Sync pipe
|
Serializable |
getStartpoint() |
void |
initializeSyncSource(com.unboundid.directory.sdk.sync.types.SyncServerContext serverContext,
com.unboundid.directory.sdk.sync.config.SyncSourceConfig config,
com.unboundid.util.args.ArgumentParser parser)
Performs the necessary processing to initialize the
SyncSource |
boolean |
isConfigurationAcceptable(com.unboundid.directory.sdk.sync.config.SyncSourceConfig syncSourceConfig,
com.unboundid.util.args.ArgumentParser argumentParser,
List<String> unacceptableReasons)
Performs the necessary processing to validate the validity of the proposed configuration
|
void |
setStartpoint(com.unboundid.directory.sdk.sync.types.SetStartpointOptions setStartpointOptions)
Performs the necessary processing to correctly set the start point of the Sync pipe the instance of the extension
is associated with.
|
public static final String SORT_CRITERIA_MODIFIED
public static final String SORT_CRITERIA_CREATED
public static final String SORT_CRITERIA_NAME
public static final String SORT_CRITERIA_RAW
public RawFiles()
public String getExtensionName()
getExtensionName
in interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension
getExtensionName
in class com.unboundid.directory.sdk.sync.api.SyncSource
public String[] getExtensionDescription()
getExtensionDescription
in interface com.unboundid.directory.sdk.common.internal.UnboundIDExtension
getExtensionDescription
in class com.unboundid.directory.sdk.sync.api.SyncSource
public void defineConfigArguments(com.unboundid.util.args.ArgumentParser parser) throws com.unboundid.util.args.ArgumentException
defineConfigArguments
in interface com.unboundid.directory.sdk.common.internal.Configurable
defineConfigArguments
in class com.unboundid.directory.sdk.sync.api.SyncSource
parser
- the argument parsercom.unboundid.util.args.ArgumentException
- if any argument declaration is incorrectpublic boolean isConfigurationAcceptable(com.unboundid.directory.sdk.sync.config.SyncSourceConfig syncSourceConfig, com.unboundid.util.args.ArgumentParser argumentParser, List<String> unacceptableReasons)
isConfigurationAcceptable
in interface com.unboundid.directory.sdk.common.internal.Reconfigurable<com.unboundid.directory.sdk.sync.config.SyncSourceConfig>
syncSourceConfig
- the configuration object to use to verify validityargumentParser
- the argument parserunacceptableReasons
- a list of String describing the reasons for which the proposed configuration is not acceptabletrue
is the configuration is found to be acceptable, false
otherwisepublic com.unboundid.ldap.sdk.ResultCode applyConfiguration(com.unboundid.directory.sdk.sync.config.SyncSourceConfig syncSourceConfig, com.unboundid.util.args.ArgumentParser parser, List<String> adminActionsRequired, List<String> messages)
applyConfiguration
in interface com.unboundid.directory.sdk.common.internal.Reconfigurable<com.unboundid.directory.sdk.sync.config.SyncSourceConfig>
syncSourceConfig
- the configuration object to useparser
- the argument parser from whence to pull the configuration argument valuesadminActionsRequired
- a list of String with administrative operations required to complete applying the configurationmessages
- a list of String with message about the processing of applying the configurationResultCode.SUCCESS
public void initializeSyncSource(com.unboundid.directory.sdk.sync.types.SyncServerContext serverContext, com.unboundid.directory.sdk.sync.config.SyncSourceConfig config, com.unboundid.util.args.ArgumentParser parser)
SyncSource
initializeSyncSource
in class com.unboundid.directory.sdk.sync.api.SyncSource
serverContext
- the server context of the instance of the SyncSourceconfig
- the configuration objectparser
- the argument parserpublic String getCurrentEndpointURL()
SyncSource
getCurrentEndpointURL
in class com.unboundid.directory.sdk.sync.api.SyncSource
public void setStartpoint(com.unboundid.directory.sdk.sync.types.SetStartpointOptions setStartpointOptions) throws com.unboundid.directory.sdk.sync.types.EndpointException
setStartpoint
in class com.unboundid.directory.sdk.sync.api.SyncSource
setStartpointOptions
- the SetStartpointOptions
to use, such as SetStartpointOptions.BEGINNING_OF_CHANGELOGcom.unboundid.directory.sdk.sync.types.EndpointException
- if an error was encountered in the process of setting the startpointpublic Serializable getStartpoint()
getStartpoint
in class com.unboundid.directory.sdk.sync.api.SyncSource
public List<com.unboundid.directory.sdk.sync.types.ChangeRecord> getNextBatchOfChanges(int maxChanges, AtomicLong stillPending) throws com.unboundid.directory.sdk.sync.types.EndpointException
getNextBatchOfChanges
in class com.unboundid.directory.sdk.sync.api.SyncSource
maxChanges
- the maximum number of files to enqueue in one callstillPending
- the remaining number of files still pending after one call has completedcom.unboundid.directory.sdk.sync.types.EndpointException
- if an error was encountered while retrieving the next batchpublic com.unboundid.ldap.sdk.Entry fetchEntry(com.unboundid.directory.sdk.sync.types.SyncOperation syncOperation) throws com.unboundid.directory.sdk.sync.types.EndpointException
fetchEntry
in class com.unboundid.directory.sdk.sync.api.SyncSource
syncOperation
- the sync operation to processEntry
with the file contents and metadatacom.unboundid.directory.sdk.sync.types.EndpointException
- if an issue was encountered while processing the SyncOperation
public void acknowledgeCompletedOps(LinkedList<com.unboundid.directory.sdk.sync.types.SyncOperation> completedOperations) throws com.unboundid.directory.sdk.sync.types.EndpointException
SyncOperation
after it has been
successfully processedacknowledgeCompletedOps
in class com.unboundid.directory.sdk.sync.api.SyncSource
completedOperations
- a List of completed SyncOperation
com.unboundid.directory.sdk.sync.types.EndpointException
- if an error is encountered in the process of acknowledging the completed operationsCopyright © 2019 PingIdentity Corp.. All rights reserved.