ome.smuggler.core.types

Class ImportConfigReader

java.lang.Object

ome.smuggler.core.types.ImportConfigReader

All Implemented Interfaces:

ImportConfigSource

public class ImportConfigReader
extends java.lang.Object
implements ImportConfigSource

Implements ImportConfigSource by extracting and validating values from an underlying ImportConfig.

Field Summary

Fields inherited from interface ome.smuggler.core.types.ImportConfigSource

DefaultBatchStatusDbLockStripes

Constructor Summary

Constructors

Constructor and Description
ImportConfigReader(ImportConfig config) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
java.nio.file.Path	batchStatusDbDir()
PositiveN	batchStatusDbLockStripes() Optional number of lock stripes to use with the import batch status key-value store.
java.nio.file.Path	failedImportLogDir()
java.nio.file.Path	importLogDir()
java.time.Duration	logRetentionPeriod()
util.runtime.CommandBuilder	niceCommand() Optional command to use to set the priority of processes that run OMERO imports.
java.util.List<java.time.Duration>	retryIntervals()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ImportConfigReader

public ImportConfigReader(ImportConfig config)

Creates a new instance.

Parameters:

config - the configuration as obtained by the configuration provider.

Throws:

java.lang.NullPointerException - if the argument is null.

Method Detail

importLogDir

public java.nio.file.Path importLogDir()

Specified by:

importLogDir in interface ImportConfigSource

Returns:

path to the directory where to keep import logs.

logRetentionPeriod

public java.time.Duration logRetentionPeriod()

Specified by:

logRetentionPeriod in interface ImportConfigSource

Returns:

how long to keep import logs before deleting them.

retryIntervals

public java.util.List<java.time.Duration> retryIntervals()

Specified by:

retryIntervals in interface ImportConfigSource

Returns:

intervals at which to retry failed imports.

failedImportLogDir

public java.nio.file.Path failedImportLogDir()

Specified by:

failedImportLogDir in interface ImportConfigSource

Returns:

path to the directory where to keep logs of failed imports.

niceCommand

public util.runtime.CommandBuilder niceCommand()

Description copied from interface: ImportConfigSource

Optional command to use to set the priority of processes that run OMERO imports.

Specified by:

niceCommand in interface ImportConfigSource

Returns:

the configured command or empty if not found in the configuration file.

batchStatusDbDir

public java.nio.file.Path batchStatusDbDir()

Specified by:

batchStatusDbDir in interface ImportConfigSource

Returns:

path to the directory where to keep the files of the import batch status key-value store.

batchStatusDbLockStripes

public PositiveN batchStatusDbLockStripes()

Description copied from interface: ImportConfigSource

Optional number of lock stripes to use with the import batch status key-value store.

Specified by:

batchStatusDbLockStripes in interface ImportConfigSource

Returns:

the configured number or a default value if none is found in the configuration file.