Local File Manager

The local file manager is suitable for integration with a file system that resides on the same machine where the application is deployed

Maven Dependency

To utilise the Local File Manager in your application include the following dependency:

    <dependency>
        <groupId>com.iconsolutions.ipf.filemanager</groupId>
        <artifactId>ipf-file-manager-local</artifactId>
    </dependency>

Write Response - Versioning

As outlined in the API Reference, the FileWriter write methods return a wrapped WriteResponse object. As versioning is not a feature of the local file manager, the WriteResponse version() method will always return null.

Configuration

Property Grouping: ipf.file-manager.local

Key Description Default Value

ipf.file-manager.local.enabled

Local file manager is enabled by default when the maven dependency is included. Can be disabled by setting this property to false

 
true

ipf.file-manager.local.reader.buffer-size

Larger buffer size for better throughput with large files

 
"32kB"

ipf.file-manager.local.resiliency-settings.default.enabled

Defines if the local file manager should retry on failure as configured in retry properties.

 
false

ipf.file-manager.local.resiliency-settings.default.max-attempts

Defines number of attemps to retry in case any of the retryable exceptions or their subclasses is encountered.

 
3

ipf.file-manager.local.resiliency-settings.default.min-backoff

Defines time interval in between retry attempts.

 
"1s"

ipf.file-manager.local.resiliency-settings.default.retryable-exceptions

Exceptions that will be retried configured number of times. Provided as a collection of comma-separated strings. Subclasses of specified exceptions will also trigger retry.

 
[
    "java.lang.Exception"
]

ipf.file-manager.local.resiliency-settings.delete.enabled

Defines if the local file manager should retry on failure as configured in retry properties.

 
false

ipf.file-manager.local.resiliency-settings.delete.max-attempts

Defines number of attemps to retry in case any of the retryable exceptions or their subclasses is encountered.

 
3

ipf.file-manager.local.resiliency-settings.delete.min-backoff

Defines time interval in between retry attempts.

 
"1s"

ipf.file-manager.local.resiliency-settings.delete.retryable-exceptions

Exceptions that will be retried configured number of times. Provided as a collection of comma-separated strings. Subclasses of specified exceptions will also trigger retry.

 
[
    "java.lang.Exception"
]

ipf.file-manager.local.resiliency-settings.read.enabled

Defines if the local file manager should retry on failure as configured in retry properties.

 
false

ipf.file-manager.local.resiliency-settings.read.max-attempts

Defines number of attemps to retry in case any of the retryable exceptions or their subclasses is encountered.

 
3

ipf.file-manager.local.resiliency-settings.read.min-backoff

Defines time interval in between retry attempts.

 
"1s"

ipf.file-manager.local.resiliency-settings.read.retryable-exceptions

Exceptions that will be retried configured number of times. Provided as a collection of comma-separated strings. Subclasses of specified exceptions will also trigger retry.

 
[
    "java.lang.Exception"
]

ipf.file-manager.local.resiliency-settings.write.enabled

Defines if the local file manager should retry on failure as configured in retry properties.

 
false

ipf.file-manager.local.resiliency-settings.write.max-attempts

Defines number of attemps to retry in case any of the retryable exceptions or their subclasses is encountered.

 
3

ipf.file-manager.local.resiliency-settings.write.min-backoff

Defines time interval in between retry attempts.

 
"1s"

ipf.file-manager.local.resiliency-settings.write.retryable-exceptions

Exceptions that will be retried configured number of times. Provided as a collection of comma-separated strings. Subclasses of specified exceptions will also trigger retry.

 
[
    "java.lang.Exception"
]

ipf.file-manager.local.writer.overwrite-existing-file

Should the file writer overwrite the file if it already exists

 
false