public interface ConfigurationMigrationService
This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.
Modifier and Type | Method and Description |
---|---|
MigrationReport |
doDecrypt(Path exportDirectory)
Decrypts an exported file from the specified path.
|
MigrationReport |
doDecrypt(Path exportDirectory,
Consumer<MigrationMessage> consumer)
Decrypts an exported file from the specified path.
|
MigrationReport |
doExport(Path exportDirectory)
Exports configurations to the specified path.
|
MigrationReport |
doExport(Path exportDirectory,
Consumer<MigrationMessage> consumer)
Exports configurations to the specified path.
|
MigrationReport |
doImport(Path exportDirectory)
Imports configurations from the specified path.
|
MigrationReport |
doImport(Path exportDirectory,
Consumer<MigrationMessage> consumer)
Imports configurations from the specified path.
|
MigrationReport doExport(Path exportDirectory)
exportDirectory
- path to export configurations toIllegalArgumentException
- if exportDirectory
is null
MigrationReport doExport(Path exportDirectory, Consumer<MigrationMessage> consumer)
Note: This version of the doExport()
method will callback the provided
consumer every time a migration message is recorded. The message will also be recorded with the
report returned at the completion of the operation.
exportDirectory
- path to export configurations toconsumer
- a consumer to call whenever a new migration message is recorded during the
operationIllegalArgumentException
- if exportDirectory
or consumer
is
null
MigrationReport doImport(Path exportDirectory)
exportDirectory
- path to import configurations fromIllegalArgumentException
- if exportDirectory
is null
MigrationReport doImport(Path exportDirectory, Consumer<MigrationMessage> consumer)
Note: This version of the doImport()
method will callback the provided
consumer every time a migration message is recorded. The message will also be recorded with the
report returned at the completion of the operation.
exportDirectory
- path to import configurations fromconsumer
- a consumer to call whenever a new migration message is recorded during the
operationIllegalArgumentException
- if exportDirectory
or consumer
is
null
MigrationReport doDecrypt(Path exportDirectory)
exportDirectory
- path to decrypt configurations fromIllegalArgumentException
- if exportDirectory
is null
MigrationReport doDecrypt(Path exportDirectory, Consumer<MigrationMessage> consumer)
Note: This version of the doDecrypt()
method will callback the provided
consumer every time a migration message is recorded. The message will also be recorded with the
report returned at the completion of the operation.
exportDirectory
- path to decrypt configurations fromconsumer
- a consumer to call whenever a new migration message is recorded during the
operationIllegalArgumentException
- if exportDirectory
or consumer
is
null
This work is licensed under a Creative Commons Attribution 4.0 International License.