通信ライブラリでは、以下のクラスを提供します。
項番 クラス名称 |
クラス名
Swrba_Protocol
メソッド一覧
メソッド | 意味 |
---|---|
String rest_request(String HostName, Integer Port, String MethodName, String ResourcePath, String Param, String Proxy, Integer ProxyPort, String ProtocolType,String RequestXML) | 指定したホストへREST型のリクエストを送信し、結果を受信します。 送受信に成功した場合、受信した結果をXML形式で出力します。 送受信に失敗した場合、例外を返します。 |
String rest_request_basic(String HostName, Integer Port, String BasicUserName, String BasicPassword, String MethodName, String ResourcePath, String Param, String Proxy, Integer ProxyPort, String ProtocolType, String RequestXML) | BASIC認証を利用して指定したホストへREST型のリクエストを送信し、結果を受信します。 送受信に成功した場合、受信した結果をXML形式で出力します。 送受信に失敗した場合、例外を返します。 |
Integer return_code() | REST型通信の結果の復帰値を返します。 |
入力情報
HostName ホスト名もしくはIPアドレスを指定します。
Port REST型で通信を行うホストのポート番号を指定します。
BasicUserName BASIC認証を行うユーザ名を指定します。
BasicPassword BASIC認証を行うユーザのパスワードを指定します。
MethodName 実行するHTTP(HTTPS)のメソッド名を指定します。 メソッド名はGET、POST、PUT、DELETEを指定します。 ResourcePath 利用するリソースのパスを指定します。
Param 利用するリソースへの引数名と引数の値を指定します。
Proxy プロキシサーバのアドレスを指定します。
ProxyPort プロキシサーバのポート番号を指定します。
ProtocolType REST通信を行うプロトコル種別を指定します。 プロトコル種別はhttp、httpsを指定します。
RequestXML REST通信でボディに格納するXML形式のリクエストを指定します。
注意事項
本ライブラリでは、HTTP V1.2を利用しています。
実行するHTTP(HTTPS)のメソッド名を指定する場合、すべて大文字にし、GET、POST、PUT、DELETEのいずれかを指定してください。
elementに利用可能な文字列は、半角英数字と半角記号です。
格納場所
Windows | <インストールパス>\itpm\rbaope\bin\parts\lib\ standard\swrba_protocol.rb |
Linux | /opt/FJSVswpm/rbaope/bin/parts/lib/standard/swrba_protocol.rb |