Class GetAdminConsoleInfo


  • public class GetAdminConsoleInfo
    extends AdHocCommand
    Command that returns information about the admin console. This command can only be executed by administrators or components of the server.
    Author:
    Gabriel Guardincerri
    • Constructor Detail

      • GetAdminConsoleInfo

        public GetAdminConsoleInfo()
    • Method Detail

      • addStageInformation

        protected void addStageInformation​(@Nonnull
                                           SessionData data,
                                           org.dom4j.Element command)
        Description copied from class: AdHocCommand
        Adds to the command element the data form or notes required by the current stage. The current stage is specified in the SessionData. This method will never be invoked for commands that have no stages.
        Specified by:
        addStageInformation in class AdHocCommand
        Parameters:
        data - metadata and the gathered data through the command stages.
        command - the command element to be sent to the command requester.
      • execute

        public void execute​(@Nonnull
                            SessionData data,
                            org.dom4j.Element command)
        Description copied from class: AdHocCommand
        Executes the command with the specified session data.
        Specified by:
        execute in class AdHocCommand
        Parameters:
        data - metadata and the gathered data through the command stages.
        command - the command element to be sent to the command requester with a reported data result or note element with the answer of the execution.
      • getActions

        protected List<AdHocCommand.Action> getActions​(@Nonnull
                                                       SessionData data)
        Description copied from class: AdHocCommand
        Returns a collection with the allowed actions based on the current stage as defined in the SessionData. Possible actions are: prev, next and complete. This method will never be invoked for commands that have no stages.
        Specified by:
        getActions in class AdHocCommand
        Parameters:
        data - metadata and the gathered data through the command stages.
        Returns:
        a collection with the allowed actions based on the current stage as defined in the SessionData.
      • getCode

        public String getCode()
        Description copied from class: AdHocCommand
        Returns the unique identifier for this command for the containing JID. The code will be used as the node in the disco#items or the node when executing the command.
        Specified by:
        getCode in class AdHocCommand
        Returns:
        the unique identifier for this command for the containing JID.
      • getDefaultLabel

        public String getDefaultLabel()
        Description copied from class: AdHocCommand
        Returns the default label used for describing this command. This information is usually used when returning commands as disco#items. Admins can later use AdHocCommand.setLabel(String) to set a new label and reset to the default value at any time.
        Specified by:
        getDefaultLabel in class AdHocCommand
        Returns:
        the default label used for describing this command.
      • getExecuteAction

        protected AdHocCommand.Action getExecuteAction​(@Nonnull
                                                       SessionData data)
        Description copied from class: AdHocCommand
        Returns which of the actions available for the current stage is considered the equivalent to "execute". When the requester sends his reply, if no action was defined in the command then the action will be assumed "execute" thus assuming the action returned by this method. This method will never be invoked for commands that have no stages.
        Specified by:
        getExecuteAction in class AdHocCommand
        Parameters:
        data - metadata and the gathered data through the command stages.
        Returns:
        which of the actions available for the current stage is considered the equivalent to "execute".
      • getMaxStages

        public int getMaxStages​(@Nonnull
                                SessionData data)
        Description copied from class: AdHocCommand
        Returns the max number of stages for this command. The number of stages may vary according to the collected data in previous stages. Therefore, a SessionData object is passed as a parameter. When the max number of stages has been reached then the command is ready to be executed.
        Specified by:
        getMaxStages in class AdHocCommand
        Parameters:
        data - metadata and the gathered data through the command stages.
        Returns:
        the max number of stages for this command.
      • hasPermission

        public boolean hasPermission​(org.xmpp.packet.JID requester)
        Returns if the requester can access this command. Only admins and components are allowed to execute this command.
        Overrides:
        hasPermission in class AdHocCommand
        Parameters:
        requester - the JID of the user requesting to execute this command.
        Returns:
        true if the requester can access this command.