nvflare.fuel.hci.client.api_spec module

class AdminAPISpec

Bases: ABC

abstract check_command(command: str) → CommandInfo

Checks the specified command for processing info. The command could be a client command or a server command.

Parameters:

command – command to be checked

Returns: command processing info

abstract do_command(command: str)

Executes a command. The command could be a client command or a server command.

Parameters:

command – The command to be executed.

abstract is_ready() → bool

Whether the API is ready for executing commands.

abstract server_execute(command: str, reply_processor=None, cmd_ctx=None)

Executes a command on server side.

Parameters:

• command – The command to be executed.

• reply_processor – processor to process reply from server

• cmd_ctx – command context

class AdminConfigKey

Bases: object

ADMIN = 'admin'

AUTHENTICATE_MSG_TIMEOUT = 'authenticate_msg_timeout'

CA_CERT = 'ca_cert'

CLIENT_CERT = 'client_cert'

CLIENT_KEY = 'client_key'

CLI_HISTORY_SIZE = 'cli_history_size'

CONNECTION_SCHEME = 'scheme'

CONNECTION_SECURITY = 'connection_security'

DOWNLOAD_DIR = 'download_dir'

FILE_DOWNLOAD_PROGRESS_TIMEOUT = 'file_download_progress_timeout'

HOST = 'host'

IDENTITY = 'identity'

IDLE_TIMEOUT = 'idle_timeout'

LOGIN_TIMEOUT = 'login_timeout'

PORT = 'port'

PROJECT_NAME = 'project_name'

PROMPT = 'prompt'

SERVER_IDENTITY = 'server_identity'

UID_SOURCE = 'uid_source'

UPLOAD_DIR = 'upload_dir'

USERNAME = 'username'

WITH_DEBUG = 'with_debug'

WITH_FILE_TRANSFER = 'with_file_transfer'

class ApiPocValue

Bases: object

ADMIN = 'admin'

class CommandContext

Bases: SimpleContext

A simple context containing a props dictionary of key value pairs and convenience methods.

get_api()

get_command()

get_command_args()

get_command_entry()

get_command_headers()

get_command_name()

get_command_props()

get_command_result()

get_custom_props()

get_json_processor()

get_meta()

get_reply_processor()

get_requester()

set_api(api)

set_command(command)

set_command_args(cmd_args)

set_command_entry(entry)

set_command_headers(value)

set_command_props(value)

set_command_result(result)

set_custom_props(value)

set_json_processor(processor)

set_meta(meta)

set_reply_processor(processor)

set_requester(r)

class CommandCtxKey

Bases: object

API = 'api'

CMD = 'cmd'

CMD_ARGS = 'cmd_args'

CMD_ENTRY = 'cmd_entry'

CMD_HEADERS = 'cmd_headers'

CMD_PROPS = 'cmd_props'

CUSTOM_PROPS = 'custom_props'

JSON_PROCESSOR = 'json_processor'

META = 'meta'

REPLY_PROCESSOR = 'reply_processor'

REQUESTER = 'requester'

RESULT = 'result'

class CommandInfo(value)

Bases: Enum

An enumeration.

AMBIGUOUS = 2

CONFIRM_AUTH = 4

CONFIRM_USER_NAME = 5

CONFIRM_YN = 3

OK = 0

UNKNOWN = 1

class HCIRequester

Bases: ABC

abstract send_request(api, conn, cmd_ctx)

class ReplyProcessor

Bases: object

A base class for parsing server’s response.

process_bytes(ctx: CommandContext)

process_dict(ctx: CommandContext, data: dict)

process_error(ctx: CommandContext, err: str)

process_shutdown(ctx: CommandContext, msg: str)

process_string(ctx: CommandContext, item: str)

process_success(ctx: CommandContext, item: str)

process_table(ctx: CommandContext, table: Table)

process_token(ctx: CommandContext, token: str)

protocol_error(ctx: CommandContext, err: str)

reply_done(ctx: CommandContext)

reply_start(ctx: CommandContext, reply_json)

class UidSource

Bases: object

CERT = 'cert'

GUEST = 'guest'

USER_INPUT = 'user_input'