Module io.axoniq.connector.axonserver

Package io.axoniq.axonserver.connector.admin.impl

Class AdminChannelImpl

java.lang.Object

io.axoniq.axonserver.connector.impl.AbstractAxonServerChannel<Void>

io.axoniq.axonserver.connector.admin.impl.AdminChannelImpl

All Implemented Interfaces:

AdminChannel

public class AdminChannelImpl
extends AbstractAxonServerChannel<Void>
implements AdminChannel

AdminChannel GRPC implementation to allow a client application sending and receiving administration related messages to and from Axon Server.

Since:

4.6.0

Author:

Sara Pellegrini, Stefan Dragisic

Field Summary

Fields inherited from interface io.axoniq.axonserver.connector.admin.AdminChannel

CHANNEL_CONTEXT

Constructor Summary

Constructors

Constructor	Description
AdminChannelImpl(ClientIdentification clientIdentification, ScheduledExecutorService executor, AxonServerManagedChannel channel)

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	addNodeToReplicationGroup(JoinReplicationGroup request)	Request to add a node to a replication group.
CompletableFuture<ApplicationRoles>	authenticateToken(String token)	Authenticate an application token against the information available in Axon Server.
CompletableFuture<UserRoles>	authenticateUser(String username, String password)	Authenticate a user against the information available in Axon Server.
void	connect()	Connect this channel with AxonServer.
CompletableFuture<Void>	createContext(CreateContextRequest request)	Request to create an Axon Server context.
CompletableFuture<Token>	createOrUpdateApplication(ApplicationRequest request)	Request to create an Axon Server application, or update it if it's already present.
CompletableFuture<Void>	createOrUpdateUser(CreateOrUpdateUserRequest request)	Request to create an Axon Server user, or update it if it's already present.
CompletableFuture<Void>	createReplicationGroup(CreateReplicationGroupRequest request)	Request to create a replication group.
CompletableFuture<Void>	deleteApplication(String applicationName)	Request to delete application in Axon Server.
CompletableFuture<Void>	deleteContext(DeleteContextRequest request)	Request to delete a context in Axon Server.
CompletableFuture<Void>	deleteReplicationGroup(DeleteReplicationGroupRequest request)	Request to delete a replication group in Axon Server.
CompletableFuture<Void>	deleteUser(String username)	Request to delete a user in Axon Server.
void	disconnect()	Disconnect this channel from AxonServer.
ResultStream<EventProcessor>	eventProcessors()	Returns all the event processor registered to AxonServer.
ResultStream<EventProcessor>	eventProcessorsByComponent(String component)	Returns all the event processor registered by the specified application.
CompletableFuture<List<ApplicationOverview>>	getAllApplications()	Request to list all applications in Axon Server.
CompletableFuture<ConnectedApplicationOverview>	getAllConnectedApplications(String contextName)	Request to list all connected applications in Axon Server.
CompletableFuture<List<ContextOverview>>	getAllContexts()	Request to list all contexts in Axon Server.
CompletableFuture<List<NodeOverview>>	getAllNodes()	Request to list all nodes in Axon Server.
CompletableFuture<List<ReplicationGroupOverview>>	getAllReplicationGroups()	Request to list all replication groups in Axon Server.
CompletableFuture<List<UserOverview>>	getAllUsers()	Request to list all users in Axon Server.
CompletableFuture<ApplicationOverview>	getApplication(String applicationName)	Request to retrieve application overview in Axon Server.
CompletableFuture<List<LoadBalancingStrategy>>	getBalancingStrategies()	Returns all available load balance strategies registered to AxonServer.
CompletableFuture<ContextOverview>	getContextOverview(String context)	Request to retrieve a ContextOverview from Axon Server.
CompletableFuture<ReplicationGroupOverview>	getReplicationGroup(String replicationGroup)	Request to retrieve replication group overview in Axon Server.
boolean	isReady()	Validate whether this channel has all required streams connected with AxonServer.
CompletableFuture<Void>	loadBalanceEventProcessor(String eventProcessorName, String tokenStoreIdentifier, String strategy)	Request to balance the load for the given eventProcessorName within the connected client.
CompletableFuture<Result>	mergeEventProcessor(String eventProcessorName, String tokenStoreIdentifier, String context)	Request to merge the two smallest segments of a specific event processor in a specific context.
CompletableFuture<Result>	moveEventProcessorSegment(String eventProcessorName, String tokenStoreIdentifier, int segmentId, String targetClientIdentifier)	Requests to move a specific event processor segment to a certain client.
CompletableFuture<Result>	pauseEventProcessor(String eventProcessorName, String tokenStoreIdentifier, String contextName)	Request to pause a specific event processor in a specific context.
void	reconnect()	Reconnect this channel with AxonServer.
CompletableFuture<Token>	refreshToken(String applicationName)	Request to refresh token of application in Axon Server.
CompletableFuture<Void>	removeNodeFromReplicationGroup(LeaveReplicationGroup request)	Request to remove a node from a replication group.
CompletableFuture<Void>	setAutoLoadBalanceStrategy(String eventProcessorName, String tokenStoreIdentifier, String strategy)	Updates the autoloadbalance strategy for a eventProcessorName within the connected client.
CompletableFuture<Result>	splitEventProcessor(String eventProcessorName, String tokenStoreIdentifier, String context)	Request to split the biggest segment of a specific event processor in a specific context.
CompletableFuture<Result>	startEventProcessor(String eventProcessorName, String tokenStoreIdentifier, String contextName)	Request to start a specific event processor in a specific context.
ResultStream<ContextUpdate>	subscribeToContextUpdates()	Subscribes and listens to context updates from Axon Server, like when a context is created or deleted.
CompletableFuture<Void>	updateContextProperties(UpdateContextPropertiesRequest request)	Request to update the properties for an Axon Server context.

