Package com.io7m.waxmill.client.api

# Interface WXMClientConfigurationType

All Known Implementing Classes:
  `WXMClientConfiguration`

    @Immutable
    public interface WXMClientConfigurationType

Configuration values passed to the client.

- ## Method Summary

  Modifier and Type | Method | Description
  --- | --- | ---
  `default java.nio.file.Path` | `bhyveExecutable()` |
  `default void` | `checkPreconditions()` | Check preconditions for the type.
  `default java.nio.file.Path` | `cuExecutable()` |
  `default java.nio.file.Path` | `grubBhyveExecutable()` |
  `java.nio.file.Path` | `virtualMachineConfigurationDirectory()` | A directory that contains virtual machine configurations.
  `java.nio.file.Path` | `virtualMachineRuntimeDirectory()` | A directory that contains virtual machines.
  `default java.nio.file.Path` | `virtualMachineRuntimeDirectoryFor​(java.util.UUID machineId)` | Derive a runtime directory for a specific virtual machine.
  `default java.nio.file.Path` | `zfsExecutable()` |

- ## Method Details

  - ### virtualMachineConfigurationDirectory

    java.nio.file.Path virtualMachineConfigurationDirectory()
    A directory that contains virtual machine configurations.
    Returns:
      The virtual machine configuration directory

  - ### virtualMachineRuntimeDirectory

    java.nio.file.Path virtualMachineRuntimeDirectory()
    A directory that contains virtual machines. This directory will contain one ZFS filesystem per virtual machine.
    Returns:
      The ZFS directory containing virtual machines

  - ### bhyveExecutable

    @Default default java.nio.file.Path bhyveExecutable()
    Returns:
      The "bhyve" executable path, such as `/usr/sbin/bhyve`

  - ### grubBhyveExecutable

    @Default default java.nio.file.Path grubBhyveExecutable()
    Returns:
      The "grub-bhyve" executable path, such as `/usr/local/sbin/grub-bhyve`

  - ### zfsExecutable

    @Default default java.nio.file.Path zfsExecutable()
    Returns:
      The "zfs" executable path, such as `/sbin/zfs`

  - ### cuExecutable

    @Default default java.nio.file.Path cuExecutable()
    Returns:
      The "cu" executable path, such as `/usr/bin/cu`

  - ### virtualMachineRuntimeDirectoryFor

    default java.nio.file.Path virtualMachineRuntimeDirectoryFor​(java.util.UUID machineId)
    Derive a runtime directory for a specific virtual machine.
    Parameters:
      `machineId` - The machine ID
    Returns:
      A runtime directory

  - ### checkPreconditions

    @Check default void checkPreconditions()
    Check preconditions for the type.