net.covers1624.quack.net.httpapi

Interface EngineRequest

All Known Implementing Classes:

AbstractEngineRequest, ApacheEngineRequest, Curl4jEngineRequest, OkHttpEngineRequest

public interface EngineRequest

Builds a request executable by a specific HttpEngine.

method(String, WebBody) MUST be called before any other function.

Created by covers1624 on 1/8/23.

Method Summary

Modifier and Type	Method and Description
EngineResponse	execute() Execute the given EngineRequest.
HeaderList	getHeaders() Get all the headers for this request.
java.lang.String	getUrl() Get the url for this request.
EngineRequest	header(java.lang.String key, java.lang.String value) Add a specific HTTP header to this request.
EngineRequest	headers(HeaderList headers) Add all the specified HTTP headers to this request.
EngineRequest	headers(java.util.Map<java.lang.String,java.lang.String> headers) Add all the specified HTTP headers to this request.
EngineRequest	listener(RequestListener listener) Set a listener to receive progress updates about this transfer.
EngineRequest	method(java.lang.String method, @Nullable WebBody body) Sets the HTTP method and WebBody for this request.
EngineRequest	removeHeader(java.lang.String key) Removes all the specified HTTP headers with the given key.
EngineRequest	url(java.lang.String url) Set the url for this request.
default EngineRequest	url(java.net.URL url) Set the URL for this request.

Method Detail

method

EngineRequest method(java.lang.String method,
                     @Nullable
                     @Nullable WebBody body)

Sets the HTTP method and WebBody for this request.

Parameters:

method - The HTTP method.

body - The WebBody.

Returns:

The same EngineRequest.

url

default EngineRequest url(java.net.URL url)

Set the URL for this request.

Parameters:

url - The URL.

Returns:

The same EngineRequest.

url

EngineRequest url(java.lang.String url)

Set the url for this request.

Parameters:

url - The url.

Returns:

The same EngineRequest.

header

EngineRequest header(java.lang.String key,
                     java.lang.String value)

Add a specific HTTP header to this request.

Parameters:

key - The key.

value - The value.

Returns:

The same EngineRequest.

headers

EngineRequest headers(java.util.Map<java.lang.String,java.lang.String> headers)

Add all the specified HTTP headers to this request.

Parameters:

headers - The headers to add.

Returns:

The same EngineRequest.

headers

EngineRequest headers(HeaderList headers)

Add all the specified HTTP headers to this request.

Parameters:

headers - The headers to add.

Returns:

The same EngineRequest.

removeHeader

EngineRequest removeHeader(java.lang.String key)

Removes all the specified HTTP headers with the given key.

Parameters:

key - The key.

Returns:

The same EngineRequest.

listener

@ApiStatus.Experimental
EngineRequest listener(RequestListener listener)

Set a listener to receive progress updates about this transfer.

Note: This API is still experimental, may crash, may not be supported by all http impls, or may change.

Parameters:

listener - The listener.

Returns:

The same request.

getUrl

java.lang.String getUrl()

Get the url for this request.

Returns:

The url for this request.

getHeaders

HeaderList getHeaders()

Get all the headers for this request.

Returns:

A HeaderList collection representing all the headers.

execute

EngineResponse execute()
                throws java.io.IOException

Execute the given EngineRequest.

This method blocks until the underlying HTTP implementation returns a response, or throws an exception.

Returns:

The EngineResponse for the request.

Throws:

java.io.IOException - Thrown by the underlying HTTP implementation in the event of an error.