masecla.modrinth4j.client.instances

Class RatelimitedHttpClient

java.lang.Object

masecla.modrinth4j.client.HttpClient

masecla.modrinth4j.client.instances.RatelimitedHttpClient

public class RatelimitedHttpClient
extends HttpClient

This class is used to connect to the Modrinth API with rate limiting.

Constructor Summary

Constructors

Constructor and Description
RatelimitedHttpClient(UserAgent userAgent, String apiKey) Creates a new instance of the client.
RatelimitedHttpClient(UserAgent userAgent, String baseUrl, String apiKey) Creates a new instance of the client.
RatelimitedHttpClient(UserAgent userAgent, String baseUrl, String apiKey, long timeout) Creates a new instance of the client.

Method Summary

Modifier and Type	Method and Description
void	interceptResponse(okhttp3.Response response) Intercepts the response.
CompletableFuture<Void>	nextRequest() Returns the next request.

Methods inherited from class masecla.modrinth4j.client.HttpClient

connect, connect, execute

Methods inherited from class java.lang.Object

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

Constructor Detail

RatelimitedHttpClient

public RatelimitedHttpClient(UserAgent userAgent,
                             String apiKey)

Creates a new instance of the client.

Parameters:

userAgent - The user agent to use.

apiKey - The API key to use.

RatelimitedHttpClient

public RatelimitedHttpClient(UserAgent userAgent,
                             String baseUrl,
                             String apiKey)

Creates a new instance of the client.

Parameters:

userAgent - The user agent to use.

baseUrl - The base URL to use.

apiKey - The API key to use.

RatelimitedHttpClient

public RatelimitedHttpClient(UserAgent userAgent,
                             String baseUrl,
                             String apiKey,
                             long timeout)

Creates a new instance of the client.

Parameters:

userAgent - The user agent to use.

baseUrl - The base URL to use.

apiKey - The API key to use.

timeout - The timeout to use in milliseconds.

Method Detail

nextRequest

public CompletableFuture<Void> nextRequest()

Returns the next request.

Specified by:

nextRequest in class HttpClient

Returns:

A future that completes when the next request is allowed.

interceptResponse

public void interceptResponse(okhttp3.Response response)

Intercepts the response.

Overrides:

interceptResponse in class HttpClient

Parameters:

response - - The response to intercept.