aries_cloudagent.admin package

Submodules

aries_cloudagent.admin.base_server module

Abstract admin server interface.

class aries_cloudagent.admin.base_server.BaseAdminServer

Bases: abc.ABC

Admin HTTP server class.

start() → None

Start the webserver.

Raises:AdminSetupError – If there was an error starting the webserver

stop() → None

Stop the webserver.

aries_cloudagent.admin.error module

Admin error classes.

exception aries_cloudagent.admin.error.AdminError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.core.error.BaseError

Base class for Admin-related errors.

exception aries_cloudagent.admin.error.AdminSetupError(*args, error_code: str = None, **kwargs)

Bases: aries_cloudagent.admin.error.AdminError

Admin server setup or configuration error.

aries_cloudagent.admin.request_context module

Admin request context class.

A request context provided by the admin server to admin route handlers.

class aries_cloudagent.admin.request_context.AdminRequestContext(profile: aries_cloudagent.core.profile.Profile, *, context: aries_cloudagent.config.injection_context.InjectionContext = None, settings: Mapping[str, object] = None)

Bases: object

Context established by the Conductor and passed into message handlers.

inject(base_cls: Type[InjectType], settings: Mapping[str, object] = None) → InjectType

Get the provided instance of a given class identifier.

Parameters:

• cls – The base class to retrieve an instance of
• settings – An optional mapping providing configuration to the provider

Returns:

An instance of the base class, or None

inject_or(base_cls: Type[InjectType], settings: Mapping[str, object] = None, default: Optional[InjectType] = None) → Optional[InjectType]

Get the provided instance of a given class identifier or default if not found.

Parameters:

• base_cls – The base class to retrieve an instance of
• settings – An optional dict providing configuration to the provider
• default – default return value if no instance is found

Returns:

An instance of the base class, or None

injector

Accessor for the associated Injector instance.

profile

Accessor for the associated Profile instance.

session() → aries_cloudagent.core.profile.ProfileSession

Start a new interactive session with no transaction support requested.

settings

Accessor for the context settings.

classmethod test_context(session_inject: dict = None, profile: aries_cloudagent.core.profile.Profile = None) → aries_cloudagent.admin.request_context.AdminRequestContext

Quickly set up a new admin request context for tests.

transaction() → aries_cloudagent.core.profile.ProfileSession

Start a new interactive session with commit and rollback support.

If the current backend does not support transactions, then commit and rollback operations of the session will not have any effect.

update_settings(settings: Mapping[str, object])

Update the current scope with additional settings.

aries_cloudagent.admin.server module