Module org.elasticsearch.nativeaccess
Package org.elasticsearch.nativeaccess

Interface NativeAccess

All Known Implementing Classes:
LinuxNativeAccess, MacNativeAccess, PosixNativeAccess, WindowsNativeAccess
public interface NativeAccess
Provides access to native functionality needed by Elastisearch.

  • Method Details

    • instance

      static NativeAccess instance()
      Get the one and only instance of NativeAccess which is specific to the running platform and JVM.

    • onPosix

      static void onPosix(Consumer<PosixNativeAccess> callback)
      Run the given callback if the current platform is POSIX.
      Parameters:
      callback - A callback consuming a Posix-specific native access instance

    • onPosixReturn

      static <T> Optional<T> onPosixReturn(Function<PosixNativeAccess,T> callback)
      Run the given callback if the current platform is POSIX and return a value.
      Parameters:
      callback - A callback consuming a Posix-specific native access instance and returning a value
      Returns:
      An optional containing the result of the callback if the platform is POSIX, or empty otherwise

    • onWindows

      static void onWindows(Consumer<WindowsNativeAccess> callback)
      Run the given callback if the current platform is Windows.
      Parameters:
      callback - A callback consuming a Windows-specific native access instance

    • onWindowsReturn

      static <T> Optional<T> onWindowsReturn(Function<WindowsNativeAccess,T> callback)
      Run the given callback if the current platform is Windows and return a value.
      Parameters:
      callback - A callback consuming a Windows-specific native access instance and returning a value
      Returns:
      An optional containing the result of the callback if the platform is Windows, or empty otherwise

    • onMac

      static void onMac(Consumer<MacNativeAccess> callback)
      Run the given callback if the current platform is Mac.
      Parameters:
      callback - A callback consuming a Mac-specific native access instance

    • onMacReturn

      static <T> Optional<T> onMacReturn(Function<MacNativeAccess,T> callback)
      Run the given callback if the current platform is Mac and return a value.
      Parameters:
      callback - A callback consuming a Mac-specific native access instance and returning a value
      Returns:
      An optional containing the result of the callback if the platform is Mac, or empty otherwise

    • onLinux

      static void onLinux(Consumer<LinuxNativeAccess> callback)
      Run the given callback if the current platform is Linux.
      Parameters:
      callback - A callback consuming a Linux-specific native access instance

    • onLinuxReturn

      static <T> Optional<T> onLinuxReturn(Function<LinuxNativeAccess,T> callback)
      Run the given callback if the current platform is Linux and return a value.
      Parameters:
      callback - A callback consuming a Linux-specific native access instance and returning a value
      Returns:
      An optional containing the result of the callback if the platform is Linux, or empty otherwise

    • definitelyRunningAsRoot

      boolean definitelyRunningAsRoot()
      Determine whether this JVM is running as the root user.
      Returns:
      true if running as root, or false if unsure

    • getProcessLimits

      ProcessLimits getProcessLimits()
      Return limits for the current process.

    • tryLockMemory

      void tryLockMemory()
      Attempt to lock this process's virtual memory address space into physical RAM.

    • isMemoryLocked

      boolean isMemoryLocked()
      Return whether locking memory was successful, or false otherwise.

    • tryInstallExecSandbox

      void tryInstallExecSandbox()
      Attempts to install a system call filter to block process execution.

    • getExecSandboxState

      NativeAccess.ExecSandboxState getExecSandboxState()
      Return whether installing the exec system call filters was successful, and to what degree.

    • systemd

      Systemd systemd()

    • getZstd

      Zstd getZstd()
      Returns an accessor to zstd compression functions.
      Returns:
      an object used to compress and decompress bytes using zstd

    • allocatedSizeInBytes

      OptionalLong allocatedSizeInBytes(Path path)
      Retrieves the actual number of bytes of disk storage used to store a specified file.
      Parameters:
      path - the path to the file
      Returns:
      an OptionalLong that contains the number of allocated bytes on disk for the file, or empty if the size is invalid

    • tryPreallocate

      void tryPreallocate(Path file, long size)

    • getVectorSimilarityFunctions

      Optional<VectorSimilarityFunctions> getVectorSimilarityFunctions()

    • newSharedBuffer

      CloseableByteBuffer newSharedBuffer(int len)
      Creates a new CloseableByteBuffer using a shared arena. The buffer can be used across multiple threads.
      Parameters:
      len - the number of bytes the buffer should allocate
      Returns:
      the buffer

    • newConfinedBuffer

      CloseableByteBuffer newConfinedBuffer(int len)
      Creates a new CloseableByteBuffer using a confined arena. The buffer must be used within the same thread that it is created.
      Parameters:
      len - the number of bytes the buffer should allocate
      Returns:
      the buffer