ExportMigrationEntryImpl (DDF Reactor 2.11.5 API)

java.lang.Object
- org.codice.ddf.configuration.migration.MigrationEntryImpl
- - org.codice.ddf.configuration.migration.ExportMigrationEntryImpl

All Implemented Interfaces:

Comparable<MigrationEntry>, ExportMigrationEntry, MigrationEntry

Direct Known Subclasses:

ExportMigrationPropertyReferencedEntryImpl
```
public class ExportMigrationEntryImpl
extends MigrationEntryImpl
implements ExportMigrationEntry
```
This class provides an implementation of the ExportMigrationEntry.

Field Summary

Fields
Modifier and Type Field and Description

protected Boolean stored
Will track if store 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

Fields
Modifier and Type	Field and Description
`protected Boolean`	`stored` Will track if store was attempted along with its result.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ExportMigrationEntryImpl(ExportMigrationContextImpl context, Path path)` Instantiates a new migration entry given a migratable context and path.
`protected`	`ExportMigrationEntryImpl(ExportMigrationContextImpl context, String pathname)` Instantiates a new migration entry given a migratable context and path.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)` The superclass implementation is sufficient for our needs.
`protected Path`	`getAbsolutePath()`
`protected ExportMigrationContextImpl`	`getContext()`
`protected File`	`getFile()`
`long`	`getLastModifiedTime()` Gets the last modification time of the entry.
`String`	`getName()` Gets name for this entry.
`OutputStream`	`getOutputStream()` Gets an output stream for this entry which provides a low-level way for the migratable to store its own content in the export.
`Path`	`getPath()` Gets a `Path` for this entry.
`Optional<ExportMigrationEntry>`	`getPropertyReferencedEntry(String name)` Creates or retrieves (if already created) a migration entry referenced from the specified property in the properties file associated with this migration entry to be exported by the corresponding migratable.
`Optional<ExportMigrationEntry>`	`getPropertyReferencedEntry(String pname, BiPredicate<MigrationReport,String> validator)` Creates or retrieves (if already created) a migration entry referenced from the specified property in the properties file associated with this migration entry to be exported by the corresponding migratable.
`ExportMigrationReportImpl`	`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.
`protected MigrationException`	`newError(String reason, Object cause)`
`protected MigrationWarning`	`newWarning(String reason)`
`protected void`	`recordEntry()` Called to record that this entry is being processed.
`boolean`	`store(BiThrowingConsumer<MigrationReport,OutputStream,IOException> consumer)` Stores this entry's content in the export using the specified consumer based on this entry's path which can include sub-directories.
`boolean`	`store(boolean required)` Stores this entry's content in the export based on this entry's path which can include sub-directories.
`boolean`	`store(boolean required, PathMatcher filter)` Stores all files that recursively match the provided path filter in the export 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.ExportMigrationEntry
store, store

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

Methods inherited from interface java.lang.Comparable
compareTo

- Field Detail
  - stored
```
protected Boolean stored
```
    Will track if store was attempted along with its result. Will be null until store() is attempted, at which point it will start tracking the first store() result.
- Constructor Detail
  - ExportMigrationEntryImpl
```
protected ExportMigrationEntryImpl(ExportMigrationContextImpl context,
                                   Path path)
```
    Instantiates a new migration entry given a migratable context and path.
    Note: In this version of the constructor, the path is either absolute or assumed to be relative to ${ddf.home}. It will also be automatically relativized to ${ddf.home}.
    
    Parameters:
    
    context - the migration context associated with this entry
    
    path - the path for this entry
    
    Throws:
    
    IllegalArgumentException - if context or path is null
  - ExportMigrationEntryImpl
```
protected ExportMigrationEntryImpl(ExportMigrationContextImpl context,
                                   String pathname)
```
    Instantiates a new migration entry given a migratable context and path.
    Note: In this version of the constructor, the path is either absolute or assumed to be relative to ${ddf.home}. It will also be automatically relativized to ${ddf.home}.
    
    Parameters:
    
    context - the migration context associated with this entry
    
    pathname - the path string for this entry
    
    Throws:
    
    IllegalArgumentException - if context or pathname is null
- Method Detail
  - getReport
```
public ExportMigrationReportImpl 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
  - 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
  - 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
  - getOutputStream
