ome.smuggler.config.items

Class ImportConfig

java.lang.Object

ome.smuggler.config.items.ImportConfig

public class ImportConfig
extends java.lang.Object

Specifies how to configure import logs. The available settings:

• Log directory path. Path to the directory where all import logs will be kept. Directories in the path will be created if needed.
• Log file retention period. How long to keep an import run's log around after the import has completed. Past the specified amount of minutes, the file will be deleted.
• Retry intervals. How many times and at which intervals to retry a failed import. If an import fails, it will be retried after the number of minutes given in the first slot of this array; if the retry fails, it will be attempted again after the number of minutes given in the second slot of this array; and so on until the import succeeds or the last slot is used. So a failed import will be retried at most a number of times equal to the length of this array; if the array is null or empty, no retries will ever be attempted.
• Failed log directory path. Path to the directory where to copy the log files of failed imports. Directories in the path will be created if needed. Note that the original file will still be available in the log directory but will be removed past the retention period. However, its copy in the failed log directory will be kept indefinitely, the system administrator will have to explicitly delete it after resolving the issue that caused the failure.
• Nice command. Optional command to use to set the priority of processes that run OMERO imports. If specified, this string will be prepended to the command used to spawn any process that runs an import. On Unix-like platforms you could use the nice utility; e.g. nice -n 10. As for Windows, you could use winice with the the exact same command you would use for Unix. Or you could use a similar program, e.g. nice from the GNU Core Utils for Windows or even a GUI like AdvancedRun. Whatever you do, do not use the Windows shell (as in e.g. cmd /c start /belownormal /wait /b) because it just doesn't work nicely when called from Java.
• Batch status DB directory path. Path to the directory where to keep the files of the batch status DB. This DB stores data to keep track of progress of a running import batch. Directories in the path will be created if needed.
• Number of lock stripes for the batch status DB. Optional number of lock stripes the DB should use to control parallel access to the data. If specified, it has to be a positive integer.

Constructor Summary

Constructors

Constructor and Description
ImportConfig()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object other)
java.lang.String	getBatchStatusDbDir()
java.lang.Long	getBatchStatusDbLockStripes()
java.lang.String	getFailedImportLogDir()
java.lang.String	getImportLogDir()
java.lang.Long	getLogRetentionMinutes()
java.lang.String	getNiceCommand()
java.lang.Long[]	getRetryIntervals()
int	hashCode()
void	setBatchStatusDbDir(java.lang.String batchStatusDbDir)
void	setBatchStatusDbLockStripes(java.lang.Long batchStatusDbLockStripes)
void	setFailedImportLogDir(java.lang.String failedImportLogDir)
void	setImportLogDir(java.lang.String importLogDir)
void	setLogRetentionMinutes(java.lang.Long retentionMinutes)
void	setNiceCommand(java.lang.String niceCommand)
void	setRetryIntervals(java.lang.Long[] retryIntervals)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ImportConfig

public ImportConfig()

Method Detail

getImportLogDir

public java.lang.String getImportLogDir()

setImportLogDir

public void setImportLogDir(java.lang.String importLogDir)

getLogRetentionMinutes

public java.lang.Long getLogRetentionMinutes()

setLogRetentionMinutes

public void setLogRetentionMinutes(java.lang.Long retentionMinutes)

getRetryIntervals

public java.lang.Long[] getRetryIntervals()

setRetryIntervals

public void setRetryIntervals(java.lang.Long[] retryIntervals)

getFailedImportLogDir

public java.lang.String getFailedImportLogDir()

setFailedImportLogDir

public void setFailedImportLogDir(java.lang.String failedImportLogDir)

getNiceCommand

public java.lang.String getNiceCommand()

setNiceCommand

public void setNiceCommand(java.lang.String niceCommand)

getBatchStatusDbDir

public java.lang.String getBatchStatusDbDir()

setBatchStatusDbDir

public void setBatchStatusDbDir(java.lang.String batchStatusDbDir)

getBatchStatusDbLockStripes

public java.lang.Long getBatchStatusDbLockStripes()

setBatchStatusDbLockStripes

public void setBatchStatusDbLockStripes(java.lang.Long batchStatusDbLockStripes)

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object other)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object