类class io.agentscope.harness.agent.filesystem.sandbox 2.x

BaseSandboxFilesystem

public abstract class BaseSandboxFilesystem implements AbstractSandboxFilesystem

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:55–505

基类沙箱文件系统，承载智能体的部署、调度与服务化运行。位于 io.agentscope.harness.agent.filesystem.sandbox 包，实现 AbstractSandboxFilesystem。核心成员包括 id、execute、uploadFiles、downloadFiles、ls、read。

Abstract base sandbox implementation with #execute as the core abstract method.

This class provides default implementations for all AbstractFilesystem methods by delegating to shell commands via #execute. File listing, grep, and glob use standard Unix commands. Read uses server-side commands for paginated access. Write delegates content transfer to #uploadFiles. Edit uses server-side commands for string replacement.

Subclasses must implement:

#execute - execute a command in the sandbox
#uploadFiles - upload files to the sandbox
#downloadFiles - download files from the sandbox
#id() - unique identifier for the sandbox instance

方法摘要Method Summary

方法Method	说明Description
`public abstract String id()` abstract	返回标识。 Returns the id.
`public abstract` `ExecuteResponse execute(RuntimeContext runtimeContext, String command, Integer timeoutSeconds)` abstract	执行执行相关操作。 Performs the execute operation.
`public abstract List<FileUploadResponse> uploadFiles(RuntimeContext runtimeContext, List<Map.Entry<String, byte[]>> files)` abstract	执行上传文件相关操作。 Performs the upload files operation.
`public abstract List<FileDownloadResponse> downloadFiles(RuntimeContext runtimeContext, List<String> paths)` abstract	执行下载文件相关操作。 Performs the download files operation.
`public` `LsResult ls(RuntimeContext runtimeContext, String path)`	执行 `ls` 方法。 Performs the ls operation.
`public` `ReadResult read(RuntimeContext runtimeContext, String filePath, int offset, int limit)`	执行读取相关操作。 Performs the read operation.
`public` `WriteResult write(RuntimeContext runtimeContext, String filePath, String content)`	执行写入相关操作。 Performs the write operation.
`public` `EditResult edit(RuntimeContext runtimeContext, String filePath, String oldString, String newString, boolean replaceAll)`	执行 `edit` 方法。 Performs the edit operation.
`public` `GrepResult grep(RuntimeContext runtimeContext, String pattern, String path, String glob)`	执行 `grep` 方法。 Performs the grep operation.
`public` `GlobResult glob(RuntimeContext runtimeContext, String pattern, String path)`	执行 `glob` 方法。 Performs the glob operation.
`public` `WriteResult delete(RuntimeContext runtimeContext, String path)`	删除数据。 Performs the delete operation.
`public` `WriteResult move(RuntimeContext runtimeContext, String fromPath, String toPath)`	执行 `move` 方法。 Performs the move operation.
`public boolean exists(RuntimeContext runtimeContext, String path)`	判断数据是否存在。 Performs the exists operation.

方法详情Method Detail

id

public abstract String id()

abstract

返回标识。

Returns the id.

返回Returns String

返回字符串结果。Returns a string.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:57–58

execute

public abstract ExecuteResponse execute(RuntimeContext runtimeContext, String command, Integer timeoutSeconds)

abstract

执行执行相关操作。

Performs the execute operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`command`	String	命令（类型 `String`）。The command.
`timeoutSeconds`	Integer	超时秒（类型 `Integer`）。The timeout seconds.

返回Returns ExecuteResponse

返回ExecuteResponse。Returns execute response.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:60–62

uploadFiles

public abstract List<FileUploadResponse> uploadFiles(RuntimeContext runtimeContext, List<Map.Entry<String, byte[]>> files)

abstract

执行上传文件相关操作。

Performs the upload files operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`files`	List<Map.Entry<String, byte[]>>	文件（类型 `List >`）。The files.

返回Returns List<FileUploadResponse>

返回列出。Returns list.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:64–66

downloadFiles

public abstract List<FileDownloadResponse> downloadFiles(RuntimeContext runtimeContext, List<String> paths)

abstract

执行下载文件相关操作。

Performs the download files operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`paths`	List<String>	paths（类型 `List`）。The paths.

返回Returns List<FileDownloadResponse>

返回列出。Returns list.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:68–70

ls

public LsResult ls(RuntimeContext runtimeContext, String path)

执行 ls 方法。

Performs the ls operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`path`	String	路径（类型 `String`）。The path.

返回Returns LsResult

返回LsResult。Returns ls result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:72–130

read

public ReadResult read(RuntimeContext runtimeContext, String filePath, int offset, int limit)

执行读取相关操作。

Performs the read operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`filePath`	String	文件路径（类型 `String`）。The file path.
`offset`	int	偏移量（类型 `int`）。The offset.
`limit`	int	数量上限（类型 `int`）。The limit.

返回Returns ReadResult

返回ReadResult。Returns read result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:132–192

write

public WriteResult write(RuntimeContext runtimeContext, String filePath, String content)

执行写入相关操作。

Performs the write operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`filePath`	String	文件路径（类型 `String`）。The file path.
`content`	String	内容（类型 `String`）。The content.

返回Returns WriteResult

返回WriteResult。Returns write result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:194–232

edit

public EditResult edit(RuntimeContext runtimeContext, String filePath, String oldString, String newString, boolean replaceAll)

执行 edit 方法。

Performs the edit operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`filePath`	String	文件路径（类型 `String`）。The file path.
`oldString`	String	旧的 String（类型 `String`）。The old string.
`newString`	String	新建 String（类型 `String`）。The new string.
`replaceAll`	boolean	replace 所有（类型 `boolean`）。The replace all.

返回Returns EditResult

返回EditResult。Returns edit result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:234–319

grep

public GrepResult grep(RuntimeContext runtimeContext, String pattern, String path, String glob)

执行 grep 方法。

Performs the grep operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`pattern`	String	pattern（类型 `String`）。The pattern.
`path`	String	路径（类型 `String`）。The path.
`glob`	String	glob（类型 `String`）。The glob.

返回Returns GrepResult

返回GrepResult。Returns grep result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:321–367

glob

public GlobResult glob(RuntimeContext runtimeContext, String pattern, String path)

执行 glob 方法。

Performs the glob operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`pattern`	String	pattern（类型 `String`）。The pattern.
`path`	String	路径（类型 `String`）。The path.

返回Returns GlobResult

返回GlobResult。Returns glob result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:369–413

delete

public WriteResult delete(RuntimeContext runtimeContext, String path)

删除数据。

Performs the delete operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`path`	String	路径（类型 `String`）。The path.

返回Returns WriteResult

返回WriteResult。Returns write result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:415–425

move

public WriteResult move(RuntimeContext runtimeContext, String fromPath, String toPath)

执行 move 方法。

Performs the move operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`fromPath`	String	来自路径（类型 `String`）。The from path.
`toPath`	String	到路径（类型 `String`）。The to path.

返回Returns WriteResult

返回WriteResult。Returns write result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:427–440

exists

public boolean exists(RuntimeContext runtimeContext, String path)

判断数据是否存在。

Performs the exists operation.

参数Parameters

名称Name	类型Type	说明Description
`runtimeContext`	RuntimeContext	运行时上下文（类型 `RuntimeContext`）。The runtime context.
`path`	String	路径（类型 `String`）。The path.

返回Returns boolean

返回布尔值，表示判断结果。Returns a boolean result.

源码Source io/agentscope/harness/agent/filesystem/sandbox/BaseSandboxFilesystem.java:442–451

继承成员Inherited Members

继承自Methods inherited from AbstractFilesystem

validatePath