Package org.gnome.webkit

Class SecurityOrigin

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.webkit.SecurityOrigin

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class SecurityOrigin
extends ProxyInstance

A security boundary for websites.

WebKitSecurityOrigin is a representation of a security domain defined by websites. A security origin consists of a protocol, a hostname, and an optional port number.

Resources with the same security origin can generally access each other for client-side scripting or database access. When comparing origins, beware that if both protocol and host are null, the origins should not be treated as equal.

Constructor Summary

Constructors

Constructor	Description
SecurityOrigin(MemorySegment address)	Create a SecurityOrigin proxy instance for the provided memory address.
SecurityOrigin(String protocol, String host, short port)	Create a new security origin from the provided protocol, host and port.

Method Summary

Modifier and Type	Method	Description
static SecurityOrigin	forUri(String uri)	Create a new security origin from the provided.
String	getHost()	Gets the hostname of this SecurityOrigin.
short	getPort()	Gets the port of this SecurityOrigin.
String	getProtocol()	Gets the protocol of this SecurityOrigin.
static Type	getType()	Get the GType of the SecurityOrigin class
SecurityOrigin	ref()	Atomically increments the reference count of this SecurityOrigin by one.
String	toString()	Gets a string representation of this SecurityOrigin.
void	unref()	Atomically decrements the reference count of this SecurityOrigin by one.

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

SecurityOrigin

public SecurityOrigin(MemorySegment address)

Create a SecurityOrigin proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

SecurityOrigin

public SecurityOrigin(String protocol,
 String host,
 short port)
               throws UnsupportedPlatformException

Create a new security origin from the provided protocol, host and port.

Parameters:

protocol - The protocol for the new origin

host - The host for the new origin

port - The port number for the new origin, or 0 to indicate the default port for protocol

Throws:

UnsupportedPlatformException - when run on a platform other than linux

Method Details

getType

public static Type getType()

Get the GType of the SecurityOrigin class

Returns:

the GType

forUri

public static SecurityOrigin forUri(String uri)

Create a new security origin from the provided.

Create a new security origin from the provided URI. Components of uri other than protocol, host, and port do not affect the created WebKitSecurityOrigin.

Parameters:

uri - The URI for the new origin

Returns:

A WebKitSecurityOrigin.

Throws:

UnsupportedPlatformException - when run on a platform other than linux

getHost

public String getHost()

Gets the hostname of this SecurityOrigin.

It is reasonable for this to be null if its protocol does not require a host component.

Returns:

The host of the WebKitSecurityOrigin

getPort

public short getPort()

Gets the port of this SecurityOrigin.

This function will always return 0 if the port is the default port for the given protocol. For example, http://example.com has the same security origin as http://example.com:80, and this function will return 0 for a WebKitSecurityOrigin constructed from either URI.

Returns:

The port of the WebKitSecurityOrigin.

getProtocol

public String getProtocol()

Gets the protocol of this SecurityOrigin.

Returns:

The protocol of the WebKitSecurityOrigin

ref

public SecurityOrigin ref()

Atomically increments the reference count of this SecurityOrigin by one.

This function is MT-safe and may be called from any thread.

Returns:

The passed WebKitSecurityOrigin

toString

public String toString()

Gets a string representation of this SecurityOrigin.

The string representation is a valid URI with only protocol, host, and port components, or null.

Overrides:

toString in class Object

Returns:

a URI representing this SecurityOrigin.

unref

public void unref()

Atomically decrements the reference count of this SecurityOrigin by one.

If the reference count drops to 0, all memory allocated by WebKitSecurityOrigin is released. This function is MT-safe and may be called from any thread.