HttpServerUtil Introduction

The HttpServerUtil module provides a base code for the HttpServer module and code requiring HttpServer definitions but not the entire HttpServer module itself.

To use this module, use "%requires HttpServerUtil" in your code.

All the public symbols in the module are defined in the HttpServer namespace

The main classes are:

AbstractAuthenticator: can be implemented to provide authentication and authorization info to the server
AbstractHttpRequestHandler: this class must be subclassed to provide the real work of the HttpServer handling connections
AbstractHttpSocketHandler: this class must be subclassed to implement a dedicated socket handler for protcol changes (for an example, see the WebSocketHandler module)
AbstractLogger: this abstract class provides an interface for classes providing basic logging methods
AbstractStreamRequest: this class is used to directly handle HTTP chunked requests and responses
AbstractUrlHandler: this class serves as a base class for handler classes that serve requests anchored at a particular URL
HttpListenerInterface: this abstract class provides the interface for the private HttpListener class implemented in the HttpServer module
PermissiveAuthenticator: this class implements a dummy authenticator that accepts all requests

HttpServerUtil Definitions

HttpServerUtil Request Context

The HTTP listener and server set the context hash as follows when handling HTTP requests

Key	Type	Description
`auth`	*string	the original `Authorization` header value, if any
`char_encoding`	string	the character encoding of the Socket object handling the request
`client-cert`	SSLCertificate	the client certificate if the server is configured to capture them and one is present in the request
`close`	*bool	set to True if the connection should be closed after responding (as derived from request headers)
`debug`	*bool	True if the debug flag is enabled on the HTTP server
`handler_name`	string	the name of the handler serving the request
`hdr`	hash	the header information as returned by Socket::readHTTPHeader()
`id`	int	the ID for this socket connection; note that socket connections may be reused by proxies, so this ID cannot be used to identify the peer
`handler_name`	string	the name of the handler serving the request
`header-info`	hash	a hash of information as returned from the output info argument to Socket::readHTTPHeader()
`listener-id`	int	a unique ID for the listener serving the request
`listener-name`	string	a unique name for the listener serving the request
`logger`	LoggerInterface	a LoggerInterface object for the HTTP server
`masked_path`	string	the URI path after URL decoding and masking for sensitive information
`orig_path`	string	the URI path in the request after URL decoding
`peer-info`	hash	information about the remote socket as returned by Socket::getPeerInfo()
`raw_path`	string	the raw URI request path in the request
`response-encoding`	*string	any value given by any `"Accept-Charset"` in the request
`root_path`	*string	the root URL path matched if the request was matched by a URL prefix
`socket`	string	the bind address used to bind the listener (`"socket-info"` provides more detailed information)
`socket-info`	hash	information about the listening socket as returned by Socket::getSocketInfo()
`ssl`	*bool	True if the request was encrypted with HTTPS
`url`	hash	a hash with a `path` key giving the URI path in the request
`user`	*string	set by the authenticator if the request was authenticated to a specific user
`uctx`	*hash	any user thread context for the listener (see HttpListenerInterface::addUserThreadContext())

HttpServerUtil Module Release Notes

HttpServerUtil 1.3.1

added Brotli (br) and Zstandard (zstd) Content-Encoding support in decodeBody() and encodeBody() (issue 5071)

HttpServerUtil 1.3

allow authentication methods to set the call context (issue 4970)
added utility functionality for cookies

HttpServerUtil 1.2

allow handlers to remove thread-local auth information after requests have been handled

HttpServerUtil 1.1

implemented support for reloading X.509 certificate information without manually restarting listeners (issue 4574)

HttpServerUtil 1.0.12

updated version to match Qore and server version

HttpServerUtil 1.0

fixed a bug handling wildcard address binds in http_get_url_from_bind() (issue 4266)
added a definition for the 308 Permanent Redirect response (issue 4169)
added support for the Logger module for logging (issue 4157)

HttpServerUtil 0.9.11

fixed a bug where it was not possible to include CORS headers or any context-sensitive information in a 401 response (issue 4136)
fixed a bug that left hanging threads in HTTP operations with I/O callbacks with HEAD requests and a Transfer-Encoding: chunked header in the response (issue 4109)

HttpServerUtil 0.9.5

aligned version with the HttpServer module version

HttpServerUtil 0.9.4

added support for sending chunked replies from an InputStream (issue 3702)

HttpServerUtil 0.3.12.1

improved sensitive data masking in log messages (issue 2621)

HttpServerUtil 0.3.12

fixed a bug in AbstractAuthenticator::do401() where the msg argument was ignored (issue 1047)
added logic to allow sensitive data to be masked in log messages (issue 1086)
updated for complex types (issue 1724)
moved HttpServer::parse_uri_query to the Util module

HttpServerUtil 0.3.11.2

eliminated excess logging of each HTTP chunk sent or received

HttpServerUtil 0.3.11.1

aligned version with HttpServer module version

HttpServerUtil 0.3.11

initial version of the module
implemented support for notifying persistent connections when the connection is terminated while a persistent connection is in place
removed unused AbstractStreamRequestHandler class
fixed HttpServer::parse_uri_query to always return params as a hash (issue 569)
added root_path to the context hash if the path was matched by a URL path prefix (issue 570)
implemented support for custom timeout values in stream handlers (issue 719)

Table of Contents