org.codice.ddf.configuration.migration

Class ImportMigrationPropertyReferencedEntryImpl

java.lang.Object

org.codice.ddf.configuration.migration.MigrationEntryImpl

org.codice.ddf.configuration.migration.ImportMigrationEntryImpl

org.codice.ddf.configuration.migration.ImportMigrationPropertyReferencedEntryImpl

All Implemented Interfaces:

Comparable<MigrationEntry>, ImportMigrationEntry, MigrationEntry

Direct Known Subclasses:

ImportMigrationJavaPropertyReferencedEntryImpl, ImportMigrationSystemPropertyReferencedEntryImpl

public abstract class ImportMigrationPropertyReferencedEntryImpl
extends ImportMigrationEntryImpl

Defines a migration entry representing a property which value references another migration entry.

Field Summary

Fields inherited from class org.codice.ddf.configuration.migration.ImportMigrationEntryImpl

restored

Fields inherited from class org.codice.ddf.configuration.migration.MigrationEntryImpl

METADATA_CHECKSUM, METADATA_FILES, METADATA_FILTERED, METADATA_FOLDER, METADATA_LAST_MODIFIED, METADATA_NAME, METADATA_PROPERTY, METADATA_REFERENCE, METADATA_SOFTLINK

Method Summary

Modifier and Type	Method and Description
int	compareTo(MigrationEntry me)
boolean	equals(Object o) The superclass implementation is sufficient for our needs.
protected Optional<InputStream>	getInputStream(boolean checkAccess)
long	getLastModifiedTime() Gets the last modification time of the entry.
Optional<ImportMigrationEntry>	getPropertyReferencedEntry(String name) Retrieves a migration entry referenced from a property value defined in the properties file associated with this migration entry.
int	hashCode() The superclass implementation is sufficient for our needs.
boolean	isDirectory() Tests whether this entry represents a directory.
boolean	isFile() Tests whether this entry represents a file.
boolean	restore(BiThrowingConsumer<MigrationReport,Optional<InputStream>,IOException> consumer) Restores this required entry's content appropriately based on this entry's path which can include sub-directories using the specified consumer.
boolean	restore(boolean required) Restores this entry's content underneath the distribution root directory based on this entry's path which can include sub-directories.
boolean	restore(boolean required, PathMatcher filter) Restores all entries that recursively match the provided path filter underneath the distribution root directory based on this entry's path which can include sub-directories.
protected abstract void	verifyPropertyAfterCompletion() Called after the referenced migration entry is restored to register code to be invoked after the migration operation completion to verify if the property value references the referenced migration entry.

Methods inherited from class org.codice.ddf.configuration.migration.ImportMigrationEntryImpl

getAbsolutePath, getContext, getFile, getInputStream, getName, getPath, getReport, toDebugString

Methods inherited from class org.codice.ddf.configuration.migration.MigrationEntryImpl

getId, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

restore, restore

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

getId

Method Detail

getLastModifiedTime

public long getLastModifiedTime()

Description copied from interface: MigrationEntry

Gets the last modification time of the entry.

Specified by:

getLastModifiedTime in interface MigrationEntry

Overrides:

getLastModifiedTime in class ImportMigrationEntryImpl

Returns:

the last modification time of the entry in milliseconds since the epoch, or -1 if not specified

isFile

public boolean isFile()

Description copied from interface: MigrationEntry

Tests whether this entry represents a file.

Specified by:

isFile in interface MigrationEntry

Overrides:

isFile in class ImportMigrationEntryImpl

Returns:

true if and only if the entry represents a file; false otherwise

isDirectory

public boolean isDirectory()

Description copied from interface: MigrationEntry

Tests whether this entry represents a directory.

Specified by:

isDirectory in interface MigrationEntry

Overrides:

isDirectory in class ImportMigrationEntryImpl

Returns:

true if and only if the entry represents a directory; false otherwise

restore

public boolean restore(boolean required)

Description copied from interface: ImportMigrationEntry

Restores this entry's content underneath the distribution root directory based on this entry's path which can include sub-directories. If the entry represents a directory then all files recursively located underneath the directory will automatically be imported.

This entry's sub-directories (if any) will be created if they don't already exist. The destination file will be overwritten if it already exists.

All errors and warnings are automatically recorded with the associated migration report.

Errors can be reported in two ways:

1. Errors that abort the whole operation would be thrown out as MigrationException (e.g. failure to write to the exported file)
2. Errors that are specific to this specific entry and that will eventually fail the export operation at the end. Such errors are simply recorded with the report and false is returned from this method. This allows for the accumulation of as many issues as possible to report to the user before aborting the operation.

Note: If this entry represents a directory which had been completely exported using ExportMigrationEntry.store() or ExportMigrationEntry.store(boolean) then in addition to restoring all entries recursively, calling this method will also remove any existing files or directories that were not on the original system.

Note: Calling restore() twice will not restore the entry two times. The second time it is called, the same result will be returned as the first time no matter which restore() method was called.

Specified by:

restore in interface ImportMigrationEntry

Overrides:

restore in class ImportMigrationEntryImpl

Parameters:

required - true if the file or directory is required to exist in the export and if it doesn't an error should be recorded; false if the file or directory is optional and may not be exported in which case calling this method will do nothing