```
public OutputStream getOutputStream()
                             throws IOException
```
    Description copied from interface: ExportMigrationEntry
    
    Gets an output stream for this entry which provides a low-level way for the migratable to store its own content in the export.
    Note: The output stream will automatically be closed (if not closed already) wwhen the output stream for another entry is retrieved, when calling ExportMigrationEntry.store() on another entry, or when the export operation completes regardless of outcome for the associated migratable.
    Note: Storing an entry via the output stream returned by this method will automatically mark the entry as a file even though on disk it might have represented a directory.
    
    Specified by:
    
    getOutputStream in interface ExportMigrationEntry
    
    Returns:
    
    an output stream for this entry
    
    Throws:
    
    IOException - if an I/O error has occurred
  - store
```
public boolean store(boolean required)
```
    Description copied from interface: ExportMigrationEntry
    Stores this entry's content in the export 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 exported.
    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 store() twice will not store the entry twice. The second time it is called, the same result will be returned as the first time no matter which store() method was called.
    Specified by:
    
    store in interface ExportMigrationEntry
    
    Parameters:
    
    required - true if the file or directory is required to exist on disk and if it doesn't an error should be recorded; false if the file or directory is optional and may not be present 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
  - store
```
public boolean store(boolean required,
                     PathMatcher filter)
```
    Description copied from interface: ExportMigrationEntry
    Stores all files that recursively match the provided path filter in the export based on this entry's path which can include sub-directories. If this entry represents a file that doesn't match the provided path filter then nothing will be exported and the entry will be considered as non-existent when the required parameter is interpreted for recording errors and deciding what to return.
    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 store() twice will not store the entry twice. The second time it is called, the same result will be returned as the first time no matter which store() method was called.
    Specified by:
    
    store in interface ExportMigrationEntry
    
    Parameters:
    
    required - true if the file or directory is required to exist on disk and if it doesn't an error should be recorded; false if the file or directory is optional and may not be present 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
  - store
```
public boolean store(BiThrowingConsumer<MigrationReport,OutputStream,IOException> consumer)
```
    Description copied from interface: ExportMigrationEntry
    Stores this entry's content in the export using the specified consumer based on this entry's path which can include sub-directories.
    All errors and warnings are automatically recorded with the associated migration report including those thrown by the consumer's 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 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: The output stream will automatically be closed (if not closed already) when the output stream for another entry is retrieved, when calling ExportMigrationEntry.store() on another entry, or when the export operation completes regardless of outcome for the associated migratable.
    Note: Calling store() twice will not store the entry twice. The second time it is called, the same result will be returned as the first time no matter which store() method was called.
    Note: Storing an entry in this fashion will automatically mark the entry as a file even though on disk it might have represented a directory.
    Specified by:
    
    store in interface ExportMigrationEntry
    
    Parameters:
    
    consumer - a consumer capable of exporting the content of this entry to a provided output stream
    
    Returns:
    
    true if no errors were recorded as a result of processing this command; false otherwise
  - getPropertyReferencedEntry
```
public Optional<ExportMigrationEntry> getPropertyReferencedEntry(String name)
```
    Description copied from interface: ExportMigrationEntry
    Creates or retrieves (if already created) a migration entry referenced from the specified property in the properties file associated with this migration entry to be exported by the corresponding migratable.
    An error will be automatically recorded with the associated migration report if the property is not defined in the property file referenced by this entry or its value is blank.
    Note: The file referenced from the property is assumed to be relative to ${ddf.home} if not defined as absolute. All paths will automatically be relativized from ${ddf.home} if located underneath.
    The entry returned would be an entry representing the file that is referenced by the specified property value in the java properties file represented by this entry on the local system. For example:
    If the properties file (e.g. etc/ws-security/server/encryption.properties) represented by this entry defines the following mapping: org.apache.ws.security.crypto.merlin.x509crl.file=etc/certs/demoCA/crl/crl.pem
    then the following code:
