Exponenta Banner
exponenta event banner

matlab.net.http.AuthInfo класс

Пакет: matlab.net.http

Сведения о проверке подлинности или авторизации в сообщениях HTTP

развернуть все на странице

Описание

MATLAB ® автоматически обрабатывает аутентификацию в сообщениях запроса при предоставлении учетных данных в HTTPOptions объект. Используйте AuthInfo класс для проверки аутентификации, для указания информации авторизации или для реализации протокола аутентификации, такого как OAuth, который не обрабатывается автоматически интерфейсом MATLAB HTTP.

AuthInfo класс представляет один вызов аутентификации, возвращенный в следующих случаях:

  • Вы называете AuthenticateField.convert способ для ответного сообщения.

  • Вы вставляете учетные данные в AuthorizationField поле заголовка в сообщение запроса. При хранении AuthInfo объект в поле Полномочия, MATLAB автоматически заключает значения в кавычки, где это необходимо, и вставляет символы escape при необходимости.

  • Сервер возвращает auth-info данные в AuthenticationInfoField поле заголовка.

AuthenticateField и AuthorizationField convert методы преобразуют каждый name=value атрибут пары в поле к парам имя-значение параметра в Parameters собственность. Символы escape и любые кавычки, окружающие значения, удаляются.

Дополнительные сведения см. в разделах Аутентификация RFC 7235 и Интерфейс RFC 2617 Host-Imp (для базовой и цифровой аутентификации).

Атрибуты класса

Sealed
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

obj = matlab.net.http.AuthInfo(Scheme,paramName,paramValue) создает AuthInfo объект, включающий свойство Scheme и необязательный paramName,paramValue параметры. Можно указать несколько пар аргументов в любом порядке как paramName1,paramValue1,...,paramNameN,paramValueN.

obj = matlab.net.http.AuthInfo(paramName,paramValue) создает AuthInfo объект с пустым Scheme значение.

obj = matlab.net.http.AuthInfo(pStruct) копирует параметры и значения из полей pStruct.

obj = matlab.net.http.AuthInfo(pStr) создает AuthInfo от pStr.

Входные аргументы

развернуть все

Имя параметра, указанное как строка или символьный вектор. Веб-служба определяет paramName,paramValue пар, которые он принимает как часть запроса. A paramName аргумент представляет параметры, преобразованные в name=value параметры при преобразовании AuthInfo объект в строку.

Типы данных: char | string

Значение параметра, указанное как тип, требуемый paramName. Нет ограничений на paramValue типы, но значения должны поддерживать string или char способ.

Параметры и значения, указанные как поля в структуре MATLAB. Структура должна иметь по крайней мере Scheme поле. MATLAB пропускает поля с пустыми значениями.

Типы данных: struct

Параметры и значения, указанные как строки. Для pStr синтаксис:

pStr является одним из этих форматов. Значения дополнительно заключены в кавычки, и при необходимости вставляются символы escape.

SCHEME token
SCHEME param1=value1, param2=value2, ...
param1=value1, param2=value2, ...

Типы данных: string

Свойства

развернуть все

Схема аутентификации, указанная как matlab.net.http.AuthenticationScheme объект или строка, называющая схему.

  • Если Scheme является строкой, то MATLAB пытается преобразовать ее в AuthenticationScheme перечисление. MATLAB не обеспечивает специальной обработки для Scheme с числовым значением меньше 0.

  • Если AuthInfo объект является вызовом в AuthenticateField поле заголовка и Scheme не является AuthenticationScheme перечисление, затем Scheme является строкой. В противном случае Scheme является AuthenticationScheme объект.

  • Если AuthInfo находится в AuthorizationField поле заголовка, затем Scheme является AuthenticationScheme объект.

  • Если AuthInfo находится в AuthenticationInfoField поле заголовка, затем Scheme может быть пустым.

Атрибуты:

GetAccess
public
SetAccess
public

Имена и значения параметров, заданные как массив ячеек n-by-2. Parameters{i,1} является именем i-й параметр и является строкой. Parameters{i,2} - его ценность. Тип зависит от параметра. Чтобы получить или задать это свойство, используйте getParameter или setParameter методы.

Parameters свойство зависит от Scheme свойство и следующие атрибуты Scheme в поле заголовка. Сопоставление имен параметров не учитывает регистр. Используйте addParameter, setParameter, и removeParameter для доступа к значениям в Parameters массив.

Некоторые свойства параметров имеют специальные значения и синтаксис, которые MATLAB обеспечивает на основе Scheme. Здесь перечислены параметры со специальными значениями. Все остальные параметры: string объекты.

  • Если Scheme является AuthenticationScheme.Basic, то ожидается один параметр.

    • В AuthenticateField (вызов с сервера), имя свойства: realm. Сервер предоставляет область для запроса пользователя, которая соответствует Credentials.Realm собственность. Один AuthInfo возвращено AuthenticateField.convert метод всегда имеет параметр области.

    • В AuthorizationField (учетные данные в ответе клиента), имя свойства: encoded. Encoded свойство представляет собой последовательность символов в кодировке base64, представляющих имя пользователя и пароль в том виде, в каком они отображаются в поле заголовка после Scheme. Если этот параметр установлен, его необходимо кодировать самостоятельно с помощью base64encode функция.

  • Если Scheme является AuthenticationScheme.Digest, то количество свойств является переменным и соответствует name=value атрибуты в поле заголовка.

  • Если Scheme является любым другим AuthenticationScheme свойство или строка, то все имена атрибутов и значения являются приемлемыми, если они могут быть преобразованы в строки.

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true

Методы

развернуть все

См. также

| | | | | |

Внешние веб-сайты

Представлен в R2016b

Документация MATLAB

Поддержка