OPRO X Server SOAP Interface

  1. OPRO X Server SOAP Interfaceの概要
  2. エンドポイント
    1. MTOMの有効化
  3. オペレーション

OPRO X Server SOAP Interfaceの概要

OPRO X Server SOAP Interfaceは、SOAPを使用した OPRO X Serverのインターフェイスです。

SOAP Interfaceは、OXSとTCPソケットを用いて通信を行います。このため、SOAP InterfaceとOXSが同一の環境内にある必要はありません。
また、SOAP Interfaceは、OXSを操作するものではなく、既存のCGI/Servlet・APIと同様の位置づけで、OXSへのクライアントからのリクエストを簡単に行うためのものです。

SOAP Interfaceは主に以下のOXSの機能を提供します。

OXSによって生成されたドキュメントは、URLと、必要であればバイナリで、クライアントに返されます。
バイナリは、使用されたオペレーションとクライアントのサポート状況によって、MTOM (MTOM/XOP、Message Transmission Optimization Mechanism/XML-binary Optimized Packaging) あるいはbase64Binary形式、またはSwA (SOAP Messages with Attachments) で返されます。
また、SOAP1.1とSOAP1.2とに対応しているため、クライアントの実装に適した方法でSOAP Interfaceを使用し、ドキュメントを取得することが可能です。

エンドポイント

SOAP Interfaceには、SOAP1.1とSOAP1.2、SwAオペレーションの有無の組み合わせによって、4つのエンドポイントが用意されています。

SOAPバージョンSwAの有無URL
SOAP1.1SwA無し
サービスhttp://host/oxs_ws/service/soap11
WSDLhttp://host/oxs_ws/wsdl/soap11
SwA有り
サービスhttp://host/oxs_ws/service/soap11swa
WSDLhttp://host/oxs_ws/wsdl/soap11swa
SOAP1.2SwA無し
サービスhttp://host/oxs_ws/service/soap12
WSDLhttp://host/oxs_ws/wsdl/soap12
SwA有り
サービスhttp://host/oxs_ws/service/soap12swa
WSDLhttp://host/oxs_ws/wsdl/soap12swa

http://host/oxs_ws/wsdl/allには、上記全てのエンドポイントが記述されています。

SwA有りのエンドポイントには、OXSが生成したドキュメントのバイナリをSwAで添付するオペレーションが追加されています。 これは、MTOMを使用できないクライアント環境や、SwAを理解できないクライアント環境を考慮したもので、SwAの有無による機能差はありません。

クライアントがMTOMを使用できる場合、あるいは、ドキュメントのバイナリを受け取る必要がない場合は、SwA無しのエンドポイントを使用します。
ドキュメントのバイナリを受け取る必要があり、その方法としてSwAを使用する場合にのみ、SwA有りのエンドポイントを使用します。

MTOMの有効化

全てのエンドポイントは、以下のいずれかの場合にMTOM形式でレスポンスを行います。

OXSが生成したドキュメントのサイズや、レスポンスにバイナリデータが含まれるか否かにはよらず、上記いずれかの場合には、常にMTOM形式でレスポンスを行います。
レスポンスにバイナリデータが含まれるオペレーションで、MTOMが有効ではない場合、バイナリデータはbase64Binary形式でSOAPメッセージ内に記述されます。

オペレーション

SOAP Interfaceのオペレーションは、大きく以下の3種類に区分されます。

詳細はリファレンスを参照してください。