Insider.Sentinel.Sandbox.Provider behaviour (Insider Lab v0.1.0)

Copy Markdown View Source

Behaviour for trusted disposable-target adapters.

Providers must register every resource under owner_id before creating it, make cleanup idempotent, and support cleanup by owner even when acquisition did not return. Provider modules are trusted runtime configuration and must never be selected by converting wire strings to atoms.

Summary

Types

deadline()

@type deadline() :: integer()

owner_id()

@type owner_id() :: binary()

resource_reference()

@type resource_reference() :: %{required(String.t()) => String.t()}

Callbacks

acquire(owner_id, t, deadline)

@callback acquire(owner_id(), Insider.Sentinel.Sandbox.Target.t(), deadline()) ::
  :ok | {:error, atom()}

cleanup(owner_id, deadline)

@callback cleanup(owner_id(), deadline()) :: :ok | {:error, atom()}

identity()

@callback identity() :: map()

inventory(owner_id, deadline)

@callback inventory(owner_id(), deadline()) ::
  {:ok, [resource_reference()]} | {:error, atom()}

observe(owner_id, deadline)

@callback observe(owner_id(), deadline()) :: {:ok, map()} | {:error, atom()}