matlab.net.http.RequestMessage クラス

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

HTTP 要求メッセージ

説明

RequestMessage クラスは、サーバーに送信して処理される HTTP 要求メッセージを書式設定するために使用します。メッセージを送信するには send メソッドを使用します。また、メッセージを送信する前に検証するには complete メソッドを使用します。これらのメソッドでは、必要なヘッダー フィールドおよび他のメッセージ プロパティが埋められます。

クラスの属性

Sealed

true

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

作成

説明

obj = matlab.net.http.RequestMessage は既定値で要求メッセージを作成します。メッセージを送信または完了するとき、既定の Method プロパティは RequestMethod.GET です。

obj = matlab.net.http.RequestMessage(method,header,body) は、1 つ以上のオプションのメッセージ プロパティを指定します。後続の引数を省略し、[] を使って任意のプレースホルダーを指定できます。

obj = matlab.net.http.RequestMessage(requestLine,header,body) は RequestLine プロパティを requestLine に設定します。要求行の内容を制御する必要がある場合は、この構文を使用します。たとえば、メッセージを明示的にプロキシに送信するには RequestLine.RequestTarget プロパティを完全な URI に設定します。それ以外の場合、MATLAB はユーザーのプロキシの設定に基づいてプロキシを選択し、send メソッドで RequestTarget を URI の Path プロパティに設定します。

obj = matlab.net.http.RequestMessage(requestLine,header,provider) は matlab.net.http.io.ContentProvider からメッセージ本文のデータを取得します。

プロパティ

RequestLine — 要求行

matlab.net.http.RequestLine オブジェクト | string | 文字ベクトル

要求行。matlab.net.http.RequestLine オブジェクト、またはメソッド、ターゲットおよびプロトコルのバージョンを含む string または文字ベクトルとして指定します。この行は、メッセージを送信するときに、指定したメソッドと URI に基づいて自動的に作成されます。このプロパティを明示的に設定すると、その内容が要求行として使用されます。値は、RequestLine オブジェクト、または解析されて RequestLine オブジェクトに変換される string に設定されることがあります。

例: 'GET HTTP/1.1'

属性:

GetAccess	public
SetAccess	public
Dependent	true

Method — 要求メソッド

[] (既定値) | matlab.net.http.RequestMethod 列挙型 | string | 文字ベクトル

要求メソッド。matlab.net.http.RequestMethod 列挙型、要求メソッドを表す string または文字ベクトルとして指定します。メッセージを送信するには、RequestMessage.Method プロパティまたは RequestLine.Method プロパティを設定します。

例: 'GET'

属性:

GetAccess	public
SetAccess	public
Dependent	true

Header — メッセージ ヘッダー

[] (既定値) | matlab.net.http.HeaderField オブジェクト

メッセージ ヘッダー。matlab.net.http.HeaderField オブジェクトまたは HeaderField オブジェクトのベクトルとして指定します。Header プロパティを設定すると、MATLAB^® はヘッダーのフィールドをチェックしてメッセージ タイプに対して適切であることを確認します。RequestMessage の send メソッドおよび complete メソッドは、正しい形式の要求になるように必要なヘッダー フィールドを埋めます。

属性:

GetAccess	public
SetAccess	public

Body — メッセージ本文

[] (既定値) | matlab.net.http.MessageBody オブジェクト | matlab.net.http.io.ContentProvider

メッセージ本文。matlab.net.http.MessageBody オブジェクト、matlab.net.http.io.ContentProvider、または MessageBody コンストラクターで受け入れ可能なデータとして指定します。既定では、Body は空です ([] に設定されます)。Body プロパティを含む要求メッセージでは、既定値の 'GET' ではなく、'PUT' や 'POST' などのメソッドを使用する必要があります。

完了したメッセージまたは受信したメッセージで、メッセージに ContentTypeField ヘッダー フィールドがある場合、MessageBody.ContentType プロパティはその値に設定されます。それ以外の場合、ContentType は変更されないか空になります。

属性:

GetAccess	public
SetAccess	public

Completed — メッセージが完了しているかどうか

false (既定値) | true

