Package org.gnome.soup

Class Logger

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.soup.Logger

All Implemented Interfaces:

SessionFeature, Proxy

@Generated("io.github.jwharm.JavaGI")
public final class Logger
extends GObject
implements SessionFeature

Debug logging support

SoupLogger watches a Session and logs the HTTP traffic that it generates, for debugging purposes. Many applications use an environment variable to determine whether or not to use SoupLogger, and to determine the amount of debugging output.

To use SoupLogger, first create a logger with Logger(), optionally configure it with setRequestFilter(org.gnome.soup.LoggerFilter), setResponseFilter(org.gnome.soup.LoggerFilter), and setPrinter(org.gnome.soup.LoggerPrinter), and then attach it to a session (or multiple sessions) with Session.addFeature(org.gnome.soup.SessionFeature).

By default, the debugging output is sent to stdout, and looks something like:

 > POST /unauth HTTP/1.1
 > Soup-Debug-Timestamp: 1200171744
 > Soup-Debug: SoupSession 1 (0x612190), SoupMessage 1 (0x617000), GSocket 1 (0x612220)
 > Host: localhost
 > Content-Type: text/plain
 > Connection: close

 < HTTP/1.1 201 Created
 < Soup-Debug-Timestamp: 1200171744
 < Soup-Debug: SoupMessage 1 (0x617000)
 < Date: Sun, 12 Jan 2008 21:02:24 GMT
 < Content-Length: 0
 

The Soup-Debug-Timestamp line gives the time (as a time_t) when the request was sent, or the response fully received.

The Soup-Debug line gives further debugging information about the Session, Message, and Socket involved; the hex numbers are the addresses of the objects in question (which may be useful if you are running in a debugger). The decimal IDs are simply counters that uniquely identify objects across the lifetime of the SoupLogger. In particular, this can be used to identify when multiple messages are sent across the same connection.

Currently, the request half of the message is logged just before the first byte of the request gets written to the network (from the Message::starting signal).

The response is logged just after the last byte of the response body is read from the network (from the Message::got-body or Message::got-informational signal), which means that the Message::got-headers signal, and anything triggered off it (such as SoupMessage::authenticate) will be emitted before the response headers are actually logged.

If the response doesn't happen to trigger the Message::got-body nor Message::got-informational signals due to, for example, a cancellation before receiving the last byte of the response body, the response will still be logged on the event of the Message::finished signal.

Nested Class Summary

Nested Classes

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

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

GObject.NotifyCallback, GObject.ObjectClass

Nested classes/interfaces inherited from interface org.gnome.soup.SessionFeature

SessionFeature.SessionFeature$Impl, SessionFeature.SessionFeatureInterface

Constructor Summary

Constructors

Constructor	Description
Logger()	Creates a new Logger.
Logger(MemorySegment address)	Create a Logger proxy instance for the provided memory address.
Logger(LoggerLogLevel level)	Creates a new SoupLogger with the given debug level.

Method Summary

Modifier and Type	Method	Description
protected Logger	asParent()	Returns this instance as if it were its parent type.
static Logger.Builder<? extends Logger.Builder>	builder()	A Logger.Builder object constructs a Logger with the specified properties.
int	getMaxBodySize()	Get the maximum body size for logger.
static @Nullable Type	getType()	Get the GType of the Logger class
void	setMaxBodySize(int maxBodySize)	Sets the maximum body size for this Logger (-1 means no limit).
void	setPrinter(@Nullable LoggerPrinter printer)	Sets up an alternate log printing routine, if you don't want the log to go to stdout.
void	setRequestFilter(@Nullable LoggerFilter requestFilter)	Sets up a filter to determine the log level for a given request.
void	setResponseFilter(@Nullable LoggerFilter responseFilter)	Sets up a filter to determine the log level for a given response.

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

Methods inherited from interface org.javagi.base.Proxy

handle

Constructor Details

Logger

public Logger(MemorySegment address)

Create a Logger proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Logger

public Logger(LoggerLogLevel level)

Creates a new SoupLogger with the given debug level.

If you need finer control over what message parts are and aren't logged, use setRequestFilter(org.gnome.soup.LoggerFilter) and setResponseFilter(org.gnome.soup.LoggerFilter).

Parameters:

level - the debug level

Logger

public Logger()

Creates a new Logger.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Logger class

Returns:

the GType

asParent

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

getMaxBodySize

public int getMaxBodySize()

Get the maximum body size for logger.

Returns:

the maximum body size, or -1 if unlimited

setMaxBodySize

public void setMaxBodySize(int maxBodySize)

Sets the maximum body size for this Logger (-1 means no limit).

Parameters:

maxBodySize - the maximum body size to log

setPrinter

public void setPrinter(@Nullable LoggerPrinter printer)

Sets up an alternate log printing routine, if you don't want the log to go to stdout.

Parameters:

printer - the callback for printing logging output

setRequestFilter

public void setRequestFilter(@Nullable LoggerFilter requestFilter)

Sets up a filter to determine the log level for a given request.

For each HTTP request this Logger will invoke requestFilter to determine how much (if any) of that request to log. (If you do not set a request filter, this Logger will just always log requests at the level passed to Logger().)

Parameters:

requestFilter - the callback for request debugging

setResponseFilter

public void setResponseFilter(@Nullable LoggerFilter responseFilter)

Sets up a filter to determine the log level for a given response.

For each HTTP response this Logger will invoke responseFilter to determine how much (if any) of that response to log. (If you do not set a response filter, this Logger will just always log responses at the level passed to Logger().)

Parameters:

responseFilter - the callback for response debugging

builder

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

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

Returns:

the builder object