Package org.webkitgtk

Class WebResource

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.WebResource

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public final class WebResource
extends GObject

Represents a resource at the end of a URI.

A WebKitWebResource encapsulates content for each resource at the end of a particular URI. For example, one WebKitWebResource will be created for each separate image and stylesheet when a page is loaded.

You can access the response and the URI for a given WebKitWebResource, using webkit_web_resource_get_uri() and webkit_web_resource_get_response(), as well as the raw data, using webkit_web_resource_get_data().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebResource.Builder<B extends WebResource.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	WebResource.FailedCallback	Functional interface declaration of the FailedCallback callback.
static interface	WebResource.FailedWithTlsErrorsCallback	Functional interface declaration of the FailedWithTlsErrorsCallback callback.
static interface	WebResource.FinishedCallback	Functional interface declaration of the FinishedCallback callback.
static interface	WebResource.SentRequestCallback	Functional interface declaration of the SentRequestCallback callback.
static class	WebResource.WebResourceClass

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
WebResource()	Creates a new WebResource.
WebResource(MemorySegment address)	Create a WebResource proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected WebResource	asParent()	Returns this instance as if it were its parent type.
static WebResource.Builder<? extends WebResource.Builder>	builder()	A WebResource.Builder object constructs a WebResource with the specified properties.
void	emitFailed(@Nullable GError error)	Emits the "failed" signal.
void	emitFailedWithTlsErrors(@Nullable TlsCertificate certificate, Set<TlsCertificateFlags> errors)	Emits the "failed-with-tls-errors" signal.
void	emitFinished()	Emits the "finished" signal.
void	emitSentRequest(@Nullable URIRequest request, @Nullable URIResponse redirectedResponse)	Emits the "sent-request" signal.
void	getData(@Nullable Cancellable cancellable, @Nullable AsyncReadyCallback callback)	Asynchronously get the raw data for resource.
byte[]	getDataFinish(AsyncResult result)	Finish an asynchronous operation started with webkit_web_resource_get_data().
URIResponse	getResponse()	Retrieves the WebKitURIResponse of the resource load operation.
static @Nullable Type	getType()	Get the GType of the WebResource class
String	getUri()	Returns the current active URI of resource.
SignalConnection<WebResource.FailedCallback>	onFailed(WebResource.FailedCallback handler)	This signal is emitted when an error occurs during the resource load operation.
SignalConnection<WebResource.FailedWithTlsErrorsCallback>	onFailedWithTlsErrors(WebResource.FailedWithTlsErrorsCallback handler)	This signal is emitted when a TLS error occurs during the resource load operation.
SignalConnection<WebResource.FinishedCallback>	onFinished(WebResource.FinishedCallback handler)	This signal is emitted when the resource load finishes successfully or due to an error.
SignalConnection<WebResource.SentRequestCallback>	onSentRequest(WebResource.SentRequestCallback handler)	This signal is emitted when request has been sent to the server.

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, getMemoryLayout, 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

Constructor Details

WebResource

public WebResource(MemorySegment address)

Create a WebResource proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

WebResource

public WebResource()

Creates a new WebResource.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the WebResource class

Returns:

the GType

asParent

protected WebResource 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 GObject

getData

public void getData(@Nullable Cancellable cancellable,
 @Nullable AsyncReadyCallback callback)

Asynchronously get the raw data for resource.

When the operation is finished, callback will be called. You can then call webkit_web_resource_get_data_finish() to get the result of the operation.

Parameters:

cancellable - a GCancellable or null to ignore

callback - a GAsyncReadyCallback to call when the request is satisfied

getDataFinish

public byte[] getDataFinish(AsyncResult result)
                     throws GErrorException

Finish an asynchronous operation started with webkit_web_resource_get_data().

Parameters:

result - a GAsyncResult

Returns:

a string with the data of resource, or null in case of error. if length is not null, the size of the data will be assigned to it.

Throws:

GErrorException - see GError

getResponse

public URIResponse getResponse()

Retrieves the WebKitURIResponse of the resource load operation.

This method returns null if called before the response is received from the server. You can connect to notify::response signal to be notified when the response is received.

Returns:

the WebKitURIResponse, or null if the response hasn't been received yet.

getUri

public String getUri()

Returns the current active URI of resource.

The active URI might change during a load operation:

<orderedlist> <listitem><para> When the resource load starts, the active URI is the requested URI </para></listitem> <listitem><para> When the initial request is sent to the server, WebKitWebResource::sent-request signal is emitted without a redirected response, the active URI is the URI of the request sent to the server. </para></listitem> <listitem><para> In case of a server redirection, WebKitWebResource::sent-request signal is emitted again with a redirected response, the active URI is the URI the request was redirected to. </para></listitem> <listitem><para> When the response is received from the server, the active URI is the final one and it will not change again. </para></listitem> </orderedlist>

You can monitor the active URI by connecting to the notify::uri signal of resource.

Returns:

the current active URI of this WebResource

onFailed

public SignalConnection<WebResource.FailedCallback> onFailed(WebResource.FailedCallback handler)

This signal is emitted when an error occurs during the resource load operation.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebResource.FailedCallback.run(org.gnome.glib.GError)

emitFailed

public void emitFailed(@Nullable GError error)

Emits the "failed" signal. See onFailed(org.webkitgtk.WebResource.FailedCallback).

onFailedWithTlsErrors

public SignalConnection<WebResource.FailedWithTlsErrorsCallback> onFailedWithTlsErrors(WebResource.FailedWithTlsErrorsCallback handler)

This signal is emitted when a TLS error occurs during the resource load operation.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

2.8

See Also:

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

emitFailedWithTlsErrors

public void emitFailedWithTlsErrors(@Nullable TlsCertificate certificate,
 Set<TlsCertificateFlags> errors)

Emits the "failed-with-tls-errors" signal. See onFailedWithTlsErrors(org.webkitgtk.WebResource.FailedWithTlsErrorsCallback).

onFinished

public SignalConnection<WebResource.FinishedCallback> onFinished(WebResource.FinishedCallback handler)

This signal is emitted when the resource load finishes successfully or due to an error. In case of errors WebKitWebResource::failed signal is emitted before this one.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebResource.FinishedCallback.run()

emitFinished

public void emitFinished()

Emits the "finished" signal. See onFinished(org.webkitgtk.WebResource.FinishedCallback).

onSentRequest

public SignalConnection<WebResource.SentRequestCallback> onSentRequest(WebResource.SentRequestCallback handler)

This signal is emitted when request has been sent to the server. In case of a server redirection this signal is emitted again with the request argument containing the new request sent to the server due to the redirection and the redirectedResponse parameter containing the response received by the server for the initial request.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• WebResource.SentRequestCallback.run(org.webkitgtk.URIRequest, org.webkitgtk.URIResponse)

emitSentRequest

public void emitSentRequest(@Nullable URIRequest request,
 @Nullable URIResponse redirectedResponse)

Emits the "sent-request" signal. See onSentRequest(org.webkitgtk.WebResource.SentRequestCallback).

builder

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

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

Returns:

the builder object