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

名前空間: matlab.net.http.field
スーパークラス: matlab.net.http.HeaderField

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

説明

AuthenticateField オブジェクトには、サーバーからの 1 つ以上のチャレンジが含まれ、これにより認証情報を求めます。サーバーまたはプロキシは AuthenticateField を応答メッセージ内に作成します。

認証を要求するサーバーまたはプロキシ経由で要求メッセージを送信するとき、MATLAB^® は次の場合に自動的にサーバーまたはプロキシに対して認証を行おうとします。

• HTTPOptions.Authenticate プロパティが true (既定)

• HTTPOptions.Credentials プロパティに必要な名前とパスワードが含まれる。

認証が正しく行われると、応答メッセージは OK ステータスを返し、認証フィールドを含みません。

認証を無効にした場合、または認証に失敗した場合、応答メッセージは認証フィールドを返します。その場合、応答メッセージのステータス コードは 401 (Unauthorized) または 407 (ProxyAuthenticationRequired) になります。AuthInfo オブジェクトを検証し、資格情報を含む要求メッセージに適切な AuthorizationField を追加して応答します。または、正しい Credentials プロパティを HTTPOptions で設定して要求を再送信します。

サーバーまたはプロキシが MATLAB でサポートされない認証スキームを要求する場合、認証プロトコルを自分で実装しなければなりません。適切な資格情報と他の情報で要求メッセージを作成します。

クラスの属性

Sealed

true

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

作成

説明

obj = matlab.net.http.field.AuthenticateField(name,value) は、Name プロパティを name に、Value プロパティを value に設定して認証ヘッダー フィールドを作成します。

サーバーはこのフィールドを応答メッセージ内に作成します。このコンストラクターは、テスト目的で使用します。

プロパティ

Name — ヘッダー フィールド名

'WWW-Authenticate' | 'Proxy-Authenticate'

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

属性:

GetAccess	public
SetAccess	public

Value — チャレンジ

AuthInfo オブジェクトのベクトル | string

チャレンジのコンマ区切りリスト。matlab.net.http.AuthInfo オブジェクトのベクトル、または以下で定義されている書式の string として指定します。RFC 7235 Hypertext Transfer Protocol (HTTP/1.1): Authentication and RFC 2617 HTTP Authentication: Basic and Digest Access Authentication (RFC Editor の Web サイト上) を参照してください。このフィールドを解析するには AuthenticateField.convert メソッドを使用します。

属性:

GetAccess	public
SetAccess	public
Dependent	true

メソッド

パブリック メソッド

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

サブクラスに特化

convert

AuthInfo オブジェクトのベクトルとしての AuthenticateField の Value プロパティ。ヘッダー フィールドのチャレンジごとに 1 つで、順番は AuthenticateField で示されるとおりです。

特殊な演算子と関数

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

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

例

認証の指定

この例では、要求メッセージで認証スキームを設定する方法を示します。

イメージの URL の指定

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

httpsUrl = "https://requestserver.mathworks.com";
uri = URI(strcat(httpsUrl, "/assets/computerVision.jpg?authenticate=digest"));

資格情報の設定

認証スキームを Digest に設定し、ログイン資格情報を指定します。

cred = Credentials("Scheme", "Digest", "Username", "testName", "Password", "testPass");
options = HTTPOptions;
options.Credentials = cred;
options.Authenticate = false;
req = RequestMessage('GET');
response = req.send(uri, options);
authenticateField = response.getFields("WWW-Authenticate");
disp(authenticateField)

  AuthenticateField with properties:

     Name: "WWW-Authenticate"
    Value: "Digest realm="Digest Authentication",qop="auth",nonce="0.3598425461739989",opaque="0d3ced1a5756977875a15f93cc12dd21""

バージョン履歴

R2016b で導入

参考

AuthInfo | RequestMessage | ResponseMessage | HTTPOptions | Credentials | StatusCode | matlab.net.http.field.AuthorizationField