JwtTokenValidation Класс

  • Ссылка
Пакет:
com.microsoft.bot.connector.authentication
Артефакт Maven:
com.microsoft.bot:bot-connector:4.14.3
  • java.lang.Object
    • com.microsoft.bot.connector.authentication.JwtTokenValidation

public final class JwtTokenValidation

Содержит вспомогательные методы проверки подлинности входящих HTTP-запросов.

Сводка по методу

Модификатор и тип Метод и описание
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider)

Проверяет подлинность запроса и добавляет Activity#getServiceUrl() действия в набор доверенных URL-адресов.
static java.util.concurrent.CompletableFuture<ClaimsIdentity> authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, AuthenticationConfiguration authConfig)

Проверяет подлинность запроса и добавляет Activity#getServiceUrl() действия в набор доверенных URL-адресов.
static java.lang.String getAppIdFromClaims(Map<String,String> claims)

Возвращает идентификатор приложенияиз утверждений.
static boolean isValidTokenFormat(String authHeader)

Внутренний вспомогательный элемент, чтобы проверить, имеет ли маркер фигуру, которая ожидается "Медведь [большая длинная строка]".
static java.util.concurrent.CompletableFuture<ClaimsIdentity> validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl)

Проверяет заголовок проверки подлинности входящего запроса.
static java.util.concurrent.CompletableFuture<ClaimsIdentity> validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl, AuthenticationConfiguration authConfig)

Проверяет заголовок проверки подлинности входящего запроса.

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Сведения о методе

authenticateRequest

public static CompletableFuture authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider)

Проверяет подлинность запроса и добавляет Activity#getServiceUrl() действия в набор доверенных URL-адресов.

Параметры:

activity - Входящие действия из Bot Framework или эмулятора
authHeader - Маркер носителя, включенный в состав запроса
credentials - Поставщик учетных данных бота.
channelProvider - Поставщик услуг канала бота.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

authenticateRequest

public static CompletableFuture authenticateRequest(Activity activity, String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, AuthenticationConfiguration authConfig)

Проверяет подлинность запроса и добавляет Activity#getServiceUrl() действия в набор доверенных URL-адресов.

Параметры:

activity - Входящие действия из Bot Framework или эмулятора
authHeader - Маркер носителя, включенный в состав запроса
credentials - Поставщик учетных данных бота.
channelProvider - Поставщик услуг канала бота.
authConfig - Необязательная конфигурация проверки подлинности.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

getAppIdFromClaims

public static String getAppIdFromClaims(Map claims)

Возвращает Идентификатор приложения из утверждений.

В маркерах версии 1 Идентификатор AppId находится в утверждении AppIdClaim. В токенах версии 2 идентификатор AppId находится в утверждении AuthorizedParty.

Параметры:

claims - Карта утверждений.

Возвращаемое значение:

Значение утверждения appId, если найдено (значение NULL, если оно не удается найти подходящее утверждение).

Активизирует исключение:

java.lang.IllegalArgumentException - Отсутствующие утверждения

isValidTokenFormat

public static boolean isValidTokenFormat(String authHeader)

Внутренний вспомогательный элемент, чтобы проверить, имеет ли маркер фигуру, которая ожидается "Медведь [большая длинная строка]".

Параметры:

authHeader - Строка, содержащая заголовок токена.

Возвращаемое значение:

Значение True, если маркер действителен, значение false, если нет.

validateAuthHeader

public static CompletableFuture validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl)

Проверяет заголовок проверки подлинности входящего запроса.

Параметры:

authHeader - Заголовок проверки подлинности.
credentials - Поставщик учетных данных бота.
channelProvider - Поставщик услуг канала бота.
channelId - Идентификатор канала, отправляющего запрос.
serviceUrl - URL-адрес службы для действия.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь. 
     On Call:

validateAuthHeader

public static CompletableFuture validateAuthHeader(String authHeader, CredentialProvider credentials, ChannelProvider channelProvider, String channelId, String serviceUrl, AuthenticationConfiguration authConfig)

Проверяет заголовок проверки подлинности входящего запроса.

Параметры:

authHeader - Заголовок проверки подлинности.
credentials - Поставщик учетных данных бота.
channelProvider - Поставщик услуг канала бота.
channelId - Идентификатор канала, отправляющего запрос.
serviceUrl - URL-адрес службы для действия.
authConfig - Конфигурация проверки подлинности.

Возвращаемое значение:

Задача, представляющая выполняемую рабочую очередь.

Применяется к