aries_cloudagent.messaging.connections.models package

Submodules

aries_cloudagent.messaging.connections.models.connection_detail module

An object for containing the connection request/response DID information.

class aries_cloudagent.messaging.connections.models.connection_detail.ConnectionDetail(*, did: str = None, did_doc: aries_cloudagent.messaging.connections.models.diddoc.diddoc.DIDDoc = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Class representing the details of a connection.

class Meta[source]

Bases: object

ConnectionDetail metadata.

schema_class = 'ConnectionDetailSchema'
did

Accessor for the connection DID.

Returns:The DID for this connection
did_doc

Accessor for the connection DID Document.

Returns:The DIDDoc for this connection
class aries_cloudagent.messaging.connections.models.connection_detail.ConnectionDetailSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

ConnectionDetail schema.

class Meta[source]

Bases: object

ConnectionDetailSchema metadata.

model_class = 'ConnectionDetail'
did

Used by autodoc_mock_imports.

did_doc

Field that loads and serializes DIDDoc.

class aries_cloudagent.messaging.connections.models.connection_detail.DIDDocWrapper(*args, **kwargs)[source]

Bases: sphinx.ext.autodoc.importer._MockObject

Field that loads and serializes DIDDoc.

aries_cloudagent.messaging.connections.models.connection_record module

Handle connection information interface with non-secrets storage.

class aries_cloudagent.messaging.connections.models.connection_record.ConnectionRecord(*, connection_id: str = None, my_did: str = None, their_did: str = None, their_label: str = None, their_role: str = None, initiator: str = None, invitation_key: str = None, request_id: str = None, state: str = None, inbound_connection_id: str = None, error_msg: str = None, routing_state: str = None, accept: str = None, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base_record.BaseRecord

Represents a single pairwise connection.

ACCEPT_AUTO = 'auto'
ACCEPT_MANUAL = 'manual'
CACHE_ENABLED = True
DIRECTION_RECEIVED = 'received'
DIRECTION_SENT = 'sent'
INITIATOR_EXTERNAL = 'external'
INITIATOR_SELF = 'self'
LOG_STATE_FLAG = 'debug.connections'
class Meta[source]

Bases: object

ConnectionRecord metadata.

schema_class = 'ConnectionRecordSchema'
RECORD_ID_NAME = 'connection_id'
RECORD_TYPE = 'connection'
RECORD_TYPE_ACTIVITY = 'connection_activity'
RECORD_TYPE_INVITATION = 'connection_invitation'
RECORD_TYPE_REQUEST = 'connection_request'
ROUTING_STATE_ACTIVE = 'active'
ROUTING_STATE_ERROR = 'error'
ROUTING_STATE_NONE = 'none'
ROUTING_STATE_REQUEST = 'request'
STATE_ACTIVE = 'active'
STATE_ERROR = 'error'
STATE_INACTIVE = 'inactive'
STATE_INIT = 'init'
STATE_INVITATION = 'invitation'
STATE_REQUEST = 'request'
STATE_RESPONSE = 'response'
WEBHOOK_TOPIC = 'connections'
WEBHOOK_TOPIC_ACTIVITY = 'connections_activity'
attach_invitation(context: aries_cloudagent.config.injection_context.InjectionContext, invitation: aries_cloudagent.messaging.connections.messages.connection_invitation.ConnectionInvitation)[source]

Persist the related connection invitation to storage.

Parameters:
  • context – The injection context to use
  • invitation – The invitation to relate to this connection record
attach_request(context: aries_cloudagent.config.injection_context.InjectionContext, request: aries_cloudagent.messaging.connections.messages.connection_request.ConnectionRequest)[source]

Persist the related connection request to storage.

Parameters:
  • context – The injection context to use
  • request – The request to relate to this connection record
connection_id

Accessor for the ID associated with this connection.

fetch_activity(context: aries_cloudagent.config.injection_context.InjectionContext, activity_type: str = None, direction: str = None) → Sequence[dict][source]

Fetch all activity logs for this connection record.

Parameters:
  • context – The injection context to use
  • activity_type – An optional activity type filter
  • direction – An optional direction filter
is_ready

Accessor for connection readiness.

log_activity(context: aries_cloudagent.config.injection_context.InjectionContext, activity_type: str, direction: str, meta: dict = None)[source]

Log an event against this connection record.

Parameters:
  • context – The injection context to use
  • activity_type – The activity type identifier
  • direction – The direction of the activity (sent or received)
  • meta – Optional metadata for the activity
post_save(context: aries_cloudagent.config.injection_context.InjectionContext, *args, **kwargs)[source]

Perform post-save actions.

Parameters:context – The injection context to use
record_tags

Accessor for the record tags generated for this connection.

record_value

Accessor to for the JSON record value properties for this connection.

retrieve_activity(context: aries_cloudagent.config.injection_context.InjectionContext, activity_id: str) → Sequence[dict][source]

Retrieve a single activity record.

Parameters:
  • context – The injection context to use
  • activity_id – The ID of the activity entry
classmethod retrieve_by_did(context: aries_cloudagent.config.injection_context.InjectionContext, their_did: str = None, my_did: str = None, initiator: str = None) → aries_cloudagent.messaging.connections.models.connection_record.ConnectionRecord[source]

Retrieve a connection record by target DID.

Parameters:
  • context – The injection context to use
  • their_did – The target DID to filter by
  • my_did – One of our DIDs to filter by
  • initiator – Filter connections by the initiator value
classmethod retrieve_by_invitation_key(context: aries_cloudagent.config.injection_context.InjectionContext, invitation_key: str, initiator: str = None) → aries_cloudagent.messaging.connections.models.connection_record.ConnectionRecord[source]

Retrieve a connection record by invitation key.

Parameters:
  • context – The injection context to use
  • invitation_key – The key on the originating invitation
  • initiator – Filter by the initiator value
classmethod retrieve_by_request_id(context: aries_cloudagent.config.injection_context.InjectionContext, request_id: str) → aries_cloudagent.messaging.connections.models.connection_record.ConnectionRecord[source]

Retrieve a connection record from our previous request ID.

Parameters:
  • context – The injection context to use
  • request_id – The ID of the originating connection request
retrieve_invitation(context: aries_cloudagent.config.injection_context.InjectionContext) → aries_cloudagent.messaging.connections.messages.connection_invitation.ConnectionInvitation[source]

Retrieve the related connection invitation.

Parameters:context – The injection context to use
retrieve_request(context: aries_cloudagent.config.injection_context.InjectionContext) → aries_cloudagent.messaging.connections.messages.connection_request.ConnectionRequest[source]

Retrieve the related connection invitation.

Parameters:context – The injection context to use
update_activity_meta(context: aries_cloudagent.config.injection_context.InjectionContext, activity_id: str, meta: dict) → Sequence[dict][source]

Update metadata for an activity entry.

Parameters:
  • context – The injection context to use
  • activity_id – The ID of the activity entry
  • meta – The metadata stored on the activity
updated_activity(context: aries_cloudagent.config.injection_context.InjectionContext)[source]

Call webhook when the record activity is updated.

class aries_cloudagent.messaging.connections.models.connection_record.ConnectionRecordSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base_record.BaseRecordSchema

Schema to allow serialization/deserialization of connection records.

class Meta[source]

Bases: object

ConnectionRecordSchema metadata.

model_class

alias of ConnectionRecord

accept

Used by autodoc_mock_imports.

connection_id

Used by autodoc_mock_imports.

error_msg

Used by autodoc_mock_imports.

inbound_connection_id

Used by autodoc_mock_imports.

initiator

Used by autodoc_mock_imports.

invitation_key

Used by autodoc_mock_imports.

my_did

Used by autodoc_mock_imports.

request_id

Used by autodoc_mock_imports.

routing_state

Used by autodoc_mock_imports.

their_did

Used by autodoc_mock_imports.

their_label

Used by autodoc_mock_imports.

their_role

Used by autodoc_mock_imports.

aries_cloudagent.messaging.connections.models.connection_target module

Record used to handle routing of messages to another agent.

class aries_cloudagent.messaging.connections.models.connection_target.ConnectionTarget(*, did: str = None, endpoint: str = None, label: str = None, recipient_keys: Sequence[str] = None, routing_keys: Sequence[str] = None, sender_key: str = None)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModel

Record used to handle routing of messages to another agent.

class Meta[source]

Bases: object

ConnectionTarget metadata.

schema_class = 'ConnectionTargetSchema'
class aries_cloudagent.messaging.connections.models.connection_target.ConnectionTargetSchema(*args, **kwargs)[source]

Bases: aries_cloudagent.messaging.models.base.BaseModelSchema

ConnectionTarget schema.

class Meta[source]

Bases: object

ConnectionTargetSchema metadata.

model_class

alias of ConnectionTarget

did

Used by autodoc_mock_imports.

endpoint

Used by autodoc_mock_imports.

label

Used by autodoc_mock_imports.

recipient_keys

Used by autodoc_mock_imports.

routing_keys

Used by autodoc_mock_imports.

sender_key

Used by autodoc_mock_imports.