Package io.agentscope.harness.agent.sandbox.impl.docker

Class DockerSandboxClient

java.lang.Object

io.agentscope.harness.agent.sandbox.impl.docker.DockerSandboxClient

All Implemented Interfaces:

SandboxClient<DockerSandboxClientOptions>

public class DockerSandboxClient
extends Object
implements SandboxClient<DockerSandboxClientOptions>

SandboxClient implementation for the Docker sandbox store.

Creates and manages Docker containers via the docker CLI. The Docker daemon must be accessible from the host's PATH.

Constructor Summary

Constructors

Constructor	Description
DockerSandboxClient()
DockerSandboxClient(com.fasterxml.jackson.databind.ObjectMapper objectMapper)	Uses the given mapper as-is.

Method Summary

Modifier and Type	Method	Description
Sandbox	create(WorkspaceSpec workspaceSpec, SandboxSnapshotSpec snapshotSpec, DockerSandboxClientOptions options)	Creates a new sandbox with the given workspace spec and snapshot spec.
void	delete(Sandbox sandbox)
SandboxState	deserializeState(String json)
SandboxState	deserializeState(String json, SandboxSnapshotSpec snapshotSpec)
Sandbox	resume(SandboxState state)	Resumes a sandbox from previously serialized SandboxState.
String	serializeState(SandboxState state)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DockerSandboxClient

public DockerSandboxClient()

DockerSandboxClient

public DockerSandboxClient(com.fasterxml.jackson.databind.ObjectMapper objectMapper)

Uses the given mapper as-is. For SandboxState JSON round-trip, register HarnessSandboxJacksonModule (and any extra NamedType for custom state subclasses) on this mapper before calling deserializeState(java.lang.String).

Method Details

create

public Sandbox create(WorkspaceSpec workspaceSpec,
 SandboxSnapshotSpec snapshotSpec,
 DockerSandboxClientOptions options)

Description copied from interface: SandboxClient

Creates a new sandbox with the given workspace spec and snapshot spec.

Returned in a pre-start state; call Sandbox.start() before use.

Specified by:

create in interface SandboxClient<DockerSandboxClientOptions>

resume

public Sandbox resume(SandboxState state)

Description copied from interface: SandboxClient

Resumes a sandbox from previously serialized SandboxState.

Specified by:

resume in interface SandboxClient<DockerSandboxClientOptions>

delete

public void delete(Sandbox sandbox)

Specified by:

delete in interface SandboxClient<DockerSandboxClientOptions>

serializeState

public String serializeState(SandboxState state)

Specified by:

serializeState in interface SandboxClient<DockerSandboxClientOptions>

deserializeState

public SandboxState deserializeState(String json)

Specified by:

deserializeState in interface SandboxClient<DockerSandboxClientOptions>

deserializeState

public SandboxState deserializeState(String json,
 SandboxSnapshotSpec snapshotSpec)

Specified by:

deserializeState in interface SandboxClient<DockerSandboxClientOptions>