com.atlassian.bitbucket.scm

Interface PushCallback

public interface PushCallback

Describes a callback for receiving streaming ref changes.

Implementations of this callback performing internal paging may return false from onRefChange(com.atlassian.bitbucket.repository.MinimalRefChange) to indicate no more ref changes are desired.

Since:

7.11

Method Summary

Modifier and Type	Method and Description
default void	onEnd(PushSummary summary) Called after the final ref change has been streamed.
default void	onFailedRef(MinimalRef ref) Called when a ref failed to synchronize.
default void	onProgress(Progress progress) Called when there is a progress update for the operation.
default void	onRefChange(MinimalRefChange refChange) Provides a ref change to the callback for processing.
default void	onStart(PushContext context) Called before the first ref change is streamed.

Method Detail

onEnd

default void onEnd(@Nonnull
                   PushSummary summary)
            throws IOException

Called after the final ref change has been streamed.

Note: If there were no ref changes, this method may be called immediately after onStart(com.atlassian.bitbucket.scm.PushContext) without any calls to onRefChange(com.atlassian.bitbucket.repository.MinimalRefChange).

Parameters:

summary - summarizes the request and the streamed changes

Throws:

IOException - may be thrown by implementations which perform I/O

onFailedRef

default void onFailedRef(@Nonnull
                         MinimalRef ref)
                  throws IOException

Called when a ref failed to synchronize.

Parameters:

ref - the ref that failed

Throws:

IOException - may be thrown by implementations which perform I/O

onProgress

default void onProgress(@Nonnull
                        Progress progress)
                 throws IOException

Called when there is a progress update for the operation.

Progress messages are taken directly from the output of the SCM and are not localized. Percentages are estimates and are not guaranteed to reach 100 before onEnd(com.atlassian.bitbucket.scm.PushSummary) has been called. Once onEnd(com.atlassian.bitbucket.scm.PushSummary) has been called, the progress should be assumed to be 100% complete.

Parameters:

progress - the message and percentage of the progress

Throws:

IOException - may be thrown by implementations which perform I/O

onRefChange

default void onRefChange(@Nonnull
                         MinimalRefChange refChange)
                  throws IOException

Provides a ref change to the callback for processing.

Parameters:

refChange - the ref change to process

Throws:

IOException - may be thrown by implementations which perform I/O

onStart

default void onStart(@Nonnull
                     PushContext context)
              throws IOException

Called before the first ref change is streamed.

Parameters:

context - provides details about the request for which ref changes are being streamed

Throws:

IOException - may be thrown by implementations which perform I/O