Module SimpleHttpServer

Package dev.katsute.simplehttpserver

Class SimpleHttpExchange

java.lang.Object

com.sun.net.httpserver.HttpExchange

dev.katsute.simplehttpserver.SimpleHttpExchange

All Implemented Interfaces:

Request, AutoCloseable

public abstract class SimpleHttpExchange
extends HttpExchange

A HttpExchange with additional extensions to simplify usage.

Requests

GET Request

If a user sends a GET request to the server, a map of keys and values of that request can be retrieved by using the getGetMap() method.

POST Request

If a user sends a POST request to the server, a map of keys and values; or a MultipartFormData can be retrieved by using getPostMap() and getMultipartFormData().

multipart/form-data

For requests that have content type multipart/form-data, data must be retrieved using getMultipartFormData(), which returns a MultipartFormData using Records and FileRecords. Files sent through here are sent as a Byte array and not a File.

Cookies

A clients browser cookies for the site can be retrieved by using the getCookie(String) or getCookies() method.
Cookies can be set by using the setCookie(HttpCookie) or setCookie(String, String).
An exchange must be sent in order to change on the client.

Session

Normally the only "identifier" that we can retrieve from the user is their address and port provided from an exchange. This however, doesn't work across multiple tabs or when the user refreshes the page; instead we use a session cookie to track a user.
A server must have a HttpSessionHandler set using HttpServerExtensions.setSessionHandler(HttpSessionHandler) for this to work.
The HttpSessionHandler assigns session IDs to clients and allows the server to retrieve them using HttpServerExtensions.getSession(HttpExchange).

Response

To send response headers you must first retrieve then with HttpExchange.getResponseHeaders(), modify them, then send them using HttpExchange.sendResponseHeaders(int, long) or any other of the send methods.
Data can be sent as a Byte array, String, or as a File. Responses can optionally gziped to compress the data sent.

• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

Note: An exchange must be sent or closed, otherwise the connection may resend the request until it gets response or times out.

Since:

5.0.0

Version:

5.0.0

Author:

Katsute

See Also:

• HttpExchange

Method Summary

Modifier and Type	Method	Description
abstract String	getCookie(String cookie)	Returns the value of a given cookie for a client.
abstract Map<String,String>	getCookies()	Returns a map of all the cookies for a client.
abstract Map<String,String>	getGetMap()	Returns GET query as a map of keys and values.
abstract HttpExchange	getHttpExchange()	Returns the underlying http exchange.
abstract HttpServer	getHttpServer()	Returns the http server associated with an exchange.
abstract MultipartFormData	getMultipartFormData()	For content type multipart/form-data, returns POST body as a MultipartFormData object.
abstract Map<String,?>	getPostMap()	Returns the POST body as a map of keys and values.
abstract String	getRawGet()	Returns the raw string representation of a GET query.
abstract String	getRawPost()	Returns the raw string representation of a POST body.
abstract boolean	hasGet()	Returns if there is a GET query.
abstract boolean	hasPost()	Returns if there is a POST body.
abstract void	send(byte[] bytes)	Sends a byte array to the client.
abstract void	send(byte[] bytes, boolean gzip)	Sends a byte array to the client that can be gziped.
abstract void	send(byte[] bytes, int responseCode)	Sends a byte array to the client with a response code.
abstract void	send(byte[] bytes, int responseCode, boolean gzip)	Sends a byte array to the client with a response code that can be gziped.
abstract void	send(int responseCode)	Sends a response code to the client.
abstract void	send(File file)	Sends a file to the client.
abstract void	send(File file, boolean gzip)	Sends a byte array to the client that can be gziped.
abstract void	send(File file, int responseCode)	Sends a byte array to the client with a response code.
abstract void	send(File file, int responseCode, boolean gzip)	Sends a file to the client with a response code that can be gziped.
abstract void	send(String string)	Sends a string to the client.
abstract void	send(String string, boolean gzip)	Sends a string to the client that can be gziped.
abstract void	send(String string, int responseCode)	Sends a string to the client with a response code
abstract void	send(String string, int responseCode, boolean gzip)	Sends a string to the client with a response code that can be gziped.
abstract void	setCookie(String key, String value)	Sets a cookie for the client.
abstract void	setCookie(HttpCookie cookie)	Sets a cookie for the client.

Methods inherited from class com.sun.net.httpserver.HttpExchange

close, getAttribute, getHttpContext, getLocalAddress, getPrincipal, getProtocol, getRemoteAddress, getRequestBody, getRequestHeaders, getRequestMethod, getRequestURI, getResponseBody, getResponseCode, getResponseHeaders, sendResponseHeaders, setAttribute, setStreams

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.net.httpserver.Request

with

Method Details

getHttpServer

public abstract HttpServer getHttpServer()

Returns the http server associated with an exchange.

Returns:

http server

Since:

5.0.0

See Also:

• HttpServer

getHttpExchange

public abstract HttpExchange getHttpExchange()

Returns the underlying http exchange.

Returns:

http exchange

Since:

5.0.0

See Also:

• HttpExchange

getRawGet

public abstract String getRawGet()

Returns the raw string representation of a GET query. The GET query is the string of characters located after the ? in the URL.

Returns:

raw GET

Since:

5.0.0

See Also:

• getGetMap()
• hasGet()

getGetMap

public abstract Map<String,String> getGetMap()

Returns GET query as a map of keys and values. The GET query is the string of characters located after the ? in the URL.

Returns:

GET map

Since:

5.0.0

See Also:

• getRawGet()
• hasGet()

hasGet

public abstract boolean hasGet()

Returns if there is a GET query. The GET query is the string of characters located after the ? in the URL.

Returns:

if GET query exists

Since:

5.0.0

See Also:

• getRawGet()
• getGetMap()

getRawPost

public abstract String getRawPost()

Returns the raw string representation of a POST body.

Returns:

raw POST body

Since:

5.0.0

See Also:

• getPostMap()
• getMultipartFormData()
• hasPost()

getPostMap

public abstract Map<String,?> getPostMap()

Returns the POST body as a map of keys and values. For content type multipart/form-data use getMultipartFormData().

Returns:

POST map

Since:

5.0.0

See Also:

• getRawPost()
• getMultipartFormData()
• hasPost()

getMultipartFormData

public abstract MultipartFormData getMultipartFormData()

For content type multipart/form-data, returns POST body as a MultipartFormData object.

Returns:

multipart/form-data object

Since:

5.0.0

See Also:

• MultipartFormData
• getRawPost()
• getPostMap()
• hasPost()

hasPost

public abstract boolean hasPost()

Returns if there is a POST body.

Returns:

if POST body exists

Since:

5.0.0

See Also:

• getRawPost()
• getPostMap()
• getMultipartFormData()

getCookie

public abstract String getCookie(String cookie)

Returns the value of a given cookie for a client.

Parameters:

cookie - name of cookie

Returns:

value of cookie

Since:

5.0.0

See Also:

• getCookies()
• setCookie(HttpCookie)
• setCookie(String, String)

getCookies

public abstract Map<String,String> getCookies()

Returns a map of all the cookies for a client.

Returns:

map of cookies

Since:

5.0.0

See Also:

• getCookie(String)
• setCookie(HttpCookie)
• setCookie(String, String)

setCookie

public abstract void setCookie(String key,
 String value)

Sets a cookie for the client. Response must be sent for cookies to update on the client.

Parameters:

key - cookie key

value - value of cookie

Since:

5.0.0

See Also:

• setCookie(HttpCookie)
• getCookie(String)
• getCookies()

setCookie

public abstract void setCookie(HttpCookie cookie)

Sets a cookie for the client. Response must be sent for cookies to update on the client.

Parameters:

cookie - http cookie

See Also:

• HttpCookie
• setCookie(String, String)
• getCookies()
• getCookie(String)

send

public abstract void send(int responseCode)
                   throws IOException

Sends a response code to the client.

Parameters:

responseCode - response code

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(byte[] bytes)
                   throws IOException

Sends a byte array to the client.

Parameters:

bytes - byte array

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(int)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(byte[] bytes,
 int responseCode)
                   throws IOException

Sends a byte array to the client with a response code.

Parameters:

bytes - byte array

responseCode - response code

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(byte[])
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(int)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(byte[] bytes,
 boolean gzip)
                   throws IOException

Sends a byte array to the client that can be gziped.

Parameters:

bytes - byte array

gzip - if the response should be compressed

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(byte[])
• send(byte[], int)
• send(byte[], int, boolean)
• send(int)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(byte[] bytes,
 int responseCode,
 boolean gzip)
                   throws IOException

Sends a byte array to the client with a response code that can be gziped.

Parameters:

bytes - byte array

responseCode - response code

gzip - if the response should be compressed

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(int)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(String string)
                   throws IOException

Sends a string to the client.

Parameters:

string - string to send

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(String, int)
• send(String, boolean)
• send(String, int, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(String string,
 int responseCode)
                   throws IOException

Sends a string to the client with a response code

Parameters:

string - string to send

responseCode - response code

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(String)
• send(String, boolean)
• send(String, int, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(String string,
 boolean gzip)
                   throws IOException

Sends a string to the client that can be gziped.

Parameters:

string - string to send

gzip - if the response should be compressed

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(String)
• send(String, int)
• send(String, int, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(String string,
 int responseCode,
 boolean gzip)
                   throws IOException

Sends a string to the client with a response code that can be gziped.

Parameters:

string - string to send

responseCode - response code

gzip - if the response should be compressed

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(String)
• send(String, int)
• send(String, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(File)
• send(File, int)
• send(File, boolean)
• send(File, int, boolean)

send

public abstract void send(File file)
                   throws IOException

Sends a file to the client.

Parameters:

file - file

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(File, int)
• send(File, boolean)
• send(File, int, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)

send

public abstract void send(File file,
 int responseCode)
                   throws IOException

Sends a byte array to the client with a response code.

Parameters:

file - file to send

responseCode - response code

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(File)
• send(File, boolean)
• send(File, int, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)

send

public abstract void send(File file,
 boolean gzip)
                   throws IOException

Sends a byte array to the client that can be gziped.

Parameters:

file - file to send

gzip - if the response should be compressed

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(File)
• send(File, int)
• send(File, int, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)

send

public abstract void send(File file,
 int responseCode,
 boolean gzip)
                   throws IOException

Sends a file to the client with a response code that can be gziped.

Parameters:

file - file to send

responseCode - response code

gzip - if the response should be compressed

Throws:

IOException - IO exception

Since:

5.0.0

See Also:

• send(File)
• send(File, int)
• send(File, boolean)
• send(int)
• send(byte[])
• send(byte[], int)
• send(byte[], boolean)
• send(byte[], int, boolean)
• send(String)
• send(String, int)
• send(String, boolean)
• send(String, int, boolean)