discord4j.rest

Class RestClientBuilder<C,O extends RouterOptions>

java.lang.Object

discord4j.rest.RestClientBuilder<C,O>

public class RestClientBuilder<C,O extends RouterOptions>
extends Object

Builder suited for creating a RestClient. To acquire an instance, see createRest(String).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	RestClientBuilder.Config

Field Summary

Fields

Modifier and Type	Field and Description
protected AllowedMentions	allowedMentions
protected Function<RestClientBuilder.Config,C>	clientFactory
protected ExchangeStrategies	exchangeStrategies
protected GlobalRateLimiter	globalRateLimiter
protected JacksonResources	jacksonResources
protected Function<RouterOptions,O>	optionsModifier
protected ReactorResources	reactorResources
protected RequestQueueFactory	requestQueueFactory
protected List<ResponseFunction>	responseTransformers
protected String	token

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RestClientBuilder(RestClientBuilder<?,?> source, Function<RestClientBuilder.Config,C> clientFactory, Function<RouterOptions,O> optionsModifier)
protected	RestClientBuilder(String token, Function<RestClientBuilder.Config,C> clientFactory, Function<RouterOptions,O> optionsModifier)

Method Summary

Modifier and Type	Method and Description
C	build() Create a client capable of connecting to Discord REST API using a DefaultRouter that is capable of working in monolithic environments.
C	build(Function<O,Router> routerFactory) Create a client capable of connecting to Discord REST API using a custom Router factory.
static RestClientBuilder<RestClient,RouterOptions>	createRest(String token) Initialize a new builder with the given token.
RestClientBuilder<C,O>	onClientResponse(ResponseFunction responseFunction) Sets a new API response behavior to the supporting Router, allowing cross-cutting behavior across all requests made by it.
RestClientBuilder<C,O>	setDefaultAllowedMentions(AllowedMentions allowedMentions) Sets the AllowedMentions object that can limit the mentioned target entities that are notified upon message created by this client.
RestClientBuilder<C,O>	setExchangeStrategies(ExchangeStrategies exchangeStrategies) Set the strategies to use when reading or writing HTTP request and response body entities.
<O2 extends RouterOptions> RestClientBuilder<C,O2>	setExtraOptions(Function<? super O,O2> optionsModifier) Add a configuration for Router implementation-specific cases, changing the type of the current RouterOptions object passed to the Router factory in build methods.
RestClientBuilder<C,O>	setGlobalRateLimiter(GlobalRateLimiter globalRateLimiter) Define the GlobalRateLimiter to be applied while configuring the Router for a client.
RestClientBuilder<C,O>	setJacksonResources(JacksonResources jacksonResources) Set a new JacksonResources to this builder, dedicated to provide an ObjectMapper for serialization and deserialization of data.
RestClientBuilder<C,O>	setReactorResources(ReactorResources reactorResources) Set a new ReactorResources dedicated to set up a connection pool, an event pool, as well as the supporting HttpClient used for making rest requests and maintaining gateway connections.
RestClientBuilder<C,O>	setRequestQueueFactory(RequestQueueFactory requestQueueFactory) Sets the RequestQueueFactory that will provide RequestQueue instances for the router.
RestClientBuilder<C,O>	setToken(String token) Change the token stored in this builder.

Methods inherited from class java.lang.Object

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

Field Detail

clientFactory

protected final Function<RestClientBuilder.Config,C> clientFactory

optionsModifier

protected final Function<RouterOptions,O extends RouterOptions> optionsModifier

token

protected String token

reactorResources

protected ReactorResources reactorResources

jacksonResources

protected JacksonResources jacksonResources

exchangeStrategies

protected ExchangeStrategies exchangeStrategies

responseTransformers

protected List<ResponseFunction> responseTransformers

globalRateLimiter

protected GlobalRateLimiter globalRateLimiter

requestQueueFactory

protected RequestQueueFactory requestQueueFactory

allowedMentions

@Nullable
protected AllowedMentions allowedMentions

Constructor Detail

RestClientBuilder

protected RestClientBuilder(String token,
                            Function<RestClientBuilder.Config,C> clientFactory,
                            Function<RouterOptions,O> optionsModifier)

RestClientBuilder

protected RestClientBuilder(RestClientBuilder<?,?> source,
                            Function<RestClientBuilder.Config,C> clientFactory,
                            Function<RouterOptions,O> optionsModifier)

Method Detail

createRest

public static RestClientBuilder<RestClient,RouterOptions> createRest(String token)

Initialize a new builder with the given token.

Parameters:

token - the bot token used to authenticate to Discord

setExtraOptions

public <O2 extends RouterOptions> RestClientBuilder<C,O2> setExtraOptions(Function<? super O,O2> optionsModifier)

