Skip to content

academy.exchange.cloud.backend

MailboxBackend

Bases: Protocol

Backend protocol for storing mailboxes on server.

check_mailbox async 

check_mailbox(
    client: ClientInfo, uid: EntityId
) -> MailboxStatus

Check if a mailbox exists, or is terminated.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

Returns:

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
async def check_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> MailboxStatus:
    """Check if a mailbox exists, or is terminated.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.

    Returns:
        The mailbox status.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    ...

create_mailbox async 

create_mailbox(
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None

Create a mailbox is not exists.

This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

  • agent (tuple[str, ...] | None, default: None ) –

    The agent_mro for behavior discovery.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
async def create_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None:
    """Create a mailbox is not exists.

    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.
        agent: The agent_mro for behavior discovery.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    ...

terminate async 

terminate(client: ClientInfo, uid: EntityId) -> None

Close a mailbox.

For security, the manager should keep a gravestone so the same id cannot be re-registered.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to close.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
async def terminate(self, client: ClientInfo, uid: EntityId) -> None:
    """Close a mailbox.

    For security, the manager should keep a gravestone so the same id
    cannot be re-registered.

    Args:
        client: Client making the request.
        uid: Mailbox id to close.

    Raises:
        ForbiddenError: If the client does not have the right permissions.

    """
    ...

discover async 

discover(
    client: ClientInfo, agent: str, allow_subclasses: bool
) -> list[AgentId[Any]]

Find mailboxes of matching agent class.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • agent (str) –

    Agent class to search for.

  • allow_subclasses (bool) –

    Include agents that inherit from the target.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
async def discover(
    self,
    client: ClientInfo,
    agent: str,
    allow_subclasses: bool,
) -> list[AgentId[Any]]:
    """Find mailboxes of matching agent class.

    Args:
        client: Client making the request.
        agent: Agent class to search for.
        allow_subclasses: Include agents that inherit from the target.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    ...

get async 

get(
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None
) -> Message[Any]

Get messages from a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to get messages.

  • timeout (float | None, default: None ) –

    Time in seconds to wait for message. If None, wait indefinitely.

Raises:

Source code in academy/exchange/cloud/backend.py 
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
async def get(
    self,
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None,
) -> Message[Any]:
    """Get messages from a mailbox.

    Args:
        client: Client making the request.
        uid: Mailbox id to get messages.
        timeout: Time in seconds to wait for message.
            If None, wait indefinitely.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        TimeoutError: There was not message received during the timeout.
    """
    ...

put async 

put(client: ClientInfo, message: Message[Any]) -> None

Put a message in a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • message (Message[Any]) –

    Message to put in mailbox.

Raises:

Source code in academy/exchange/cloud/backend.py 
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
async def put(self, client: ClientInfo, message: Message[Any]) -> None:
    """Put a message in a mailbox.

    Args:
        client: Client making the request.
        message: Message to put in mailbox.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        MessageTooLargeError: The message is larger than the message
            size limit for this exchange.
    """
    ...

share_mailbox async 

share_mailbox(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Share a mailbox with a Globus Group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to share.

Raises:

Source code in academy/exchange/cloud/backend.py 
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
async def share_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Share a mailbox with a Globus Group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to share.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

get_mailbox_shares async 

get_mailbox_shares(
    client: ClientInfo, uid: EntityId
) -> list[str]

Get list of globus groups the mailbox is shared with.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

Returns:

  • list[str] –

    List of globus groups id strings

Raises:

Source code in academy/exchange/cloud/backend.py 
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
async def get_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> list[str]:
    """Get list of globus groups the mailbox is shared with.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.

    Returns:
        List of globus groups id strings

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

remove_mailbox_shares async 

