matlab.net.http.field.AuthorizationField クラス

パッケージ: matlab.net.http.field
スーパークラス: matlab.net.http.HeaderField

HTTP Authorization または Proxy-Authorization ヘッダーフィールド

説明

AuthorizationField オブジェクトには、AuthenticateField のサーバーからのチャレンジに応答する、要求メッセージ内の資格情報が含まれます。資格情報は AuthInfo オブジェクトの形式になっています。詳細については、Internet Engineering Task Force (IETF^®) Web サイトで RFC 7235、セクション 4.2 の Authorization とセクション 4.4 の Proxy-Authorization を参照してください。

次の場合、MATLAB^® はこのフィールドを自動的に作成します。

HTTPOptions.Authenticate プロパティが要求メッセージで true (既定) である。
HTTPOptions.Credentials プロパティで適切な資格情報を指定した。
MATLAB がサーバーで要求される認証スキームをサポートする。

自動認証を無効にする場合、またはサポートされない認証プロトコルを実装する場合は、このフィールドを明示的に作成します。このフィールドを明示的に作成する場合は、Value プロパティを有効な認証 string または AuthInfo オブジェクトに設定します。

自動認証のためにサーバーに送信された AuthorizationField を確認するには、完了した要求または RequestMessage.send メソッドによって返された履歴引数を調べます。

クラスの属性

Sealed true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

例

obj = matlab.net.http.field.AuthorizationField(name,value) は Name プロパティを name に、Value プロパティを value に設定して、認証ヘッダーフィールドを作成します。自動認証を無効にした場合、またはサポートされない認証プロトコルを実装する場合は、このフィールドを作成します。

プロパティ

すべて展開する

`Name` — ヘッダーフィールド名
`'Authorization'` | `'Proxy-Authorization'`

ヘッダーフィールド名。'Authorization' または 'Proxy-Authorization' として指定します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`

`Value` — 認証
string | `matlab.net.http.AuthInfo` オブジェクト

認証。有効な認証 string または matlab.net.http.AuthInfo オブジェクトとして指定します。

属性:

`GetAccess`	`public`
`SetAccess`	`public`
`Dependent`	`true`

メソッド

すべて展開する

パブリックメソッド

`addFields`	HeaderField 配列へのフィールドの追加
`removeFields`	ヘッダーフィールド配列からフィールドを削除
`changeFields`	HeaderField 配列内の既存値を変更
`replaceFields`	HeaderFields の配列の値を変更またはフィールドを追加
`getFields`	名前またはクラスが一致するヘッダーフィールドを返す
`eq`	2 つの HeaderField 配列の比較
`convertLike`	ヘッダーフィールド値を別のヘッダーフィールドと同様に変換
`parse`	ヘッダーフィールド値を解析して string として返す
`displaySubclasses`	サポートされる HeaderField サブクラスの表示

サブクラスに特化

convert

AuthInfo オブジェクトのベクトルとしての AuthorizationField の Value プロパティ

AuthorizationField の AuthInfo オブジェクトは 1 つのみです。AuthorizationField オブジェクトのベクトルを渡す場合、convert は同じサイズの AuthInfo オブジェクトのベクトルを返します。AuthInfo のパラメーターは、AuthorizationField の資格情報のパラメーターに対応します。このパラメーターのセットは、フィールドの最初のトークンである AuthInfo.Scheme プロパティによって異なります。

特殊な演算子と関数

次のメソッドは、MATLAB の標準の演算子および関数を、このクラスのオブジェクト用に特殊化したものです。

`isequal`	`eq` メソッドで示されているように、2 つのヘッダーフィールド配列が同じサイズで、対応する要素が等しい場合は `true`
`string`	string としてのヘッダーフィールドの配列。メッセージに表示されます。フィールド間に改行文字を挿入しますが、すべてのフィールドの最後には挿入しません。
`char`	`string` メソッドで示されているように、文字ベクトルとしてのヘッダーフィールドの配列

例

すべて折りたたむ

資格情報の指定

ライブスクリプトを開く

この例では、ユーザー名とパスワードを Web サーバーに渡す方法を示します。

import matlab.net.*;
import matlab.net.http.*;

httpsUrl = 'https://requestserver.mathworks.com';
cred = Credentials('Scheme', 'Digest', 'Username', 'testName', 'Password', 'testPass');
uri = URI(strcat(httpsUrl, '/assets/computerVision.jpg?authenticate=digest'));
options = HTTPOptions;
options.Credentials = cred;
req = RequestMessage('GET');
[~, completedRequest, ~] = req.send(uri, options);
authorizationField = completedRequest.getFields("Authorization");
disp(authorizationField)

  AuthorizationField with properties:

     Name: "Authorization"
    Value: "Digest username="testName",realm="Digest Authentication",nonce="0.10850025543344421",uri="/assets/computerVision.jpg?authenticate=digest",cnonce="3abc9b6ff07a1e6e6b261f50a40b16cd",nc=00000001,response="3bd7d2e24c3bf3e3e5ea78628c1ccf76",qop="auth",opaque="0d3ced1a5756977875a15f93cc12dd21""

要求の AuthorizationField 資格情報の表示

import matlab.net.http.*
creds = Credentials('Username','MyName','Password','MyPassword');
options = HTTPOptions('Credentials', creds);
[response, request] = RequestMessage().send('http://myhost.com',options);
authorizationField = request.getFields('Authorization');
authInfo = authorizationField.convert;
disp(string(authInfo));

バージョン履歴

R2016b で導入