| com.atlassian.bitbucket.scm.mirror.MirrorSyncCallback |
Describes a callback for receiving streaming ref changes.
Implementations of this callback performing internal paging may return false from
onRefChange(RefChange) to indicate no more ref changes are desired. Such implementations are
encouraged to also implement the PagedCallback interface to
allow the system to optimise output handling, where possible, based on the page being requested.
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Called after the final
ref change has been streamed. | |||||||||||
Called when a ref failed to synchronize.
| |||||||||||
Provides a
ref change to the callback for processing. | |||||||||||
Called before the first
ref change is streamed. | |||||||||||
Called after the final ref change has been streamed.
Note: If there were no ref changes, this method may be called immediately after onStart(MirrorSyncContext)
without any calls to onRefChange(RefChange).
| summary | summarizes the request and the streamed changes |
|---|
| IOException | May be thrown by implementations which perform I/O. |
|---|
Called when a ref failed to synchronize.
If the callback is performing internal paging, it may signal the end of the page by returning false here.
| ref | the ref that failed |
|---|
true if additional ref changes should be provided; otherwise, false if the callback has
received as many ref changes as desired| IOException | |
| IOException |
Provides a ref change to the callback for processing.
If the callback is performing internal paging, it may signal the end of the page by returning false here.
| refChange | the ref change to process |
|---|
true if additional ref changes should be provided; otherwise, false if the callback has
received as many ref changes as desired| IOException | may be thrown by implementations which perform I/O |
|---|
Called before the first ref change is streamed.
| context | provides details about the request for which ref changes are being streamed |
|---|
| IOException | May be thrown by implementations which perform I/O. |
|---|