nvflare.fuel.hci.server.sess module

class Session(sess_id, user_name, org, role, origin_fqcn, active_study='default')

Bases: object

Object keeping track of an admin client session with token and time data.

static decode_token(token: str, id_asserter: IdentityAsserter | None = None)

make_token(id_asserter: IdentityAsserter)

mark_active()

class SessionManager(cell, idle_timeout=1800, monitor_interval=5)

Bases: CommandModule

Session manager.

Parameters:

• idle_timeout – session idle timeout

• monitor_interval – interval for obtaining updates when monitoring

create_session(user_name, user_org, user_role, origin_fqcn, active_study='default')

Creates new session with a new session token.

Parameters:

• user_name – username for session

• user_org – org of the user

• user_role – user’s role

• origin_fqcn – request origin FQCN

• id_asserter – used to sign session token

Returns: Session

end_session_by_id(sess_id: str, reason=None)

end_session_by_token(token, reason=None)

get_session(token: str, id_asserter=None)

get_sessions()

get_spec()

handle_check_session(conn: Connection, args: List[str])

handle_list_sessions(conn: Connection, args: List[str])

Lists sessions and the details in a table.

Registered in the FedAdminServer with cmd_reg.register_module(sess_mgr).

monitor_sessions()

Runs loop in a thread to end sessions that time out.

recreate_session(token: str, origin_fqcn, id_asserter: IdentityAsserter)

shutdown()