net.covers1624.quack.net.httpapi.curl4j

Class Curl4jEngineRequest

java.lang.Object

net.covers1624.quack.net.httpapi.AbstractEngineRequest

net.covers1624.quack.net.httpapi.curl4j.Curl4jEngineRequest

All Implemented Interfaces:

EngineRequest

public class Curl4jEngineRequest
extends AbstractEngineRequest

Created by covers1624 on 1/11/23.

Field Summary

Fields inherited from class net.covers1624.quack.net.httpapi.AbstractEngineRequest

executed, headers, listener, url

Constructor Summary

Constructors

Constructor and Description
Curl4jEngineRequest(Curl4jHttpEngine engine)

Method Summary

Modifier and Type	Method and Description
Curl4jEngineRequest	addCustomOption(java.util.function.Consumer<net.covers1624.curl4j.util.CurlHandle> action) Provide custom configuration to curl.
protected void	assertState()
Curl4jEngineRequest	dontFollowRedirects() Called to tell this request to not follow redirects.
Curl4jEngineResponse	execute() Execute the given EngineRequest.
Curl4jEngineRequest	header(java.lang.String key, java.lang.String value) Add a specific HTTP header to this request.
Curl4jEngineRequest	headers(HeaderList headers) Add all the specified HTTP headers to this request.
Curl4jEngineRequest	headers(java.util.Map<java.lang.String,java.lang.String> headers) Add all the specified HTTP headers to this request.
Curl4jEngineRequest	listener(RequestListener listener) Set a listener to receive progress updates about this transfer.
Curl4jEngineRequest	method(java.lang.String method, @Nullable WebBody body) Sets the HTTP method and WebBody for this request.
Curl4jEngineRequest	removeHeader(java.lang.String key) Removes all the specified HTTP headers with the given key.
Curl4jEngineRequest	unixSocket(java.lang.String unixSocket) Set the CURL.CURLOPT_UNIX_SOCKET_PATH option.
Curl4jEngineRequest	url(java.lang.String url) Set the url for this request.
Curl4jEngineRequest	useCABundle(@Nullable net.covers1624.curl4j.CABundle caBundle) Use the given CABundle.
Curl4jEngineRequest	useFileOutput(java.nio.file.Path destFile) Tell this Request to store the body in the given file.

Methods inherited from class net.covers1624.quack.net.httpapi.AbstractEngineRequest

getHeaders, getUrl

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.covers1624.quack.net.httpapi.EngineRequest

url

Constructor Detail

Curl4jEngineRequest

public Curl4jEngineRequest(Curl4jHttpEngine engine)

Method Detail

method

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

Description copied from interface: EngineRequest

Sets the HTTP method and WebBody for this request.

Parameters:

method - The HTTP method.

body - The WebBody.

Returns:

The same EngineRequest.

dontFollowRedirects

public Curl4jEngineRequest dontFollowRedirects()

Called to tell this request to not follow redirects.

Returns:

The same request.

useFileOutput

public Curl4jEngineRequest useFileOutput(java.nio.file.Path destFile)

Tell this Request to store the body in the given file. Otherwise, the request will return an incremental response, only downloading as fast as the client pulls data from the body.

This is a hot-path for downloading files.

If a path is provided, it can be assumed that a WebBody.PathBody is used on the response.

Parameters:

destFile - The destination file.

Returns:

The same request.

unixSocket

public Curl4jEngineRequest unixSocket(java.lang.String unixSocket)

Set the CURL.CURLOPT_UNIX_SOCKET_PATH option.

Parameters:

unixSocket - The socket.

Returns:

The same request.

useCABundle

public Curl4jEngineRequest useCABundle(@Nullable
                                       @Nullable net.covers1624.curl4j.CABundle caBundle)

Use the given CABundle.

Parameters:

caBundle - The bundle.

Returns:

The same request.

addCustomOption

public Curl4jEngineRequest addCustomOption(java.util.function.Consumer<net.covers1624.curl4j.util.CurlHandle> action)

Provide custom configuration to curl.

These callbacks are called after all default state has been set, but prior to executing the curl operation.

Parameters:

action - The action.

Returns:

The same request.

url

public Curl4jEngineRequest url(java.lang.String url)

Description copied from interface: EngineRequest

Set the url for this request.

Specified by:

url in interface EngineRequest

Overrides:

url in class AbstractEngineRequest

Parameters:

url - The url.

Returns:

The same EngineRequest.

header

public Curl4jEngineRequest header(java.lang.String key,
                                  java.lang.String value)

Description copied from interface: EngineRequest

Add a specific HTTP header to this request.

Specified by:

header in interface EngineRequest

Overrides:

header in class AbstractEngineRequest

Parameters:

key - The key.

value - The value.

Returns:

The same EngineRequest.

headers

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

Description copied from interface: EngineRequest

Add all the specified HTTP headers to this request.

Specified by:

headers in interface EngineRequest

Overrides:

headers in class AbstractEngineRequest

Parameters:

headers - The headers to add.

Returns:

The same EngineRequest.

headers

public Curl4jEngineRequest headers(HeaderList headers)

Description copied from interface: EngineRequest

Add all the specified HTTP headers to this request.

Specified by:

headers in interface EngineRequest

Overrides:

headers in class AbstractEngineRequest

Parameters:

headers - The headers to add.

Returns:

The same EngineRequest.

removeHeader

public Curl4jEngineRequest removeHeader(java.lang.String key)

Description copied from interface: EngineRequest

Removes all the specified HTTP headers with the given key.

Specified by:

removeHeader in interface EngineRequest

Overrides:

removeHeader in class AbstractEngineRequest

Parameters:

key - The key.

Returns:

The same EngineRequest.

listener

public Curl4jEngineRequest listener(RequestListener listener)

Description copied from interface: EngineRequest

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.

Specified by:

listener in interface EngineRequest

Overrides:

listener in class AbstractEngineRequest

Parameters:

listener - The listener.

Returns:

The same request.

assertState

protected void assertState()

Overrides:

assertState in class AbstractEngineRequest

execute

public Curl4jEngineResponse execute()
                             throws java.io.IOException

Description copied from interface: EngineRequest

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.