matlab.net.http.AuthInfo类

包:matlab.net.http

HTTP消息中的身份验证或授权信息

展开全部页面

描述

MATLAB^®类中提供凭据时，自动处理请求消息中的身份验证HTTPOptions对象。使用AuthInfo类来检查身份验证、指定授权信息或实现身份验证协议，例如OAuth，这不是由MATLAB HTTP接口自动处理。

的AuthInfo类表示在以下情况下返回的一个身份验证挑战:

你打电话给AuthenticateField.convert方法用于响应消息。
类型中插入凭据AuthorizationField头字段转换为请求消息。当你存储AuthInfo对象，MATLAB自动在需要的地方将值括在引号中，并根据需要插入转义字符。
服务器返回auth-info的数据AuthenticationInfoField头字段。

的AuthenticateField而且AuthorizationField转换方法转换名称=值属性中的参数名称和值对参数财产。转义字符和任何围绕值的引号被删除。

有关更多信息，请参见RFC 7235认证而且RFC 2617 Host-Imp接口(用于基本和摘要身份验证)。

类属性

密封 真正的

有关类属性的信息，请参见类属性．

创建

描述

obj = matlab.net.http.AuthInfo(方案，paramName,paramValue）创建一个AuthInfo对象，该对象包含计划属性和可选paramName,paramValue参数。您可以以任意顺序指定多个参数对paramName1, paramValue1,…,paramNameN paramValueN．

obj = matlab.net.http.AuthInfo(paramName,paramValue）创建一个AuthInfo对象的空计划价值。

obj = matlab.net.http.AuthInfo(pStruct）的字段中复制参数和值pStruct．

obj = matlab.net.http.AuthInfo(pStr）创建一个AuthInfo从pStr．

输入参数

全部展开

`paramName`- - - - - -参数名称
字符串|特征向量

参数名称，指定为字符串或字符向量。web服务定义了paramName, paramValue对，它接受作为请求的一部分。一个paramName参数表示转换为的参数名称=值参数AuthInfo对象指定为字符串。

数据类型:字符|字符串

`paramValue`- - - - - -参数值
所需类型`paramName`

参数值，指定为所需的类型paramName．没有约束paramValue类型，但值必须支持金宝app字符串或字符方法。

`pStruct`- - - - - -参数和值
MATLAB结构

参数和值，在MATLAB结构中指定为字段。结构应该至少有一个计划字段。MATLAB省略空值字段。

数据类型:结构体

`pStr`- - - - - -参数和值
字符串

参数和值，以字符串形式指定。为pStr语法:

如果pStr是证书还是挑战，明白了吗RFC 7235，章节2.1．
如果pStr是一个auth-info在Authentication-Info头中，然后参见RFC 2617，章节3.2.3．

pStr是这些格式之一。值可选地括在引号中，并根据需要插入转义字符。

SCHEME token方案param1=value1, param2=value2，…Param1 =value1, param2=value2，…

数据类型:字符串

属性

全部展开

`计划`- - - - - -身份验证方案
`AuthenticationScheme。基本`(默认)|`matlab.net.http.AuthenticationScheme`对象|字符串|空

认证方案，指定为matlab.net.http.AuthenticationScheme对象或命名方案的字符串。

如果计划是一个字符串，然后MATLAB尝试将其转换为AuthenticationScheme枚举。MATLAB没有提供特殊的处理计划数值小于0。
如果AuthInfo对象是一个挑战AuthenticateField报头字段和计划不是AuthenticationScheme枚举,然后计划是一个字符串。否则,计划是一个AuthenticationScheme对象。
如果AuthInfo在一个AuthorizationField头字段，然后计划是一个AuthenticationScheme对象。
如果AuthInfo在一个AuthenticationInfoField头字段，然后计划可能是空的。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`

`参数`- - - - - -参数名称和值
n × 2单元格数组

参数名称和值，指定为n × 2单元格数组。参数{1},我是名字吗我参数，是一个字符串。参数{2},我就是它的值。类型取决于参数。要获取或设置此属性，请使用getParameter或setParameter方法。

的参数属性取决于计划属性及其后面的属性计划在头字段中。参数名称匹配不区分大小写。使用addParameter,setParameter,removeParameter方法来访问参数数组中。

一些参数属性具有特殊的含义和语法，这是MATLAB基于计划．此处列出了具有特殊含义的参数。所有其他参数为字符串对象。

如果计划是AuthenticationScheme。基本，则需要一个参数。
- 在一个AuthenticateField(来自服务器的挑战)，属性名为领域．服务器为用户提示符提供域，该提示符与凭证。领域财产。一个AuthInfo由AuthenticateField.convert方法总是有一个域参数。
- 在一个AuthorizationField(客户端响应中的凭证)，属性名为编码．的编码属性是一个base64编码的字符序列，表示出现在下面的报头字段中的用户名和密码计划．方法对其进行编码base64encode函数。
如果计划是AuthenticationScheme。消化，则属性的数量是可变的，对应于名称=值属性。
- 对于一个AuthenticateField中列出的属性RFC 2617，章节3.2.1．
- 对于一个AuthorizationField中列出的属性RFC 2617，第3.2.2节．
如果计划还有其他的吗AuthenticationScheme属性或字符串，则所有属性名称和值都是可接受的，只要它们可以转换为字符串。

属性:

`GetAccess`	`公共`
`SetAccess`	`公共`
`依赖`	`真正的`

方法

全部展开

公共方法

`getParameter`	AuthInfo参数的返回值
`removeParameter`	删除AuthInfo参数
`setParameter`	设置“AuthInfo”参数值

专用操作符和函数

这些方法专门针对该类对象的标准MATLAB运算符和函数。

`情商`而且`isequal`	两个`AuthInfo`如果满足以下条件，对象是相等的: 他们有相同的`计划`属性和参数名称。参数名称匹配不区分大小写。参数值相等`isequal`，与参数的顺序无关。两个值都必须是标量。
`字符串`	AuthInfo作为出现在授权或身份验证报头字段中的字符串
`字符`	AuthInfo作为字符向量

另请参阅

外部网站

在R2016b中引入

matlab.net.http.AuthInfo类

描述

类属性

创建

描述