public abstract class UploadDataSink
extends Object



Defines callbacks methods for UploadDataProvider. All methods may be called synchronously or asynchronously, on any thread.

Summary

Public constructors

UploadDataSink()

Public methods

abstract void onReadError(Exception exception)

Called by UploadDataProvider when a read fails.

abstract void onReadSucceeded(boolean finalChunk)

Called by UploadDataProvider when a read succeeds.

abstract void onRewindError(Exception exception)

Called by UploadDataProvider when a rewind fails, or if rewinding uploads is not supported.

abstract void onRewindSucceeded()

Called by UploadDataProvider when a rewind succeeds.

Inherited methods

From class java.lang.Object

Object clone()

Creates and returns a copy of this object.

boolean equals(Object obj)

Indicates whether some other object is "equal to" this one.

void finalize()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.

final Class<?> getClass()

Returns the runtime class of this Object.

int hashCode()

Returns a hash code value for the object.

final void notify()

Wakes up a single thread that is waiting on this object's monitor.

final void notifyAll()

Wakes up all threads that are waiting on this object's monitor.

String toString()

Returns a string representation of the object.

final void wait(long timeoutMillis, int nanos)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait(long timeoutMillis)

Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

final void wait()

Causes the current thread to wait until it is awakened, typically by being notified or interrupted.

Public constructors

UploadDataSink

public UploadDataSink ()

Public methods

onReadError

public abstract void onReadError (Exception exception)

Called by UploadDataProvider when a read fails.

Parameters
exception Exception: Exception passed on to the embedder.
This value cannot be null.

onReadSucceeded

public abstract void onReadSucceeded (boolean finalChunk)

Called by UploadDataProvider when a read succeeds.

Parameters
finalChunk boolean: For chunked uploads, true if this is the final read. It must be false for non-chunked uploads.

onRewindError

public abstract void onRewindError (Exception exception)

Called by UploadDataProvider when a rewind fails, or if rewinding uploads is not supported.

Parameters
exception Exception: Exception passed on to the embedder.
This value cannot be null.

onRewindSucceeded

public abstract void onRewindSucceeded ()

Called by UploadDataProvider when a rewind succeeds.

Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.

Last updated 2026-02-13 UTC.