AS AgentScopeAPI 手册 / API Reference

RoutedSandboxFilesystem

public final class RoutedSandboxFilesystem implements AbstractSandboxFilesystem
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:41–138

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

Prefix-routed filesystem that preserves shell execution on the primary sandbox backend.

File operations are delegated to an internal CompositeFilesystem (primary as default backend + optional prefix routes). #execute and #id always go to primary, so Managed Agents can mount JPA-backed memory-stores/ routes alongside a SandboxBackedFilesystem without losing shell_execute.

构造器摘要Constructor Summary

构造器Constructor说明Description
public RoutedSandboxFilesystem(AbstractSandboxFilesystem primary, Map<String, AbstractFilesystem> routes)
初始化 `RoutedSandboxFilesystem` 实例。
Creates a new instance.

方法摘要Method Summary

方法Method说明Description
public AbstractSandboxFilesystem primary()
返回 `primary` 结果。
Returns the primary sandbox filesystem (lifecycle middleware injects into this).
public AbstractFilesystem backendFor(String path)
设置该参数。
Returns the backend that would serve `path`: the longest matching prefix route, or the primary sandbox filesystem when no route matches.
public String id()
返回标识。
Returns the id.
public ExecuteResponse execute(RuntimeContext runtimeContext, String command, Integer timeoutSeconds)
执行执行相关操作。
Performs the execute 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 List<FileUploadResponse> uploadFiles(RuntimeContext runtimeContext, List<Map.Entry<String, byte[]>> files)
执行上传文件相关操作。
Performs the upload files operation.
public List<FileDownloadResponse> downloadFiles(RuntimeContext runtimeContext, List<String> paths)
执行下载文件相关操作。
Performs the download files 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.

构造器详情Constructor Detail

RoutedSandboxFilesystem

public RoutedSandboxFilesystem(AbstractSandboxFilesystem primary, Map<String, AbstractFilesystem> routes)

初始化 RoutedSandboxFilesystem 实例。

Creates a new instance.

参数Parameters
名称Name类型Type说明Description
primaryAbstractSandboxFilesystemprimary(类型 `AbstractSandboxFilesystem`)。The primary.
routesMap<String, AbstractFilesystem>路由(类型 `Map`)。The routes.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:46–50

方法详情Method Detail

primary

public AbstractSandboxFilesystem primary()

返回 primary 结果。

Returns the primary sandbox filesystem (lifecycle middleware injects into this).

返回Returns AbstractSandboxFilesystem
返回AbstractSandboxFilesystem。Returns abstract sandbox filesystem.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:53–55

backendFor

public AbstractFilesystem backendFor(String path)

设置该参数。

Returns the backend that would serve path: the longest matching prefix route, or the primary sandbox filesystem when no route matches.

参数Parameters
名称Name类型Type说明Description
pathString路径(类型 `String`)。The path.
返回Returns AbstractFilesystem
返回AbstractFilesystem。Returns abstract filesystem.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:61–63

id

public String id()

返回标识。

Returns the id.

返回Returns String
返回字符串结果。Returns a string.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:65–68

execute

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

执行执行相关操作。

Performs the execute operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
commandString命令(类型 `String`)。The command.
timeoutSecondsInteger超时秒(类型 `Integer`)。The timeout seconds.
返回Returns ExecuteResponse
返回ExecuteResponse。Returns execute response.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:70–74

ls

public LsResult ls(RuntimeContext runtimeContext, String path)

执行 ls 方法。

Performs the ls operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathString路径(类型 `String`)。The path.
返回Returns LsResult
返回LsResult。Returns ls result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:76–79

read

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

执行读取相关操作。

Performs the read operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filePathString文件路径(类型 `String`)。The file path.
offsetint偏移量(类型 `int`)。The offset.
limitint数量上限(类型 `int`)。The limit.
返回Returns ReadResult
返回ReadResult。Returns read result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:81–84

write

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

执行写入相关操作。

Performs the write operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filePathString文件路径(类型 `String`)。The file path.
contentString内容(类型 `String`)。The content.
返回Returns WriteResult
返回WriteResult。Returns write result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:86–89

edit

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

执行 edit 方法。

Performs the edit operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filePathString文件路径(类型 `String`)。The file path.
oldStringString旧的 String(类型 `String`)。The old string.
newStringString新建 String(类型 `String`)。The new string.
replaceAllbooleanreplace 所有(类型 `boolean`)。The replace all.
返回Returns EditResult
返回EditResult。Returns edit result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:91–99

grep

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

执行 grep 方法。

Performs the grep operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
patternStringpattern(类型 `String`)。The pattern.
pathString路径(类型 `String`)。The path.
globStringglob(类型 `String`)。The glob.
返回Returns GrepResult
返回GrepResult。Returns grep result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:101–105

glob

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

执行 glob 方法。

Performs the glob operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
patternStringpattern(类型 `String`)。The pattern.
pathString路径(类型 `String`)。The path.
返回Returns GlobResult
返回GlobResult。Returns glob result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:107–110

uploadFiles

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

执行上传文件相关操作。

Performs the upload files operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
filesList<Map.Entry<String, byte[]>>文件(类型 `List >`)。The files.
返回Returns List<FileUploadResponse>
返回列出。Returns list.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:112–116

downloadFiles

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

执行下载文件相关操作。

Performs the download files operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathsList<String>paths(类型 `List`)。The paths.
返回Returns List<FileDownloadResponse>
返回列出。Returns list.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:118–122

delete

public WriteResult delete(RuntimeContext runtimeContext, String path)

删除数据。

Performs the delete operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathString路径(类型 `String`)。The path.
返回Returns WriteResult
返回WriteResult。Returns write result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:124–127

move

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

执行 move 方法。

Performs the move operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
fromPathString来自路径(类型 `String`)。The from path.
toPathString到路径(类型 `String`)。The to path.
返回Returns WriteResult
返回WriteResult。Returns write result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:129–132

exists

public boolean exists(RuntimeContext runtimeContext, String path)

判断数据是否存在。

Performs the exists operation.

参数Parameters
名称Name类型Type说明Description
runtimeContextRuntimeContext运行时上下文(类型 `RuntimeContext`)。The runtime context.
pathString路径(类型 `String`)。The path.
返回Returns boolean
返回布尔值,表示判断结果。Returns a boolean result.
源码Source io/agentscope/harness/agent/filesystem/RoutedSandboxFilesystem.java:134–137

继承成员Inherited Members

继承自Methods inherited from AbstractFilesystem
基于官方固定版本源码静态生成Generated from pinned official sources · Python 2.0.11 · Java 2.0.4
签名与文档为静态抽取;如有疑问请以源码为准。Signatures and docs are extracted statically; verify against the source when in doubt.