org.codice.ddf.configuration.migration

Class ConfigurationMigrationManager

java.lang.Object

org.codice.ddf.configuration.migration.ConfigurationMigrationManager

All Implemented Interfaces:

ConfigurationMigrationService

public class ConfigurationMigrationManager
extends Object
implements ConfigurationMigrationService

Implementation of the ConfigurationMigrationService that allows migration of Configuration objects as well as any other configuration files needed.

Constructor Summary

Constructors

Constructor and Description
ConfigurationMigrationManager(List<Migratable> migratables, org.apache.karaf.system.SystemService system) Constructor.

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.
static <T> BinaryOperator<T>	throwingMerger()

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigurationMigrationManager

public ConfigurationMigrationManager(List<Migratable> migratables,
                                     org.apache.karaf.system.SystemService system)

Constructor.

Parameters:

migratables - list of Migratable services. Needs to be kept up-to-date by the client of this class.

system - the system service

Throws:

IOError - if unable to load the distribution branding or version information.

Method Detail

throwingMerger

public static <T> BinaryOperator<T> throwingMerger()

doExport

public MigrationReport doExport(Path exportDirectory)

Description copied from interface: ConfigurationMigrationService

Exports configurations to the specified path.

Specified by:

doExport in interface ConfigurationMigrationService

Parameters:

exportDirectory - path to export configurations to

Returns:

a migration report for the export operation

doExport

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

Description copied from interface: ConfigurationMigrationService

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.

Specified by:

doExport in interface ConfigurationMigrationService

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

doImport

public MigrationReport doImport(Path exportDirectory)

Description copied from interface: ConfigurationMigrationService

Imports configurations from the specified path.

Specified by:

doImport in interface ConfigurationMigrationService

Parameters:

exportDirectory - path to import configurations from

Returns:

a migration report for the import operation

doImport

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

Description copied from interface: ConfigurationMigrationService

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.

Specified by:

doImport in interface ConfigurationMigrationService

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

doDecrypt

public MigrationReport doDecrypt(Path exportDirectory)

Description copied from interface: ConfigurationMigrationService

Decrypts an exported file from the specified path.

Specified by:

doDecrypt in interface ConfigurationMigrationService

Parameters:

exportDirectory - path to decrypt configurations from

Returns:

a migration report for the decrypt operation

doDecrypt

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

Description copied from interface: ConfigurationMigrationService

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.

Specified by:

doDecrypt in interface ConfigurationMigrationService

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