Methods inherited from class io.axoniq.axonserver.connector.impl.AbstractAxonServerChannel

processAck, scheduleImmediateReconnect, scheduleReconnect, sendInstruction

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.axoniq.axonserver.connector.admin.AdminChannel

mergeEventProcessor, pauseEventProcessor, splitEventProcessor, startEventProcessor

Constructor Detail

AdminChannelImpl

public AdminChannelImpl(ClientIdentification clientIdentification,
                        ScheduledExecutorService executor,
                        AxonServerManagedChannel channel)

Method Detail

eventProcessors

public ResultStream<EventProcessor> eventProcessors()

Description copied from interface: AdminChannel

Returns all the event processor registered to AxonServer.

Specified by:

eventProcessors in interface AdminChannel

Returns:

the stream of all event processor registered to AxonServer.

eventProcessorsByComponent

public ResultStream<EventProcessor> eventProcessorsByComponent(String component)

Description copied from interface: AdminChannel

Returns all the event processor registered by the specified application.

Specified by:

eventProcessorsByComponent in interface AdminChannel

Parameters:

component - the component name

Returns:

the stream of all event processor registered to AxonServer by the specified application.

pauseEventProcessor

public CompletableFuture<Result> pauseEventProcessor(String eventProcessorName,
                                                     String tokenStoreIdentifier,
                                                     String contextName)

Description copied from interface: AdminChannel

Request to pause a specific event processor in a specific context. Returns a CompletableFuture that completes when the pause has been performed. The CompletableFuture completes with Result ACCEPTED, if the client application running the event processor is using a version of the connector prior to 4.6.0.

Specified by:

pauseEventProcessor in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to pause

tokenStoreIdentifier - the token store identifier of the processor to pause

contextName - the name of the context where the event processor is

Returns:

a CompletableFuture that completes when the pause has been performed

startEventProcessor

public CompletableFuture<Result> startEventProcessor(String eventProcessorName,
                                                     String tokenStoreIdentifier,
                                                     String contextName)

Description copied from interface: AdminChannel

Request to start a specific event processor in a specific context. Returns a CompletableFuture that completes when the start has been performed The CompletableFuture completes with Result ACCEPTED, if the client application running the event processor is using a version of the connector prior to 4.6.0.

Specified by:

startEventProcessor in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to start

tokenStoreIdentifier - the token store identifier of the processor to start

contextName - the name of the context where the event processor is

Returns:

a CompletableFuture that completes when the start has been performed

splitEventProcessor

public CompletableFuture<Result> splitEventProcessor(String eventProcessorName,
                                                     String tokenStoreIdentifier,
                                                     String context)

Description copied from interface: AdminChannel

Request to split the biggest segment of a specific event processor in a specific context. Returns a CompletableFuture that completes when the split has been performed The CompletableFuture completes with Result ACCEPTED, if the client application running the event processor is using a version of the connector prior to 4.6.0.

Specified by:

splitEventProcessor in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to split

tokenStoreIdentifier - the token store identifier of the processor to split

context - the name of the context where the event processor is

Returns:

a CompletableFuture that completes when the split has been performed

mergeEventProcessor

public CompletableFuture<Result> mergeEventProcessor(String eventProcessorName,
                                                     String tokenStoreIdentifier,
                                                     String context)

