net.covers1624.quack.net.httpapi

Interface WebBody

All Known Implementing Classes:

MultipartBody, WebBody.BytesBody

public interface WebBody

Represents a request or response body.

Created by covers1624 on 1/8/23.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	WebBody.BytesBody Simple WebBody implementation reading from an in-memory, byte[].

Method Summary

Modifier and Type	Method and Description
static WebBody	bytes(byte[] bytes) Create a WebBody form a byte[].
static WebBody	bytes(byte[] bytes, java.lang.String contentType) Create a WebBody form a byte[].
java.lang.String	contentType() The mime content type for this data.
long	length() The length of the data.
boolean	multiOpenAllowed() Checks if this WebBody supports open() being called multiple times.
java.io.InputStream	open() Open a stream to read the body data.
static WebBody	string(java.lang.String str) Create a WebBody from a String.
static WebBody	string(java.lang.String str, java.nio.charset.Charset charset) Create a WebBody from a String.
static WebBody	string(java.lang.String str, java.nio.charset.Charset charset, java.lang.String contentType) Create a WebBody from a String.
static WebBody	string(java.lang.String str, java.lang.String contentType) Create a WebBody from a String.

Method Detail

open

java.io.InputStream open()
                  throws java.io.IOException

Open a stream to read the body data.

Returns:

The stream.

Throws:

java.io.IOException - If an IO error occurs.

multiOpenAllowed

boolean multiOpenAllowed()

Checks if this WebBody supports open() being called multiple times.

Returns:

If the body can be opened multiple times.

length

long length()

The length of the data.

Returns:

The length in bytes. -1 for unknown.

contentType

java.lang.String contentType()

The mime content type for this data.

Returns:

The content type.

string

static WebBody string(java.lang.String str)

Create a WebBody from a String. This method assumes null contentType This method assumes StandardCharsets.UTF_8 charset.

Parameters:

str - The string.

Returns:

The WebBody.

string

static WebBody string(java.lang.String str,
                      java.lang.String contentType)

Create a WebBody from a String. This method assumes StandardCharsets.UTF_8 charset.

Parameters:

str - The string.

contentType - The Content-Type for the body.

Returns:

The WebBody.

string

static WebBody string(java.lang.String str,
                      java.nio.charset.Charset charset)

Create a WebBody from a String. This method assumes null Content-Type

Parameters:

str - The string.

charset - The Charset for the body.

Returns:

The WebBody.

string

static WebBody string(java.lang.String str,
                      java.nio.charset.Charset charset,
                      java.lang.String contentType)

Create a WebBody from a String.

Parameters:

str - The string.

charset - The Charset for the body.

contentType - The Content-Type for the body.

Returns:

The WebBody.

bytes

static WebBody bytes(byte[] bytes)

Create a WebBody form a byte[]. This method assumes null Content-Type

Parameters:

bytes - The bytes.

Returns:

The WebBody

bytes

static WebBody bytes(byte[] bytes,
                     java.lang.String contentType)

Create a WebBody form a byte[].

Parameters:

bytes - The bytes.

contentType - The Content-Type for the body.

Returns:

The WebBody