Add a configuration for Router implementation-specific cases, changing the type of the current RouterOptions object passed to the Router factory in build methods.

Type Parameters:

O2 - new type for the options

Parameters:

optionsModifier - Function to transform the RouterOptions type to provide custom Router implementations a proper configuration object.

Returns:

a new RestClientBuilder that will now work with the new options type.

setToken

public RestClientBuilder<C,O> setToken(String token)

Change the token stored in this builder.

Parameters:

token - the new bot token

Returns:

this builder

setReactorResources

public RestClientBuilder<C,O> setReactorResources(ReactorResources reactorResources)

Set a new ReactorResources dedicated to set up a connection pool, an event pool, as well as the supporting HttpClient used for making rest requests and maintaining gateway connections.

Parameters:

reactorResources - the new resource provider used for rest and gateway operations

Returns:

this builder

setJacksonResources

public RestClientBuilder<C,O> setJacksonResources(JacksonResources jacksonResources)

Set a new JacksonResources to this builder, dedicated to provide an ObjectMapper for serialization and deserialization of data.

Parameters:

jacksonResources - the new resource provider for serialization and deserialization

Returns:

this builder

setExchangeStrategies

public RestClientBuilder<C,O> setExchangeStrategies(ExchangeStrategies exchangeStrategies)

Set the strategies to use when reading or writing HTTP request and response body entities. Defaults to using setJacksonResources(JacksonResources) to build a ExchangeStrategies.jackson(ObjectMapper) that is capable of encoding and decoding JSON using Jackson.

Parameters:

exchangeStrategies - the HTTP exchange strategies to use

Returns:

this builder

onClientResponse

public RestClientBuilder<C,O> onClientResponse(ResponseFunction responseFunction)

Sets a new API response behavior to the supporting Router, allowing cross-cutting behavior across all requests made by it.

The given ResponseFunction will be applied after every response. Calling this function multiple times will result in additive behavior, so care must be taken regarding the order in which multiple calls occur. Transformations will be added to the response pipeline in that order.

Built-in factories are supplied for commonly used behavior:

• ResponseFunction.emptyIfNotFound() transforms any HTTP 404 error into an empty sequence.
• ResponseFunction.emptyIfNotFound(RouteMatcher) transforms HTTP 404 errors from the given Routes into an empty sequence.
• ResponseFunction.emptyOnErrorStatus(RouteMatcher, Integer...) provides the same behavior as above but for any given status codes.
• ResponseFunction.retryOnceOnErrorStatus(Integer...) retries once for the given status codes.
• ResponseFunction.retryOnceOnErrorStatus(RouteMatcher, Integer...) provides the same behavior as above but for any matching Route.

Parameters:

responseFunction - the ResponseFunction to transform the responses from matching requests.

Returns:

this builder

setGlobalRateLimiter

public RestClientBuilder<C,O> setGlobalRateLimiter(GlobalRateLimiter globalRateLimiter)

Define the GlobalRateLimiter to be applied while configuring the Router for a client. GlobalRateLimiter purpose is to coordinate API requests to properly delay them under global rate limiting scenarios. A supporting Router factory (supplied at build(Function)) is responsible for applying the given limiter.

Parameters:

globalRateLimiter - the limiter instance to be used while configuring a Router

Returns:

this builder

See Also:

GlobalRateLimiter

setRequestQueueFactory

public RestClientBuilder<C,O> setRequestQueueFactory(RequestQueueFactory requestQueueFactory)

Sets the RequestQueueFactory that will provide RequestQueue instances for the router.

If not set, it will use a RequestQueueFactory providing request queues backed by a sink with reasonable buffering capacity, delaying overflowing requests.

Parameters:

requestQueueFactory - the factory that will provide RequestQueue instances for the router

Returns:

this builder

See Also:

RequestQueueFactory.createFromSink(Function, EmissionStrategy)

setDefaultAllowedMentions

public RestClientBuilder<C,O> setDefaultAllowedMentions(AllowedMentions allowedMentions)

Sets the AllowedMentions object that can limit the mentioned target entities that are notified upon message created by this client.

Parameters:

allowedMentions - the options for limiting message mentions. See AllowedMentions.builder().

Returns:

this builder

build

public C build()

Create a client capable of connecting to Discord REST API using a DefaultRouter that is capable of working in monolithic environments.

Returns:

a configured RestClient based on this builder parameters

build

public C build(Function<O,Router> routerFactory)

Create a client capable of connecting to Discord REST API using a custom Router factory. The resulting RestClient will use the produced Router for every request.

Parameters:

routerFactory - the factory of Router implementation

Returns:

a configured RestClient based on this builder parameters