メッセージが完了しているかどうか。true または false として指定します。true 値はメッセージが完了していることを意味します。

メッセージを検証するメソッド (RequestMessage.send と RequestMessage.complete) は、次を行った後に Completed プロパティを true に設定します。

• メッセージが有効であることを判別する。

• 必要なヘッダー フィールドの追加やデータの変換などの処理を完了する。

このプロパティが true の場合、これらのメソッドはメッセージを変更せず、send メソッドはメッセージの有効性をチェックせずにメッセージを送信します。その後にこのメッセージに変更を加えると、Completed プロパティが false に戻されます。

任意のヘッダーとデータを要求メッセージで送信するには、Completed を true に設定して send メソッドでメッセージが変更されないようにします。引き続き complete メソッドを使用してメッセージを検証できますが、メッセージが有効かどうかにかかわらず send メソッドはメッセージを送信します。

要求メッセージにデータが含まれている (Body.Data プロパティが空でない) 場合、Completed は Body.Payload に生のデータが含まれている場合にのみ、true に設定されます。応答メッセージでは、HTTPOptions.SavePayload プロパティを指定した場合にのみ、ペイロードが設定されます。

属性:

GetAccess	public
SetAccess	public
Transient	true

データ型: logical

StartLine — メッセージの開始行

matlab.net.http.StartLine

メッセージの開始行。matlab.net.http.StartLine オブジェクトとして指定します。

属性:

GetAccess	public
SetAccess	public

メソッド

パブリック メソッド

complete	HTTP 要求メッセージを送信せずに検証して完了
send	HTTP 要求メッセージの送信と応答の受信
addFields	メッセージ ヘッダーへのフィールドの追加
changeFields	メッセージ ヘッダーの既存フィールドの変更
getFields	名前またはクラスが一致するメッセージ ヘッダー フィールドを返す
removeFields	メッセージ ヘッダーからのフィールドの削除
replaceFields	メッセージ ヘッダーで値を変更またはフィールドを追加
show	書式設定されたバージョンのメッセージを表示または返す

特殊な演算子と関数

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

string	string としてのメッセージ Header、Body と StartLine プロパティ。複数のメッセージの場合、string 配列が返されます。 Body に文字に変換できないバイナリ データが含まれている場合、メソッドはデータの長さをバイト数で示すメッセージを表示します。 string は送信時または受信時のメッセージ表示の近似表現です。 ログ作成、診断、デバッグに使用します。 書式設定されたバージョンのメッセージの場合、show を使用します。
char	メッセージを文字ベクトルとして返すことを除いて、string と同じです。
isequal	2 つのメッセージ配列ですべてのメッセージの表示可能なパブリック プロパティが等しい場合は、true を返します。

例

HTTP 要求メッセージの作成

テキストを Web サイトに追加するようにサーバーに要求する HTTP メッセージを構成します。この例では、メッセージの書式設定のみを行い、データの送信はしません。

メッセージ本文に内容を追加します。

data = 'Data to send';
body = matlab.net.http.MessageBody(data);
body.show

Data to send

本文のデータ型を表す Content-Type ヘッダー フィールドを作成します。

contentTypeField = matlab.net.http.field.ContentTypeField('text/plain');

応答メッセージ内で許容されるデータ型を指定する Accept ヘッダー フィールドを作成します。

type1 = matlab.net.http.MediaType('text/*');
type2 = matlab.net.http.MediaType('application/json','q','.5');
acceptField = matlab.net.http.field.AcceptField([type1 type2]);

2 つのヘッダー フィールドを含む要求ヘッダーを作成します。

header = [acceptField contentTypeField];

このメッセージが PUT 要求であることを指定します。

method = matlab.net.http.RequestMethod.PUT;

要求メッセージを作成し、その内容を表示します。

request = matlab.net.http.RequestMessage(method,header,body);
show(request)

PUT
Accept: text/*, application/json; q=.5
Content-Type: text/plain

Data to send

バージョン履歴

R2016b で導入

参考

webread | ResponseMessage | RequestLine | RequestMethod | matlab.net.URI | MessageBody