Package io.github.theword.queqiao.core.api

Class SendRconCommandApi

java.lang.Object

io.github.theword.queqiao.core.api.Api<CommandPayload,String>

io.github.theword.queqiao.core.api.SendRconCommandApi

public final class SendRconCommandApi
extends Api<CommandPayload,String>

通过 RCON 执行命令

协议名：send_rcon_command。

该 Api 与平台无关——它只依赖 Runtime 注入的 RCON 执行器， 因此不继承 PlatformApi，也不要求平台上下文。

状态码语义（不同失败原因不统一归为 400）：

• 命令为空 → 400（调用方请求不合法）
• Rcon 未启用 / 未连接 → 503（服务暂不可用）
• 命令已下发但执行失败 → 500（服务端错误）

日志：不在 INFO 级别记录完整命令内容，因为命令可能包含密码、token 或玩家隐私； 完整内容仅在显式开启 debug 时输出。

Field Summary

Fields inherited from class io.github.theword.queqiao.core.api.Api

logger

Constructor Summary

Constructors

Constructor	Description
SendRconCommandApi(org.slf4j.Logger logger, RconCommandExecutor rconCommandExecutor)

Method Summary

Modifier and Type	Method	Description
protected String	doExecute(CommandPayload payload)	处理已经解析好的负载
String	name()	协议 api 字段的主名字，例如 "broadcast"

Methods inherited from class io.github.theword.queqiao.core.api.Api

aliases, execute, mapPlatformResult, requireSuccess

Methods inherited from class java.lang.Object

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

Constructor Details

SendRconCommandApi

public SendRconCommandApi(org.slf4j.Logger logger,
 RconCommandExecutor rconCommandExecutor)

Method Details

name

public String name()

Description copied from class: Api

协议 api 字段的主名字，例如 "broadcast"

Specified by:

name in class Api<CommandPayload,String>

Returns:

api 名字

doExecute

protected String doExecute(CommandPayload payload)
                    throws ProtocolException

Description copied from class: Api

处理已经解析好的负载

Specified by:

doExecute in class Api<CommandPayload,String>

Parameters:

payload - 负载，永不为 null

Returns:

处理结果

Throws:

ProtocolException - 处理失败