aries_cloudagent.protocols.introduction.v0_1 package

Submodules

aries_cloudagent.protocols.introduction.v0_1.base_service module

Introduction service base classes.

class aries_cloudagent.protocols.introduction.v0_1.base_service.BaseIntroductionService[source]

Bases: abc.ABC

Service handler for allowing connections to exchange invitations.

return_invitation(target_connection_id: str, invitation: aries_cloudagent.protocols.introduction.v0_1.messages.invitation.Invitation, session: aries_cloudagent.core.profile.ProfileSession, outbound_handler)[source]

Handle the forwarding of an invitation to the responder.

Parameters:
  • target_connection_id – The ID of the connection sending the Invitation
  • invitation – The received Invitation message
  • session – Profile session to use for introduction records
  • outbound_handler – The outbound handler coroutine for sending a message
classmethod service_handler()[source]

Quick accessor for conductor to use.

start_introduction(init_connection_id: str, target_connection_id: str, outbound_handler, session: aries_cloudagent.core.profile.ProfileSession, message: str = None)[source]

Start the introduction process between two connections.

Parameters:
  • init_connection_id – The connection initiating the request
  • target_connection_id – The connection which is asked for an invitation
  • outbound_handler – The outbound handler coroutine for sending a message
  • session – Profile session to use for connection, introduction records
  • message – The message to use when requesting the invitation
exception aries_cloudagent.protocols.introduction.v0_1.base_service.IntroductionError(*args, error_code: str = None, **kwargs)[source]

Bases: aries_cloudagent.core.error.BaseError

Generic introduction service error.

aries_cloudagent.protocols.introduction.v0_1.demo_service module

Introduction service demo classes.

class aries_cloudagent.protocols.introduction.v0_1.demo_service.DemoIntroductionService[source]

Bases: aries_cloudagent.protocols.introduction.v0_1.base_service.BaseIntroductionService

Service handler for allowing connections to exchange invitations.

RECORD_TYPE = 'introduction_record'
return_invitation(target_connection_id: str, invitation: aries_cloudagent.protocols.introduction.v0_1.messages.invitation.Invitation, session: aries_cloudagent.core.profile.ProfileSession, outbound_handler)[source]

Handle the forwarding of an invitation to the responder.

Parameters:
  • target_connection_id – The ID of the connection sending the Invitation
  • invitation – The received (Introduction) Invitation message
  • session – Profile session to use for introduction records
  • outbound_handler – The outbound handler coroutine for sending a message
start_introduction(init_connection_id: str, target_connection_id: str, message: str, session: aries_cloudagent.core.profile.ProfileSession, outbound_handler)[source]

Start the introduction process between two connections.

Parameters:
  • init_connection_id – The connection initiating the request
  • target_connection_id – The connection which is asked for an invitation
  • outbound_handler – The outbound handler coroutine for sending a message
  • session – Profile session to use for connection, introduction records
  • message – The message to use when requesting the invitation

aries_cloudagent.protocols.introduction.v0_1.message_types module

Message type identifiers for Introductions.

aries_cloudagent.protocols.introduction.v0_1.routes module

Introduction service admin routes.

class aries_cloudagent.protocols.introduction.v0_1.routes.IntroConnIdMatchInfoSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Path parameters and validators for request taking connection id.

conn_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>
class aries_cloudagent.protocols.introduction.v0_1.routes.IntroModuleResponseSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Response schema for Introduction Module.

class aries_cloudagent.protocols.introduction.v0_1.routes.IntroStartQueryStringSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.openapi.OpenAPISchema

Query string parameters for request to start introduction.

message = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=False, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>
target_connection_id = <fields.String(default=<marshmallow.missing>, attribute=None, validate=None, required=True, load_only=False, dump_only=False, missing=<marshmallow.missing>, allow_none=False, error_messages={'required': 'Missing data for required field.', 'null': 'Field may not be null.', 'validator_failed': 'Invalid value.', 'invalid': 'Not a valid string.', 'invalid_utf8': 'Not a valid utf-8 string.'})>
aries_cloudagent.protocols.introduction.v0_1.routes.introduction_start(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054718910>)[source]

Request handler for starting an introduction.

Parameters:request – aiohttp request object
aries_cloudagent.protocols.introduction.v0_1.routes.post_process_routes(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054718910>)[source]

Amend swagger API.

aries_cloudagent.protocols.introduction.v0_1.routes.register(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7fb054718910>)[source]

Register routes.