Package tigase.cluster.api

Interface CommandListener

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void executeCommand​(JID fromNode, java.util.Set<JID> visitedNodes, java.util.Map<java.lang.String,​java.lang.String> data, java.util.Queue<Element> packets)
      Method is responsible for executing commands from other nodes and appropriate processing
      java.lang.String getName()
      Method allows retrieval name of the particular command
      Priority getPriority()
      Method returns priority of particular command which should be used to assign proper priority for processing of this command
      void getStatistics​(StatisticsList list)
      Method allows retrieval possible statistics for particular command
      void setName​(java.lang.String name)
      Method allows setting name of the command

      • Methods inherited from interface java.lang.Comparable

        compareTo

    • Method Detail

      • executeCommand

        void executeCommand​(JID fromNode,
                    java.util.Set<JID> visitedNodes,
                    java.util.Map<java.lang.String,​java.lang.String> data,
                    java.util.Queue<Element> packets)
             throws ClusterCommandException
        Method is responsible for executing commands from other nodes and appropriate processing
        Parameters:
        fromNode - address of the node from which command was received
        visitedNodes - collection of already visited nodes
        data - additional data associated with the command in addition to the main Element
        packets - collection of Element commands to be executed
        Throws:
        ClusterCommandException - execution exception

      • getName

        java.lang.String getName()
        Method allows retrieval name of the particular command
        Returns:
        a value of String name of the command

      • setName

        void setName​(java.lang.String name)
        Method allows setting name of the command
        Parameters:
        name - to be used

      • getPriority

        Priority getPriority()
        Method returns priority of particular command which should be used to assign proper priority for processing of this command

      • getStatistics

        void getStatistics​(StatisticsList list)
        Method allows retrieval possible statistics for particular command
        Parameters:
        list - collection to which statistics should be appended