org.codice.ddf.migration

Interface MigrationReport

All Known Implementing Classes:

ExportMigrationReportImpl, MigrationReportImpl

public interface MigrationReport

The migration report provides information about the execution of a migration operation.

This code is experimental. While this interface is functional and tested, it may change or be removed in a future version of the library.

Method Summary

Modifier and Type	Method and Description
MigrationReport	doAfterCompletion(Consumer<MigrationReport> code) Registers code to be invoked at the completion of the migration operation.
default Stream<MigrationException>	errors() Retrieves all errors recorded by the operation that generated this migration report.
Optional<Instant>	getEndTime() Gets the time the corresponding migration operation ended.
MigrationOperation	getOperation() Gets the type of migration operation this report is associated with.
Instant	getStartTime() Gets the time the corresponding migration operation started.
boolean	hasErrors() Checks if the operation that generated this migration recorded any errors.
boolean	hasInfos() Checks if the operation that generated this migration recorded any information messages.
boolean	hasWarnings() Checks if the operation that generated this migration recorded any warnings.
default Stream<MigrationInformation>	infos() Retrieves all informational messages recorded by the operation that generated this migration report.
Stream<MigrationMessage>	messages() Retrieves all messages recorded by the operation that generated this migration report.
MigrationReport	record(MigrationMessage msg) Records a message that occurred during the migration report.
default MigrationReport	record(String msg) Records an informational message that occurred during the migration report.
default MigrationReport	record(String format, Object... args) Records an informational message that occurred during the migration report.
void	verifyCompletion() Verifies if the operation that generated this migration report completed successfully.
default Stream<MigrationWarning>	warnings() Retrieves all warnings recorded by the operation that generated this migration report.
boolean	wasIOSuccessful(ThrowingRunnable<IOException> code) Runs the specified code and report whether or not it was successful.
boolean	wasSuccessful() Checks if the operation that generated this migration report was successful or not.
boolean	wasSuccessful(Runnable code) Runs the specified code and report whether or not it was successful.

Method Detail

getOperation

MigrationOperation getOperation()

Gets the type of migration operation this report is associated with.

Returns:

the type of migration operation this report is associated with

getStartTime

Instant getStartTime()

Gets the time the corresponding migration operation started.

Returns:

the time the report migration operation started

getEndTime

Optional<Instant> getEndTime()

Gets the time the corresponding migration operation ended.

Returns:

the time the report migration operation ended or empty if it is still in operation

record

default MigrationReport record(String msg)

Records an informational message that occurred during the migration report.

Note: This is equivalent to record(new MigrationInformation(msg)).

Parameters:

msg - the information message to record

Returns:

this for chaining

Throws:

IllegalArgumentException - if msg is null

record

default MigrationReport record(String format,
                               @Nullable
                               Object... args)

Records an informational message that occurred during the migration report.

Note: This is equivalent to record(new MigrationInformation(format, args)) .

Parameters:

format - the format string for the detail message for the information message to record (see String.format(java.lang.String, java.lang.Object...))

args - the arguments to the format message

Returns:

this for chaining

Throws:

IllegalArgumentException - if format is null

record

MigrationReport record(MigrationMessage msg)

Records a message that occurred during the migration report.

Recorded errors (i.e. MigrationException} will be thrown back when verifyCompletion() is called at the end of the operation.

Parameters:

msg - the message to record

Returns:

this for chaining

Throws:

IllegalArgumentException - if msg is null

doAfterCompletion

MigrationReport doAfterCompletion(Consumer<MigrationReport> code)

Registers code to be invoked at the completion of the migration operation. Registered code is guaranteed to be called a maximum of one time before a successful result is returned.

Parameters:

code - the code to execute which will receive this report in parameter where additional errors and/or warnings can be registered

Returns:

this for chaining

Throws:

IllegalArgumentException - if code is null

messages

Stream<MigrationMessage> messages()

Retrieves all messages recorded by the operation that generated this migration report.

Returns:

a stream of all recorded messages (may be empty)

errors

default Stream<MigrationException> errors()

Retrieves all errors recorded by the operation that generated this migration report.

Returns:

a stream of all recorded errors (may be empty)

warnings

default Stream<MigrationWarning> warnings()

Retrieves all warnings recorded by the operation that generated this migration report.

Returns:

a stream of all recorded warnings (may be empty)

infos

default Stream<MigrationInformation> infos()

Retrieves all informational messages recorded by the operation that generated this migration report.

Returns:

a stream of all recorded info messages (may be empty)

wasSuccessful

boolean wasSuccessful()

Checks if the operation that generated this migration report was successful or not.

Note: A successful operation might still report warnings.

Returns:

true if the operation was successfull; false if not

wasSuccessful

boolean wasSuccessful(@Nullable
                      Runnable code)

Runs the specified code and report whether or not it was successful.

Note: This method will only account for errors generated from the point where the provided code is called to the moment it terminates.

Parameters:

code - the code to run

Returns:

true if no new errors were recorded while running the provided code; false if at least one error was recorded

wasIOSuccessful

boolean wasIOSuccessful(@Nullable
                        ThrowingRunnable<IOException> code)
                 throws IOException

Runs the specified code and report whether or not it was successful.

Note: This method will only account for errors generated from the point where the provided code is called to the moment it terminates.

Parameters:

code - the code to run

Returns:

true if no new errors were recorded while running the provided code; false if at least one error was recorded

Throws:

IOException - if the code executed throws it

hasInfos

boolean hasInfos()

Checks if the operation that generated this migration recorded any information messages.

Returns:

true if the operation recorded at least one informational message; false if not

hasWarnings

boolean hasWarnings()

Checks if the operation that generated this migration recorded any warnings.

Returns:

true if the operation recorded at least one warning; false if not

hasErrors

boolean hasErrors()

Checks if the operation that generated this migration recorded any errors.

Returns:

true if the operation recorded at least one error; false if not

verifyCompletion

void verifyCompletion()

Verifies if the operation that generated this migration report completed successfully.

Note: The first exception recorded will always be thrown out and all additional exceptions recorded will be added to it as suppressed exceptions (see Throwable.getSuppressed()).

Throws:

MigrationException - if at least one error occurred during the operation