Description copied from interface: AdminChannel

Request to merge the two smallest segments of a specific event processor in a specific context. Returns a CompletableFuture that completes when the merge has been performed The CompletableFuture completes with Result ACCEPTED, if the client application running the event processor is using a version of the connector prior to 4.6.0.

Specified by:

mergeEventProcessor in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to merge

tokenStoreIdentifier - the token store identifier of the processor to merge

context - the name of the context where the event processor is

Returns:

a CompletableFuture that completes when the merge has been performed

moveEventProcessorSegment

public CompletableFuture<Result> moveEventProcessorSegment(String eventProcessorName,
                                                           String tokenStoreIdentifier,
                                                           int segmentId,
                                                           String targetClientIdentifier)

Description copied from interface: AdminChannel

Requests to move a specific event processor segment to a certain client. Returns a CompletableFuture that completes when all clients other than the targetClientIdentifier release or disregard the segment for claiming. There is no guarantee that the target client has already claimed the segment when the result completes.

Specified by:

moveEventProcessorSegment in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to move

tokenStoreIdentifier - the token store identifier of the processor to move

segmentId - the identifier of the segment to move

targetClientIdentifier - the desired destination for the segment

Returns:

a CompletableFuture that completes when all the other clients released the segment or disregard the segment for claiming. There is no guarantee that the target client has already claimed the segment when the result completes.

loadBalanceEventProcessor

public CompletableFuture<Void> loadBalanceEventProcessor(String eventProcessorName,
                                                         String tokenStoreIdentifier,
                                                         String strategy)

Description copied from interface: AdminChannel

Request to balance the load for the given eventProcessorName within the connected client. Returns a CompletableFuture that completes when the request has been received by Axon Server. Note that this doesn't imply that the processor is balanced, but only that the request has been properly delivered.

Specified by:

loadBalanceEventProcessor in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to balance the load for

tokenStoreIdentifier - the token store identifier of the processor to balance the load for

strategy - the balancing strategy to use

Returns:

a CompletableFuture that completes when the request is delivered to Axon Server

setAutoLoadBalanceStrategy

public CompletableFuture<Void> setAutoLoadBalanceStrategy(String eventProcessorName,
                                                          String tokenStoreIdentifier,
                                                          String strategy)

Description copied from interface: AdminChannel

Updates the autoloadbalance strategy for a eventProcessorName within the connected client. Returns a CompletableFuture that completes when the request has been received by Axon Server. Note that this doesn't imply that the processor is balanced, but only that the request has been properly delivered.

Specified by:

setAutoLoadBalanceStrategy in interface AdminChannel

Parameters:

eventProcessorName - the name of the event processor to balance the load for

tokenStoreIdentifier - the token store identifier of the processor to balance the load for

strategy - the balancing strategy to use

Returns:

a CompletableFuture that completes when the request is delivered to Axon Server

getBalancingStrategies

public CompletableFuture<List<LoadBalancingStrategy>> getBalancingStrategies()

Description copied from interface: AdminChannel

Returns all available load balance strategies registered to AxonServer.

Specified by:

getBalancingStrategies in interface AdminChannel

Returns:

the list of all available load balance strategies registered to AxonServer.

createOrUpdateUser

public CompletableFuture<Void> createOrUpdateUser(CreateOrUpdateUserRequest request)

Description copied from interface: AdminChannel

Request to create an Axon Server user, or update it if it's already present. Returns a CompletableFuture that completes when the request has been processed by AxonServer.

Specified by:

createOrUpdateUser in interface AdminChannel

Parameters:

request - CreateOrUpdateUserRequest to create the user, containing the username, password and user roles

Returns:

a CompletableFuture that completes when the request has been processed by Axon Server

getAllUsers

public CompletableFuture<List<UserOverview>> getAllUsers()

Description copied from interface: AdminChannel

Request to list all users in Axon Server.

Specified by:

getAllUsers in interface AdminChannel

Returns:

a CompletableFuture that contains list of all UserOverview in Axon Server.

getAllNodes

public CompletableFuture<List<NodeOverview>> getAllNodes()

Description copied from interface: AdminChannel

Request to list all nodes in Axon Server.

Specified by:

getAllNodes in interface AdminChannel

Returns:

a CompletableFuture that contains list of all NodeOverview in Axon Server.

deleteUser

public CompletableFuture<Void> deleteUser(String username)

Description copied from interface: AdminChannel

Request to delete a user in Axon Server.

Specified by:

deleteUser in interface AdminChannel

Parameters:

username - is the username of the user to delete

Returns:

