Package org.gnome.soup

package org.gnome.soup

An HTTP client/server library for GNOME

The following native libraries are required and will be loaded: libsoup-3.0.so

For namespace-global declarations, refer to the Soup class documentation.

This package is only available on linux.

Soup-method

soup-method.h contains a number of defines for standard HTTP and WebDAV headers. You do not need to use these defines; you can pass arbitrary strings to soup_message_new() if you prefer.

The thing that these defines <emphasis>are</emphasis> useful for is performing quick comparisons against soup_message_get_method(); because SoupMessage always contains an interned string, and these macros return interned strings, you can compare methods directly against these macros rather than needing to use strcmp(). This is most useful in SoupServer handlers. Eg:

<informalexample><programlisting> if (soup_message_get_method (msg) != SOUP_METHOD_GET &amp;&amp; soup_message_get_method (msg) != SOUP_METHOD_HEAD) { soup_message_set_status (msg, SOUP_METHOD_NOT_IMPLEMENTED); return; } </programlisting></informalexample>

Class	Description
Auth	The abstract base class for handling authentication.
Auth.AuthClass
Auth.AuthImpl	The AuthImpl type represents a native instance of the abstract Auth class.
Auth.Builder<B extends Auth.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthBasic	HTTP "Basic" authentication.
AuthBasic.Builder<B extends AuthBasic.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthDigest	HTTP "Digest" authentication.
AuthDigest.Builder<B extends AuthDigest.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthDomain	Server-side authentication.
AuthDomain.AuthDomainClass
AuthDomain.AuthDomainImpl	The AuthDomainImpl type represents a native instance of the abstract AuthDomain class.
AuthDomain.Builder<B extends AuthDomain.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthDomainBasic	Server-side "Basic" authentication.
AuthDomainBasic.AuthDomainBasicClass
AuthDomainBasic.Builder<B extends AuthDomainBasic.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthDomainBasicAuthCallback	Functional interface declaration of the AuthDomainBasicAuthCallback callback.
AuthDomainDigest	Server-side "Digest" authentication.
AuthDomainDigest.AuthDomainDigestClass
AuthDomainDigest.Builder<B extends AuthDomainDigest.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthDomainDigestAuthCallback	Functional interface declaration of the AuthDomainDigestAuthCallback callback.
AuthDomainFilter	Functional interface declaration of the AuthDomainFilter callback.
AuthDomainGenericAuthCallback	Functional interface declaration of the AuthDomainGenericAuthCallback callback.
AuthManager	HTTP client-side authentication handler.
AuthManager.AuthManagerClass
AuthManager.Builder<B extends AuthManager.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthNegotiate	HTTP-based GSS-Negotiate authentication, as defined by RFC 4559.
AuthNegotiate.Builder<B extends AuthNegotiate.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
AuthNTLM	HTTP-based NTLM authentication.
AuthNTLM.Builder<B extends AuthNTLM.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
Cache	File-based cache for HTTP resources.
Cache.Builder<B extends Cache.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
Cache.CacheClass
Cacheability	Indicates if a message should or shouldn't be cached.
CacheType	The type of cache; this affects what kinds of responses will be saved.
ContentDecoder	Handles decoding of HTTP messages.
ContentDecoder.Builder<B extends ContentDecoder.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
ContentDecoder.ContentDecoderClass
ContentSniffer	Sniffs the mime type of messages.
ContentSniffer.Builder<B extends ContentSniffer.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
ContentSniffer.ContentSnifferClass
Cookie	Implements HTTP cookies, as described by RFC 6265.
CookieJar	Automatic cookie handling for SoupSession.
CookieJar.Builder<B extends CookieJar.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
CookieJar.ChangedCallback	Functional interface declaration of the ChangedCallback callback.
CookieJar.CookieJarClass
CookieJarAcceptPolicy	The policy for accepting or rejecting cookies returned in responses.
CookieJarDB	Database-based Cookie Jar.
CookieJarDB.Builder<B extends CookieJarDB.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
CookieJarDB.CookieJarDBClass
CookieJarText	Text-file-based ("cookies.txt") Cookie Jar
CookieJarText.Builder<B extends CookieJarText.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
CookieJarText.CookieJarTextClass
DateFormat	Date formats that Soup.dateTimeToString(org.gnome.glib.DateTime, org.gnome.soup.DateFormat) can use.
Encoding	How a message body is encoded for transport
Expectation	Represents the parsed value of the "Expect" header.
HSTSEnforcer	Automatic HTTP Strict Transport Security enforcing for Session.
HSTSEnforcer.Builder<B extends HSTSEnforcer.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
HSTSEnforcer.ChangedCallback	Functional interface declaration of the ChangedCallback callback.
HSTSEnforcer.HSTSEnforcerClass	Class structure for SoupHSTSEnforcer.
HSTSEnforcerDB	Persistent HTTP Strict Transport Security enforcer.
HSTSEnforcerDB.Builder<B extends HSTSEnforcerDB.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
HSTSEnforcerDB.HSTSEnforcerDBClass
HSTSPolicy	SoupHSTSPolicy implements HTTP policies, as described by RFC 6797.
HTTPVersion	Indicates the HTTP protocol version being used.
Logger	Debug logging support
Logger.Builder<B extends Logger.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
Logger.LoggerClass
LoggerFilter	Functional interface declaration of the LoggerFilter callback.
LoggerLogLevel	Describes the level of logging output to provide.
LoggerPrinter	Functional interface declaration of the LoggerPrinter callback.
MemoryUse	The lifetime of the memory being passed.
Message	Represents an HTTP message being sent or received.
Message.AcceptCertificateCallback	Functional interface declaration of the AcceptCertificateCallback callback.
Message.AuthenticateCallback	Functional interface declaration of the AuthenticateCallback callback.
Message.Builder<B extends Message.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
Message.ContentSniffedCallback	Functional interface declaration of the ContentSniffedCallback callback.
Message.FinishedCallback	Functional interface declaration of the FinishedCallback callback.
Message.GotBodyCallback	Functional interface declaration of the GotBodyCallback callback.
Message.GotBodyDataCallback	Functional interface declaration of the GotBodyDataCallback callback.
Message.GotHeadersCallback	Functional interface declaration of the GotHeadersCallback callback.
Message.GotInformationalCallback	Functional interface declaration of the GotInformationalCallback callback.
Message.HstsEnforcedCallback	Functional interface declaration of the HstsEnforcedCallback callback.
Message.MessageClass
Message.NetworkEventCallback	Functional interface declaration of the NetworkEventCallback callback.
Message.RequestCertificateCallback	Functional interface declaration of the RequestCertificateCallback callback.
Message.RequestCertificatePasswordCallback	Functional interface declaration of the RequestCertificatePasswordCallback callback.
Message.RestartedCallback	Functional interface declaration of the RestartedCallback callback.
Message.StartingCallback	Functional interface declaration of the StartingCallback callback.
Message.WroteBodyCallback	Functional interface declaration of the WroteBodyCallback callback.
Message.WroteBodyDataCallback	Functional interface declaration of the WroteBodyDataCallback callback.
Message.WroteHeadersCallback	Functional interface declaration of the WroteHeadersCallback callback.
MessageBody	SoupMessageBody represents the request or response body of a Message.
MessageFlags	Various flags that can be set on a SoupMessage to alter its behavior.
MessageHeaders	The HTTP message headers associated with a request or response.
MessageHeadersForeachFunc	Functional interface declaration of the MessageHeadersForeachFunc callback.
MessageHeadersIter	An opaque type used to iterate over a SoupMessageHeaders structure.
MessageHeadersType	Value passed to MessageHeaders(org.gnome.soup.MessageHeadersType) to set certain default behaviors.
MessageMetrics	Contains metrics collected while loading a Message either from the network or the disk cache.
MessagePriority	Priorities that can be set on a Message to instruct the message queue to process it before any other message with lower priority.
Multipart	Represents a multipart HTTP message body, parsed according to the syntax of RFC 2046.
MultipartInputStream	Handles streams of multipart messages.
MultipartInputStream.Builder<B extends MultipartInputStream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
MultipartInputStream.MultipartInputStreamClass
Range	Represents a byte range as used in the Range header.
SameSitePolicy	Represents the same-site policies of a cookie.
Server	A HTTP server.
Server.Builder<B extends Server.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
Server.RequestAbortedCallback	Functional interface declaration of the RequestAbortedCallback callback.
Server.RequestFinishedCallback	Functional interface declaration of the RequestFinishedCallback callback.
Server.RequestReadCallback	Functional interface declaration of the RequestReadCallback callback.
Server.RequestStartedCallback	Functional interface declaration of the RequestStartedCallback callback.
Server.ServerClass
ServerCallback	Functional interface declaration of the ServerCallback callback.
ServerListenOptions	Options to pass to Server.listen(org.gnome.gio.SocketAddress, java.util.Set<org.gnome.soup.ServerListenOptions>), etc.
ServerMessage	An HTTP server request and response pair.
ServerMessage.AcceptCertificateCallback	Functional interface declaration of the AcceptCertificateCallback callback.
ServerMessage.Builder<B extends ServerMessage.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
ServerMessage.ConnectedCallback	Functional interface declaration of the ConnectedCallback callback.
ServerMessage.DisconnectedCallback	Functional interface declaration of the DisconnectedCallback callback.
ServerMessage.FinishedCallback	Functional interface declaration of the FinishedCallback callback.
ServerMessage.GotBodyCallback	Functional interface declaration of the GotBodyCallback callback.
ServerMessage.GotChunkCallback	Functional interface declaration of the GotChunkCallback callback.
ServerMessage.GotHeadersCallback	Functional interface declaration of the GotHeadersCallback callback.
ServerMessage.ServerMessageClass
ServerMessage.WroteBodyCallback	Functional interface declaration of the WroteBodyCallback callback.
ServerMessage.WroteBodyDataCallback	Functional interface declaration of the WroteBodyDataCallback callback.
ServerMessage.WroteChunkCallback	Functional interface declaration of the WroteChunkCallback callback.
ServerMessage.WroteHeadersCallback	Functional interface declaration of the WroteHeadersCallback callback.
ServerMessage.WroteInformationalCallback	Functional interface declaration of the WroteInformationalCallback callback.
ServerWebsocketCallback	Functional interface declaration of the ServerWebsocketCallback callback.
Session	Soup session state object.
Session.Builder<B extends Session.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
Session.RequestQueuedCallback	Functional interface declaration of the RequestQueuedCallback callback.
Session.RequestUnqueuedCallback	Functional interface declaration of the RequestUnqueuedCallback callback.
Session.SessionClass
SessionError	A SoupSession error.
SessionFeature	Interface for miscellaneous Session features.
SessionFeature.SessionFeatureImpl	The SessionFeatureImpl type represents a native instance of the SessionFeature interface.
SessionFeature.SessionFeatureInterface	The interface implemented by SessionFeatures.
Soup	Constants and functions that are declared in the global Soup namespace.
Status	These represent the known HTTP status code values, plus various network and internal errors.
TLDError	Error codes for SOUP_TLD_ERROR.
URIComponent	Enum values passed to Soup.uriCopy(org.gnome.glib.Uri, org.gnome.soup.URIComponent, java.lang.Object...) to indicate the components of the URI that should be updated with the given values.
WebsocketCloseCode	Pre-defined close codes that can be passed to WebsocketConnection.close(short, java.lang.String) or received from WebsocketConnection.getCloseCode().
WebsocketConnection	The WebSocket Protocol
WebsocketConnection.Builder<B extends WebsocketConnection.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
WebsocketConnection.ClosedCallback	Functional interface declaration of the ClosedCallback callback.
WebsocketConnection.ClosingCallback	Functional interface declaration of the ClosingCallback callback.
WebsocketConnection.ErrorCallback	Functional interface declaration of the ErrorCallback callback.
WebsocketConnection.MessageCallback	Functional interface declaration of the MessageCallback callback.
WebsocketConnection.PongCallback	Functional interface declaration of the PongCallback callback.
WebsocketConnection.WebsocketConnectionClass	The abstract base class for WebsocketConnection.
WebsocketConnectionType	The type of a WebsocketConnection.
WebsocketDataType	The type of data contained in a WebsocketConnection::message signal.
WebsocketError	WebSocket-related errors.
WebsocketExtension	A WebSocket extension
WebsocketExtension.Builder<B extends WebsocketExtension.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
WebsocketExtension.WebsocketExtensionClass	The class structure for the SoupWebsocketExtension.
WebsocketExtension.WebsocketExtensionImpl	The WebsocketExtensionImpl type represents a native instance of the abstract WebsocketExtension class.
WebsocketExtensionDeflate	A SoupWebsocketExtensionDeflate is a WebsocketExtension implementing permessage-deflate (RFC 7692).
WebsocketExtensionDeflate.Builder<B extends WebsocketExtensionDeflate.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
WebsocketExtensionDeflate.WebsocketExtensionDeflateClass
WebsocketExtensionManager	SoupWebsocketExtensionManager is the SessionFeature that handles WebSockets extensions for a Session.
WebsocketExtensionManager.Builder<B extends WebsocketExtensionManager.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
WebsocketExtensionManager.WebsocketExtensionManagerClass
WebsocketState	The state of the WebSocket connection.