Package org.gnome.soup

Class MultipartInputStream

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gio.InputStream

org.gnome.gio.FilterInputStream

org.gnome.soup.MultipartInputStream

All Implemented Interfaces:

AutoCloseable, PollableInputStream, Proxy, AutoCloseable

@Generated("io.github.jwharm.JavaGI")
public final class MultipartInputStream
extends FilterInputStream
implements PollableInputStream

Handles streams of multipart messages.

This adds support for the multipart responses. For handling the multiple parts the user needs to wrap the InputStream obtained by sending the request with a MultipartInputStream and use nextPart(org.gnome.gio.Cancellable) before reading. Responses which are not wrapped will be treated like non-multipart responses.

Note that although SoupMultipartInputStream is a InputStream, you should not read directly from it, and the results are undefined if you do.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MultipartInputStream.Builder<B extends MultipartInputStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	MultipartInputStream.MultipartInputStreamClass

Nested classes/interfaces inherited from class org.gnome.gio.FilterInputStream

FilterInputStream.FilterInputStream$Impl, FilterInputStream.FilterInputStreamClass

Nested classes/interfaces inherited from class org.gnome.gio.InputStream

InputStream.InputStream$Impl, InputStream.InputStreamClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.gio.PollableInputStream

PollableInputStream.PollableInputStream$Impl, PollableInputStream.PollableInputStreamInterface

Constructor Summary

Constructors

Constructor	Description
MultipartInputStream()	Creates a new MultipartInputStream.
MultipartInputStream(MemorySegment address)	Create a MultipartInputStream proxy instance for the provided memory address.
MultipartInputStream(Message msg, InputStream baseStream)	Creates a new SoupMultipartInputStream that wraps the InputStream obtained by sending the Message.

Method Summary

Modifier and Type	Method	Description
protected MultipartInputStream	asParent()	Returns this instance as if it were its parent type.
static MultipartInputStream.Builder<? extends MultipartInputStream.Builder>	builder()	A MultipartInputStream.Builder object constructs a MultipartInputStream with the specified properties.
@Nullable MessageHeaders	getHeaders()	Obtains the headers for the part currently being processed.
static @Nullable Type	getType()	Get the GType of the MultipartInputStream class
@Nullable InputStream	nextPart(@Nullable Cancellable cancellable)	Obtains an input stream for the next part.
void	nextPartAsync(int ioPriority, @Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Obtains a InputStream for the next request.
@Nullable InputStream	nextPartFinish(AsyncResult result)	Finishes an asynchronous request for the next part.

Methods inherited from class org.gnome.gio.FilterInputStream

getBaseStream, getCloseBaseStream, getMemoryLayout, setCloseBaseStream

Methods inherited from class org.gnome.gio.InputStream

clearPending, close, closeAsync, closeFinish, closeFn, hasPending, isClosed, read, readAll, readAllAsync, readAllFinish, readAsync, readBytes, readBytesAsync, readBytesFinish, readFinish, readFn, setPending, skip, skipAsync, skipFinish

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.javagi.gio.AutoCloseable

close

Methods inherited from interface org.gnome.gio.PollableInputStream

canPoll, createSource, isReadable, readNonblocking

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

MultipartInputStream

public MultipartInputStream(MemorySegment address)

Create a MultipartInputStream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

MultipartInputStream

public MultipartInputStream(Message msg,
 InputStream baseStream)

Creates a new SoupMultipartInputStream that wraps the InputStream obtained by sending the Message.

Reads should not be done directly through this object, use the input streams returned by nextPart(org.gnome.gio.Cancellable) or its async counterpart instead.

Parameters:

msg - the SoupMessage the response is related to.

baseStream - the GInputStream returned by sending the request.

MultipartInputStream

public MultipartInputStream()

Creates a new MultipartInputStream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the MultipartInputStream class

Returns:

the GType

asParent

protected MultipartInputStream asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class FilterInputStream

getHeaders

public @Nullable MessageHeaders getHeaders()

Obtains the headers for the part currently being processed.

Note that the MessageHeaders that are returned are owned by the SoupMultipartInputStream and will be replaced when a call is made to nextPart(org.gnome.gio.Cancellable) or its async counterpart, so if keeping the headers is required, a copy must be made.

Note that if a part had no headers at all an empty MessageHeaders will be returned.

Returns:

a SoupMessageHeaders containing the headers for the part currently being processed or null if the headers failed to parse.

nextPart

public @Nullable InputStream nextPart(@Nullable Cancellable cancellable)
                               throws GErrorException

Obtains an input stream for the next part.

When dealing with a multipart response the input stream needs to be wrapped in a SoupMultipartInputStream and this function or its async counterpart need to be called to obtain the first part for reading.

After calling this function, getHeaders() can be used to obtain the headers for the first part. A read of 0 bytes indicates the end of the part; a new call to this function should be done at that point, to obtain the next part.

error will only be set if an error happens during a read, null is a valid return value otherwise.

Parameters:

cancellable - a GCancellable

Returns:

a new GInputStream, or null if there are no more parts

Throws:

GErrorException - see GError

nextPartAsync

public void nextPartAsync(int ioPriority,
 @Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Obtains a InputStream for the next request.

See nextPart(org.gnome.gio.Cancellable) for details on the workflow.

Parameters:

ioPriority - the I/O priority for the request.

cancellable - a GCancellable.

callback - callback to call when request is satisfied.

nextPartFinish

public @Nullable InputStream nextPartFinish(AsyncResult result)
                                     throws GErrorException

Finishes an asynchronous request for the next part.

Parameters:

result - a GAsyncResult.

Returns:

a newly created InputStream for reading the next part or null if there are no more parts.

Throws:

GErrorException - see GError

builder

public static MultipartInputStream.Builder<? extends MultipartInputStream.Builder> builder()

A MultipartInputStream.Builder object constructs a MultipartInputStream with the specified properties. Use the various set...() methods to set properties, and finish construction with MultipartInputStream.Builder.build().

Returns:

the builder object