aries_cloudagent.admin package¶
Submodules¶
aries_cloudagent.admin.base_server module¶
Abstract admin server interface.
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.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, root_profile: aries_cloudagent.core.profile.Profile = None, metadata: dict = None)[source]¶ Bases:
object
Context established by the Conductor and passed into message handlers.
-
inject
(base_cls: Type[InjectType], settings: Mapping[str, object] = None) → InjectType[source]¶ 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][source]¶ 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.
-
metadata
¶ Accessor for the associated metadata.
-
profile
¶ Accessor for the associated Profile instance.
-
root_profile
¶ Accessor for the associated root_profile instance.
-
session
() → aries_cloudagent.core.profile.ProfileSession[source]¶ 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[source]¶ Quickly set up a new admin request context for tests.
-