Package org.eclipse.jetty.client.util

Class OutputStreamContentProvider

java.lang.Object

org.eclipse.jetty.client.util.OutputStreamContentProvider

All Implemented Interfaces:

Closeable, AutoCloseable, Iterable<ByteBuffer>, ContentProvider, AsyncContentProvider, Callback, Invocable

@Deprecated(since="2021-05-27")
public class OutputStreamContentProvider
extends Object
implements AsyncContentProvider, Callback, Closeable

Deprecated.

The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.

A ContentProvider that provides content asynchronously through an OutputStream similar to DeferredContentProvider.

OutputStreamContentProvider can only be used in conjunction with Request.send(Response.CompleteListener) (and not with its blocking counterpart Request.send()) because it provides content asynchronously.

The deferred content is provided once by writing to the output stream and then fully consumed. Invocations to the iterator() method after the first will return an "empty" iterator because the stream has been consumed on the first invocation. However, it is possible for subclasses to support multiple invocations of iterator() by overriding write(ByteBuffer) and close(), copying the bytes and making them available for subsequent invocations.

Content must be provided by writing to the output stream, that must be closed when all content has been provided.

Example usage:

  HttpClient httpClient = ...;

  // Use try-with-resources to autoclose the output stream
  OutputStreamContentProvider content = new OutputStreamContentProvider();
  try (OutputStream output = content.getOutputStream())
  {
      httpClient.newRequest("localhost", 8080)
              .content(content)
              .send(new Response.CompleteListener()
              {
                  @Override
                  public void onComplete(Result result)
                  {
                      // Your logic here
                  }
              });

      // At a later time...
      output.write("some content".getBytes());
  }
  

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.AsyncContentProvider

AsyncContentProvider.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Callback

Callback.Completable, Callback.Completing, Callback.InvocableCallback, Callback.Nested

Nested classes/interfaces inherited from interface org.eclipse.jetty.client.api.ContentProvider

ContentProvider.Typed

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

Invocable.InvocationType

Field Summary

Fields inherited from interface org.eclipse.jetty.util.Callback

NOOP

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking

Constructor Summary

Constructors

Constructor	Description
OutputStreamContentProvider()	Deprecated.

Method Summary

Modifier and Type	Method	Description
void	close()	Deprecated.
void	failed(Throwable failure)	Deprecated. Callback invoked when the operation fails.
Invocable.InvocationType	getInvocationType()	Deprecated.
long	getLength()	Deprecated.
OutputStream	getOutputStream()	Deprecated.
Iterator<ByteBuffer>	iterator()	Deprecated.
void	setListener(AsyncContentProvider.Listener listener)	Deprecated.
void	succeeded()	Deprecated. Callback invoked when the operation completes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.client.api.ContentProvider

isReproducible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

OutputStreamContentProvider

public OutputStreamContentProvider()

Deprecated.

Method Detail

getInvocationType

public Invocable.InvocationType getInvocationType()

Deprecated.

Specified by:

getInvocationType in interface Invocable

Returns:

The InvocationType of this object

getLength

public long getLength()

Deprecated.

Specified by:

getLength in interface ContentProvider

Returns:

the content length, if known, or -1 if the content length is unknown

iterator

public Iterator<ByteBuffer> iterator()

Deprecated.

Specified by:

iterator in interface Iterable<ByteBuffer>

setListener

public void setListener(AsyncContentProvider.Listener listener)

Deprecated.

Specified by:

setListener in interface AsyncContentProvider

Parameters:

listener - the listener to be notified of content availability

getOutputStream

public OutputStream getOutputStream()

Deprecated.

close

public void close()

Deprecated.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

succeeded

public void succeeded()

Deprecated.

Description copied from interface: Callback

Callback invoked when the operation completes.

Specified by:

succeeded in interface Callback

See Also:

Callback.failed(Throwable)

failed

public void failed(Throwable failure)

Deprecated.

Description copied from interface: Callback

Callback invoked when the operation fails.

Specified by:

failed in interface Callback

Parameters:

failure - the reason for the operation failure