Class Server

java.lang.Object
org.javagi.base.ProxyInstance
org.gnome.gobject.TypeInstance
org.gnome.gobject.GObject
org.gnome.soup.Server
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class Server extends GObject

Server provides a basic implementation of an HTTP server. The recommended usage of this server is for internal use, tasks like a mock server for tests, a private service for IPC, etc. It is not recommended to be exposed to untrusted clients as it may be vulnerable to denial of service attacks or other exploits.

To begin, create a server using Server(). Add at least one handler by calling addHandler(String, ServerCallback) or addEarlyHandler(String, ServerCallback); the handler will be called to process any requests underneath the path you pass. (If you want all requests to go to the same handler, just pass "/" (or null) for the path.)

When a new connection is accepted (or a new request is started on an existing persistent connection), the Server will emit Server::request-started and then begin processing the request as described below, but note that once the message is assigned a status-code, then callbacks after that point will be skipped. Note also that it is not defined when the callbacks happen relative to various ServerMessage signals.

Once the headers have been read, Server will check if there is a AuthDomain (qv) covering the Request-URI; if so, and if the message does not contain suitable authorization, then the AuthDomain will set a status of Status.UNAUTHORIZED on the message.

After checking for authorization, Server will look for "early" handlers (added with addEarlyHandler(String, ServerCallback)) matching the Request-URI. If one is found, it will be run; in particular, this can be used to connect to signals to do a streaming read of the request body.

(At this point, if the request headers contain Expect: 100-continue, and a status code has been set, then Server will skip the remaining steps and return the response. If the request headers contain Expect: 100-continue and no status code has been set, Server will return a Status.CONTINUE status before continuing.)

The server will then read in the response body (if present). At this point, if there are no handlers at all defined for the Request-URI, then the server will return Status.NOT_FOUND to the client.

Otherwise (assuming no previous step assigned a status to the message) any "normal" handlers (added with addHandler(String, ServerCallback)) for the message's Request-URI will be run.

Then, if the path has a WebSocket handler registered (and has not yet been assigned a status), Server will attempt to validate the WebSocket handshake, filling in the response and setting a status of Status.SWITCHING_PROTOCOLS or Status.BAD_REQUEST accordingly.

If the message still has no status code at this point (and has not been paused with ServerMessage.pause()), then it will be given a status of Status.INTERNAL_SERVER_ERROR (because at least one handler ran, but returned without assigning a status).

Finally, the server will emit Server::request-finished (or Server::request-aborted if an I/O error occurred before handling was completed).

If you want to handle the special "*" URI (eg, "OPTIONS "), you must explicitly register a handler for ""; the default handler will not be used for that case.

If you want to process https connections in addition to (or instead of) http connections, you can set the Server:tls-certificate property.

