Package org.webkitgtk

Class URISchemeRequest

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.webkitgtk.URISchemeRequest

All Implemented Interfaces:

Proxy

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

Represents a URI scheme request.

If you register a particular URI scheme in a WebKitWebContext, using webkit_web_context_register_uri_scheme(), you have to provide a WebKitURISchemeRequestCallback. After that, when a URI request is made with that particular scheme, your callback will be called. There you will be able to access properties such as the scheme, the URI and path, and the WebKitWebView that initiated the request, and also finish the request with webkit_uri_scheme_request_finish().

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected URISchemeRequest	asParent()	Returns this instance as if it were its parent type.
static URISchemeRequest.Builder<? extends URISchemeRequest.Builder>	builder()	A URISchemeRequest.Builder object constructs a URISchemeRequest with the specified properties.
void	finish(InputStream stream, long streamLength, @Nullable String contentType)	Finish a WebKitURISchemeRequest by setting the contents of the request and its mime type.
void	finishError(GError error)	Finish a WebKitURISchemeRequest with a GError.
void	finishWithResponse(URISchemeResponse response)	Finish a WebKitURISchemeRequest by returning a WebKitURISchemeResponse
InputStream	getHttpBody()	Get the request body.
MessageHeaders	getHttpHeaders()	Get the SoupMessageHeaders of the request.
String	getHttpMethod()	Get the HTTP method of the request.
String	getPath()	Get the URI path of request.
String	getScheme()	Get the URI scheme of request.
static @Nullable Type	getType()	Get the GType of the URISchemeRequest class
String	getUri()	Get the URI of request.
WebView	getWebView()	Get the WebKitWebView that initiated the request.

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

URISchemeRequest

public URISchemeRequest(MemorySegment address)

Create a URISchemeRequest proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

URISchemeRequest

public URISchemeRequest()

Creates a new URISchemeRequest.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the URISchemeRequest class

Returns:

the GType

asParent

protected URISchemeRequest 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

finish

public void finish(InputStream stream,
 long streamLength,
 @Nullable String contentType)

Finish a WebKitURISchemeRequest by setting the contents of the request and its mime type.

Parameters:

stream - a GInputStream to read the contents of the request

streamLength - the length of the stream or -1 if not known

contentType - the content type of the stream or null if not known

finishError

public void finishError(GError error)

Finish a WebKitURISchemeRequest with a GError.

Parameters:

error - a GError that will be passed to the WebKitWebView

Since:

2.2

finishWithResponse

public void finishWithResponse(URISchemeResponse response)

Finish a WebKitURISchemeRequest by returning a WebKitURISchemeResponse

Parameters:

response - a WebKitURISchemeResponse

Since:

2.36

getHttpBody

public InputStream getHttpBody()

Get the request body.

Returns:

(nullable): the body of the request.

Since:

2.40

getHttpHeaders

public MessageHeaders getHttpHeaders()

Get the SoupMessageHeaders of the request.

Returns:

the SoupMessageHeaders of the request.

Since:

2.36

getHttpMethod

public String getHttpMethod()

Get the HTTP method of the request.

Returns:

the HTTP method of the this URISchemeRequest

Since:

2.36

getPath

public String getPath()

Get the URI path of request.

Returns:

the URI path of this URISchemeRequest

getScheme

public String getScheme()

Get the URI scheme of request.

Returns:

the URI scheme of this URISchemeRequest

getUri

public String getUri()

Get the URI of request.

Returns:

the full URI of this URISchemeRequest

getWebView

public WebView getWebView()

Get the WebKitWebView that initiated the request.

Returns:

the WebKitWebView that initiated request.

builder

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

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

Returns:

the builder object