Package org.gnome.soup

Class ServerMessage.Builder<B extends ServerMessage.Builder<B>>

java.lang.Object

io.github.jwharm.javagi.gobject.Builder<B>

org.gnome.gobject.GObject.Builder<B>

org.gnome.soup.ServerMessage.Builder<B>

Type Parameters:

B - the type of the Builder that is returned

All Implemented Interfaces:

BuilderInterface

Enclosing class:

ServerMessage

public static class ServerMessage.Builder<B extends ServerMessage.Builder<B>>
extends GObject.Builder<B>

Inner class implementing a builder pattern to construct a GObject with properties.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()	Default constructor for a Builder object.

Method Summary

Modifier and Type	Method	Description
ServerMessage	build()	Finish building the ServerMessage object.
B	onAcceptCertificate(ServerMessage.AcceptCertificateCallback handler)	Emitted during the msg's connection TLS handshake after client TLS certificate has been received.
B	onConnected(ServerMessage.ConnectedCallback handler)	Emitted when the msg's socket is connected and the TLS handshake completed.
B	onDisconnected(ServerMessage.DisconnectedCallback handler)	Emitted when the msg's socket is disconnected.
B	onFinished(ServerMessage.FinishedCallback handler)	Emitted when all HTTP processing is finished for a message.
B	onGotBody(ServerMessage.GotBodyCallback handler)	Emitted after receiving the complete request body.
B	onGotChunk(ServerMessage.GotChunkCallback handler)	Emitted after receiving a chunk of a message body.
B	onGotHeaders(ServerMessage.GotHeadersCallback handler)	Emitted after receiving the Request-Line and request headers.
B	onWroteBody(ServerMessage.WroteBodyCallback handler)	Emitted immediately after writing the complete response body for a message.
B	onWroteBodyData(ServerMessage.WroteBodyDataCallback handler)	Emitted immediately after writing a portion of the message body to the network.
B	onWroteChunk(ServerMessage.WroteChunkCallback handler)	Emitted immediately after writing a body chunk for a message.
B	onWroteHeaders(ServerMessage.WroteHeadersCallback handler)	Emitted immediately after writing the response headers for a message.
B	onWroteInformational(ServerMessage.WroteInformationalCallback handler)	Emitted immediately after writing a 1xx (Informational) response.

Methods inherited from class org.gnome.gobject.GObject.Builder

onNotify

Methods inherited from class io.github.jwharm.javagi.gobject.Builder

addBuilderProperty, connect, connect, connectSignals, getArena, getNames, getValues

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Default constructor for a Builder object.

Method Details

build

public ServerMessage build()
                    throws UnsupportedPlatformException

Finish building the ServerMessage object. This will call GObject.withProperties(org.gnome.glib.Type, java.lang.String[], org.gnome.gobject.Value[]) to create a new GObject instance, which is then cast to ServerMessage.

Overrides:

build in class GObject.Builder<B extends ServerMessage.Builder<B>>

Returns:

a new instance of ServerMessage with the properties that were set in the Builder object.

Throws:

UnsupportedPlatformException - when run on an unsupported platform

onAcceptCertificate

public B onAcceptCertificate(ServerMessage.AcceptCertificateCallback handler)

Emitted during the msg's connection TLS handshake after client TLS certificate has been received. You can return true to accept tlsCertificate despite tlsErrors.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.AcceptCertificateCallback.run(org.gnome.gio.TlsCertificate, java.util.Set<org.gnome.gio.TlsCertificateFlags>)

onConnected

public B onConnected(ServerMessage.ConnectedCallback handler)

Emitted when the msg's socket is connected and the TLS handshake completed.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.ConnectedCallback.run()

onDisconnected

public B onDisconnected(ServerMessage.DisconnectedCallback handler)

Emitted when the msg's socket is disconnected.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.DisconnectedCallback.run()

onFinished

public B onFinished(ServerMessage.FinishedCallback handler)

Emitted when all HTTP processing is finished for a message. (After ServerMessage::wrote-body).

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.FinishedCallback.run()

onGotBody

public B onGotBody(ServerMessage.GotBodyCallback handler)

Emitted after receiving the complete request body.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.GotBodyCallback.run()

onGotChunk

public B onGotChunk(ServerMessage.GotChunkCallback handler)

Emitted after receiving a chunk of a message body.

Note that "chunk" in this context means any subpiece of the body, not necessarily the specific HTTP 1.1 chunks sent by the other side.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.GotChunkCallback.run(org.gnome.glib.Bytes)

onGotHeaders

public B onGotHeaders(ServerMessage.GotHeadersCallback handler)

Emitted after receiving the Request-Line and request headers.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.GotHeadersCallback.run()

onWroteBody

public B onWroteBody(ServerMessage.WroteBodyCallback handler)

Emitted immediately after writing the complete response body for a message.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.WroteBodyCallback.run()

onWroteBodyData

public B onWroteBodyData(ServerMessage.WroteBodyDataCallback handler)

Emitted immediately after writing a portion of the message body to the network.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.WroteBodyDataCallback.run(int)

onWroteChunk

public B onWroteChunk(ServerMessage.WroteChunkCallback handler)

Emitted immediately after writing a body chunk for a message.

Note that this signal is not parallel to ServerMessage::got-chunk; it is emitted only when a complete chunk (added with MessageBody.append(byte[]) or MessageBody.appendBytes(org.gnome.glib.Bytes) has been written. To get more useful continuous progress information, use ServerMessage::wrote-body-data.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.WroteChunkCallback.run()

onWroteHeaders

public B onWroteHeaders(ServerMessage.WroteHeadersCallback handler)

Emitted immediately after writing the response headers for a message.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.WroteHeadersCallback.run()

onWroteInformational

public B onWroteInformational(ServerMessage.WroteInformationalCallback handler)

Emitted immediately after writing a 1xx (Informational) response.

Parameters:

handler - the signal handler

Returns:

the Builder instance is returned, to allow method chaining

See Also:

• ServerMessage.WroteInformationalCallback.run()