AS AgentScopeAPI 手册 / API Reference

SandboxException

public class SandboxException extends RuntimeException
源码Source io/agentscope/harness/agent/sandbox/SandboxException.java:28–329

沙箱异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 RuntimeException。核心成员包括 getErrorCode、getOp、SandboxException。

Base exception for all sandbox operations.

Specialized subclasses are provided as static nested classes for common failure modes: SandboxConfigurationException, SandboxRuntimeException, WorkspaceStartException, WorkspaceStopException, ExecException, ExecTimeoutException, SnapshotException.

嵌套类摘要Nested Class Summary

类Class类型Kind说明Description
SandboxConfigurationException类class
沙箱配置异常,表示执行过程中的错误。
Thrown when sandbox configuration is invalid or missing (e.g.
SandboxRuntimeException类class
沙箱运行时异常,表示执行过程中的错误。
Thrown for general sandbox runtime failures not covered by a more specific subclass.
WorkspaceStartException类class
工作区启动异常,表示执行过程中的错误。
Thrown when the workspace backend fails to start.
WorkspaceStopException类class
工作区停止异常,表示执行过程中的错误。
Thrown when the workspace backend fails to stop.
ExecException类class
Exec 异常,表示执行过程中的错误。
Thrown when a sandbox command exits with a non-zero exit code.
ExecTimeoutException类class
Exec 超时异常,表示执行过程中的错误。
Thrown when a sandbox command times out.
SnapshotException类class
快照异常,表示执行过程中的错误。
Thrown when a snapshot operation (persist or restore) fails.

构造器摘要Constructor Summary

构造器Constructor说明Description
public SandboxException(SandboxErrorCode errorCode, String message)
初始化 `SandboxException` 实例。
Creates a sandbox exception with an error code and message.
public SandboxException(SandboxErrorCode errorCode, String message, Throwable cause)
初始化 `SandboxException` 实例。
Creates a sandbox exception with an error code, message, and cause.
public SandboxException(SandboxErrorCode errorCode, String op, String message, Throwable cause)
初始化 `SandboxException` 实例。
Creates a sandbox exception with an error code, operation name, message, and cause.

方法摘要Method Summary

方法Method说明Description
public SandboxErrorCode getErrorCode()
获取 `getErrorCode`。
Returns the error code classifying this failure.
public String getOp()
获取Op。
Returns the operation name that failed, or `null` if not specified.

构造器详情Constructor Detail

SandboxException

public SandboxException(SandboxErrorCode errorCode, String message)

初始化 SandboxException 实例。

Creates a sandbox exception with an error code and message.

参数Parameters
名称Name类型Type说明Description
errorCodeSandboxErrorCode错误 Code(类型 `SandboxErrorCode`)。the error code classifying the failure
messageString消息(类型 `String`)。human-readable description
源码Source io/agentscope/harness/agent/sandbox/SandboxException.java:39–43

SandboxException

public SandboxException(SandboxErrorCode errorCode, String message, Throwable cause)

初始化 SandboxException 实例。

Creates a sandbox exception with an error code, message, and cause.

参数Parameters
名称Name类型Type说明Description
errorCodeSandboxErrorCode错误 Code(类型 `SandboxErrorCode`)。the error code classifying the failure
messageString消息(类型 `String`)。human-readable description
causeThrowablecause(类型 `Throwable`)。the underlying cause
源码Source io/agentscope/harness/agent/sandbox/SandboxException.java:52–56

SandboxException

public SandboxException(SandboxErrorCode errorCode, String op, String message, Throwable cause)

初始化 SandboxException 实例。

Creates a sandbox exception with an error code, operation name, message, and cause.

参数Parameters
名称Name类型Type说明Description
errorCodeSandboxErrorCode错误 Code(类型 `SandboxErrorCode`)。the error code classifying the failure
opStringop(类型 `String`)。the operation that failed (e.g. "start", "exec", "persist")
messageString消息(类型 `String`)。human-readable description
causeThrowablecause(类型 `Throwable`)。the underlying cause
源码Source io/agentscope/harness/agent/sandbox/SandboxException.java:66–71

方法详情Method Detail

getErrorCode

public SandboxErrorCode getErrorCode()

获取 getErrorCode。

Returns the error code classifying this failure.

返回Returns SandboxErrorCode
返回SandboxErrorCode。the error code
源码Source io/agentscope/harness/agent/sandbox/SandboxException.java:78–80

getOp

public String getOp()

获取Op。

Returns the operation name that failed, or null if not specified.

返回Returns String
返回字符串结果。operation name, may be null
源码Source io/agentscope/harness/agent/sandbox/SandboxException.java:87–89

嵌套类详情Nested Class Detail

SandboxConfigurationException

public static class SandboxConfigurationException extends SandboxException

沙箱配置异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 SandboxConfigurationException。

Thrown when sandbox configuration is invalid or missing (e.g. no client configured).

SandboxRuntimeException

public static class SandboxRuntimeException extends SandboxException

沙箱运行时异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 SandboxRuntimeException。

Thrown for general sandbox runtime failures not covered by a more specific subclass.

WorkspaceStartException

public static class WorkspaceStartException extends SandboxException

工作区启动异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 getPath、WorkspaceStartException。

Thrown when the workspace backend fails to start.

WorkspaceStopException

public static class WorkspaceStopException extends SandboxException

工作区停止异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 getPath、WorkspaceStopException。

Thrown when the workspace backend fails to stop.

ExecException

public static class ExecException extends SandboxException

Exec 异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 getExitCode、getStdout、getStderr、ExecException。

Thrown when a sandbox command exits with a non-zero exit code.

ExecTimeoutException

public static class ExecTimeoutException extends SandboxException

Exec 超时异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 ExecTimeoutException。

Thrown when a sandbox command times out.

SnapshotException

public static class SnapshotException extends SandboxException

快照异常,表示执行过程中的错误。位于 io.agentscope.harness.agent.sandbox 包,继承自 SandboxException。核心成员包括 getSnapshotId、SnapshotException。

Thrown when a snapshot operation (persist or restore) fails.

基于官方固定版本源码静态生成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.