```
     final ExportMigrationEntry entry
         = context.getEntry("etc/ws-security/server/encryption.properties");

     final Optional<ExportMigrationEntry> entry2
         = entry.getPropertyReferenceEntry("org.apache.ws.security.crypto.merlin.x509crl.file");
 
```
    would return an entry representing the local file etc/certs/demoCA/crl/crl.pem giving the migratable a chance to export it alongside the original property value so it can be later restored and the property value can be verified after the import operation such that it would still be defined with the same value in the local etc/ws-security/server/encryption.properties file.
    Specified by:
    
    getPropertyReferencedEntry in interface ExportMigrationEntry
    
    Parameters:
    
    name - the name of the property in the corresponding java properties file referencing a migration entry to create or retrieve
    
    Returns:
    
    a new migration entry or the existing one if already created for the migration entry referenced from the specified property value or empty if the property is not defined or its value is blank
  - getPropertyReferencedEntry
```
public Optional<ExportMigrationEntry> getPropertyReferencedEntry(String pname,
                                                                 BiPredicate<MigrationReport,String> validator)
```
    Description copied from interface: ExportMigrationEntry
    Creates or retrieves (if already created) a migration entry referenced from the specified property in the properties file associated with this migration entry to be exported by the corresponding migratable.
    The provided predicate is always invoked (as long as the entry was not previously created) to validate the property value which may be null if not defined. Returning false will abort the process and yield an Optional.empty() being returned out of this method. In such case, it is up to the validator to record any required errors or warnings. Returning true from the predicate will allow for a new entry to be created for the corresponding system property unless the property is not defined or its value is blank in which case an error will be recorded and an Optional.empty() is returned from this method. In other words:
    1. If the predicate returns false, no migration entry is created and no error is recorded.
    2. If the predicate returns true and ...
      
      If the property is not defined or its value is blank, no migration entry is created and an error is recorded
      Otherwise, a new migration entry is created and returned
    Note: The file referenced from the property is assumed to be relative to ${ddf.home} if not defined as absolute. All paths will automatically be relativized from ${ddf.home} if located underneath.
    The entry returned would be an entry representing the file that is referenced by the specified property value in the java properties file represented by this entry on the local system. For example:
    If the properties file (e.g. etc/ws-security/server/encryption.properties) represented by this entry defines the following mapping: org.apache.ws.security.crypto.merlin.x509crl.file=etc/certs/demoCA/crl/crl.pem
    then the following code:
```
     final ExportMigrationEntry entry
         = context.getEntry("etc/ws-security/server/encryption.properties");

     final Optional<ExportMigrationEntry> entry2
         = entry.getPropertyReferenceEntry("org.apache.ws.security.crypto.merlin.x509crl.file");
 
```
    would return an entry representing the local file etc/certs/demoCA/crl/crl.pem allowing the migratable a chance to export it alongside the original property value so it can be later restored and the property value can be verified after the import operation such that it would still be defined with the same value in the local etc/ws-security/server/encryption.properties file.
    Specified by:
    
    getPropertyReferencedEntry in interface ExportMigrationEntry
    
    Parameters:
    
    pname - the name of the property in the corresponding java properties file referencing a migration entry to create or retrieve
    
    validator - a predicate to be invoked to validate the property value further which must return true to have a migration entry created
    
    Returns:
    
    a new migration entry or the existing one if already created for the referenced file from the specified property value or empty if the property is not defined, is blank or is invalid
  - getContext
```
protected ExportMigrationContextImpl getContext()
```
    Specified by:
    
    getContext in class MigrationEntryImpl
  - getAbsolutePath
```
protected Path getAbsolutePath()
```
  - getFile
```
protected File getFile()
```
  - recordEntry
```
protected void recordEntry()
```
    Called to record that this entry is being processed.
  - toDebugString
```
protected String toDebugString()
```
    Gets a debug string to represent this entry.
    
    Returns:
    
    a debug string for this entry
  - newWarning
```
protected MigrationWarning newWarning(String reason)
```
  - newError
```
protected MigrationException newError(String reason,
                                      Object cause)
```
  - 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

Class ExportMigrationEntryImpl

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

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

Methods inherited from interface java.lang.Comparable

Field Detail

stored

Constructor Detail

ExportMigrationEntryImpl

ExportMigrationEntryImpl

Method Detail

getReport

getName

getPath

isDirectory

isFile

getLastModifiedTime

getOutputStream

store

store

store

getPropertyReferencedEntry

getPropertyReferencedEntry

getContext

getAbsolutePath

getFile

recordEntry

toDebugString

newWarning

newError

equals

hashCode