Package io.bdeploy.common

Interface ActivityReporter

All Known Implementing Classes:

ActivityReporter.Delegating, ActivityReporter.Null, ActivityReporter.Stream, JerseyBroadcastingActivityReporter

public interface ActivityReporter

Allows reporting and tracking of activities.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ActivityReporter.Activity	An Activity allows updating progress and signaling when the ActivityReporter.Activity is finished.
static class	ActivityReporter.ActivityCancelledException	Exception to be thrown when an activity has been cancelled from outside.
static class	ActivityReporter.Delegating	Delegator ActivityReporter which can change destination lazily once a proper instance is available (after server startup, ...).
static class	ActivityReporter.Null	No-op ActivityReporter, which does nothing, except being null.
static final class	ActivityReporter.Stream	An ActivityReporter implementation which reports progress to a given PrintStream.

Method Summary

Modifier and Type	Method	Description
NoThrowAutoCloseable	proxyActivities(RemoteService service)	Proxy remote activities to this ActivityReporter implementation if possible.
ActivityReporter.Activity	start(String activity)	Start an ActivityReporter.Activity without any associated work amount.
ActivityReporter.Activity	start(String activity, long maxWork)	Start an ActivityReporter.Activity with a static work amount.
ActivityReporter.Activity	start(String activity, LongSupplier maxValue, LongSupplier currentValue)	Start an ActivityReporter.Activity with a dynamic maximum and current work amount.

Method Details

start

ActivityReporter.Activity start(String activity)

Start an ActivityReporter.Activity without any associated work amount.

start

ActivityReporter.Activity start(String activity,
 long maxWork)

Start an ActivityReporter.Activity with a static work amount. Use ActivityReporter.Activity.worked(long) to updated the already consumed work amount.

Special maxWork values:

• -1: don't report work at all. only time will be reported
• 0: don't report any maximum, just report current amount if possible.

start

ActivityReporter.Activity start(String activity,
 LongSupplier maxValue,
 LongSupplier currentValue)

Start an ActivityReporter.Activity with a dynamic maximum and current work amount. The Suppliers are queried periodically when reporting progress, to catch updates on the values.

proxyActivities

NoThrowAutoCloseable proxyActivities(RemoteService service)

Proxy remote activities to this ActivityReporter implementation if possible.