aries_cloudagent.admin package¶
Submodules¶
aries_cloudagent.admin.base_server module¶
Abstract admin server interface.
-
class
aries_cloudagent.admin.base_server.
BaseAdminServer
[source]¶ Bases:
abc.ABC
Admin HTTP server class.
-
add_webhook_target
(target_url: str, topic_filter: Sequence[str] = None, max_attempts: int = None)[source]¶ Add a webhook target.
-
send_webhook
(topic: str, payload: dict)[source]¶ Add a webhook to the queue, to send to all registered targets.
-
aries_cloudagent.admin.error module¶
Admin error classes.
-
exception
aries_cloudagent.admin.error.
AdminError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.core.error.BaseError
Base class for Admin-related errors.
-
exception
aries_cloudagent.admin.error.
AdminSetupError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.admin.error.AdminError
Admin server setup or configuration error.
aries_cloudagent.admin.server module¶
Admin server classes.
-
class
aries_cloudagent.admin.server.
AdminModulesSchema
(*args, **kwargs)[source]¶ Bases:
sphinx.ext.autodoc.importer._MockObject
Schema for the modules endpoint.
-
result
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.admin.server.
AdminResponder
(context: aries_cloudagent.config.injection_context.InjectionContext, send: Coroutine[T_co, T_contra, V_co], webhook: Coroutine[T_co, T_contra, V_co], **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.responder.BaseResponder
Handle outgoing messages from message handlers.
-
class
aries_cloudagent.admin.server.
AdminServer
(host: str, port: int, context: aries_cloudagent.config.injection_context.InjectionContext, outbound_message_router: Coroutine[T_co, T_contra, V_co], webhook_router: Callable, task_queue: aries_cloudagent.utils.task_queue.TaskQueue = None, conductor_stats: Coroutine[T_co, T_contra, V_co] = None)[source]¶ Bases:
aries_cloudagent.admin.base_server.BaseAdminServer
Admin HTTP server class.
-
add_webhook_target
(target_url: str, topic_filter: Sequence[str] = None, max_attempts: int = None)[source]¶ Add a webhook target.
-
make_application
() → <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c18403ba8>[source]¶ Get the aiohttp application instance.
-
on_startup
(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c18403ba8>)[source]¶ Perform webserver startup actions.
-
plugins_handler
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c18403ba8>)[source]¶ Request handler for the loaded plugins list.
Parameters: request – aiohttp request object Returns: The module list response
-
redirect_handler
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c18403ba8>)[source]¶ Perform redirect to documentation.
-
send_webhook
(topic: str, payload: dict)[source]¶ Add a webhook to the queue, to send to all registered targets.
-
start
() → None[source]¶ Start the webserver.
Raises: AdminSetupError
– If there was an error starting the webserver
-
status_handler
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f9c18403ba8>)[source]¶ Request handler for the server status information.
Parameters: request – aiohttp request object Returns: The web response
-