org.codice.ddf.configuration.migration

Class ImportMigrationExternalEntryImpl

java.lang.Object

org.codice.ddf.configuration.migration.MigrationEntryImpl

org.codice.ddf.configuration.migration.ImportMigrationEntryImpl

org.codice.ddf.configuration.migration.ImportMigrationExternalEntryImpl

All Implemented Interfaces:

Comparable<MigrationEntry>, ImportMigrationEntry, MigrationEntry

public class ImportMigrationExternalEntryImpl
extends ImportMigrationEntryImpl

This class provides an implementation of the ImportMigrationEntry representing an external file that was exported.

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
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.
int	hashCode() The superclass implementation is sufficient for our needs.
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 String	toDebugString() Gets a debug string to represent this entry.

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

getAbsolutePath, getContext, getFile, getInputStream, getName, getPath, getPropertyReferencedEntry, getReport, isDirectory, isFile, restore

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

compareTo, 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

Methods inherited from interface java.lang.Comparable

compareTo

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

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

getInputStream

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

Overrides:

getInputStream in class ImportMigrationEntryImpl

Throws:

IOException

toDebugString

protected String toDebugString()

Description copied from class: ImportMigrationEntryImpl

Gets a debug string to represent this entry.

Overrides:

toDebugString in class ImportMigrationEntryImpl

Returns:

a debug string for this entry

equals

public boolean equals(Object o)

The superclass implementation is sufficient for our needs.

Overrides:

equals in class ImportMigrationEntryImpl

Parameters:

o - the object to check

Returns:

true if equal

hashCode

public int hashCode()

The superclass implementation is sufficient for our needs.

Overrides:

hashCode in class ImportMigrationEntryImpl

Returns:

the hashcode