matlab.net.http.AuthInfo class

Пакет: matlab.net.http

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

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

Описание

MATLAB® автоматически обрабатывает аутентификацию в сообщениях запроса, когда вы обеспечиваете учетные данные в HTTPOptions объект. Используйте AuthInfo класс, чтобы исследовать аутентификацию, задать информацию авторизации или реализовать протокол аутентификации, такой как OAuth, это не обработано автоматически интерфейсом 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 (для Стандартной аутентификации и Дайджест-аутентификации).

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

Sealed
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

obj = matlab.net.http.AuthInfo(Scheme,paramName,paramValue) создает AuthInfo объект, который включает свойство Scheme и дополнительный paramNameparamValue параметры. Можно задать несколько пар аргумента в любом порядке как 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 типы, но значения должны поддержать string или char метод.

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

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

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

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

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

Parameters свойство зависит от Scheme свойство и атрибуты, которые следуют за Scheme в поле заголовка. Название параметра, соответствующее, является нечувствительным к регистру. Используйте addParametersetParameter, и 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

Методы

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

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

| | | | | |

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

Введенный в R2017b

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