remove_mailbox_shares(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Stop sharing a mailbox with a group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent (removing a group that the mailbox is not shared with is a no-op).

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to remove.

Raises:

Source code in academy/exchange/cloud/backend.py 
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
async def remove_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Stop sharing a mailbox with a group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent (removing a group that the mailbox
    is not shared with is a no-op).

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to remove.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

update_heartbeat async 

update_heartbeat(client: ClientInfo, uid: EntityId) -> None

Update the heartbeat timestamp for a mailbox.

Parameters:

Source code in academy/exchange/cloud/backend.py 
231
232
233
234
235
236
237
238
239
240
241
242
async def update_heartbeat(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> None:
    """Update the heartbeat timestamp for a mailbox.

    Args:
        uid: Mailbox id to update.
        client: Client Info to verify.
    """
    ...

heartbeat_status async 

heartbeat_status(
    client: ClientInfo, uid: EntityId
) -> float | None

Get the last heartbeat timestamp of a mailbox.

Parameters:

Returns:

  • float | None –

    Unix timestamp of the last heartbeat, or None if never recorded.

Source code in academy/exchange/cloud/backend.py 
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
async def heartbeat_status(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> float | None:
    """Get the last heartbeat timestamp of a mailbox.

    Args:
        uid: Mailbox id to check.
        client: Client Info to verify.

    Returns:
        Unix timestamp of the last heartbeat, or None if never recorded.
    """
    ...

agent_stats async 

agent_stats(
    client: ClientInfo, uid: EntityId
) -> AgentStats

Return live exchange-level metrics for an agent.

Parameters:

Source code in academy/exchange/cloud/backend.py 
260
261
262
263
264
265
266
267
268
269
270
271
272
async def agent_stats(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> AgentStats:
    """Return live exchange-level metrics for an agent.

    Args:
           uid: Mailbox id to check.
           client: Client Info to verify.

    """
    ...

PythonBackend 

PythonBackend(message_size_limit_kb: int = 1024)

Mailbox backend using in-memory python data structures.

Parameters:

  • message_size_limit_kb (int, default: 1024 ) –

    Maximum message size to allow.

Source code in academy/exchange/cloud/backend.py 
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
def __init__(
    self,
    message_size_limit_kb: int = 1024,
) -> None:
    self._owners: dict[EntityId, str | None] = {}
    self._shares: dict[EntityId, set[str]] = {}
    self._mailboxes: dict[EntityId, AsyncQueue[Message[Any]]] = {}
    self._terminated: set[EntityId] = set()
    self._agents: dict[AgentId[Any], tuple[str, ...]] = {}
    self._locks: dict[EntityId, asyncio.Lock] = {}
    self._requests: dict[EntityId, dict[uuid.UUID, Header]] = {}
    self._completions: dict[EntityId, int] = {}
    self._outgoing: dict[EntityId, int] = {}
    self.message_size_limit = message_size_limit_kb * KB_TO_BYTES
    self.last_active: dict[EntityId, float] = {}

check_mailbox async 

check_mailbox(
    client: ClientInfo, uid: EntityId
) -> MailboxStatus

Check if a mailbox exists, or is terminated.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

Returns:

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
async def check_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> MailboxStatus:
    """Check if a mailbox exists, or is terminated.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.

    Returns:
        The mailbox status.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if uid not in self._mailboxes:
        return MailboxStatus.MISSING
    elif not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    async with self._locks[uid]:
        if uid in self._terminated:
            return MailboxStatus.TERMINATED
        else:
            return MailboxStatus.ACTIVE

create_mailbox async 

create_mailbox(
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None

Create a mailbox is not exists.

This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

  • agent (tuple[str, ...] | None, default: None ) –

    The agent_mro for behavior discovery.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
async def create_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None:
    """Create a mailbox is not exists.

    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.
        agent: The agent_mro for behavior discovery.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    mailbox = self._mailboxes.get(uid, None)
    if mailbox is None:
        if sys.version_info >= (3, 13):  # pragma: >=3.13 cover
            queue: AsyncQueue[Message[Any]] = Queue()
        else:  # pragma: <3.13 cover
            queue: AsyncQueue[Message[Any]] = Queue().async_q
        self._mailboxes[uid] = queue
        self._terminated.discard(uid)
        self._owners[uid] = client.client_id
        self._locks[uid] = asyncio.Lock()
        if agent is not None and isinstance(uid, AgentId):
            self._agents[uid] = agent
        logger.info(
            'Created mailbox for %s',
            uid,
            extra={'academy.mailbox_id': uid},
        )

terminate async 

terminate(client: ClientInfo, uid: EntityId) -> None

Close a mailbox.

For security, the manager should keep a gravestone so the same id cannot be re-registered.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to close.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
async def terminate(self, client: ClientInfo, uid: EntityId) -> None:
    """Close a mailbox.

    For security, the manager should keep a gravestone so the same id
    cannot be re-registered.

    Args:
        client: Client making the request.
        uid: Mailbox id to close.

    Raises:
        ForbiddenError: If the client does not have the right permissions.

    """
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    self._terminated.add(uid)
    mailbox = self._mailboxes.get(uid, None)
    if mailbox is None:
        return

    async def send(message: Message[Any]) -> None:
        await self.put(client, message)

    pending_requests: list[Header] | None = None
    async with self._locks[uid]:
        pending_requests = list(self._requests.pop(uid, {}).values())
        mailbox.shutdown(immediate=True)

    await _respond_pending_requests_on_terminate(
        pending_requests,
        send,
    )

update_heartbeat async 

update_heartbeat(client: ClientInfo, uid: EntityId) -> None

Update the heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
438
439
440
441
442
443
444
445
446
447
448
async def update_heartbeat(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> None:
    """Update the heartbeat timestamp for a mailbox."""
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )
    self.last_active[uid] = time.time()

heartbeat_status async 

heartbeat_status(
    client: ClientInfo, uid: EntityId
) -> float | None

Get the last heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
async def heartbeat_status(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> float | None:
    """Get the last heartbeat timestamp for a mailbox."""
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if self.last_active.get(uid) is None:
        return None

    return time.time() - self.last_active[uid]

agent_stats async 

agent_stats(
    client: ClientInfo, uid: EntityId
) -> AgentStats

Return live exchange-level metrics for an agent.

Source code in academy/exchange/cloud/backend.py 
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
async def agent_stats(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> AgentStats:
    """Return live exchange-level metrics for an agent."""
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    queue = self._mailboxes.get(uid)
    queued = queue.qsize() if queue is not None else 0
    pending = len(self._requests.get(uid, {}))
    completed = self._completions.get(uid, 0)
    outgoing = self._outgoing.get(uid, 0)
    in_progress = max(0, pending - queued)
    incoming = completed + pending
    return AgentStats(
        incoming=incoming,
        outgoing=outgoing,
        completed=completed,
        in_progress=in_progress,
        queued=queued,
    )

discover async 

discover(
    client: ClientInfo, agent: str, allow_subclasses: bool
) -> list[AgentId[Any]]

Find mailboxes of matching agent class.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • agent (str) –

    Agent class to search for.

  • allow_subclasses (bool) –

    Include agents that inherit from the target.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
async def discover(
    self,
    client: ClientInfo,
    agent: str,
    allow_subclasses: bool,
) -> list[AgentId[Any]]:
    """Find mailboxes of matching agent class.

    Args:
        client: Client making the request.
        agent: Agent class to search for.
        allow_subclasses: Include agents that inherit from the target.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    found: list[AgentId[Any]] = []
    for aid, agents in self._agents.items():
        if not self._has_permissions(client, aid):
            continue
        if aid in self._terminated:
            continue
        if agent == agents[0] or (allow_subclasses and agent in agents):
            found.append(aid)
    return found

get async 

get(
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None
) -> Message[Any]

Get messages from a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to get messages.

  • timeout (float | None, default: None ) –

    Time in seconds to wait for message. If None, wait indefinitely.

Raises:

Source code in academy/exchange/cloud/backend.py 
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
async def get(
    self,
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None,
) -> Message[Any]:
    """Get messages from a mailbox.

    Args:
        client: Client making the request.
        uid: Mailbox id to get messages.
        timeout: Time in seconds to wait for message.
            If None, wait indefinitely.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        TimeoutError: There was not message received during the timeout.
    """
    if not self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    try:
        queue = self._mailboxes[uid]
    except KeyError as e:
        raise BadEntityIdError(uid) from e
    try:
        return await asyncio.wait_for(queue.get(), timeout=timeout)
    except QueueShutDown:
        raise MailboxTerminatedError(uid) from None
    except asyncio.TimeoutError:
        # In Python 3.10 and older, asyncio.TimeoutError and TimeoutError
        # are different error types.
        raise TimeoutError(
            f'No message retrieved within {timeout} seconds.',
        ) from None

put async 

put(client: ClientInfo, message: Message[Any]) -> None

Put a message in a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • message (Message[Any]) –

    Message to put in mailbox.

Raises:

Source code in academy/exchange/cloud/backend.py 
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
async def put(self, client: ClientInfo, message: Message[Any]) -> None:
    """Put a message in a mailbox.

    Args:
        client: Client making the request.
        message: Message to put in mailbox.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        MessageTooLargeError: The message is larger than the message
            size limit for this exchange.
    """
    if not self._has_permissions(client, message.dest):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    if sys.getsizeof(message.body) > self.message_size_limit:
        raise MessageTooLargeError(
            sys.getsizeof(message.body),
            self.message_size_limit,
        )

    try:
        queue = self._mailboxes[message.dest]
    except KeyError as e:
        raise BadEntityIdError(message.dest) from e

    if message.is_request():
        self._requests.setdefault(message.dest, {})[message.tag] = (
            message.header
        )
        self._outgoing[message.src] = (
            self._outgoing.get(message.src, 0) + 1
        )
        logger.debug(
            'Tracking in-flight request: tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )
    elif (
        message.src in self._requests
        and message.tag in self._requests[message.src]
    ):
        request_msg = self._requests[message.src].pop(message.tag)
        if not self._requests[message.src]:
            del self._requests[message.src]
        self._completions[message.src] = (
            self._completions.get(message.src, 0) + 1
        )
        logger.debug(
            'Response received for in-flight request: '
            'tag=%s src=%s dest=%s',
            request_msg.tag,
            request_msg.src,
            request_msg.dest,
            extra={
                'academy.message_tag': request_msg.tag,
                'academy.src': request_msg.src,
                'academy.dest': request_msg.dest,
            },
        )
    else:
        logger.warning(
            'Response received without corresponding request: '
            'tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )

    async with self._locks[message.dest]:
        try:
            await queue.put(message)
        except QueueShutDown:
            raise MailboxTerminatedError(message.dest) from None

share_mailbox async 

share_mailbox(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Share a mailbox with a Globus group.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Target Mailbox for sharing

  • group_uid (str) –

    Group id to share mailbox with.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
async def share_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Share a mailbox with a Globus group.

    Args:
        client: Client making the request.
        uid: Target Mailbox for sharing
        group_uid: Group id to share mailbox with.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if not self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot share mailbox '
            f'{uid} it does not own.',
        )

    if group_uid not in client.group_memberships:
        raise ForbiddenError(
            f'Owner does not belong to the group {group_uid}',
        )

    if uid not in self._shares:
        self._shares[uid] = set()

    self._shares[uid].add(group_uid)

get_mailbox_shares async 

get_mailbox_shares(
    client: ClientInfo, uid: EntityId
) -> list[str]

Get list of globus groups the mailbox is shared with.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

Returns:

  • list[str] –

    List of globus groups id strings

Raises:

Source code in academy/exchange/cloud/backend.py 
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
async def get_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> list[str]:
    """Get list of globus groups the mailbox is shared with.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.

    Returns:
        List of globus groups id strings

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if not self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            'Viewing shared groups requires ownership',
        )

    return list(self._shares.get(uid, set()))

remove_mailbox_shares async 

remove_mailbox_shares(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Stop sharing a mailbox with a group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent (removing a group that the mailbox is not shared with is a no-op).

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to remove.

Raises:

Source code in academy/exchange/cloud/backend.py 
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
async def remove_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Stop sharing a mailbox with a group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent (removing a group that the mailbox
    is not shared with is a no-op).

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to remove.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    ...

    if uid not in self._mailboxes:
        raise BadEntityIdError(uid)

    if uid in self._terminated:
        raise MailboxTerminatedError(uid)

    if not self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot change permissions on'
            f'mailbox {uid} it does not own.',
        )

    self._shares[uid].discard(group_uid)
    logger.info('Group %s removed from mailbox %s', group_uid, uid)

RedisBackend 

RedisBackend(
    hostname: str = "localhost",
    port: int = 6379,
    *,
    message_size_limit_kb: int = 1024,
    kwargs: dict[str, Any] | None = None,
    mailbox_expiration_s: int | None = None,
    gravestone_expiration_s: int | None = None
)

Redis backend of mailboxes.

Parameters:

  • hostname (str, default: 'localhost' ) –

    Host address of redis.

  • port (int, default: 6379 ) –

    Redis port.

  • message_size_limit_kb (int, default: 1024 ) –

    Maximum message size to allow.

  • kwargs (dict[str, Any] | None, default: None ) –

    Addition arguments to pass to redis session.

Source code in academy/exchange/cloud/backend.py 
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
def __init__(  # noqa: PLR0913
    self,
    hostname: str = 'localhost',
    port: int = 6379,
    *,
    message_size_limit_kb: int = 1024,
    kwargs: dict[str, Any] | None = None,
    mailbox_expiration_s: int | None = None,
    gravestone_expiration_s: int | None = None,
) -> None:
    self.message_size_limit = message_size_limit_kb * KB_TO_BYTES

    if kwargs is None:  # pragma: no branch
        kwargs = {}

    self._client: redis.asyncio.Redis[bytes] = redis.asyncio.Redis(
        host=hostname,
        port=port,
        decode_responses=False,
        **kwargs,
    )
    self.mailbox_expiration_s = mailbox_expiration_s
    self.gravestone_expiration_s = gravestone_expiration_s

check_mailbox async 

check_mailbox(
    client: ClientInfo, uid: EntityId
) -> MailboxStatus

Check if a mailbox exists, or is terminated.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

Returns:

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
async def check_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> MailboxStatus:
    """Check if a mailbox exists, or is terminated.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.

    Returns:
        The mailbox status.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self._client.get(self._active_key(uid))
    if status is None:
        return MailboxStatus.MISSING
    elif status.decode() == MailboxStatus.TERMINATED.value:
        return MailboxStatus.TERMINATED
    else:
        return MailboxStatus.ACTIVE

create_mailbox async 

create_mailbox(
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None

Create a mailbox is not exists.

This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to check.

  • agent (tuple[str, ...] | None, default: None ) –

    The agent_mro for behavior discovery.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
async def create_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    agent: tuple[str, ...] | None = None,
) -> None:
    """Create a mailbox is not exists.

    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to check.
        agent: The agent_mro for behavior discovery.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    await self._client.set(
        self._active_key(uid),
        MailboxStatus.ACTIVE.value,
    )

    if agent is not None:
        await self._client.set(
            self._agent_key(uid),
            ','.join(agent),
        )

    await self._client.set(
        self._owner_key(uid),
        f'{client.client_id}{_OWNER_SUFFIX}',
    )
    await self._update_expirations(uid)

terminate async 

terminate(client: ClientInfo, uid: EntityId) -> None

Close a mailbox.

For security, the manager should keep a gravestone so the same id cannot be re-registered.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to close.

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
async def terminate(self, client: ClientInfo, uid: EntityId) -> None:
    """Close a mailbox.

    For security, the manager should keep a gravestone so the same id
    cannot be re-registered.

    Args:
        client: Client making the request.
        uid: Mailbox id to close.

    Raises:
        ForbiddenError: If the client does not have the right permissions.

    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self.check_mailbox(client, uid)

    if status in {MailboxStatus.MISSING, MailboxStatus.TERMINATED}:
        return

    await self._client.set(
        self._active_key(uid),
        MailboxStatus.TERMINATED.value,
    )

    if self.gravestone_expiration_s is not None:
        await self._client.expire(
            self._active_key(uid),
            self.gravestone_expiration_s,
        )

    await self._client.delete(self._queue_key(uid))
    # Sending a close sentinel to the queue is a quick way to force
    # the entity waiting on messages to the mailbox to stop blocking.
    # This assumes that only one entity is reading from the mailbox.
    await self._client.rpush(self._queue_key(uid), _CLOSE_SENTINEL)
    if isinstance(uid, AgentId):
        await self._client.delete(self._agent_key(uid))

    req_keys = [
        key
        async for key in self._client.scan_iter(
            f'request:{uid.uid}:*',
            count=1000,
        )
    ]
    pending_requests: list[Header] = []
    for req_key in req_keys:
        data = await self._client.get(req_key)
        if data is None:  # The key was removed between scan and delete
            continue  # pragma: no cover
        pending_requests.append(Header.model_validate_json(data.decode()))
        await self._client.delete(req_key)

    async def send(message: Message[Any]) -> None:
        await self.put(client, message)

    await _respond_pending_requests_on_terminate(
        pending_requests,
        send,
    )

update_heartbeat async 

update_heartbeat(client: ClientInfo, uid: EntityId) -> None

Update the heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
async def update_heartbeat(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> None:
    """Update the heartbeat timestamp for a mailbox."""
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    now = await self._redis_current_time()

    await self._client.set(self._heartbeat_key(uid), str(now))
    await self._update_expirations(uid)

heartbeat_status async 

heartbeat_status(
    client: ClientInfo, uid: EntityId
) -> float | None

Get the time since last heartbeat timestamp for a mailbox.

Source code in academy/exchange/cloud/backend.py 
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
async def heartbeat_status(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> float | None:
    """Get the time since last heartbeat timestamp for a mailbox."""
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)

    if status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    heartbeat_time = await self._client.get(self._heartbeat_key(uid))

    if heartbeat_time is None:
        return None

    now = await self._redis_current_time()

    return now - float(heartbeat_time.decode())

agent_stats async 

agent_stats(
    client: ClientInfo, uid: EntityId
) -> AgentStats

Return live exchange-level metrics for an agent.

Source code in academy/exchange/cloud/backend.py 
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
async def agent_stats(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> AgentStats:
    """Return live exchange-level metrics for an agent."""
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    queued = await self._client.llen(self._queue_key(uid))
    pending = 0
    async for _ in self._client.scan_iter(
        f'request:{uid.uid}:*',
        count=1000,
    ):
        pending += 1
    completed_raw = await self._client.get(self._completions_key(uid))
    outgoing_raw = await self._client.get(self._outgoing_key(uid))
    completed = int(completed_raw) if completed_raw is not None else 0
    outgoing = int(outgoing_raw) if outgoing_raw is not None else 0
    in_progress = max(0, pending - queued)
    incoming = completed + pending
    return AgentStats(
        incoming=incoming,
        outgoing=outgoing,
        completed=completed,
        in_progress=in_progress,
        queued=queued,
    )

discover async 

discover(
    client: ClientInfo, agent: str, allow_subclasses: bool
) -> list[AgentId[Any]]

Find mailboxes of matching agent class.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • agent (str) –

    Agent class to search for.

  • allow_subclasses (bool) –

    Include agents that inherit from the target.

Source code in academy/exchange/cloud/backend.py 
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
async def discover(
    self,
    client: ClientInfo,
    agent: str,
    allow_subclasses: bool,
) -> list[AgentId[Any]]:
    """Find mailboxes of matching agent class.

    Args:
        client: Client making the request.
        agent: Agent class to search for.
        allow_subclasses: Include agents that inherit from the target.
    """
    found: list[AgentId[Any]] = []
    async for key in self._client.scan_iter(
        'agent:*',
        count=1000,
    ):  # pragma: no branch
        data = await self._client.get(key)
        if data is None:  # Key was removed between scan and read
            continue  # pragma: no cover
        mro_str = data.decode()
        assert isinstance(mro_str, str)
        mro = mro_str.split(',')
        if agent == mro[0] or (allow_subclasses and agent in mro):
            aid: AgentId[Any] = AgentId(
                uid=uuid.UUID(key.decode().split(':')[-1]),
            )
            found.append(aid)

    active: list[AgentId[Any]] = []
    for aid in found:
        if await self._has_permissions(client, aid):
            status = await self._client.get(self._active_key(aid))
            if (
                status is not None
                and status.decode() == MailboxStatus.ACTIVE.value
            ):  # pragma: no branch
                active.append(aid)

    return active

get async 

get(
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None
) -> Message[Any]

Get messages from a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to get messages.

  • timeout (float | None, default: None ) –

    Time in seconds to wait for message. If None, wait indefinitely.

Raises:

Source code in academy/exchange/cloud/backend.py 
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
async def get(
    self,
    client: ClientInfo,
    uid: EntityId,
    *,
    timeout: float | None = None,
) -> Message[Any]:
    """Get messages from a mailbox.

    Args:
        client: Client making the request.
        uid: Mailbox id to get messages.
        timeout: Time in seconds to wait for message.
            If None, wait indefinitely.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        TimeoutError: There was not message received during the timeout.
    """
    if not await self._has_permissions(client, uid):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    _timeout = timeout if timeout is not None else 0
    status = await self._client.get(
        self._active_key(uid),
    )
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    await self._update_expirations(uid)
    if self.mailbox_expiration_s:
        await self._client.expire(
            self._queue_key(uid),
            self.mailbox_expiration_s,
        )

    raw = await self._client.blpop(
        [self._queue_key(uid)],
        timeout=_timeout,
    )
    if raw is None:
        raise TimeoutError(
            f'Timeout waiting for next message for {uid} '
            f'after {timeout} seconds.',
        )

    # Only passed one key to blpop to result is [key, item]
    assert len(raw) == 2  # noqa: PLR2004
    if raw[1] == _CLOSE_SENTINEL:  # pragma: no cover
        raise MailboxTerminatedError(uid)
    return Message.model_deserialize(raw[1])

put async 

put(client: ClientInfo, message: Message[Any]) -> None

Put a message in a mailbox.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • message (Message[Any]) –

    Message to put in mailbox.

Raises:

Source code in academy/exchange/cloud/backend.py 
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
async def put(self, client: ClientInfo, message: Message[Any]) -> None:
    """Put a message in a mailbox.

    Args:
        client: Client making the request.
        message: Message to put in mailbox.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
        MessageTooLargeError: The message is larger than the message
            size limit for this exchange.
    """
    if not await self._has_permissions(client, message.dest):
        raise ForbiddenError(
            'Client does not have correct permissions.',
        )

    status = await self._client.get(self._active_key(message.dest))
    if status is None:
        raise BadEntityIdError(message.dest)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(message.dest)

    serialized = message.model_serialize()
    if len(serialized) > self.message_size_limit:
        raise MessageTooLargeError(
            len(serialized),
            self.message_size_limit,
        )

    if message.is_request():
        await self._client.set(
            self._request_key(message.dest, message.tag),
            message.header.model_dump_json(),
        )
        await self._client.incr(self._outgoing_key(message.src))
        if self.mailbox_expiration_s:
            await self._client.expire(
                self._request_key(message.dest, message.tag),
                self.mailbox_expiration_s,
            )
        logger.debug(
            'Tracking in-flight request: tag=%s src=%s dest=%s',
            message.tag,
            message.src,
            message.dest,
            extra={
                'academy.message_tag': message.tag,
                'academy.src': message.src,
                'academy.dest': message.dest,
            },
        )
    else:
        req_key = self._request_key(message.src, message.tag)
        matching_data = await self._client.get(req_key)
        if matching_data is not None:
            # TODO: Use redis locks here to ensure thread safety
            matching: Header = Header.model_validate_json(
                matching_data.decode(),
            )
            await self._client.delete(req_key)
            await self._client.incr(self._completions_key(message.src))
            logger.debug(
                'Response received for in-flight request: '
                'tag=%s src=%s dest=%s',
                matching.tag,
                matching.src,
                matching.dest,
                extra={
                    'academy.message_tag': matching.tag,
                    'academy.src': matching.src,
                    'academy.dest': matching.dest,
                },
            )
        else:
            logger.warning(
                'Response received without corresponding request: '
                'tag=%s src=%s dest=%s',
                message.tag,
                message.src,
                message.dest,
                extra={
                    'academy.message_tag': message.tag,
                    'academy.src': message.src,
                    'academy.dest': message.dest,
                },
            )

    await self._client.rpush(
        self._queue_key(message.dest),
        serialized,
    )

    if self.mailbox_expiration_s:
        await self._client.expire(
            self._queue_key(message.dest),
            self.mailbox_expiration_s,
            nx=True,
        )

share_mailbox async 

share_mailbox(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Share a mailbox with a Globus group.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • group_uid (str) –

    Group id to share mailbox with.

  • uid (EntityId) –

    Target Mailbox for sharing

Raises:

  • ForbiddenError –

    If the client does not have the right permissions.

Source code in academy/exchange/cloud/backend.py 
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
async def share_mailbox(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Share a mailbox with a Globus group.

    Args:
         client: Client making the request.
         group_uid: Group id to share mailbox with.
         uid: Target Mailbox for sharing

    Raises:
        ForbiddenError: If the client does not have the right permissions.
    """
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    if not await self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot share mailbox '
            f'{uid} it does not own.',
        )
    if group_uid not in client.group_memberships:
        raise ForbiddenError(
            f'Owner does not belong to the group {group_uid}',
        )

    await self._client.sadd(self._share_key(uid), group_uid)

get_mailbox_shares async 

get_mailbox_shares(
    client: ClientInfo, uid: EntityId
) -> list[str]

Get list of globus groups the mailbox is shared with.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent.

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

Returns:

  • list[str] –

    List of globus groups id strings

Raises:

Source code in academy/exchange/cloud/backend.py 
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
async def get_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
) -> list[str]:
    """Get list of globus groups the mailbox is shared with.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent.

    Args:
        client: Client making the request.
        uid: Mailbox id to share.

    Returns:
        List of globus groups id strings

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox requested does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    if not await self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            'Viewing shared groups requires ownership',
        )

    _groups = await self._client.smembers(self._share_key(uid))
    groups = [g.decode() for g in _groups]
    return groups

remove_mailbox_shares async 

remove_mailbox_shares(
    client: ClientInfo, uid: EntityId, group_uid: str
) -> None

Stop sharing a mailbox with a group.

Only the owner of the Mailbox is allowed to share with a Globus Group. This method should be idempotent (removing a group that the mailbox is not shared with is a no-op).

Parameters:

  • client (ClientInfo) –

    Client making the request.

  • uid (EntityId) –

    Mailbox id to share.

  • group_uid (str) –

    Globus Group id to remove.

Raises:

Source code in academy/exchange/cloud/backend.py 
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
async def remove_mailbox_shares(
    self,
    client: ClientInfo,
    uid: EntityId,
    group_uid: str,
) -> None:
    """Stop sharing a mailbox with a group.

    Only the owner of the Mailbox is allowed to share with a Globus Group.
    This method should be idempotent (removing a group that the mailbox
    is not shared with is a no-op).

    Args:
        client: Client making the request.
        uid: Mailbox id to share.
        group_uid: Globus Group id to remove.

    Raises:
        ForbiddenError: If the client does not have the right permissions.
        BadEntityIdError: The mailbox to share does not exist.
        MailboxTerminatedError: The mailbox is closed.
    """
    status = await self._client.get(self._active_key(uid))
    if status is None:
        raise BadEntityIdError(uid)
    elif status.decode() == MailboxStatus.TERMINATED.value:
        raise MailboxTerminatedError(uid)

    if not await self._has_mailbox_ownership(client, uid):
        raise ForbiddenError(
            f'{client.client_id} cannot change permissions on'
            f'mailbox {uid} it does not own.',
        )

    await self._client.srem(self._share_key(uid), group_uid)