Interface ClusterNodeProvider

public interface ClusterNodeProvider
The main api point for accessing node information of all nodes which are currently connected to the current node. As per the CloudNet cluster contract, all nodes need to know all information about each other node without a node in the middle. This means that, for example, Node-1 must be connected to Node-3 to know all information, this will not work if Node-1 is only connected to Node-2, and Node-2 is then connected to Node-3.

Note: Sometimes the documentation of methods in this class refers to the current node - that is either the current component or the node component to which the current wrapped is connected (if running remotely).

Since:
4.0

  • Method Details

    • consoleCommands

      @NonNull @UnmodifiableView @NonNull Collection<CommandInfo> consoleCommands()
      Get all commands which are registered on the current node. Additions and removals to the returned collection are not possible and will not have any effect. There is no way to register a command from this provider because remote commands are not supported. You need to use the node command provider to register a command on the current node.
      Returns:
      all registered commands.

    • consoleCommand

      @Nullable @Nullable CommandInfo consoleCommand(@NonNull @NonNull String name)
      Get an information about a specific registered command on the current node. This method returns null if no command with the given name is present on the current node.
      Parameters:
      name - the name of the command to get the information of.
      Returns:
      the command info of the command with the given name or null if no such command exists.
      Throws:
      NullPointerException - if the given command name is null.

    • consoleTabCompleteResults

      @NonNull @NonNull Collection<String> consoleTabCompleteResults(@NonNull @NonNull String commandLine)
      Gets all tab complete results for the next argument in the provided command line. An empty command line will list all root command names. This method resolves all tab completion results which are allowed to be executed via a console command source. This does not mean that the api is actually able to execute the command. For example, if the input is tasks one suggestion might be setup (which will start the task console setup animation), the api is not allowed to execute that command but the result will be listed anyway.
      Parameters:
      commandLine - the current command line input to start the tab completion based on.
      Returns:
      the suggestions for further input based on the current command line.
      Throws:
      NullPointerException - if the given command line is null.

    • sendCommandLine

      @NonNull @NonNull Collection<String> sendCommandLine(@NonNull @NonNull String commandLine)
      Sends the given command line to the current node and returns the output of the command from the execution. Only lines which were sent to the command sender are returned, lines send to the console directly are not caught by this method.
      Parameters:
      commandLine - the command line to execute.
      Returns:
      all lines send to the command sender associated with this method call.
      Throws:
      NullPointerException - if the given command line is null.

    • nodes

      @NonNull @UnmodifiableView @NonNull Collection<NetworkClusterNode> nodes()
      Gets all nodes which are currently registered on the current node. As per the CloudNet cluster contract, each node must know all other nodes in the cluster. Therefore, the returned collection is not synced with the cluster. Additions and removals to the returned collection are not possible and will not have a result, use the add/remove node methods for that purpose.
      Returns:
      all nodes which are registered on the current node.

    • node

      @Nullable @Nullable NetworkClusterNode node(@NonNull @NonNull String uniqueId)
      Get the network cluster node object association from the given node unique id registered on the current node. This method returns null if no node with the given unique is registered on the local node.
      Parameters:
      uniqueId - the unique id of the node to get the associated object of.
      Returns:
      the cluster node object registered on the current node or null if no node with the given name is present.
      Throws:
      NullPointerException - if the given unique id is null.

    • addNode

      boolean addNode(@NonNull @NonNull NetworkClusterNode node)
      Adds a new node on the current node and synchronizes the change into the cluster. This method has no effect if a node with the same unique id is already present. This will also update the ip whitelist of all nodes and adds all network listeners of the given cluster node to it.

      After registering the node it can directly connect to the node the action was executed on. There is no guarantee that the method has an immediate effect on all nodes.

      Parameters:
      node - the node to register.
      Returns:
      true if the node was registered successfully, false otherwise.
      Throws:
      NullPointerException - if the given node to register is null.

    • removeNode

      boolean removeNode(@NonNull @NonNull String uniqueId)
      Removes the given node on the current node and synchronizes the change into the cluster. This method has no effect if no node with the given unique id is registered on the current node. This will also update the ip whitelist of all nodes and removes all network listeners of the given cluster node from it.

      This method has an immediate effect. All nodes will disconnect the node and mark all services started on it as removed. The node has no chance after the method call to reconnect to the cluster until it was added again.

      Parameters:
      uniqueId - the unique id of the node to remove.
      Returns:
      true if the node was removed successfully, false otherwise.
      Throws:
      NullPointerException - if the given node unique id is null.

    • nodeInfoSnapshots

      @NonNull @NonNull Collection<NodeInfoSnapshot> nodeInfoSnapshots()
      Get the network cluster node snapshots of all nodes which are currently connected to the current node. A node might be registered and able to connect to the cluster, but will not appear in the list when it is not connected (or didn't send a snapshot after the connection yet).

      The returned snapshot collection is not modifiable as additions or removals from it will have no effect.

      Returns:
      the snapshot information of all nodes which are currently connected to the current node.

    • nodeInfoSnapshot

      @Nullable @Nullable NodeInfoSnapshot nodeInfoSnapshot(@NonNull @NonNull String uniqueId)
      Get the network cluster node snapshot of the node with the given unique id. This method returns null either if no node with the given unique id exists or the node is currently not connected. If the existence of a node should get checked, use node(String) instead.
      Parameters:
      uniqueId - the unique id of the node to get the snapshot of.
      Returns:
      the snapshot of the node or null if no node with the given id is registered or the node is not connected.
      Throws:
      NullPointerException - if the given node unique id is null.

    • consoleCommandsAsync

      @NonNull @NonNull CompletableFuture<Collection<CommandInfo>> consoleCommandsAsync()
      Get all commands which are registered on the current node. Additions and removals to the returned collection are not possible and will not have any effect. There is no way to register a command from this provider because remote commands are not supported. You need to use the node command provider to register a command on the current node.
      Returns:
      a task completed with all registered commands.

    • consoleCommandAsync

      @NonNull @NonNull CompletableFuture<CommandInfo> consoleCommandAsync(@NonNull @NonNull String name)
      Get an information about a specific registered command on the current node. This method returns null if no command with the given name is present on the current node.
      Parameters:
      name - the name of the command to get the information of.
      Returns:
      a task completed with the info of the command with the given name or null if no such command exists.
      Throws:
      NullPointerException - if the given command name is null.

    • consoleTabCompleteResultsAsync

      @NonNull @NonNull CompletableFuture<Collection<String>> consoleTabCompleteResultsAsync(@NonNull @NonNull String commandLine)
      Gets all tab complete results for the next argument in the provided command line. An empty command line will list all root command names. This method resolves all tab completion results which are allowed to be executed via a console command source. This does not mean that the api is actually able to execute the command. For example, if the input is task one suggestion might be setup (which will start the task console setup animation), the api is not allowed to execute that command but the result will be listed anyway.
      Parameters:
      commandLine - the current command line input to start the tab completion based on.
      Returns:
      a task completed with the suggestions for further input based on the current command line.
      Throws:
      NullPointerException - if the given command line is null.

    • sendCommandLineAsync

      @NonNull @NonNull CompletableFuture<Collection<String>> sendCommandLineAsync(@NonNull @NonNull String commandLine)
      Sends the given command line to the current node and returns the output of the command from the execution. Only lines which were sent to the command sender are returned, lines send to the console directly are not caught by this method.
      Parameters:
      commandLine - the command line to execute.
      Returns:
      a task completed with all lines send to the command sender associated with this method call.
      Throws:
      NullPointerException - if the given command line is null.

    • nodesAsync

      @NonNull @NonNull CompletableFuture<Collection<NetworkClusterNode>> nodesAsync()
      Gets all nodes which are currently registered on the current node. As per the CloudNet cluster contract, each node must know all other nodes in the cluster. Therefore, the returned collection is not synced with the cluster. Additions and removals to the returned collection are not possible will not have a result, use the add/remove node methods for that purpose.
      Returns:
      a task completed with all nodes which are registered on the current node.

    • nodeAsync

      @NonNull @NonNull CompletableFuture<NetworkClusterNode> nodeAsync(@NonNull @NonNull String uniqueId)
      Get the network cluster node object association from the given node unique id registered on the current node. This method returns null if no node with the given unique is registered on the local node.
      Parameters:
      uniqueId - the unique id of the node to get the associated object of.
      Returns:
      a task completed with the cluster node object associated with the given unique id or null if unknown.
      Throws:
      NullPointerException - if the given unique id is null.

    • addNodeAsync

      @NonNull @NonNull CompletableFuture<Boolean> addNodeAsync(@NonNull @NonNull NetworkClusterNode node)
      Adds a new node on the current node and synchronizes the change into the cluster. This method has no effect if a node with the same unique id is already present. This will also update the ip whitelist of all nodes and adds all network listeners of the given cluster node to it.

      After registering the node it can directly connect to the node the action was executed on. There is no guarantee that the method has an immediate effect on all nodes.

      Parameters:
      node - the node to register.
      Returns:
      a task completed with true if the node was registered successfully, false otherwise.
      Throws:
      NullPointerException - if the given node to register is null.

    • removeNodeAsync

      @NonNull @NonNull CompletableFuture<Boolean> removeNodeAsync(@NonNull @NonNull String uniqueId)
      Removes the given node on the current node and synchronizes the change into the cluster. This method has no effect if no node with the given unique id is registered on the current node. This will also update the ip whitelist of all nodes and removes all network listeners of the given cluster node from it.

      This method has an immediate effect. All nodes will disconnect the node and mark all services started on it as removed. The node has no chance after the method call to reconnect to the cluster until it was added again.

      Parameters:
      uniqueId - the unique id of the node to remove.
      Returns:
      a task completed with true if the node was removed successfully, false otherwise.
      Throws:
      NullPointerException - if the given node unique id is null.

    • nodeInfoSnapshotsAsync

      @NonNull @NonNull CompletableFuture<Collection<NodeInfoSnapshot>> nodeInfoSnapshotsAsync()
      Get the network cluster node snapshots of all nodes which are currently connected to the current node. A node might be registered and able to connect to the cluster, but will not appear in the list when it is not connected (or didn't send a snapshot after the connection yet).

      The returned snapshot collection is not modifiable as additions or removals from it will have no effect.

      Returns:
      a task completed with the snapshot of all nodes which are currently connected to the current node.

    • nodeInfoSnapshotAsync

      @NonNull @NonNull CompletableFuture<NodeInfoSnapshot> nodeInfoSnapshotAsync(@NonNull @NonNull String uniqueId)
      Get the network cluster node snapshot of the node with the given unique id. This method returns null either if no node with the given unique id exists or the node is currently not connected. If the existence of a node should get checked, use node(String) instead.
      Parameters:
      uniqueId - the unique id of the node to get the snapshot of.
      Returns:
      a task completed with the snapshot of the node or null if the node is not registered or connected.
      Throws:
      NullPointerException - if the given node unique id is null.