org.axonframework.axonserver.connector

Class AxonServerConnectionManager.Builder

java.lang.Object

org.axonframework.axonserver.connector.AxonServerConnectionManager.Builder

Enclosing class:

AxonServerConnectionManager

public static class AxonServerConnectionManager.Builder
extends Object

Builder class to instantiate an AxonServerConnectionManager.

The TagsConfiguration is defaulted to TagsConfiguration.TagsConfiguration() and the ScheduledExecutorService defaults to an instance using a single thread with an AxonThreadFactory tied to it. The Axon Framework version resolver (Supplier<String>) is defaulted to AxonFrameworkVersionResolver. The AxonServerConfiguration is a hard requirements and as such should be provided.

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
AxonServerConnectionManager.Builder	axonFrameworkVersionResolver(Supplier<String> axonFrameworkVersionResolver) Sets the Axon Framework version resolver used in order to communicate the client version to send to Axon Server.
AxonServerConnectionManager.Builder	axonServerConfiguration(AxonServerConfiguration axonServerConfiguration) Sets the AxonServerConfiguration used to correctly configure connections between Axon clients and Axon Server.
AxonServerConnectionManager	build() Initializes a AxonServerConnectionManager as specified through this Builder.
AxonServerConnectionManager.Builder	instructionAckSource(InstructionAckSource<PlatformInboundInstruction> instructionAckSource) Sets the instruction ack source used to send instruction acknowledgements.
AxonServerConnectionManager.Builder	requestStreamFactory(Function<UpstreamAwareStreamObserver<PlatformOutboundInstruction>,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> requestStreamFactory) Sets the request stream factory that creates a request stream based on upstream.
AxonServerConnectionManager.Builder	scheduler(ScheduledExecutorService scheduler) Sets the ScheduledExecutorService used to schedule connection attempts given certain success and/or failure scenarios of a channel.
AxonServerConnectionManager.Builder	tagsConfiguration(TagsConfiguration tagsConfiguration) Sets the TagsConfiguration used to add the tags of this Axon instance as client information when setting up a channel.
protected void	validate() Validates whether the fields contained in this Builder are set accordingly.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

axonServerConfiguration

public AxonServerConnectionManager.Builder axonServerConfiguration(AxonServerConfiguration axonServerConfiguration)

Sets the AxonServerConfiguration used to correctly configure connections between Axon clients and Axon Server.

Parameters:

axonServerConfiguration - an AxonServerConfiguration used to correctly configure the connections created by an AxonServerConnectionManager instance

Returns:

the current Builder instance, for fluent interfacing

tagsConfiguration

public AxonServerConnectionManager.Builder tagsConfiguration(TagsConfiguration tagsConfiguration)

Sets the TagsConfiguration used to add the tags of this Axon instance as client information when setting up a channel. Can for example be used to introduce labelling of your client applications for correct distribution in an Axon Server cluster. Defaults to TagsConfiguration.TagsConfiguration(), thus an empty set of tags.

Parameters:

tagsConfiguration - a TagsConfiguration to add the tags of this Axon instance as client information when setting up a channel

Returns:

the current Builder instance, for fluent interfacing

scheduler

public AxonServerConnectionManager.Builder scheduler(ScheduledExecutorService scheduler)

Sets the ScheduledExecutorService used to schedule connection attempts given certain success and/or failure scenarios of a channel. Defaults to a ScheduledExecutorService with a single thread, using the AxonThreadFactory to instantiate the threads.

Parameters:

scheduler - a ScheduledExecutorService used to schedule connection attempts given certain success and/or failure scenarios of a channel

Returns:

the current Builder instance, for fluent interfacing

axonFrameworkVersionResolver

public AxonServerConnectionManager.Builder axonFrameworkVersionResolver(Supplier<String> axonFrameworkVersionResolver)

Sets the Axon Framework version resolver used in order to communicate the client version to send to Axon Server.

Parameters:

axonFrameworkVersionResolver - a string supplier that retrieve the current Axon Framework version

Returns:

the current Builder instance, for fluent interfacing

requestStreamFactory

public AxonServerConnectionManager.Builder requestStreamFactory(Function<UpstreamAwareStreamObserver<PlatformOutboundInstruction>,io.grpc.stub.StreamObserver<PlatformInboundInstruction>> requestStreamFactory)

Sets the request stream factory that creates a request stream based on upstream. Defaults to UpstreamAwareStreamObserver.getRequestStream().

Parameters:

requestStreamFactory - factory that creates a request stream based on upstream

Returns:

the current Builder instance, for fluent interfacing

instructionAckSource

public AxonServerConnectionManager.Builder instructionAckSource(InstructionAckSource<PlatformInboundInstruction> instructionAckSource)

Sets the instruction ack source used to send instruction acknowledgements. Defaults to DefaultInstructionAckSource.

Parameters:

instructionAckSource - used to send instruction acknowledgements

Returns:

the current Builder instance, for fluent interfacing

build

public AxonServerConnectionManager build()

Initializes a AxonServerConnectionManager as specified through this Builder.

Returns:

a AxonServerConnectionManager as specified through this Builder

validate

protected void validate()
                 throws AxonConfigurationException

Validates whether the fields contained in this Builder are set accordingly.

Throws:

AxonConfigurationException - if one field is asserted to be incorrect according to the Builder's specifications