org.codice.ddf.configuration.migration

Class ImportMigrationEntryImpl

java.lang.Object

org.codice.ddf.configuration.migration.MigrationEntryImpl

org.codice.ddf.configuration.migration.ImportMigrationEntryImpl

All Implemented Interfaces:

Comparable<MigrationEntry>, ImportMigrationEntry, MigrationEntry

Direct Known Subclasses:

ImportMigrationDirectoryEntryImpl, ImportMigrationEmptyEntryImpl, ImportMigrationExternalEntryImpl, ImportMigrationPropertyReferencedEntryImpl

public class ImportMigrationEntryImpl
extends MigrationEntryImpl
implements ImportMigrationEntry

This class provides an implementation of the ImportMigrationEntry interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected Boolean	restored Will track if restore was attempted along with its result.

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImportMigrationEntryImpl(ImportMigrationContextImpl context, Path path, boolean isFile) Instantiates a new migration entry with the given path.
protected	ImportMigrationEntryImpl(ImportMigrationContextImpl context, String name, boolean isFile) Instantiates a new migration entry with the given name.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) The superclass implementation is sufficient for our needs.
protected Path	getAbsolutePath()
protected ImportMigrationContextImpl	getContext()
protected File	getFile()
Optional<InputStream>	getInputStream() Gets an input stream for this entry.
protected Optional<InputStream>	getInputStream(boolean checkAccess)
long	getLastModifiedTime() Gets the last modification time of the entry.
String	getName() Gets name for this entry.
Path	getPath() Gets a Path for this entry.
Optional<ImportMigrationEntry>	getPropertyReferencedEntry(String pname) Retrieves a migration entry referenced from a property value defined in the properties file associated with this migration entry.
MigrationReport	getReport() Gets the migration report associated with this 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 String	toDebugString() Gets a debug string to represent this entry.

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

Field Detail

restored

protected Boolean restored

Will track if restore was attempted along with its result. Will be null until restore() is attempted, at which point it will start tracking the first restore() result.

Constructor Detail

ImportMigrationEntryImpl

protected ImportMigrationEntryImpl(ImportMigrationContextImpl context,
                                   String name,
                                   boolean isFile)

Instantiates a new migration entry with the given name.

Parameters:

context - the migration context associated with this entry

name - the entry's relative name

isFile - true if the entry represents a file; false if it represents a directory

ImportMigrationEntryImpl

protected ImportMigrationEntryImpl(ImportMigrationContextImpl context,
                                   Path path,
                                   boolean isFile)

Instantiates a new migration entry with the given path.

Parameters:

context - the migration context associated with this entry

path - the entry's relative path

isFile - true if the entry represents a file; false if it represents a directory

Method Detail

getReport

public MigrationReport getReport()

Description copied from interface: MigrationEntry

Gets the migration report associated with this entry. Warnings or errors can be recorded with the report.

Specified by:

getReport in interface MigrationEntry

Overrides:

getReport in class MigrationEntryImpl

Returns:

the migration report associated with this entry

getName

public String getName()

Description copied from interface: MigrationEntry

Gets name for this entry. The name is standardized with slashes (i.e /).

Specified by:

getName in interface MigrationEntry

Returns:

the name for this entry

getPath

public Path getPath()

Description copied from interface: MigrationEntry

Gets a Path for this entry.

Note: Absolute paths that are under ${ddf.home} are automatically relativized.

Specified by:

getPath in interface MigrationEntry

Returns:

a path for this entry

getLastModifiedTime

public long getLastModifiedTime()

Description copied from interface: MigrationEntry

Gets the last modification time of the entry.

Specified by:

getLastModifiedTime in interface MigrationEntry

Returns:

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

isDirectory

public boolean isDirectory()

Description copied from interface: MigrationEntry

Tests whether this entry represents a directory.

Specified by:

isDirectory in interface MigrationEntry

Returns:

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

isFile

public boolean isFile()

Description copied from interface: MigrationEntry

Tests whether this entry represents a file.

Specified by:

isFile in interface MigrationEntry

Returns:

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

getInputStream

public final Optional<InputStream> getInputStream()
                                           throws IOException

Description copied from interface: ImportMigrationEntry

Gets an input stream for this entry.

Note: The input stream provided will automatically be closed (if not closed already) regardless of whether or not the operation completes successfully for the associated migratable.

Specified by:

getInputStream in interface ImportMigrationEntry

Returns:

an input stream for this entry or empty if it was not exported or if it represents a directory

Throws:

IOException - if an I/O error has occurred

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

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

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

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 pname)

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

Parameters:

pname - 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

getContext

protected ImportMigrationContextImpl getContext()

Specified by:

getContext in class MigrationEntryImpl

getAbsolutePath

protected Path getAbsolutePath()

getFile

protected File getFile()

getInputStream

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

Throws:

IOException

toDebugString

protected String toDebugString()

Gets a debug string to represent this entry.

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 MigrationEntryImpl

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 MigrationEntryImpl

Returns:

the hashcode