club.minnced.discord.webhook

Class WebhookCluster

java.lang.Object

club.minnced.discord.webhook.WebhookCluster

All Implemented Interfaces:

java.lang.AutoCloseable

public class WebhookCluster
extends java.lang.Object
implements java.lang.AutoCloseable

Collection of webhooks, useful for subscriber pattern.
Register several webhooks and broadcast to all of them with a single call.

Webhook created by the cluster through buildWebhook(long, String) are initialized with defaults specified by

• setDefaultHttpClient(okhttp3.OkHttpClient)
• setDefaultExecutorService(java.util.concurrent.ScheduledExecutorService)
• setDefaultThreadFactory(java.util.concurrent.ThreadFactory)
• setDefaultDaemon(boolean)

Field Summary

Fields

Modifier and Type	Field and Description
protected AllowedMentions	allowedMentions
protected okhttp3.OkHttpClient	defaultHttpClient
protected java.util.concurrent.ScheduledExecutorService	defaultPool
protected boolean	isDaemon
protected java.util.concurrent.ThreadFactory	threadFactory
protected java.util.List<WebhookClient>	webhooks

Constructor Summary

Constructors

Constructor and Description
WebhookCluster() Default initializes a new WebhookCluster.
WebhookCluster(@NotNull java.util.Collection<? extends WebhookClient> initialClients) Creates a new WebhookCluster with the provided clients
WebhookCluster(int initialCapacity) Creates a webhook cluster with the specified capacity.

Method Summary

Modifier and Type	Method and Description
@NotNull WebhookCluster	addWebhooks(@NotNull java.util.Collection<WebhookClient> clients) Adds the provided webhooks to the cluster.
@NotNull WebhookCluster	addWebhooks(WebhookClient... clients) Adds the provided webhooks to the cluster.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull java.util.Collection<WebhookEmbed> embeds) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull java.io.File file) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull java.lang.String content) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull java.lang.String fileName, @NotNull byte[] data) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull java.lang.String fileName, @NotNull java.io.File file) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull java.lang.String fileName, @NotNull java.io.InputStream data) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull WebhookEmbed first, WebhookEmbed... embeds) Sends a message to all registered clients.
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	broadcast(@NotNull WebhookMessage message) Sends a message to all registered clients.
@NotNull WebhookCluster	buildWebhook(long id, @NotNull java.lang.String token) Builds a WebhookClient instance with the provided components and specified default configurations.
void	close() Performs cascade closing on current webhook clients, all clients will be closed and removed after this returns.
@NotNull java.util.List<WebhookClient>	closeIf(@NotNull java.util.function.Predicate<WebhookClient> predicate) Closes and removes webhook clients based on the specified filter.
@NotNull java.util.List<WebhookClient>	getWebhooks() Unmodifiable list of currently registered clients
@NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>>	multicast(@NotNull java.util.function.Predicate<WebhookClient> filter, @NotNull WebhookMessage message) Sends a message to a filtered set of clients.
@NotNull WebhookClientBuilder	newBuilder(long id, @NotNull java.lang.String token) Creates a WebhookClientBuilder instance with the provided components and specified default configurations.
@NotNull java.util.List<WebhookClient>	removeIf(@NotNull java.util.function.Predicate<WebhookClient> predicate) Removes webhooks from the cluster based on the specified filter.
@NotNull WebhookCluster	removeWebhooks(@NotNull java.util.Collection<WebhookClient> clients) Removes the provided webhooks from the cluster.
@NotNull WebhookCluster	removeWebhooks(WebhookClient... clients) Removes the provided webhooks from the cluster.
@NotNull WebhookCluster	setAllowedMentions(@Nullable AllowedMentions allowedMentions) The mention whitelist to use by default for every webhook client.
@NotNull WebhookCluster	setDefaultDaemon(boolean isDaemon) Configures whether WebhookClient instances should be daemon by default.
@NotNull WebhookCluster	setDefaultExecutorService(@Nullable java.util.concurrent.ScheduledExecutorService executorService) Configures the default executor service that will be used to build WebhookClient instances.
@NotNull WebhookCluster	setDefaultHttpClient(@Nullable okhttp3.OkHttpClient defaultHttpClient) Configures the default http client that will be used to build WebhookClient instances.
@NotNull WebhookCluster	setDefaultThreadFactory(@Nullable java.util.concurrent.ThreadFactory factory) Configures the default thread factory that will be used to build WebhookClient instances.

Methods inherited from class java.lang.Object

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

Field Detail

webhooks

