Show / Hide Table of Contents

Namespace Ellucian.Ethos.Integration.Client.Messages

Classes

ChangeNotification

An object representation of a change-notification. A change-notification is the resource that is published and consumed via subscriptions through the Ethos Integration messages service.

ChangeNotificationFactory

A Factory class to help with building ChangeNotification objects.

EthosMessagesClient

An EthosClient used to publish and consume messages using the Ethos Integration messages service.

This client accepts an API key that belongs to an ethos application. All requests made from this client are done on behalf of the application to which that API key belongs. That means that calling the consume methods will try to retrieve change-notifications from the subscription queue of that specific application.It is assumed that the application is configured in Ethos Integration to subscribe to some resource changes.

Likewise, calling the publish methods will try to publish change-notifications on behalf of the application to which the API key belongs. It is assumed that the application is configured in Ethos Integration to own the resources that are in the change-notifications being published. If a change-notification is sent to the Ethos Integration /publish endpoint for a resource that is not owned by the calling application, it will return a

403 Forbidden
response.

The preferred way to instantiate this class is via the { @link com.ellucian.ethos.integration.client.EthosClientBuilder EthosClientBuilder }.

Publisher

A Publisher object that is associated with a change-notification. This holds information about the application that published the change.

Resource

A Resource object that is associated with a change-notification.

Tenant

A Tenant object that is associated with a change-notification. This holds information about the ethos tenant where the change occurred.

In This Article
Back to top Generated by DocFX