Once the server is set up, make one or more calls to listen(SocketAddress, Set), listenLocal(int, Set), or listenAll(int, Set) to tell it where to listen for connections. (All ports on a Server use the same handlers; if you need to handle some ports differently, such as returning different data for http and https, you'll need to create multiple Servers, or else check the passed-in URI in the handler function.).

Server will begin processing connections as soon as you return to (or start) the main loop for the current thread-default GLib.MainContext.

  • Constructor Details

    • Server

      public Server(MemorySegment address)
      Create a Server instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • Server

      public Server(String optname1, Object... varargs)

      Creates a new Server.

      This is exactly equivalent to calling GObject() and specifying SOUP_TYPE_SERVER as the type.

      Parameters:
      optname1 - name of first property to set
      varargs - value of optname1, followed by additional property/value pairs

    • Server

      public Server()
      Create a new Server.

  • Method Details

    • getType

      public static @Nullable Type getType()
      Get the GType of the Server class.
      Returns:
      the GType

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • asParent

      protected Server asParent()
      Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.
      Overrides:
      asParent in class GObject
      Returns:
      the instance as if it were its parent type

    • acceptIostream

      public boolean acceptIostream(IOStream stream, @Nullable SocketAddress localAddr, @Nullable SocketAddress remoteAddr) throws GErrorException
      Adds a new client stream to the server.
      Parameters:
      stream - a GIOStream
      localAddr - the local GSocketAddress associated with the stream
      remoteAddr - the remote GSocketAddress associated with the stream
      Returns:
      true on success, false if the stream could not be accepted or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • addAuthDomain

      public void addAuthDomain(AuthDomain authDomain)

      Adds an authentication domain to server.

      Each auth domain will have the chance to require authentication for each request that comes in; normally auth domains will require authentication for requests on certain paths that they have been set up to watch, or that meet other criteria set by the caller. If an auth domain determines that a request requires authentication (and the request doesn't contain authentication), this Server will automatically reject the request with an appropriate status (401 Unauthorized or 407 Proxy Authentication Required). If the request used the SoupServer:100-continue Expectation, this Server will reject it before the request body is sent.

      Parameters:
      authDomain - a SoupAuthDomain

    • addEarlyHandler

      public void addEarlyHandler(@Nullable String path, @Nullable ServerCallback callback)

      Adds an "early" handler to this Server for requests prefixed by path.

      Note that "normal" and "early" handlers are matched up together, so if you add a normal handler for "/foo" and an early handler for "/foo/bar", then a request to "/foo/bar" (or any path below it) will run only the early handler. (But if you add both handlers at the same path, then both will get run.)

      For requests under path (that have not already been assigned a status code by a AuthDomain or a signal handler), callback will be invoked after receiving the request headers, but before receiving the request body; the message's method and request-headers properties will be set.

      Early handlers are generally used for processing requests with request bodies in a streaming fashion. If you determine that the request will contain a message body, normally you would call MessageBody.setAccumulate(boolean) on the message's request-body to turn off request-body accumulation, and connect to the message's ServerMessage::got-chunk signal to process each chunk as it comes in.

      To complete the message processing after the full message body has been read, you can either also connect to ServerMessage::got-body, or else you can register a non-early handler for path as well. As long as you have not set the status-code by the time ServerMessage::got-body is emitted, the non-early handler will be run as well.

      Parameters:
      path - the toplevel path for the handler
      callback - callback to invoke for requests under path

    • addHandler

      public void addHandler(@Nullable String path, @Nullable ServerCallback callback)

      Adds a handler to this Server for requests prefixed by path.

      If path is null or "/", then this will be the default handler for all requests that don't have a more specific handler. (Note though that if you want to handle requests to the special "" URI, you must explicitly register a handler for ""; the default handler will not be used for that case.)

      For requests under path (that have not already been assigned a status code by a AuthDomain, an early server handler, or a signal handler), callback will be invoked after receiving the request body; the ServerMessage's method, request-headers, and request-body properties will be set.

      After determining what to do with the request, the callback must at a minimum call ServerMessage.setStatus(int, String) on the message to set the response status code. Additionally, it may set response headers and/or fill in the response body.

      If the callback cannot fully fill in the response before returning (eg, if it needs to wait for information from a database, or another network server), it should call ServerMessage.pause() to tell this Server to not send the response right away. When the response is ready, call ServerMessage.unpause() to cause it to be sent.

      To send the response body a bit at a time using "chunked" encoding, first call MessageHeaders.setEncoding(Encoding) to set Encoding.CHUNKED on the response-headers. Then call MessageBody.append(byte[]) (or MessageBody.appendBytes(byte[]))) to append each chunk as it becomes ready, and ServerMessage.unpause() to make sure it's running. (The server will automatically pause the message if it is using chunked encoding but no more chunks are available.) When you are done, call MessageBody.complete() to indicate that no more chunks are coming.

      Parameters:
      path - the toplevel path for the handler
      callback - callback to invoke for requests under path

    • addWebsocketExtension

      public void addWebsocketExtension(Type extensionType)

      Add support for a WebSocket extension of the given extensionType.

      When a WebSocket client requests an extension of extensionType, a new WebsocketExtension of type extensionType will be created to handle the request.

      Note that WebsocketExtensionDeflate is supported by default, use removeWebsocketExtension(Type) if you want to disable it.

      Parameters:
      extensionType - a GType

    • addWebsocketHandler

      public void addWebsocketHandler(@Nullable String path, @Nullable String origin, @Nullable String @Nullable [] protocols, @Nullable ServerWebsocketCallback callback)

      Adds a WebSocket handler to this Server for requests prefixed by path.

      If path is null or "/", then this will be the default handler for all requests that don't have a more specific handler.

      When a path has a WebSocket handler registered, this Server will check incoming requests for WebSocket handshakes after all other handlers have run (unless some earlier handler has already set a status code on the message), and update the request's status, response headers, and response body accordingly.

      If origin is non-null, then only requests containing a matching "Origin" header will be accepted. If protocols is non-null, then only requests containing a compatible "Sec-WebSocket-Protocols" header will be accepted. More complicated requirements can be handled by adding a normal handler to path, and having it perform whatever checks are needed and setting a failure status code if the handshake should be rejected.

      Parameters:
      path - the toplevel path for the handler
      origin - the origin of the connection
      protocols - the protocols supported by this handler
      callback - callback to invoke for successful WebSocket requests under path

    • disconnect

      public void disconnect()

      Closes and frees server's listening sockets.

      Note that if there are currently requests in progress on server, that they will continue to be processed if server's GLib.MainContext is still running.

      You can call listen(SocketAddress, Set), etc, after calling this function if you want to start listening again.

    • getListeners

      public SList<Socket> getListeners()

      Gets server's list of listening sockets.

      You should treat these sockets as read-only; writing to or modifiying any of these sockets may cause this Server to malfunction.

      Returns:
      a list of listening sockets.

    • getTlsAuthMode

      public TlsAuthenticationMode getTlsAuthMode()
      Gets the this Server SSL/TLS client authentication mode.
      Returns:
      a GTlsAuthenticationMode

    • getTlsCertificate

      public @Nullable TlsCertificate getTlsCertificate()
      Gets the this Server SSL/TLS certificate.
      Returns:
      a GTlsCertificate or null

    • getTlsDatabase

      public @Nullable TlsDatabase getTlsDatabase()
      Gets the this Server SSL/TLS database.
      Returns:
      a GTlsDatabase

    • getUris

      public SList<Uri> getUris()

      Gets a list of URIs corresponding to the interfaces this Server is listening on.

      These will contain IP addresses, not hostnames, and will also indicate whether the given listener is http or https.

      Note that if you used listenAll(int, Set) the returned URIs will use the addresses 0.0.0.0 and ::, rather than actually returning separate URIs for each interface on the system.

      Returns:
      a list of GLib.Uri, which you must free with each element with Uri#unref when you are done with it.

    • isHttps

      public boolean isHttps()

      Checks whether this Server is capable of https.

      In order for a server to run https, you must call setTlsCertificate(TlsCertificate), or set the Server:tls-certificate property, to provide it with a certificate to use.

      If you are using the deprecated single-listener APIs, then a return value of true indicates that the Server serves https exclusively. If you are using listen(SocketAddress, Set), etc, then a true return value merely indicates that the server is able to do https, regardless of whether it actually currently is or not. Use getUris() to see if it currently has any https listeners.

      Returns:
      true if this Server is configured to serve https.

    • listen

      public boolean listen(SocketAddress address, Set<ServerListenOptions> options) throws GErrorException

      Attempts to set up this Server to listen for connections on address.

      If options includes ServerListenOptions.HTTPS, and this Server has been configured for TLS, then this Server will listen for https connections on this port. Otherwise it will listen for plain http.

      You may call this method (along with the other "listen" methods) any number of times on a server, if you want to listen on multiple ports, or set up both http and https service.

      After calling this method, this Server will begin accepting and processing connections as soon as the appropriate GLib.MainContext is run.

      Note that this API does not make use of dual IPv4/IPv6 sockets; if address is an IPv6 address, it will only accept IPv6 connections. You must configure IPv4 listening separately.

      Parameters:
      address - the address of the interface to listen on
      options - listening options for this server
      Returns:
      true on success, false if address could not be bound or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listen

      public boolean listen(SocketAddress address, ServerListenOptions... options) throws GErrorException

      Attempts to set up this Server to listen for connections on address.

      If options includes ServerListenOptions.HTTPS, and this Server has been configured for TLS, then this Server will listen for https connections on this port. Otherwise it will listen for plain http.

      You may call this method (along with the other "listen" methods) any number of times on a server, if you want to listen on multiple ports, or set up both http and https service.

      After calling this method, this Server will begin accepting and processing connections as soon as the appropriate GLib.MainContext is run.

      Note that this API does not make use of dual IPv4/IPv6 sockets; if address is an IPv6 address, it will only accept IPv6 connections. You must configure IPv4 listening separately.

      Parameters:
      address - the address of the interface to listen on
      options - listening options for this server
      Returns:
      true on success, false if address could not be bound or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listenAll

      public boolean listenAll(int port, Set<ServerListenOptions> options) throws GErrorException

      Attempts to set up this Server to listen for connections on all interfaces on the system.

      That is, it listens on the addresses 0.0.0.0 and/or ::, depending on whether options includes ServerListenOptions.IPV4_ONLY, ServerListenOptions.IPV6_ONLY, or neither.) If port is specified, this Server will listen on that port. If it is 0, this Server will find an unused port to listen on. (In that case, you can use getUris() to find out what port it ended up choosing.

      See listen(SocketAddress, Set) for more details.

      Parameters:
      port - the port to listen on, or 0
      options - listening options for this server
      Returns:
      true on success, false if port could not be bound or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listenAll

      public boolean listenAll(int port, ServerListenOptions... options) throws GErrorException

      Attempts to set up this Server to listen for connections on all interfaces on the system.

      That is, it listens on the addresses 0.0.0.0 and/or ::, depending on whether options includes ServerListenOptions.IPV4_ONLY, ServerListenOptions.IPV6_ONLY, or neither.) If port is specified, this Server will listen on that port. If it is 0, this Server will find an unused port to listen on. (In that case, you can use getUris() to find out what port it ended up choosing.

      See listen(SocketAddress, Set) for more details.

      Parameters:
      port - the port to listen on, or 0
      options - listening options for this server
      Returns:
      true on success, false if port could not be bound or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listenLocal

      public boolean listenLocal(int port, Set<ServerListenOptions> options) throws GErrorException

      Attempts to set up this Server to listen for connections on "localhost".

      That is, 127.0.0.1 and/or ::1, depending on whether options includes ServerListenOptions.IPV4_ONLY, ServerListenOptions.IPV6_ONLY, or neither). If port is specified, this Server will listen on that port. If it is 0, this Server will find an unused port to listen on. (In that case, you can use getUris() to find out what port it ended up choosing.

      See listen(SocketAddress, Set) for more details.

      Parameters:
      port - the port to listen on, or 0
      options - listening options for this server
      Returns:
      true on success, false if port could not be bound or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listenLocal

      public boolean listenLocal(int port, ServerListenOptions... options) throws GErrorException

      Attempts to set up this Server to listen for connections on "localhost".

      That is, 127.0.0.1 and/or ::1, depending on whether options includes ServerListenOptions.IPV4_ONLY, ServerListenOptions.IPV6_ONLY, or neither). If port is specified, this Server will listen on that port. If it is 0, this Server will find an unused port to listen on. (In that case, you can use getUris() to find out what port it ended up choosing.

      See listen(SocketAddress, Set) for more details.

      Parameters:
      port - the port to listen on, or 0
      options - listening options for this server
      Returns:
      true on success, false if port could not be bound or any other error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listenSocket

      public boolean listenSocket(Socket socket, Set<ServerListenOptions> options) throws GErrorException

      Attempts to set up this Server to listen for connections on socket.

      See listen(SocketAddress, Set) for more details.

      Parameters:
      socket - a listening GSocket
      options - listening options for this server
      Returns:
      true on success, false if an error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • listenSocket

      public boolean listenSocket(Socket socket, ServerListenOptions... options) throws GErrorException

      Attempts to set up this Server to listen for connections on socket.

      See listen(SocketAddress, Set) for more details.

      Parameters:
      socket - a listening GSocket
      options - listening options for this server
      Returns:
      true on success, false if an error occurred (in which case error will be set).
      Throws:
      GErrorException - see GError

    • pauseMessage

      @Deprecated public void pauseMessage(ServerMessage msg)
      Deprecated.
      Use soup_server_message_pause() instead.

      Pauses I/O on msg.

      This can be used when you need to return from the server handler without having the full response ready yet. Use unpauseMessage(ServerMessage) to resume I/O.

      This must only be called on a ServerMessage which was created by the Server and are currently doing I/O, such as those passed into a ServerCallback or emitted in a Server::request-read signal.

      Parameters:
      msg - a SoupServerMessage associated with server.

    • removeAuthDomain

      public void removeAuthDomain(AuthDomain authDomain)
      Removes authDomain from server.
      Parameters:
      authDomain - a SoupAuthDomain

    • removeHandler

      public void removeHandler(String path)
      Removes all handlers (early and normal) registered at path.
      Parameters:
      path - the toplevel path for the handler

    • removeWebsocketExtension

      public void removeWebsocketExtension(Type extensionType)
      Removes support for WebSocket extension of type extensionType (or any subclass of extensionType) from server.
      Parameters:
      extensionType - a GType

    • setTlsAuthMode

      public void setTlsAuthMode(TlsAuthenticationMode mode)
      Sets server's GTlsAuthenticationMode to use for SSL/TLS client authentication.
      Parameters:
      mode - a GTlsAuthenticationMode

    • setTlsCertificate

      public void setTlsCertificate(TlsCertificate certificate)
      Sets this Server up to do https, using the given SSL/TLS certificate.
      Parameters:
      certificate - a GTlsCertificate

    • setTlsDatabase

      public void setTlsDatabase(TlsDatabase tlsDatabase)
      Sets server's GTlsDatabase to use for validating SSL/TLS client certificates.
      Parameters:
      tlsDatabase - a GTlsDatabase

    • unpauseMessage

      @Deprecated public void unpauseMessage(ServerMessage msg)
      Deprecated.
      Use soup_server_message_unpause() instead.

      Resumes I/O on msg.

      Use this to resume after calling pauseMessage(ServerMessage), or after adding a new chunk to a chunked response.

      I/O won't actually resume until you return to the main loop.

      This must only be called on a ServerMessage which was created by the Server and are currently doing I/O, such as those passed into a ServerCallback or emitted in a Server::request-read signal.

      Parameters:
      msg - a SoupServerMessage associated with server.

    • requestAborted

      protected void requestAborted(ServerMessage msg)

    • requestFinished

      protected void requestFinished(ServerMessage msg)

    • requestRead

      protected void requestRead(ServerMessage msg)

    • requestStarted

      protected void requestStarted(ServerMessage msg)

    • onRequestAborted

      public SignalConnection<Server.RequestAbortedCallback> onRequestAborted(Server.RequestAbortedCallback handler)

      Emitted when processing has failed for a message.

      This could mean either that it could not be read (if Server::request-read has not been emitted for it yet), or that the response could not be written back (if Server::request-read has been emitted but Server::request-finished has not been).

      message is in an undefined state when this signal is emitted; the signal exists primarily to allow the server to free any state that it may have allocated in Server::request-started.

      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitRequestAborted

      public void emitRequestAborted(@Nullable ServerMessage message)
      Emits the "request-aborted" signal. See onRequestAborted(Server.RequestAbortedCallback).

    • onRequestFinished

      public SignalConnection<Server.RequestFinishedCallback> onRequestFinished(Server.RequestFinishedCallback handler)
      Emitted when the server has finished writing a response to a request.
      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitRequestFinished

      public void emitRequestFinished(@Nullable ServerMessage message)
      Emits the "request-finished" signal. See onRequestFinished(Server.RequestFinishedCallback).

    • onRequestRead

      public SignalConnection<Server.RequestReadCallback> onRequestRead(Server.RequestReadCallback handler)

      Emitted when the server has successfully read a request.

      message will have all of its request-side information filled in, and if the message was authenticated, client will have information about that. This signal is emitted before any (non-early) handlers are called for the message, and if it sets the message's status_code, then normal handler processing will be skipped.

      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitRequestRead

      public void emitRequestRead(@Nullable ServerMessage message)
      Emits the "request-read" signal. See onRequestRead(Server.RequestReadCallback).

    • onRequestStarted

      public SignalConnection<Server.RequestStartedCallback> onRequestStarted(Server.RequestStartedCallback handler)

      Emitted when the server has started reading a new request.

      message will be completely blank; not even the Request-Line will have been read yet. About the only thing you can usefully do with it is connect to its signals.

      If the request is read successfully, this will eventually be followed by a Server::request_read signal. If a response is then sent, the request processing will end with a Server::request-finished signal. If a network error occurs, the processing will instead end with Server::request-aborted.

      Parameters:
      handler - the signal handler
      Returns:
      a signal handler ID to keep track of the signal connection
      See Also:

    • emitRequestStarted

      public void emitRequestStarted(@Nullable ServerMessage message)
      Emits the "request-started" signal. See onRequestStarted(Server.RequestStartedCallback).

    • builder

      public static Server.Builder<? extends Server.Builder> builder()
      A Server.Builder object constructs a Server with the specified properties. Use the various set...() methods to set properties, and finish construction with Server.Builder.build().
      Returns:
      the builder object