[pal-cvs 3423] [1157] added batch doc.

svnno****@sourc***** svnno****@sourc*****
2008年 9月 11日 (木) 18:17:43 JST


Revision: 1157
          http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi?root=pal&view=rev&rev=1157
Author:   shinsuke
Date:     2008-09-11 18:17:42 +0900 (Thu, 11 Sep 2008)

Log Message:
-----------
added batch doc.

Modified Paths:
--------------
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml

Added Paths:
-----------
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/guide.xml
    pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/usermanager.xml


-------------- next part --------------
Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/guide.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/guide.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/guide.xml	2008-09-11 09:17:42 UTC (rev 1157)
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+	Copyright 2004 The Apache Software Foundation
+	
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+	
+	http://www.apache.org/licenses/LICENSE-2.0
+	
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+-->
+<document>
+  <properties>
+    <title>バッチ処理</title>
+    <subtitle>概要</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="バッチ処理について">
+      <p>
+ポータルシステムにおいて、ユーザー情報などを他のシステムから入出力しなければならない要件はよく起こります。
+PALポータルでは、それを実現するため、大量のユーザー情報をバッチで処理可能な API を実装しています。
+これにより、複雑なデータベーススキーマを操作など必要なく、一括で更新などが可能です。
+      </p>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/guide.xml
___________________________________________________________________
Name: svn:eol-style
   + native

Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/usermanager.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/usermanager.xml	                        (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/usermanager.xml	2008-09-11 09:17:42 UTC (rev 1157)
@@ -0,0 +1,478 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+	Copyright 2004 The Apache Software Foundation
+	
+	Licensed under the Apache License, Version 2.0 (the "License");
+	you may not use this file except in compliance with the License.
+	You may obtain a copy of the License at
+	
+	http://www.apache.org/licenses/LICENSE-2.0
+	
+	Unless required by applicable law or agreed to in writing, software
+	distributed under the License is distributed on an "AS IS" BASIS,
+	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+	See the License for the specific language governing permissions and
+	limitations under the License.
+-->
+<document>
+  <properties>
+    <title>バッチ処理</title>
+    <subtitle>ユーザー情報</subtitle>
+    <authors>
+      <person name="菅谷信介" email="shins****@yahoo*****"/>
+    </authors>
+  </properties>
+  <body>
+    <section name="ユーザー情報のバッチ処理">
+      <p>
+ユーザー情報のバッチ更新サーブレットを導入することで、ウェブ経由のアクセスでユーザー情報の更新を行うことができます。
+アクセスするだけで情報を更新できるので、シェルスクリプトや別なプログラムからアクセスすることで一括の更新等を実現できます。
+      </p>
+    </section>
+    <section name="利用方法">
+      <p><code>webapps/palportal/WEB-INF/web.xml</code> に以下のサーブレット定義を加えます。
+      </p>
+      <source><![CDATA[
+...
+  <servlet>
+    <servlet-name>UserManagerServlet</servlet-name>
+    <servlet-class>jp.sf.pal.portal.servlet.UserManagerServlet</servlet-class>
+  </servlet>
+...
+  <servlet-mapping>
+    <servlet-name>UserManagerServlet</servlet-name>
+    <url-pattern>/userManager</url-pattern>
+  </servlet-mapping>
+...
+]]></source>
+      <p>
+必要に応じて、セキュリティの設定をする必要があります。
+      </p>
+    </section>
+    <section name="アクセス方法">
+      <p>
+http://localhost:8080/palportal/userManager?name1=value1&amp;... にアクセスすると対象の操作が実行されます。
+以下の操作を実行できます。
+        <ul><li>ユーザーの認証確認</li><li>ユーザーの追加</li><li>パスワードの更新</li><li>ユーザーの削除</li><li>ユーザー属性の更新</li><li>ユーザー属性の削除</li></ul>
+      </p>
+    </section>
+    <section name="出力結果">
+      <p>
+以下の XML 形式で結果が出力されます。
+      </p>
+      <source><![CDATA[
+<?xml version="1.0" encoding="UTF-8" ?>
+<results>
+  <status>文字列</status>
+  <message>文字列</message>
+  <result>
+    <name>文字列</name>
+    <value>文字列</value>
+  </result>
+</results>
+]]></source>
+    </section>
+    <section name="各処理の説明">
+      <subsection name="ユーザーの認証確認">
+        <p>
+指定されたユーザーが認証できるかを確認します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>authenticate</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>password</td>
+              <td>パスワード</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザーが存在して、パスワードも正しい場合)</td>
+            </tr>
+            <tr>
+              <td>authentication-failed</td>
+              <td>ユーザー認証に失敗した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+      <subsection name="ユーザーの追加">
+        <p>
+指定したユーザー名でユーザーを作成します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>create</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>password</td>
+              <td>パスワード</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザーが正常に作成された場合)</td>
+            </tr>
+            <tr>
+              <td>user-already-exists</td>
+              <td>ユーザーが既に存在していて、作成できない</td>
+            </tr>
+            <tr>
+              <td>server-error</td>
+              <td>ユーザー作成時にサーバー側でエラーが発生した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+      <subsection name="パスワードの更新">
+        <p>
+指定されたユーザーのパスワードを変更します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>update</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>password</td>
+              <td>パスワード</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザー情報が正常に更新された場合)</td>
+            </tr>
+            <tr>
+              <td>user-not-found</td>
+              <td>対象ユーザーが存在しない</td>
+            </tr>
+            <tr>
+              <td>server-error</td>
+              <td>ユーザー更新時にサーバー側でエラーが発生した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+      <subsection name="ユーザーの削除">
+        <p>
+指定されたユーザー名のユーザーを削除します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>update</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>password</td>
+              <td>パスワード</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザーが正常に削除された場合)</td>
+            </tr>
+            <tr>
+              <td>user-not-found</td>
+              <td>対象ユーザーが存在しない</td>
+            </tr>
+            <tr>
+              <td>server-error</td>
+              <td>ユーザー削除時にサーバー側でエラーが発生した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+      <subsection name="ユーザー属性の取得">
+        <p>
+指定されたユーザーのユーザー属性を取得します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>get-user-attribute</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>key</td>
+              <td>キー</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザー属性が正常に取得された場合)</td>
+            </tr>
+            <tr>
+              <td>user-not-found</td>
+              <td>対象ユーザーが存在しない</td>
+            </tr>
+            <tr>
+              <td>server-error</td>
+              <td>ユーザー削除時にサーバー側でエラーが発生した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+            <tr>
+              <td>value-is-null</td>
+              <td>キーに対応する値が null の場合</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のresult</caption>
+          <tr>
+            <td>key と value </td>
+            <td>値が出力されます。</td>
+          </tr>
+        </table>
+      </subsection>
+      <subsection name="ユーザー属性の更新">
+        <p>
+指定されたユーザー名のユーザー属性を更新します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>update-user-attribute</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>key</td>
+              <td>キー</td>
+            </tr>
+            <tr>
+              <td>value</td>
+              <td>値</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザー属性が正常に登録または更新された場合)</td>
+            </tr>
+            <tr>
+              <td>user-not-found</td>
+              <td>対象ユーザーが存在しない</td>
+            </tr>
+            <tr>
+              <td>server-error</td>
+              <td>ユーザー削除時にサーバー側でエラーが発生した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+      <subsection name="ユーザー属性の削除">
+        <p>
+指定されたユーザー名のユーザー属性を削除します。
+</p>
+        <table>
+          <caption>URLで渡すパラメータ</caption>
+          <tbody>
+            <tr>
+              <td>リクエストパラメータ</td>
+              <td>値</td>
+            </tr>
+            <tr>
+              <td>action</td>
+              <td>get-user-attribute</td>
+            </tr>
+            <tr>
+              <td>username</td>
+              <td>ユーザー名</td>
+            </tr>
+            <tr>
+              <td>key</td>
+              <td>キー</td>
+            </tr>
+          </tbody>
+        </table>
+        <table>
+          <caption>出力結果のstatus</caption>
+          <tbody>
+            <tr>
+              <td>値</td>
+              <td>説明</td>
+            </tr>
+            <tr>
+              <td>success</td>
+              <td>正常終了(ユーザー属性が正常に削除された場合)</td>
+            </tr>
+            <tr>
+              <td>user-not-found</td>
+              <td>対象ユーザーが存在しない</td>
+            </tr>
+            <tr>
+              <td>server-error</td>
+              <td>ユーザー削除時にサーバー側でエラーが発生した</td>
+            </tr>
+            <tr>
+              <td>invalid-parameter</td>
+              <td>リクエストパラメータが正しくない</td>
+            </tr>
+            <tr>
+              <td>excluded-user</td>
+              <td>操作の対象外ユーザーへの処理を行った</td>
+            </tr>
+            <tr>
+              <td>value-is-null</td>
+              <td>キーに対応する値が null の場合</td>
+            </tr>
+          </tbody>
+        </table>
+      </subsection>
+    </section>
+  </body>
+</document>


Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/batch/usermanager.xml
___________________________________________________________________
Name: svn:eol-style
   + native

Modified: pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml	2008-09-11 08:23:27 UTC (rev 1156)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml	2008-09-11 09:17:42 UTC (rev 1157)
@@ -36,6 +36,10 @@
       <item name="デコレータユーティリティ" href="design/jpt.html"/>
       <item name="ログインデザイン" href="design/login.html"/>
     </menu>
+    <menu name="バッチ処理">
+      <item name="概要" href="batch/guide.html"/>
+      <item name="ユーザー情報" href="batch/usermanager.html"/>
+    </menu>
 <!--
 DB設定
 Ajax
@@ -47,6 +51,7 @@
 LDAP
 SSO
 統計
+SEO
 -->
   </body>
 </project>


pal-cvs メーリングリストの案内