通信ライブラリでは、以下のクラスを提供します。
項番 クラス名称 |
クラス名
Swrba_Protocol
メソッド一覧
メソッド | 意味 |
String rest_request(String hostname, Integer port, String methodname, String resourcepath, String param, String proxy, Integer proxyport, String protocoltype,String requestxml, String contenttype, String accepttype) | 指定したホストへREST型のリクエストを送信し、結果を受信します。 送受信に成功した場合、受信した結果をXML形式で出力します。 送受信に失敗した場合、例外を返します。 |
String rest_request_basic(String hostname, Integer port, String methodname, String resourcepath, String param, String basicusername, String basicpassword, String proxy, Integer proxyport, String protocoltype, String requestxml, String contenttype, String accepttype) | BASIC認証を利用して指定したホストへREST型のリクエストを送信し、結果を受信します。 送受信に成功した場合、受信した結果をXML形式で出力します。 送受信に失敗した場合、例外を返します。 |
Integer return_code() | REST型通信の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。
port REST型で通信を行うホストのポート番号を指定します。
methodname 実行するHTTP(HTTPS)のメソッド名を指定します。 メソッド名はGET、POST、PUT、DELETEを指定します。 resourcepath 利用するリソースのパスを指定します。
param 利用するリソースへの引数名と引数の値を指定します。
basicusername BASIC認証を行うユーザー名を指定します。
basicpassword BASIC認証を行うユーザーのパスワードを指定します。
proxy プロキシサーバのアドレスを指定します。
proxyport プロキシサーバのポート番号を指定します。
protocoltype REST通信を行うプロトコル種別を指定します。 プロトコル種別はhttp、httpsを指定します。
requestxml REST通信でボディに格納するXML形式のリクエストを指定します。
contenttype REST通信で通信されるデータ形式(MIMEタイプ)を指定します。 また、文字セットを付加することが可能です。
accepttype REST通信で受信可能なデータ形式(MIMEタイプ)を指定します。
注意事項
事前にREST型通信を行うホストの構築および設定を行ってください。
実行するHTTP(HTTPS)のメソッド名を指定する場合、すべて大文字にし、GET、POST、PUT、DELETEのいずれかを指定してください。
elementに利用可能な文字列は、半角英数字と半角記号です。
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“~”、“£”、“―”、“∥”、“¢”、“¬”、“ ̄”、“¥”、“〃”
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_protocol.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_protocol.rb |
クラス名
Swrba_Protocol
メソッド一覧
メソッド | 意味 |
String port_check(String hostname, String port) | 指定したホストのポートに接続可能か確認します。 確認に成功した場合、“Success”を返します。 確認に失敗した場合、例外を返します。 |
Integer return_code() | ポートの状態確認の結果の復帰値を返します。 |
入力情報
hostname ホスト名もしくはIPアドレスを指定します。 port 接続可能か確認するポート番号またはサービス名です。
注意事項
portオプションにサービス名を指定する場合、そのサービスが管理サーバのOSに登録されている必要があります。指定可能なサービス名は、OSの設定を確認してください。
本部品で確認可能なプロトコルはTCPです。
各入力情報には、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、メソッドの実行に失敗する場合があります。
“~”、“£”、“―”、“∥”、“¢”、“¬”、“ ̄”、“¥”、“〃”
格納場所
Windows | <インストールパス>\SWRBAM\rbaope\bin\parts\lib\ standard\swrba_protocol.rb |
Linux | /opt/FJSVswrbam/rbaope/bin/parts/lib/standard/swrba_protocol.rb |