org.codice.ddf.configuration.admin

Class ConfigurationAdminMigratable

java.lang.Object

org.codice.ddf.configuration.admin.ConfigurationAdminMigratable

All Implemented Interfaces:

Migratable, Describable

public class ConfigurationAdminMigratable
extends Object
implements Migratable

Class used to migrate ConfigurationAdmin configurations. This includes importing configuration files from a configuration directory and creating Configuration objects for those and exporting Configuration objects to configuration files.

Constructor Summary

Constructors

Constructor and Description
ConfigurationAdminMigratable(org.osgi.service.cm.ConfigurationAdmin configurationAdmin, List<PersistenceStrategy> strategies, String defaultFileExtension)

Method Summary

Modifier and Type	Method and Description
void	doExport(ExportMigrationContext context) Exports all required migratable data to the specified context.
void	doImport(ImportMigrationContext context) Imports all exported migratable data provided by the specified context when the current version of this migratable (see Migratable.getVersion()) matches the exported version.
String	getDescription() Returns a description of the describable item.
String	getId() Returns the name, aka ID, of the describable item.
String	getOrganization() Returns the organization associated with the describable item.
String	getTitle() Returns the title of the describable item.
String	getVersion() Gets the current export version handled by this migratable.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.codice.ddf.migration.Migratable

doIncompatibleImport, doMissingImport

Constructor Detail

ConfigurationAdminMigratable

public ConfigurationAdminMigratable(org.osgi.service.cm.ConfigurationAdmin configurationAdmin,
                                    List<PersistenceStrategy> strategies,
                                    String defaultFileExtension)

Method Detail

getVersion

public String getVersion()

Description copied from interface: Migratable

Gets the current export version handled by this migratable.

When exporting data, the migration framework will export this version information and provide it back to the Migratable.doIncompatibleImport(org.codice.ddf.migration.ImportMigrationContext, java.lang.String) method if the exported version string doesn't match the one provided by this method when importing the data for this migratable.

The format of the version string is migratable-dependent.

Specified by:

getVersion in interface Migratable

Specified by:

getVersion in interface Describable

Returns:

the current version handled by this migratable

getId

public String getId()

Description copied from interface: Describable

Returns the name, aka ID, of the describable item. The name should be unique for each instance within the scope of a service or a component. For example, this is unique for any Migratable in a set of Migratables. It is not necessarily unique between Migratables and Metacards.

Format should be [product].[component] such as ddf.metacards, or ddf.platform; while the [component] within a [product] may simply be a module or bundle name, the [product] itself should be the unique name of the plug-in or integration that belongs to the organization listed in Describable.getOrganization(). Note that 'ddf' as a [product] is reserved for core features only.

Specified by:

getId in interface Describable

Returns:

ID of the item

getTitle

public String getTitle()

Description copied from interface: Describable

Returns the title of the describable item. It is generally more verbose than the name (aka ID).

Specified by:

getTitle in interface Describable

Returns:

title of the item (example: File System Provider)

getDescription

public String getDescription()

Description copied from interface: Describable

Returns a description of the describable item.

Specified by:

getDescription in interface Describable

Returns:

description of the item (example: Provider that returns back static results)

getOrganization

public String getOrganization()

Description copied from interface: Describable

Returns the organization associated with the describable item.

Specified by:

getOrganization in interface Describable

Returns:

organizational name or acronym (example: USAF)

doExport

public void doExport(ExportMigrationContext context)

Description copied from interface: Migratable

Exports all required migratable data to the specified context.

Errors, warnings, and/or information messages can be recorded along with the context's report. Doing so will not abort the operation.

Specified by:

doExport in interface Migratable

Parameters:

context - a migration context to export all migratable data to

doImport

public void doImport(ImportMigrationContext context)

Description copied from interface: Migratable

Imports all exported migratable data provided by the specified context when the current version of this migratable (see Migratable.getVersion()) matches the exported version.

Errors, warnings, and/or information messages can be recorded along with the context's report. Doing so will not abort the operation.

Specified by:

doImport in interface Migratable

Parameters:

context - a migration context to import all exported migratable data from