Changes between Version 10 and Version 11 of ZooWorkshop/FOSS4GJapan/ja/CreatingOGRBasedWebServices

Timestamp:

Oct 29, 2010, 10:06:40 AM (14 years ago)

Author:

hayashi

Comment:

--

ZooWorkshop/FOSS4GJapan/ja/CreatingOGRBasedWebServices

@@ -17 +17 @@
 既に述べたように、このワークショップではサービスを記述する言語はCもしくはPython（もしくは両方！）を選ぶことができます。解説はC言語に沿って行いますが、この解説はPythonを利用する方にも非常に役立つ内容になっています。どちらの言語を使用するか決めたらインストラクターに報告してください。どちらの言語を選択されても、ワークショップの結果は同じです。
 
-== Preparing ZOO metadata file ==
-翻訳中・・・
+== ZOO メタデータファイルの準備 ==
+
+ZOOメタデータの用意
+
+ZOOのサービスは、ZOOメタデータファイル(.zcfg)とZOOサービスプロバイダーと呼ばれる機能の応じたランタイム実装モジュールとの組み合わせによって成り立ちます。
+まずはじめに順を追って.zcfgファイルを用意しましょう。
+使う慣れているテキストエディタで {{{/home/user/zoows/sources/zoo-services/ws_sp directory}}}フォルダにある {{{Boundary.zcfg}}} を開いてください。
+最初に、ファイル先頭にある括弧中に以下のようにサービス名を定義します。
+
+{{{
+#!sh
+[Boundary]
+}}}
+
+この名前は非常に重要です。この名前はサービス名になりサービスプロバイダーの機能を表します。タイトル（Title）とこのサービスが何を行うのかについての短い要約（Abstract）は、利用者のために書いておくべきです。
+
+{{{
+#!sh
+Title = Compute boundary.
+Abstract = Returns the boundary of the geometry on which the method is invoked.
+}}}
+
+これらのメタデータ情報は !GetCapabilities リクエストによって返されます。
+
+他にも {{{processVersion}}}　のような特定情報を追加することができます。
+ZOOサービスが結果を保存する機能を持つかどうかを {{{storeSupported}}} パラメータの値を {{{true}}}もしくは {{{false}}}にすることで指定できます。また処理をバックグラウンドで行い、結果をステータスで通知するかどうかを {{{statusSupported}}} の値で指定します。
+
+{{{
+#!sh
+processVersion = 1
+storeSupported = true
+statusSupported = true
+}}}
+
+ZOOサービス・メタデータファイルのメインのセクションでは、二つの重要事項を指定します。
+In the main section of the ZOO Service metadata file, you must also specify two important things:
+ * {{{serviceProvider}}}　　サービスの関数を含むCの共用ライブラリの名前、またはPythonモジュール名
+ * {{{serviceType}}}　　サービスに使用するプログラミング言語の指定 (値は C または Python となります。あなたが使用する言語とあわせてください。)
+
+C !サービスプロバイダーの例 :
+{{{
+#!sh
+serviceProvider=ogr_ws_service_provider.zo
+serviceType=C
+}}}
+
+この例ではBoundary関数を含む {{{ogr_ws_service_provider.zo}}} 共用ライブラリを使うことになります。ライブラリファイルはZOOカーネルと同じディレクトリに置いてください。
+
+Python !サービスプロバイダーの例 :
+
+{{{
+#!sh
+serviceProvider=ogr_ws_service_provider
+serviceType=Python
+}}}
+
+この例ではBoundary関数のPythonコードを含む {{{ogr_ws_service_provider.py}}} ファイルを使うことになります。
+
+
+メインセクションでは、下記の例のように他の任意の情報を追加することもできます。
+
+{{{
+#!sh
+<MetaData>
+    Title = Demo
+</MetaData>
+}}}
+
+
+これで主要なメタデータ情報が定義できました。
+次はZOOサービスで使われるデータの入力方法を定義します。サービスに必要な任意の入力を定義できます。
+ZOOのカーネルは.zcfgファイルに定義したデータよりも多くのデータを処理するリクエストを受け付けることに注意してください。これらのデータはフィルタリングされることなくサービスへと渡されます。
+この例のBoundaryサービスでは、一つのポリゴンが入力として使用され、それに対してBoundary関数が実行されます。
+
+入力データ宣言は !DataInputs ブロックで行われます。
+書式はサービスを定義するときと同じで、名前は括弧でくくられています。同様にタイトルや要約を入力の {{{MetaData}}} セクションに追加することができます。
+{{{minOccurs}}} と {{{maxOccurs}}} のパラメータは必ず設定してください。これらは、どのパラメータがサービス関数で実行するのに必要なのかをZOOカーネルに通知するのに使われます。
+
+
+{{{
+#!sh
+[InputPolygon]
+ Title = Polygon to compute boundary
+ Abstract = URI to a set of GML that describes the polygon.
+ minOccurs = 1
+ maxOccurs = 1
+ <MetaData lang="en">
+     Test = My test
+ </MetaData>
+}}}
+
+メタデータは、どのようなタイプのデータがサービスでサポートされるのかを定義します。このBoundary関数の例では、入力するポリゴンはGMLファイル形式またはJSON文字列形式で提供することができます。
+次のステップではデフォルトのデータ形式とサポートする入力フォーマットを定義しましょう。それぞれのフォーマットはタイプに応じて {{{LitteralData}}} または {{{ComplexData}}} のブロックで定義する必要があります。ここでは最初の例として {{{ComplexData}}} ブロックのみを使います。
+
+{{{
+#!sh
+<ComplexData>
+ <Default>
+   mimeType = text/xml
+   encoding = UTF-8
+ </Default>
+ <Supported>
+   mimeType = application/json
+   encoding = UTF-8
+ </Supported>
+</ComplexData>
+}}}
+
+次に、同様のメタデータ情報をサービスの出力についても定義します。{{{DataOutputs}}}　のブロック内に次のように定義します。
+
+{{{
+#!sh
+[Result]
+ Title = The created geometry
+ Abstract = The geometry containing the boundary of the geometry on which the method  was invoked.
+ <MetaData lang="en">
+   Title = Result
+ </MetaData>
+ <ComplexData>
+  <Default>
+   mimeType = application/json
+   encoding = UTF-8
+  </Default>
+  <Supported>
+   mimeType = text/xml
+   encoding = UTF-8
+  </Supported>
+ </ComplexData>
+}}}
+
+
+この .zcfg ファイルのコピーは以下のURLからも入手できます :
+
+http://zoo-project.org/trac/browser/trunk/zoo-services/ogr/base-vect-ops/cgi-env/Boundary.zcfg
+
+ZOOメタデータファイルの修正が終わりましたら、ZOOのカーネルと同じディレクトリ (この例では {{{/usr/lib/cgi-bin}}})へコピーしてください。これで以下のURLのリクエストが実行できるはずです：
+
+http://localhost/zoo/?Request=DescribeProcess&Service=WPS&Identifier=Boundary&version=1.0.0
+
+返って来る ProcessDescriptions XML ドキュメントは、以下のようになっているはずです :
+
+[[Image(Practical introduction to ZOO - 4.png,width=550px,nolink)]]
+
+GetCapabilities と DescribeProcess　を実行には　.zfgファイルさえあれば完了します。簡単ですね？
+このステップでは、ZOOカーネルに {{{Execute}}}をリクエストすれば、 以下のような {{{ExceptionReport}}} ドキュメントのレスポンスが返ってきます：
+
+[[Image(Practical introduction to ZOO - 5.png,width=550px,nolink)]]
+
+もしPythonのサービスで実行すれば、同じようなエラーメッセージが返ってきます :
+
+[[Image(Practical introduction to ZOO - 6.png,width=550px,nolink)]]
+
 
 == ジオメトリサービスの実装 ==