Interface MachineExtensionPoint

All Superinterfaces:
org.pf4j.ExtensionPoint, ExtensionProviderPoint

public interface MachineExtensionPoint extends ExtensionProviderPoint
Interface for machine extension points.
  • Method Details

    • stats

      ProcessStats stats(Machine machineIO)
      Calculates the statistics for a given machine.
      Parameters:
      machineIO - The Machines object representing the machine for which the statistics should be calculated.
      Returns:
      The ProcessStats object containing the calculated statistics.
    • config

      MachineExtensionConfig config(Machine machineIO)
      Retrieves the configuration for a given machine.
      Parameters:
      machineIO - The Machines object representing the machine for which the configuration should be retrieved.
      Returns:
      The MachineExtensionConfig object containing the configuration settings for the specified machine.
    • config

      Retrieves the configuration for a given machine.
      Returns:
      The MachineExtensionConfig object containing the configuration settings for the specified machine.
    • vnc

      VNCSocket vnc(Machine virtualized)
      Creates a VNCSocket for virtualized Machines.
      Parameters:
      virtualized - the Machines object representing the virtualized machine
      Returns:
      the VNCSocket object containing the information necessary for VNC connection (ticket, cert, port, hostname, user)
    • status

      ProcessStatus status(Machine machinesIO)
      Retrieves the status of the specified Machines object by executing the status action using available machine extension points.
      Parameters:
      machinesIO - the Machines object for which the status needs to be retrieved
      Returns:
      the ProcessStatus representing the status of the specified Machines object
    • restart

      void restart(Machine machinesIO)
      Restarts the given Machines object.
      Parameters:
      machinesIO - the Machines object that needs to be restarted
    • stop

      void stop(Machine machinesIO)
      Stops the given Machines object.
      Parameters:
      machinesIO - The Machines object representing the machine to be stopped.
    • start

      void start(Machine machinesIO)
      Starts the given Machine object.
      Parameters:
      machinesIO - The Machine object that needs to be started.
    • wol

      void wol(Machine machinesIO)
      Send WOL Magic Packet to given Machines to Wake Up on Lan.
      Parameters:
      machinesIO -
    • log

      String log(Machine machinesIO)
      Retrieves the log for the specified Machines object.
      Parameters:
      machinesIO - The Machines object for which the log needs to be retrieved.
      Returns:
      The log string for the specified Machines object.
    • attach

      void attach(Machine machineIO, ProcessConsole consoleIO)
      Attaches the specified console to the given machine (Serial Console).
      Parameters:
      machineIO - The Machine object to which the console will be attached.
      consoleIO - The ProcessConsole object representing the console to be attached.