a CompletableFuture that completes when the user has been deleted

createOrUpdateApplication

public CompletableFuture<Token> createOrUpdateApplication(ApplicationRequest request)

Description copied from interface: AdminChannel

Request to create an Axon Server application, or update it if it's already present. Returns a CompletableFuture that completes when the request has been processed by Axon Server.

Specified by:

createOrUpdateApplication in interface AdminChannel

Parameters:

request - ApplicationRequest to create the application

Returns:

a CompletableFuture that contains application Token and completes when the request has been processed by Axon Server

getAllApplications

public CompletableFuture<List<ApplicationOverview>> getAllApplications()

Description copied from interface: AdminChannel

Request to list all applications in Axon Server.

Specified by:

getAllApplications in interface AdminChannel

Returns:

a CompletableFuture that contains list of all ApplicationOverview in Axon Server.

getApplication

public CompletableFuture<ApplicationOverview> getApplication(String applicationName)

Description copied from interface: AdminChannel

Request to retrieve application overview in Axon Server.

Specified by:

getApplication in interface AdminChannel

Parameters:

applicationName - is the name of the application to retrieve

Returns:

a CompletableFuture containing ApplicationOverview with data such as name, roles, etc.

refreshToken

public CompletableFuture<Token> refreshToken(String applicationName)

Description copied from interface: AdminChannel

Request to refresh token of application in Axon Server.

Specified by:

refreshToken in interface AdminChannel

Parameters:

applicationName - is the name of the application to refresh token

Returns:

a CompletableFuture containing new Token

deleteApplication

public CompletableFuture<Void> deleteApplication(String applicationName)

Description copied from interface: AdminChannel

Request to delete application in Axon Server.

Specified by:

deleteApplication in interface AdminChannel

Parameters:

applicationName - is the name of the application to delete

Returns:

a CompletableFuture that completes when application has been deleted

getAllConnectedApplications

public CompletableFuture<ConnectedApplicationOverview> getAllConnectedApplications(String contextName)

Description copied from interface: AdminChannel

Request to list all connected applications in Axon Server.

Specified by:

getAllConnectedApplications in interface AdminChannel

Returns:

a CompletableFuture that contains ConnectedApplicationOverview in Axon Server.

createContext

public CompletableFuture<Void> createContext(CreateContextRequest request)

Description copied from interface: AdminChannel

Request to create an Axon Server context. Returns a CompletableFuture that completes when the request has been processed by Axon Server.

Specified by:

createContext in interface AdminChannel

Parameters:

request - CreateContextRequest to create the context

Returns:

a CompletableFuture that completes when the request has been processed by Axon Server

updateContextProperties

public CompletableFuture<Void> updateContextProperties(UpdateContextPropertiesRequest request)

Description copied from interface: AdminChannel

Request to update the properties for an Axon Server context. Returns a CompletableFuture that completes when the request has been processed by Axon Server.

Specified by:

updateContextProperties in interface AdminChannel

Parameters:

request - UpdateContextPropertiesRequest to update the context properties

Returns:

a CompletableFuture that completes when the request has been processed by Axon Server

deleteContext

public CompletableFuture<Void> deleteContext(DeleteContextRequest request)

Description copied from interface: AdminChannel

Request to delete a context in Axon Server.

Specified by:

deleteContext in interface AdminChannel

Parameters:

request - DeleteContextRequest to delete the context, containing the context name and option to preserve event store.

Returns:

a CompletableFuture that completes when context has been deleted

getContextOverview

public CompletableFuture<ContextOverview> getContextOverview(String context)

Description copied from interface: AdminChannel

Request to retrieve a ContextOverview from Axon Server.

Specified by:

getContextOverview in interface AdminChannel

Parameters:

context - the name of the ContextOverview to retrieve

Returns:

a CompletableFuture containing ContextOverview data such as name, roles, etc.

getAllContexts

public CompletableFuture<List<ContextOverview>> getAllContexts()

Description copied from interface: AdminChannel

Request to list all contexts in Axon Server.

Specified by:

getAllContexts in interface AdminChannel

Returns:

a CompletableFuture that contains a list of all ContextOverview in Axon Server.

subscribeToContextUpdates

public ResultStream<ContextUpdate> subscribeToContextUpdates()

Description copied from interface: AdminChannel

Subscribes and listens to context updates from Axon Server, like when a context is created or deleted.

Specified by:

subscribeToContextUpdates in interface AdminChannel

Returns:

a ResultStream that streams ContextUpdate.

addNodeToReplicationGroup

