net.covers1624.quack.net.httpapi

Interface WebBody

All Known Implementing Classes:

MultipartBody, WebBody.BytesBody, WebBody.PathBody

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[].
static class	WebBody.PathBody

Method Summary

Modifier and Type	Method and Description
default byte[]	asBytes() Read the body as a byte array.
default java.lang.String	asString() Reads the body as a UTF-8 String.
default java.lang.String	asString(java.nio.charset.Charset charset) Read the body as a String.
static WebBody	bytes(byte[] bytes) Create a WebBody form a byte[].
static WebBody	bytes(byte[] bytes, @Nullable java.lang.String contentType) Create a WebBody form a byte[].
@Nullable 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.
default java.nio.channels.ReadableByteChannel	openChannel() Open a byte channel into a body data.
static WebBody	path(java.nio.file.Path path) Create a WebBody for a Path.
static WebBody	path(java.nio.file.Path path, @Nullable java.lang.String contentType) Create a WebBody for a Path.
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, @Nullable java.lang.String contentType) Create a WebBody from a String.
static WebBody	string(java.lang.String str, @Nullable 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.

openChannel

default java.nio.channels.ReadableByteChannel openChannel()
                                                   throws java.io.IOException

Open a byte channel into a body data.

If the underlying data does not support Channels, the open() InputStream will be wrapped to a ReadableByteChannel.

Returns:

The channel.

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

@Nullable
@Nullable java.lang.String contentType()

The mime content type for this data.

Returns:

The content type.

asBytes

default byte[] asBytes()
                throws java.io.IOException

Read the body as a byte array.

Returns:

The bytes.

Throws:

java.io.IOException

asString

default java.lang.String asString()
                           throws java.io.IOException

Reads the body as a UTF-8 String.

Returns:

The String.

Throws:

java.io.IOException

asString

default java.lang.String asString(java.nio.charset.Charset charset)
                           throws java.io.IOException

Read the body as a String.

Returns:

The String.

Throws:

java.io.IOException

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,
                      @Nullable
                      @Nullable 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,
                      @Nullable
                      @Nullable 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,
                     @Nullable
                     @Nullable java.lang.String contentType)

Create a WebBody form a byte[].

Parameters:

bytes - The bytes.

contentType - The Content-Type for the body.

Returns:

The WebBody

path

static WebBody path(java.nio.file.Path path)

Create a WebBody for a Path. This method assumes null Content-Type

Parameters:

path - The path.

Returns:

The WebBody

path

static WebBody path(java.nio.file.Path path,
                    @Nullable
                    @Nullable java.lang.String contentType)

Create a WebBody for a Path.

Parameters:

path - The path.

contentType - The Content-Type for the body.

Returns:

The WebBody