Package org.axonframework.messaging.queryhandling.distributed

Record Class DistributedQueryBusConfiguration

java.lang.Object

java.lang.Record

org.axonframework.messaging.queryhandling.distributed.DistributedQueryBusConfiguration

Record Components:

queryThreads - The number of threads used by the DistributedQueryBus for querying.

queryExecutorServiceFactory - The ExecutorServiceFactory constructing the priority-aware ExecutorService for querying in the DistributedQueryBus.

queryResponseThreads - The number of threads used by the DistributedQueryBus for handling query responses.

queryResponseExecutorServiceFactory - The ExecutorServiceFactory constructing the priority-aware ExecutorService for handling query responses in the DistributedQueryBus.

public record DistributedQueryBusConfiguration(int queryThreads, @Nonnull ExecutorServiceFactory<DistributedQueryBusConfiguration> queryExecutorServiceFactory, int queryResponseThreads, @Nonnull ExecutorServiceFactory<DistributedQueryBusConfiguration> queryResponseExecutorServiceFactory)
extends Record

Configuration for the DistributedQueryBus.

Can be used to modify non-critical settings of the bus, such as the query and query response thread pools.

Since:

5.0.0

Author:

Steven van Beelen

Field Summary

Fields

Modifier and Type	Field	Description
static final DistributedQueryBusConfiguration	DEFAULT	A default instance of the DistributedQueryBusConfiguration, setting the queryThreads() to 10, the queryResponseThreads() to 5, and the queryExecutorServiceFactory() and queryResponseExecutorServiceFactory() to priority-aware ExecutorServiceFactories using the configured number of threads.

Constructor Summary

Constructors

Constructor	Description
DistributedQueryBusConfiguration(int queryThreads, ExecutorServiceFactory<DistributedQueryBusConfiguration> queryExecutorServiceFactory, int queryResponseThreads, ExecutorServiceFactory<DistributedQueryBusConfiguration> queryResponseExecutorServiceFactory)	Compact constructor validating that the given queryThreads and queryResponseThreads are strictly positive.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
DistributedQueryBusConfiguration	queryExecutorService(ExecutorService executorService)	Sets the ExecutorService to use for querying in the distributed query bus.
ExecutorServiceFactory<DistributedQueryBusConfiguration>	queryExecutorServiceFactory()	Returns the value of the queryExecutorServiceFactory record component.
DistributedQueryBusConfiguration	queryResponseExecutorService(ExecutorService executorService)	Sets the ExecutorService to use for handling query responses in the distributed query bus.
ExecutorServiceFactory<DistributedQueryBusConfiguration>	queryResponseExecutorServiceFactory()	Returns the value of the queryResponseExecutorServiceFactory record component.
int	queryResponseThreads()	Returns the value of the queryResponseThreads record component.
DistributedQueryBusConfiguration	queryResponseThreads(int queryResponseThreads)	Sets the number of threads to use for handling query responses in the distributed query bus.
int	queryThreads()	Returns the value of the queryThreads record component.
DistributedQueryBusConfiguration	queryThreads(int queryThreads)	Sets the number of threads to use for querying in the distributed query bus.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT

public static final DistributedQueryBusConfiguration DEFAULT

A default instance of the DistributedQueryBusConfiguration, setting the queryThreads() to 10, the queryResponseThreads() to 5, and the queryExecutorServiceFactory() and queryResponseExecutorServiceFactory() to priority-aware ExecutorServiceFactories using the configured number of threads.

Constructor Details

DistributedQueryBusConfiguration

public DistributedQueryBusConfiguration(int queryThreads,
 @Nonnull
 ExecutorServiceFactory<DistributedQueryBusConfiguration> queryExecutorServiceFactory,
 int queryResponseThreads,
 @Nonnull
 ExecutorServiceFactory<DistributedQueryBusConfiguration> queryResponseExecutorServiceFactory)

Compact constructor validating that the given queryThreads and queryResponseThreads are strictly positive.

Method Details

queryThreads

public DistributedQueryBusConfiguration queryThreads(int queryThreads)

Sets the number of threads to use for querying in the distributed query bus.

Defaults to 10.

Parameters:

queryThreads - The number of threads to use for the distributed query bus.

Returns:

The configuration itself, for fluent API usage.

queryExecutorService

public DistributedQueryBusConfiguration queryExecutorService(@Nonnull
 ExecutorService executorService)

Sets the ExecutorService to use for querying in the distributed query bus.

Defaults to a fixed thread pool with 10 threads using the priority queue.

Parameters:

executorService - The ExecutorService to use for querying in the distributed query bus.

Returns:

The configuration itself, for fluent API usage.

queryResponseThreads

public DistributedQueryBusConfiguration queryResponseThreads(int queryResponseThreads)

Sets the number of threads to use for handling query responses in the distributed query bus.

Defaults to 5.

Parameters:

queryResponseThreads - The number of threads to use for the distributed query bus.

Returns:

The configuration itself, for fluent API usage.

queryResponseExecutorService

public DistributedQueryBusConfiguration queryResponseExecutorService(@Nonnull
 ExecutorService executorService)

Sets the ExecutorService to use for handling query responses in the distributed query bus.

Defaults to a fixed thread pool with 5 threads using the priority queue.

Parameters:

executorService - The ExecutorService to use for handling queries in the distributed query bus.

Returns:

The configuration itself, for fluent API usage.

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

queryThreads

public int queryThreads()

Returns the value of the queryThreads record component.

Returns:

the value of the queryThreads record component

queryExecutorServiceFactory

@Nonnull
public ExecutorServiceFactory<DistributedQueryBusConfiguration> queryExecutorServiceFactory()

Returns the value of the queryExecutorServiceFactory record component.

Returns:

the value of the queryExecutorServiceFactory record component

queryResponseThreads

public int queryResponseThreads()

Returns the value of the queryResponseThreads record component.

Returns:

the value of the queryResponseThreads record component

queryResponseExecutorServiceFactory

@Nonnull
public ExecutorServiceFactory<DistributedQueryBusConfiguration> queryResponseExecutorServiceFactory()

Returns the value of the queryResponseExecutorServiceFactory record component.

Returns:

the value of the queryResponseExecutorServiceFactory record component