Allgemeine Azure Communication Service-Clientbibliothek für Java – Version 1.2.13

Artikel
10/21/2023

Azure Communication Common enthält Datenstrukturen, die häufig für die Kommunikation mit Azure Communication Services verwendet werden. Sie soll übergreifende Belange, z.B. die Authentifizierung, bereitstellen.

Erste Schritte

Voraussetzungen

Ein Azure-Konto mit einem aktiven Abonnement. Sie können kostenlos ein Konto erstellen.
Java Development Kit (JDK), Version 8 oder höher.
Apache Maven.
Eine bereitgestellte Communication Services-Ressource.

BOM-Datei einfügen

Fügen Sie das azure-sdk-bom in Ihr Projekt ein, um die Abhängigkeit von der General Availability (GA)-Version der Bibliothek zu übernehmen. Ersetzen Sie im folgenden Codeausschnitt den Platzhalter {bom_version_to_target} durch die Versionsnummer. Weitere Informationen zur Stückliste finden Sie in der AZURE SDK-BOM-INFODATEI.

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>com.azure</groupId>
            <artifactId>azure-sdk-bom</artifactId>
            <version>{bom_version_to_target}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

und fügen Sie dann die direkte Abhängigkeit ohne Versions-Tag in den Abschnitt „Abhängigkeit“ ein.

<dependencies>
  <dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-common</artifactId>
  </dependency>
</dependencies>

Direkte Abhängigkeiten einfügen

Wenn Sie abhängigkeiten von einer bestimmten Version der Bibliothek übernehmen möchten, die in der Stückliste nicht vorhanden ist, fügen Sie die direkte Abhängigkeit wie folgt zu Ihrem Projekt hinzu.

<dependency>
    <groupId>com.azure</groupId>
    <artifactId>azure-communication-common</artifactId>
    <version>1.2.13</version>
</dependency>

Wichtige Begriffe

Um mit Azure Communication Services zu arbeiten, wird ein Ressourcenzugriffsschlüssel für die Authentifizierung verwendet.

Azure Communication Service unterstützt die HMAC-Authentifizierung mit dem Ressourcenzugriffsschlüssel. Um die HMAC-Authentifizierung anzuwenden, erstellen Sie CommunicationClientCredential mit dem Zugriffsschlüssel, und instanziieren Sie a CommunicationIdentityClient , um Benutzer und Token zu verwalten.

CommunicationTokenCredential

Das CommunicationTokenCredential -Objekt wird verwendet, um einen Benutzer mit Communication Services zu authentifizieren, z. B. Chat oder Anruf. Es bietet optional einen Mechanismus für die automatische Aktualisierung, um einen kontinuierlich stabilen Authentifizierungsstatus während der Kommunikation sicherzustellen.

Abhängig von Ihrem Szenario können Sie folgendes CommunicationTokenCredential initialisieren:

ein statisches Token (geeignet für kurzlebige Clients, die z.B. einmalige Chatnachrichten senden) oder
eine Rückruffunktion, die einen kontinuierlichen Authentifizierungsstatus sicherstellt (ideal z. B. für lange Anrufsitzungen).

Die Token, die entweder über den CommunicationTokenCredential Konstruktor oder über den Tokenaktualisierungsrückruf bereitgestellt werden, können mithilfe der Azure Communication Identity-Bibliothek abgerufen werden.

Beispiele

Erstellen von Anmeldeinformationen mit einem statischen Token

Bei kurzlebigen Clients ist das Aktualisieren des Tokens nach Ablauf nicht erforderlich und CommunicationTokenCredential kann mit einem statischen Token instanziiert werden.

String token = System.getenv("COMMUNICATION_SERVICES_USER_TOKEN");
CommunicationTokenCredential tokenCredential = new CommunicationTokenCredential(token);

Erstellen von Anmeldeinformationen mit proaktiver Aktualisierung mit einem Rückruf

Alternativ können Sie für langlebige Clients einen CommunicationTokenCredential mit einem Rückruf erstellen, um Token zu verlängern, wenn sie abgelaufen sind. Hier wird davon ausgegangen, dass wir über eine Funktion fetchTokenFromMyServerForUser verfügen, die eine Netzwerkanforderung zum Abrufen einer Tokenzeichenfolge für einen Benutzer stellt. Es ist erforderlich, dass die fetchTokenFromMyServerForUser Funktion jederzeit ein gültiges Token (mit einem in der Zukunft festgelegten Ablaufdatum) zurückgibt.

Optional können Sie eine proaktive Tokenaktualisierung aktivieren, bei der ein neues Token abgerufen wird, sobald das vorherige Token abläuft. Bei Verwendung dieser Methode ist es weniger wahrscheinlich, dass Ihre Anforderungen blockiert werden, um ein neues Token abzurufen:

String token = System.getenv("COMMUNICATION_SERVICES_USER_TOKEN");
CommunicationTokenRefreshOptions tokenRefreshOptions = new CommunicationTokenRefreshOptions(fetchTokenFromMyServerForUser)
    .setRefreshProactively(true)
    .setInitialToken(token);
CommunicationTokenCredential tokenCredential = new CommunicationTokenCredential(tokenRefreshOptions);

Problembehandlung

Läuft.

Nächste Schritte

Weitere Clientbibliotheken für den Azure-Kommunikationsdienst

Mitwirken

Beiträge und Vorschläge für dieses Projekt sind willkommen. Für die meisten Beiträge ist die Zustimmung zu einer Lizenzvereinbarung für Mitwirkende (Contributor License Agreement, CLA) erforderlich, in der Sie erklären, dass Sie dazu berechtigt sind, uns die Rechte für die Nutzung Ihres Beitrags zu erteilen, und dies auch tun.

Wenn Sie einen Pull Request (PR) übermitteln, überprüft ein CLA-Bot automatisch, ob Sie eine Lizenzvereinbarung bereitstellen und den PR entsprechend ergänzen müssen (z.B. mit einer Bezeichnung oder einem Kommentar). Führen Sie einfach die Anweisungen des Bots aus. Sie müssen dies nur einmal für alle Repositorys ausführen, die unsere CLA verwenden.

Für dieses Projekt gelten die Microsoft-Verhaltensregeln für Open Source (Microsoft Open Source Code of Conduct). Weitere Informationen finden Sie in den häufig gestellten Fragen zum Verhaltenskodex. Sie können sich auch an opencode@microsoft.com wenden, wenn Sie weitere Fragen oder Anmerkungen haben.

Freigeben über