org.codice.ddf.configuration.migration

Interface ConfigurationMigrationService

All Known Implementing Classes:

ConfigurationMigrationManager

public interface ConfigurationMigrationService

Service that provides a way to migrate configurations from one instance of DDF to another. This includes exporting and importing of configurations.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

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.

Method Detail

doExport

MigrationReport doExport(Path exportDirectory)

Exports configurations to the specified path.

Parameters:

exportDirectory - path to export configurations to

Returns:

a migration report for the export operation

Throws:

IllegalArgumentException - if exportDirectory is null

doExport

MigrationReport doExport(Path exportDirectory,
                         Consumer<MigrationMessage> consumer)

Exports configurations to the specified path.

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.

Parameters:

exportDirectory - path to export configurations to

consumer - a consumer to call whenever a new migration message is recorded during the operation

Returns:

a migration report for the export operation

Throws:

IllegalArgumentException - if exportDirectory or consumer is null

doImport

MigrationReport doImport(Path exportDirectory)

Imports configurations from the specified path.

Parameters:

exportDirectory - path to import configurations from

Returns:

a migration report for the import operation

Throws:

IllegalArgumentException - if exportDirectory is null

doImport

MigrationReport doImport(Path exportDirectory,
                         Consumer<MigrationMessage> consumer)

Imports configurations from the specified path.

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.

Parameters:

exportDirectory - path to import configurations from

consumer - a consumer to call whenever a new migration message is recorded during the operation

Returns:

a migration report for the import operation

Throws:

IllegalArgumentException - if exportDirectory or consumer is null

doDecrypt

MigrationReport doDecrypt(Path exportDirectory)

Decrypts an exported file from the specified path.

Parameters:

exportDirectory - path to decrypt configurations from

Returns:

a migration report for the decrypt operation

Throws:

IllegalArgumentException - if exportDirectory is null

doDecrypt

MigrationReport doDecrypt(Path exportDirectory,
                          Consumer<MigrationMessage> consumer)

Decrypts an exported file from the specified path.

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.

Parameters:

exportDirectory - path to decrypt configurations from

consumer - a consumer to call whenever a new migration message is recorded during the operation

Returns:

a migration report for the decrypt operation

Throws:

IllegalArgumentException - if exportDirectory or consumer is null