org.codice.ddf.configuration.migration

Class MigrationReportImpl

java.lang.Object

org.codice.ddf.configuration.migration.MigrationReportImpl

All Implemented Interfaces:

MigrationReport

public class MigrationReportImpl
extends Object
implements MigrationReport

The migration report provides ways to aggregate warnings and errors related to migration operations.

Constructor Summary

Constructors

Constructor and Description
MigrationReportImpl(MigrationOperation operation, Optional<Consumer<MigrationMessage>> consumer) Creates a new migration report.

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.
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.
Stream<MigrationMessage>	messages() Retrieves all messages recorded by the operation that generated this migration report.
MigrationReportImpl	record(MigrationMessage msg) Records a message that occurred during the migration report.
void	verifyCompletion() Verifies if the operation that generated this migration report completed successfully.
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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

errors, infos, record, record, warnings

Constructor Detail

MigrationReportImpl

public MigrationReportImpl(MigrationOperation operation,
                           Optional<Consumer<MigrationMessage>> consumer)

Creates a new migration report.

Parameters:

operation - the type of migration operation for this report

consumer - an optional consumer to call whenever a new migration message is recorded during the operation

Throws:

IllegalArgumentException - if operation is null

Method Detail

getOperation

public MigrationOperation getOperation()

Description copied from interface: MigrationReport

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

Specified by:

getOperation in interface MigrationReport

Returns:

the type of migration operation this report is associated with

getStartTime

public Instant getStartTime()

Description copied from interface: MigrationReport

Gets the time the corresponding migration operation started.

Specified by:

getStartTime in interface MigrationReport

Returns:

the time the report migration operation started

getEndTime

public Optional<Instant> getEndTime()

Description copied from interface: MigrationReport

Gets the time the corresponding migration operation ended.

Specified by:

getEndTime in interface MigrationReport

Returns:

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

record

public MigrationReportImpl record(MigrationMessage msg)

Description copied from interface: MigrationReport

Records a message that occurred during the migration report.

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

Specified by:

record in interface MigrationReport

Parameters:

msg - the message to record

Returns:

this for chaining

doAfterCompletion

public MigrationReport doAfterCompletion(Consumer<MigrationReport> code)

Description copied from interface: MigrationReport

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.

Specified by:

doAfterCompletion in interface MigrationReport

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

messages

public Stream<MigrationMessage> messages()

Description copied from interface: MigrationReport

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

Specified by:

messages in interface MigrationReport

Returns:

a stream of all recorded messages (may be empty)

wasSuccessful

public boolean wasSuccessful()

Description copied from interface: MigrationReport

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

Note: A successful operation might still report warnings.

Specified by:

wasSuccessful in interface MigrationReport

Returns:

true if the operation was successfull; false if not

wasSuccessful

public boolean wasSuccessful(Runnable code)

Description copied from interface: MigrationReport

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.

Specified by:

wasSuccessful in interface MigrationReport

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

public boolean wasIOSuccessful(ThrowingRunnable<IOException> code)
                        throws IOException

Description copied from interface: MigrationReport

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.

Specified by:

wasIOSuccessful in interface MigrationReport

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

public boolean hasInfos()

Description copied from interface: MigrationReport

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

Specified by:

hasInfos in interface MigrationReport

Returns:

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

hasWarnings

public boolean hasWarnings()

Description copied from interface: MigrationReport

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

Specified by:

hasWarnings in interface MigrationReport

Returns:

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

hasErrors

public boolean hasErrors()

Description copied from interface: MigrationReport

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

Specified by:

hasErrors in interface MigrationReport

Returns:

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

verifyCompletion

public void verifyCompletion()

Description copied from interface: MigrationReport

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()).

Specified by:

verifyCompletion in interface MigrationReport