matlab.net.http.AuthInfo class

Пакет: matlab.net.http

Информация об аутентификации или авторизации в HTTP-сообщениях

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

Описание

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

The AuthInfo класс представляет один вызов проверки подлинности, возвращенный при:

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

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

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

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

Для получения дополнительной информации см. RFC 7235 Authentication и RFC 2617 Host-Imp Interface (для Basic и Digest Authentication).

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

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 является одним из этих форматов. Значения необязательно заключаются в кавычки, и при необходимости вставляются выходные символы.

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 на 2. Parameters{i,1} - имя ith параметр и является строкой. Parameters{i,2} является его значением. Тип зависит от параметра. Чтобы получить или задать это свойство, используйте getParameter или setParameter методы.

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

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

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

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

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public
Dependent
true

Методы

расширить все

См. также

| | | | | |

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

Введенный в R2016b

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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте