Package org.apache.pekko.cluster

Interface ClusterNodeMBean

  • public interface ClusterNodeMBean
    Interface for the cluster JMX MBean.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void down​(java.lang.String address)
      Send command to DOWN the node specified by 'address'.
      java.lang.String getClusterStatus()
      JSON format of the status of all nodes in the cluster as follows:
      java.lang.String getLeader()
      Get the address of the current leader.
      java.lang.String getMembers()
      Comma separated addresses of member nodes, sorted in the cluster ring order.
      java.lang.String getMemberStatus()
      Member status for this node.
      java.lang.String getUnreachable()
      Comma separated addresses of unreachable member nodes.
      boolean isAvailable()
      Returns true if the node is not unreachable and not Down and not Removed.
      boolean isSingleton()
      Does the cluster consist of only one member?
      void join​(java.lang.String address)
      Try to join this cluster node with the node specified by 'address'.
      void leave​(java.lang.String address)
      Send command to issue state transition to LEAVING for the node specified by 'address'.

    • Method Detail

      • down

        void down​(java.lang.String address)
        Send command to DOWN the node specified by 'address'. The address format is pekko://actor-system-name@hostname:port

      • getClusterStatus

        java.lang.String getClusterStatus()
        JSON format of the status of all nodes in the cluster as follows: 
        
 {
   "self-address": "pekko://system@host1:7355",
   "members": [
     {
       "address": "pekko://system@host1:7355",
       "status": "Up",
       "app-version": "1.0.0",
       "roles": [
         "frontend"
       ]
     },
     {
       "address": "pekko://system@host2:7355",
       "status": "Up",
       "app-version": "1.0.0",
       "roles": [
         "frontend"
       ]
     },
     {
       "address": "pekko://system@host3:7355",
       "status": "Down",
       "app-version": "1.0.0",
       "roles": [
         "backend"
       ]
     },
     {
       "address": "pekko://system@host4:7355",
       "status": "Joining",
       "app-version": "1.1.0",
       "roles": [
         "backend"
       ]
     }
   ],
   "unreachable": [
     {
       "node": "pekko://system@host2:7355",
       "observed-by": [
         "pekko://system@host1:7355",
         "pekko://system@host3:7355"
       ]
     },
     {
       "node": "pekko://system@host3:7355",
       "observed-by": [
         "pekko://system@host1:7355",
         "pekko://system@host2:7355"
       ]
     }
   ]
 }

      • getLeader

        java.lang.String getLeader()
        Get the address of the current leader. The address format is pekko://actor-system-name@hostname:port

      • getMemberStatus

        java.lang.String getMemberStatus()
        Member status for this node.

      • getMembers

        java.lang.String getMembers()
        Comma separated addresses of member nodes, sorted in the cluster ring order. The address format is pekko://actor-system-name@hostname:port

      • getUnreachable

        java.lang.String getUnreachable()
        Comma separated addresses of unreachable member nodes. The address format is pekko://actor-system-name@hostname:port

      • isAvailable

        boolean isAvailable()
        Returns true if the node is not unreachable and not Down and not Removed.

      • isSingleton

        boolean isSingleton()
        Does the cluster consist of only one member?

      • join

        void join​(java.lang.String address)
        Try to join this cluster node with the node specified by 'address'. The address format is pekko://actor-system-name@hostname:port. A 'Join(thisNodeAddress)' command is sent to the node to join.

      • leave

        void leave​(java.lang.String address)
        Send command to issue state transition to LEAVING for the node specified by 'address'. The address format is pekko://actor-system-name@hostname:port