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

Пакет: matlab.net.http

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

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

Описание

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

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

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

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

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

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

Для получения дополнительной информации смотрите Аутентификацию RFC 7235 и Интерфейс RFC 2617 Host-Imp (для Стандартной аутентификации и Дайджест-аутентификации).

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

Изолированный

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, которые он принимает как часть запроса. Аргумент paramName представляет параметры, которые преобразованы в параметры name=value, когда вы преобразовываете объект AuthInfo в строку.

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

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

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

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

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

  • Если pStr является учетными данными или проблемой, то смотрите RFC 7235, разделите 2.1.

  • Если pStr является auth-info в заголовке Информации Аутентификации, то смотрите RFC 2617, Раздел 3.2.3.

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

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

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

Свойства

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

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

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

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

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

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

Атрибуты:

GetAccess

общественность

SetAccess

общественность

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

Свойство 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

общественность

SetAccess

общественность

Зависимый

tRUE

Методы

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

Смотрите также

| | | | | |

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

Введенный в R2017b

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