protected final java.util.List<WebhookClient> webhooks

defaultHttpClient

protected okhttp3.OkHttpClient defaultHttpClient

defaultPool

protected java.util.concurrent.ScheduledExecutorService defaultPool

threadFactory

protected java.util.concurrent.ThreadFactory threadFactory

allowedMentions

protected AllowedMentions allowedMentions

isDaemon

protected boolean isDaemon

Constructor Detail

WebhookCluster

public WebhookCluster(@NotNull
                      @NotNull java.util.Collection<? extends WebhookClient> initialClients)

Creates a new WebhookCluster with the provided clients

Parameters:

initialClients - Clients to add to the cluster

Throws:

java.lang.NullPointerException - If provided with null

WebhookCluster

public WebhookCluster(int initialCapacity)

Creates a webhook cluster with the specified capacity.
Note that this capacity can be expanded dynamically by building/adding more clients.

Parameters:

initialCapacity - The initial capacity

Throws:

java.lang.IllegalArgumentException - If the capacity is illegal

See Also:

ArrayList.ArrayList(int)

WebhookCluster

public WebhookCluster()

Default initializes a new WebhookCluster.
This cluster will be empty.

Method Detail

setDefaultHttpClient

@NotNull
public @NotNull WebhookCluster setDefaultHttpClient(@Nullable
                                                              @Nullable okhttp3.OkHttpClient defaultHttpClient)

Configures the default http client that will be used to build WebhookClient instances.

Parameters:

defaultHttpClient - The default http client

Returns:

WebhookCluster instance for chaining convenience

See Also:

WebhookClientBuilder.setHttpClient(okhttp3.OkHttpClient)

setDefaultExecutorService

@NotNull
public @NotNull WebhookCluster setDefaultExecutorService(@Nullable
                                                                   @Nullable java.util.concurrent.ScheduledExecutorService executorService)

Configures the default executor service that will be used to build WebhookClient instances.

Parameters:

executorService - The default executor service

Returns:

WebhookCluster instance for chaining convenience

See Also:

WebhookClientBuilder.setExecutorService(java.util.concurrent.ScheduledExecutorService)

setDefaultThreadFactory

@NotNull
public @NotNull WebhookCluster setDefaultThreadFactory(@Nullable
                                                                 @Nullable java.util.concurrent.ThreadFactory factory)

Configures the default thread factory that will be used to build WebhookClient instances.

Parameters:

factory - The default thread factory

Returns:

WebhookCluster instance for chaining convenience

See Also:

WebhookClientBuilder.setThreadFactory(java.util.concurrent.ThreadFactory)

setAllowedMentions

@NotNull
public @NotNull WebhookCluster setAllowedMentions(@Nullable
                                                            @Nullable AllowedMentions allowedMentions)

The mention whitelist to use by default for every webhook client.
See AllowedMentions for more details.

Parameters:

allowedMentions - The default mention whitelist

Returns:

WebhookCluster instance for chaining convenience

setDefaultDaemon

@NotNull
public @NotNull WebhookCluster setDefaultDaemon(boolean isDaemon)

Configures whether WebhookClient instances should be daemon by default.

Parameters:

isDaemon - True, if clients should be daemon

Returns:

WebhookCluster instance for chaining convenience

See Also:

WebhookClientBuilder.setDaemon(boolean)

buildWebhook

@NotNull
public @NotNull WebhookCluster buildWebhook(long id,
                                                      @NotNull
                                                      @NotNull java.lang.String token)

Builds a WebhookClient instance with the provided components and specified default configurations.

Parameters:

id - The id of the webhook

token - The token of the webhook

Returns:

WebhookCluster instance for chaining convenience

Throws:

java.lang.NullPointerException - If the token is null

newBuilder

@NotNull
public @NotNull WebhookClientBuilder newBuilder(long id,
                                                          @NotNull
                                                          @NotNull java.lang.String token)

Creates a WebhookClientBuilder instance with the provided components and specified default configurations.
The webhook client must be explicitly added to the cluster after building.

Parameters:

id - The id of the webhook

token - The token of the webhook

Returns:

WebhookClientBuilder instance

Throws:

java.lang.NullPointerException - If the token is null

addWebhooks

@NotNull
public @NotNull WebhookCluster addWebhooks(@NotNull
                                                     WebhookClient... clients)

Adds the provided webhooks to the cluster.

Parameters:

clients - The clients to add

Returns:

WebhookCluster instance for chaining convenience

Throws:

java.lang.NullPointerException - If provided with null

java.lang.IllegalArgumentException - If at least one of the clients is already shutdown

addWebhooks

@NotNull
public @NotNull WebhookCluster addWebhooks(@NotNull
                                                     @NotNull java.util.Collection<WebhookClient> clients)

Adds the provided webhooks to the cluster.

Parameters:

clients - The clients to add

Returns:

WebhookCluster instance for chaining convenience

Throws:

java.lang.NullPointerException - If provided with null

java.lang.IllegalArgumentException - If at least one of the clients is already shutdown

removeWebhooks

@NotNull
public @NotNull WebhookCluster removeWebhooks(@NotNull
                                                        WebhookClient... clients)

Removes the provided webhooks from the cluster.

Parameters:

clients - The clients to remove

Returns:

WebhookCluster instance for chaining convenience

Throws:

java.lang.NullPointerException - If provided with null

removeWebhooks

@NotNull
public @NotNull WebhookCluster removeWebhooks(@NotNull
                                                        @NotNull java.util.Collection<WebhookClient> clients)

Removes the provided webhooks from the cluster.

Parameters:

clients - The clients to remove

Returns:

WebhookCluster instance for chaining convenience

Throws:

java.lang.NullPointerException - If provided with null

removeIf

@NotNull
public @NotNull java.util.List<WebhookClient> removeIf(@NotNull
                                                                 @NotNull java.util.function.Predicate<WebhookClient> predicate)

Removes webhooks from the cluster based on the specified filter.

Parameters:

predicate - The filter to decide whether to remove a client or not

Returns:

List of the removed webhooks

Throws:

java.lang.NullPointerException - If provided with null

closeIf

@NotNull
public @NotNull java.util.List<WebhookClient> closeIf(@NotNull
                                                                @NotNull java.util.function.Predicate<WebhookClient> predicate)

Closes and removes webhook clients based on the specified filter.

Parameters:

predicate - The filter to decide whether to close and remove the client

Returns:

List of the removed webhooks

Throws:

java.lang.NullPointerException - If provided with null

getWebhooks

@NotNull
public @NotNull java.util.List<WebhookClient> getWebhooks()

Unmodifiable list of currently registered clients

Returns:

List of clients

multicast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> multicast(@NotNull
                                                                                                            @NotNull java.util.function.Predicate<WebhookClient> filter,
                                                                                                            @NotNull
                                                                                                            @NotNull WebhookMessage message)

Sends a message to a filtered set of clients.

This will override the default AllowedMentions of the client!

Parameters:

filter - The filter to decide whether a client should be targeted

message - The message to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull WebhookMessage message)

Sends a message to all registered clients.

This will override the default AllowedMentions of the client!

Parameters:

message - The message to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull WebhookEmbed first,
                                                                                                            @NotNull
                                                                                                            WebhookEmbed... embeds)

Sends a message to all registered clients.

Parameters:

first - The first embed to send

embeds - Optional additional embeds to send, up to 10

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull java.util.Collection<WebhookEmbed> embeds)

Sends a message to all registered clients.

Parameters:

embeds - The embeds to send, up to 10

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull java.lang.String content)

Sends a message to all registered clients.

Parameters:

content - The message to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull java.io.File file)

Sends a message to all registered clients.

Parameters:

file - The file to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

java.io.UncheckedIOException - If an I/O error occurs

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull java.lang.String fileName,
                                                                                                            @NotNull
                                                                                                            @NotNull java.io.File file)

Sends a message to all registered clients.

Parameters:

fileName - The alternative file name to use

file - The file to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

java.io.UncheckedIOException - If an I/O error occurs

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull java.lang.String fileName,
                                                                                                            @NotNull
                                                                                                            @NotNull java.io.InputStream data)

Sends a message to all registered clients.

Parameters:

fileName - The alternative file name to use

data - The data to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

java.io.UncheckedIOException - If an I/O error occurs

broadcast

@NotNull
public @NotNull java.util.List<java.util.concurrent.CompletableFuture<ReadonlyMessage>> broadcast(@NotNull
                                                                                                            @NotNull java.lang.String fileName,
                                                                                                            @NotNull
                                                                                                            @NotNull byte[] data)

Sends a message to all registered clients.

Parameters:

fileName - The alternative file name to use

data - The data to send

Returns:

List of futures for each client execution

Throws:

java.lang.NullPointerException - If provided with null

close

public void close()

Performs cascade closing on current webhook clients, all clients will be closed and removed after this returns.
The cluster may still be used after calls to this method occurred.

Specified by:

close in interface java.lang.AutoCloseable