BaseClient
public abstract class BaseClient源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:27–122基类客户端，封装与远端服务的连接和调用。位于 io.agentscope.runtime.sandbox.manager.client 包。核心成员包括 connect、createContainer、startContainer、stopContainer、removeContainer、getContainerStatus。
Container management client base class Defines basic interfaces for container management, supports Docker and Kubernetes implementations
方法摘要Method Summary
方法详情Method Detail
connect
public abstract boolean connect()abstract
建立连接并完成初始化。
Connect to container management service
boolean返回布尔值，表示判断结果。connection status
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:33createContainer
public abstract ContainerCreateResult createContainer(String containerName, String imageName, List<String> ports, List<VolumeBinding> volumeBindings, Map<String, String> environment, Map<String, Object> runtimeConfig)abstract
创建容器。
Create container
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerName | String | 容器名称（类型 `String`）。container name |
imageName | String | 图像名称（类型 `String`）。image name |
ports | List<String> | ports（类型 `List`）。port list |
volumeBindings | List<VolumeBinding> | volume Bindings（类型 `List`）。volume bindings |
environment | Map<String, String> | 环境（类型 `Map`）。environment variables |
runtimeConfig | Map<String, Object> | 运行时配置（类型 `Map`）。runtime configuration |
ContainerCreateResult返回ContainerCreateResult。ContainerCreateResult containing containerId, ports, ip, and optional protocol
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:45–48startContainer
public abstract void startContainer(String containerId)abstract
启动容器。
Start container
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。container ID |
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:54stopContainer
public abstract void stopContainer(String containerId)abstract
停止容器。
Stop container
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。container ID |
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:60removeContainer
public abstract void removeContainer(String containerId)abstract
移除容器。
Remove container
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。container ID |
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:66getContainerStatus
public abstract String getContainerStatus(String containerId)abstract
获取容器状态。
Get container status
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。container ID |
String返回字符串结果。container status
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:73stopAndRemoveContainer
public void stopAndRemoveContainer(String containerId)停止和移除容器。
Stop and remove container
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerId | String | 容器标识（类型 `String`）。container ID |
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:79–82isConnected
public abstract boolean isConnected()abstract
检查连接状态。
Check connection status
boolean判断是否已连接。whether connected
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:88imageExists
public abstract boolean imageExists(String imageName)abstract
设置该参数。
Check if image exists locally
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
imageName | String | 图像名称（类型 `String`）。image name |
boolean返回布尔值，表示判断结果。whether image exists locally
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:95inspectContainer
public abstract boolean inspectContainer(String containerIdOrName)abstract
设置该参数。
Inspect container to check if it exists
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
containerIdOrName | String | 容器标识或名称（类型 `String`）。container ID or name |
boolean返回布尔值，表示判断结果。true if container exists, false otherwise
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:102pullImage
public abstract boolean pullImage(String imageName)abstract
设置该参数。
Pull image from registry
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
imageName | String | 图像名称（类型 `String`）。image name |
boolean返回布尔值，表示判断结果。whether pull was successful
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:109ensureImageAvailable
public boolean ensureImageAvailable(String imageName)设置确保图像可用。
Ensure image is available (check and pull if needed)
参数Parameters
| 名称Name | 类型Type | 说明Description |
|---|---|---|
imageName | String | 图像名称（类型 `String`）。image name |
boolean判断是否图像是可用。whether image is available
源码Source
io/agentscope/runtime/sandbox/manager/client/BaseClient.java:116–121