public CompletableFuture<Void> addNodeToReplicationGroup(JoinReplicationGroup request)

Description copied from interface: AdminChannel

Request to add a node to a replication group. Returns a CompletableFuture that completes when the request has been processed by AxonServer.

Specified by:

addNodeToReplicationGroup in interface AdminChannel

Parameters:

request - JoinReplicationGroup to add a node to replication group, containing the replication group name, the node name, role...

Returns:

a CompletableFuture that completes when the request has been processed to AxonServer

createReplicationGroup

public CompletableFuture<Void> createReplicationGroup(CreateReplicationGroupRequest request)

Description copied from interface: AdminChannel

Request to create a replication group. Returns a CompletableFuture that completes when the request has been processed by Axon Server.

Specified by:

createReplicationGroup in interface AdminChannel

Parameters:

request - CreateReplicationGroupRequest to create replication group, containing the replication group name, the node name, role...

Returns:

a CompletableFuture that completes when the request has been processed to AxonServer

deleteReplicationGroup

public CompletableFuture<Void> deleteReplicationGroup(DeleteReplicationGroupRequest request)

Description copied from interface: AdminChannel

Request to delete a replication group in Axon Server.

Specified by:

deleteReplicationGroup in interface AdminChannel

Parameters:

request - DeleteReplicationGroupRequest to delete the replication group, containing the replication group name and option to preserve event store.

Returns:

a CompletableFuture that completes when the replication group has been deleted

getReplicationGroup

public CompletableFuture<ReplicationGroupOverview> getReplicationGroup(String replicationGroup)

Description copied from interface: AdminChannel

Request to retrieve replication group overview in Axon Server.

Specified by:

getReplicationGroup in interface AdminChannel

Parameters:

replicationGroup - is the name of the replication group to retrieve

Returns:

a CompletableFuture containing ReplicationGroupOverview data such as members, contexts roles, etc.

removeNodeFromReplicationGroup

public CompletableFuture<Void> removeNodeFromReplicationGroup(LeaveReplicationGroup request)

Description copied from interface: AdminChannel

Request to remove a node from a replication group. Returns a CompletableFuture that completes when the request has been processed by Axon Server.

Specified by:

removeNodeFromReplicationGroup in interface AdminChannel

Parameters:

request - LeaveReplicationGroup to a node to be removed from replication group

Returns:

a CompletableFuture that completes when the request has been processed by Axon Server

getAllReplicationGroups

public CompletableFuture<List<ReplicationGroupOverview>> getAllReplicationGroups()

Description copied from interface: AdminChannel

Request to list all replication groups in Axon Server.

Specified by:

getAllReplicationGroups in interface AdminChannel

Returns:

a CompletableFuture that contains list of all ReplicationGroupOverview in Axon Server.

authenticateUser

public CompletableFuture<UserRoles> authenticateUser(String username,
                                                     String password)

Description copied from interface: AdminChannel

Authenticate a user against the information available in Axon Server. Returns a UserRoles object containing the roles for the user. Completes with an exception if the username/password combination is invalid. Requires Axon Server 2023.0 or higher.

Specified by:

authenticateUser in interface AdminChannel

Parameters:

username - the login name of the user

password - the password of the user

Returns:

roles for the user

authenticateToken

public CompletableFuture<ApplicationRoles> authenticateToken(String token)

Description copied from interface: AdminChannel

Authenticate an application token against the information available in Axon Server. Returns a ApplicationRoles object containing the roles for the application. Completes with an exception if the token is invalid. Requires Axon Server 2023.0 or higher.

Specified by:

authenticateToken in interface AdminChannel

Parameters:

token - the application token

Returns:

roles for the application

connect

public void connect()

Description copied from class: AbstractAxonServerChannel

Connect this channel with AxonServer.

Specified by:

connect in class AbstractAxonServerChannel<Void>

reconnect

public void reconnect()

Description copied from class: AbstractAxonServerChannel

Reconnect this channel with AxonServer.

Specified by:

reconnect in class AbstractAxonServerChannel<Void>

disconnect

public void disconnect()

Description copied from class: AbstractAxonServerChannel

Disconnect this channel from AxonServer.

Specified by:

disconnect in class AbstractAxonServerChannel<Void>

isReady

public boolean isReady()

Description copied from class: AbstractAxonServerChannel

Validate whether this channel has all required streams connected with AxonServer. If the state of the channel does not require any active streams, it is considered ready and will return true.

Specified by:

isReady in class AbstractAxonServerChannel<Void>

Returns:

true if this channel is connected with AxonServer or does not require any active connections, false otherwise