Returns:

true if no errors were recorded as a result of processing this command; false otherwise

restore

public boolean restore(boolean required,
                       PathMatcher filter)

Description copied from interface: ImportMigrationEntry

Restores all entries that recursively match the provided path filter underneath the distribution root directory based on this entry's path which can include sub-directories. If the entry represents a file that does not match the provided path filter then nothing will be imported and the entry will be considered as non-existent when the required parameter is interpreted for recording errors and deciding what to return.

This entry's sub-directories (if any) will be created if they don't already exist. The destination file will be overwritten if it already exists.

All errors and warnings are automatically recorded with the associated migration report.

Errors can be reported in two ways:

1. Errors that abort the whole operation would be thrown out as MigrationException (e.g. failure to write to the exported file)
2. Errors that are specific to this specific entry and that will eventually fail the export operation at the end. Such errors are simply recorded with the report and false is returned from this method. This allows for the accumulation of as many issues as possible to report to the user before aborting the operation.

Note: Calling restore() twice will not restore the entry two times. The second time it is called, the same result will be returned as the first time no matter which restore() method was called.

Specified by:

restore in interface ImportMigrationEntry

Overrides:

restore in class ImportMigrationEntryImpl

Parameters:

required - true if the file or directory is required to exist in the export and if it doesn't an error should be recorded; false if the file or directory is optional and may not be exported in which case calling this method will do nothing

filter - the path filter to use

Returns:

true if no errors were recorded as a result of processing this command; false otherwise

restore

public boolean restore(BiThrowingConsumer<MigrationReport,Optional<InputStream>,IOException> consumer)

Description copied from interface: ImportMigrationEntry

Restores this required entry's content appropriately based on this entry's path which can include sub-directories using the specified consumer.

All errors and warnings are automatically recorded with the associated migration report including those thrown by the consumer logic.

Errors can be reported in two ways:

1. Errors that abort the whole operation would be thrown out as MigrationException (e.g. failure to read from the exported file)
2. Errors that are specific to this specific entry and that will eventually fail the import operation at the end. Such errors are simply recorded with the report and false is returned from this method. This allows for the accumulation of as many issues as possible to report to the user before aborting the operation.

Note: The input stream will automatically be closed (if not closed already) when the operation completes successfully or not.

Specified by:

restore in interface ImportMigrationEntry

Overrides:

restore in class ImportMigrationEntryImpl

Parameters:

consumer - a consumer capable of importing the content of this entry from a provided input stream which might be empty if the entry was not exported or if the entry represents a directory (otherwise an error will automatically be recorded)

Returns:

true if no errors were recorded as a result of processing this command; false otherwise

getPropertyReferencedEntry

public Optional<ImportMigrationEntry> getPropertyReferencedEntry(String name)

Description copied from interface: ImportMigrationEntry

Retrieves a migration entry referenced from a property value defined in the properties file associated with this migration entry.

The entry returned would be an entry representing the file that was referenced by the specified property value in the java properties file represented by this entry on the exported system. For example:

If the properties file (e.g. etc/ws-security/server/encryption.properties) represented by this entry defined the following mapping: org.apache.ws.security.crypto.merlin.x509crl.file=etc/certs/demoCA/crl/crl.pem

then the following code:

     final ImportMigrationEntry entry
         = context.getEntry("etc/ws-security/server/encryption.properties");

     final Optional<ImportMigrationEntry> entry2
         = entry.getPropertyReferenceEntry("org.apache.ws.security.crypto.merlin.x509crl.file");
 

would return an entry representing the exported file etc/certs/demoCA/crl/crl.pem allowing the migratable a chance to restore it in its original location and verifying that the property in the local etc/ws-security/server/encryption.properties file is still defined with the same value after the import operation has completed.

Specified by:

getPropertyReferencedEntry in interface ImportMigrationEntry

Overrides:

getPropertyReferencedEntry in class ImportMigrationEntryImpl

Parameters:

name - the name of the property that contains the reference to a migration entry

Returns:

the migration entry corresponding to the property value defined by name in the properties file referenced by this entry or empty if it was not exported

hashCode

public int hashCode()

Description copied from class: ImportMigrationEntryImpl

The superclass implementation is sufficient for our needs.

Overrides:

hashCode in class ImportMigrationEntryImpl

Returns:

the hashcode

equals

public boolean equals(@Nullable
                      Object o)

Description copied from class: ImportMigrationEntryImpl

The superclass implementation is sufficient for our needs.

Overrides:

equals in class ImportMigrationEntryImpl

Parameters:

o - the object to check

Returns:

true if equal

compareTo

public int compareTo(@Nullable
                     MigrationEntry me)

Specified by:

compareTo in interface Comparable<MigrationEntry>

Overrides:

compareTo in class MigrationEntryImpl

getInputStream

protected Optional<InputStream> getInputStream(boolean checkAccess)
                                        throws IOException

Overrides:

getInputStream in class ImportMigrationEntryImpl

Throws:

IOException

verifyPropertyAfterCompletion

protected abstract void verifyPropertyAfterCompletion()

Called after the referenced migration entry is restored to register code to be invoked after the migration operation completion to verify if the property value references the referenced migration entry.