svnno****@sourc*****
svnno****@sourc*****
2008年 9月 12日 (金) 07:36:41 JST
Revision: 1159
http://svn.sourceforge.jp/cgi-bin/viewcvs.cgi?root=pal&view=rev&rev=1159
Author: shinsuke
Date: 2008-09-12 07:36:41 +0900 (Fri, 12 Sep 2008)
Log Message:
-----------
added ajax doc.
Modified Paths:
--------------
pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml
Added Paths:
-----------
pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/
pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/api.xml
pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/guide.xml
Removed Paths:
-------------
pal-portal/docs/ja/configuration-guide/trunk/xdocs/guides/guide-ajax-api.xml
-------------- next part --------------
Added: pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/api.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/api.xml (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/api.xml 2008-09-11 22:36:41 UTC (rev 1159)
@@ -0,0 +1,500 @@
+<?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>Ajax</title>
+ <subtitle>API</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylo****@apach*****"/>
+ <person name="加藤泰文" email="karma****@prog*****"/>
+ <person name="菅谷信介" email="shins****@yahoo*****"/>
+ </authors>
+ </properties>
+ <body>
+ <section name="API">
+ <p>
+Ajax XML API は、単純な HTTP リクエストベースの API で、REST (Representational State Transfer) プロトコル上での通信を行います。
+API へは、以下のようなポータル URL パスの "ajaxapi" サーブレット経由で HTTP を使ってアクセスします。
+<source><![CDATA[
+http://hostname/contextname/ajaxapi
+]]></source>
+</p>
+ <subsection name="リクエストパラメータとページ">
+ <p>
+リクエストパラメータは、リクエストした API の動作と、追加の API パラメータを指定します。
+リクエストが参照しているページは、HTTP URL 内に含まれます。
+ですので、もしページを変更するリクエストを作成したい場合は、ページは以下のような HTTP URL 内で指定します。
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/db-browser.psml
+]]></source>
+標準の PALポータルプロファイリングを使ったページ検索アルゴリズムが、ページを決定します。
+PALポータルのプロファイリングルールにより、ユーザーのためのページを検索するため、URL に含まれていなくても動作します。
+たとえば、
+<source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi
+]]></source>
+という URL は、現在のユーザのデフォルトページを表示します。
+</p>
+ <p>
+リクエストパラメータは、API それぞれで固有です。
+多くの場合、"action" パラメータというリクエストパラメータは必要になります (デフォルトの場合を除く)。
+デフォルトのアクションは "action=getpage" です。
+これは、プロファイリングルールにより検索された PSML ページの XML 表現を返します (PSML は XML 形式です)。
+リクエストパラメータのそれぞれの例は以下の表を参照してください。
+</p>
+ <p>現時点で利用可能な API を示します。</p>
+ </subsection>
+ <subsection name="ページの取得">
+ <table>
+ <tr>
+ <td>API:</td>
+ <td>getpage</td>
+ </tr>
+ <tr>
+ <td>コンポーネント:</td>
+ <td>AjaxGetPage</td>
+ </tr>
+ <tr>
+ <td>説明:</td>
+ <td>getpage は、ページマネージャから、PSML に保存されたページを取得します。
+ </td>
+ </tr>
+ <tr>
+ <td>パラメータ:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>URL に含まれます</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>getportlets (省略可、これがデフォルトのアクションです)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API の例:</td>
+ <td>
+ <source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/content.psml
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML レスポンス:</td>
+ <td>
+ <source><![CDATA[
+<js>
+<status>success</status>
+<action>getpage</action>
+ <page hidden="false">
+ <defaults layout-decorator="tigris" portlet-decorator="tigris"/>
+ <name>public.psml</name>
+ <path>/Public/public.psml</path>
+ <title>Public Share</title>
+ <short-title>Public Share</short-title>
+ <metadata name="title" xml:lang="es">Carpeta compartida</metadata>
+ <fragment id="ps-1000" type="layout" name="jetspeed-layouts::VelocityTwoColumns" decorator="">
+ <fragment id="ps-1001" type="portlet" name="rss::RSS" decorator="">
+ <property name="row" value="0"/>
+ <property name="column" value="0"/>
+ </fragment>
+ <fragment id="ps-1002" type="portlet" name="demo::BookmarkPortlet" decorator="">
+ <property name="row" value="1"/>
+ <property name="column" value="1"/>
+ </fragment>
+ <fragment id="ps-1003" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
+ <property name="row" value="0"/>
+ <property name="column" value="1"/>
+ </fragment>
+ <fragment id="P-1080bff9b03-10000" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
+ <property name="row" value="1"/>
+ <property name="column" value="0"/>
+ </fragment>
+ </fragment>
+</page>
+</js>
+]]></source>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="絶対位置で移動">
+ <table>
+ <tr>
+ <td>API:</td>
+ <td>moveabs</td>
+ </tr>
+ <tr>
+ <td>コンポーネント:</td>
+ <td>AjaxMovePortletAbsolute</td>
+ </tr>
+ <tr>
+ <td>説明:</td>
+ <td>ページ上のポートレットの絶対位置をリクエストパラメータで指定した row と col に従って移動する。</td>
+ </tr>
+ <tr>
+ <td>パラメータ:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>URL に含まれます</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>moveabs</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>移動させたいポートレットのポートレット PSML フラグメント ID</td>
+ </tr>
+ <tr>
+ <td>row</td>
+ <td>ポートレットフラグメントを置きたい位置の絶対的な行位置 (ゼロベース)</td>
+ </tr>
+ <tr>
+ <td>col</td>
+ <td>ポートレットフラグメントを置きたい位置の絶対的な列位置 (ゼロベース)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API の例:</td>
+ <td>
+ <source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=moveabs&id=ps-1003&row=0&col=1
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML レスポンス:</td>
+ <td>
+ <source><![CDATA[
+<js>
+ <status>success</status>
+ <action>moveabs</action>
+ <id>ps-1003</id>
+ <old_position>
+ <col>1</col>
+ <row>1</row>
+ </old_position>
+ <new_position>
+ <col>1</col>
+ <row>0</row>
+ </new_position>
+</js>
+]]></source>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="移動">
+ <table>
+ <tr>
+ <td>API:</td>
+ <td>moveleft, moveright, moveup, movedown</td>
+ </tr>
+ <tr>
+ <td>コンポーネント:</td>
+ <td>AjaxMovePortletLeft, AjaxMovePortletRight, AjaxMovePortletUp, AjaxMoveDown</td>
+ </tr>
+ <tr>
+ <td>説明:</td>
+ <td>アクションを指定して、ページ上のポートレットを相対的なある位置から移動する。</td>
+ </tr>
+ <tr>
+ <td>パラメータ:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>URL に含まれます</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>moveleft, moveright, moveup, movedown</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>移動させたいポートレットのポートレット PSML フラグメント ID</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API の例:</td>
+ <td>
+ <source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=movedown&id=ps-1003
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML レスポンス:</td>
+ <td>
+ <source><![CDATA[
+<js>
+ <status>success</status>
+ <action>movedown</action>
+ <id>ps-1003</id>
+ <old_position>
+ <col>1</col>
+ <row>0</row>
+ </old_position>
+ <new_position>
+ <col>1</col>
+ <row>1</row>
+ </new_position>
+</js>
+]]></source>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="ポートレットの追加">
+ <table>
+ <tr>
+ <td>API:</td>
+ <td>add</td>
+ </tr>
+ <tr>
+ <td>コンポーネント:</td>
+ <td>AjaxAddPortlet</td>
+ </tr>
+ <tr>
+ <td>説明:</td>
+ <td>現在のページに新しいポートレットを追加します。ポートレットは指定する行と列の場所に追加することが可能です。もし、行も列も指定されない場合は、デフォルトでそれぞれ 0 に設定されます。</td>
+ </tr>
+ <tr>
+ <td>パラメータ:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>URL に含まれます</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>add</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>ページに配置したいポートレットのフルネーム。PALポータルのポートレットの命名規則を使って指定します (ポートレットアプリケーション名::ポートレット名)</td>
+ </tr>
+ <tr>
+ <td>row</td>
+ <td>省略可: 新しいポートレットフラグメントを置きたい場所の行位置の絶対指定 (ゼロベース)</td>
+ </tr>
+ <tr>
+ <td>col</td>
+ <td>省略可: 新しいポートレットフラグメントを置きたい場所の列位置の絶対指定 (ゼロベース)</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API の例:</td>
+ <td>
+ <source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=add&id=jsf-demo::CalendarPortlet
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML レスポンス:</td>
+ <td>
+ <source><![CDATA[
+<js>
+ <status>success</status>
+ <action>add</action>
+ <id>jsf-demo::CalendarPortlet</id>
+ <new_position>
+ <col>0</col>
+ <row>0</row>
+ </new_position>
+</js>
+]]></source>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="ポートレットの削除">
+ <table>
+ <tr>
+ <td>API:</td>
+ <td>remove</td>
+ </tr>
+ <tr>
+ <td>コンポーネント:</td>
+ <td>AjaxRemovePortlet</td>
+ </tr>
+ <tr>
+ <td>説明:</td>
+ <td>現在のページから新たにポートレットを削除する。</td>
+ </tr>
+ <tr>
+ <td>パラメータ:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>URL に含まれる</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>remove</td>
+ </tr>
+ <tr>
+ <td>id</td>
+ <td>削除したいポートレットのポートレット PSML ID</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API の例:</td>
+ <td>
+ <source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=remove&id=ps-1003
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML レスポンス:</td>
+ <td>
+ <source><![CDATA[
+<js>
+ <status>success</status>
+ <action>remove</action>
+ <id>jsf-demo::CalendarPortlet</id>
+ <new_position>
+ <col>0</col>
+ <row>0</row>
+ </new_position>
+</js>
+]]></source>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ <subsection name="ポートレットの取得">
+ <table>
+ <tr>
+ <td>API:</td>
+ <td>getportlets</td>
+ </tr>
+ <tr>
+ <td>コンポーネント:</td>
+ <td>AjaxGetPortlets</td>
+ </tr>
+ <tr>
+ <td>説明:</td>
+ <td>ポートレットの取得は、現在のサブジェクトで利用可能な (ソートされた) ポートレットのリストを返します。ポートレットリストはフィルタリングされ、現在のサブジェクトで表示可能なポートレットが返されます。PALポータルセキュリティポリシー (JAAS) は、このフィルタリングを実行します。ポートレット (のリスト) は、それぞれのポートレットの名前、表示名、説明の記述された XML フォーマットで返されます。</td>
+ </tr>
+ <tr>
+ <td>パラメータ:</td>
+ <table>
+ <tr>
+ <td>page</td>
+ <td>URL に含まれる</td>
+ </tr>
+ <tr>
+ <td>action</td>
+ <td>getportlets</td>
+ </tr>
+ <tr>
+ <td>filter</td>
+ <td>まだ実装されていません。照会のフィルタを定義します。</td>
+ </tr>
+ </table>
+ </tr>
+ <tr>
+ <td>API の例:</td>
+ <td>
+ <source><![CDATA[
+http://localhost:8080/jetspeed/ajaxapi?action=getportlets
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>XML レスポンス:</td>
+ <td>
+ <source><![CDATA[
+<js>
+<status>success</status>
+<action>getportlets</action>
+-
+ <portlets>
+<portlet name="demo::AttributeScopePortlet" displayName="Attribute Scope Demo" description="$portlet.Description">
+ </portlet>
+<portlet name="demo::BookmarkPortlet" displayName="Bookmark Portlet" description="Bookmark Portlet">
+ </portlet>
+<portlet name="demo::BookmarkPortletForXHTMLBasic" displayName="Bookmark Portlet for XHTML Basic" description="Bookmark Portlet for XHTML Basic">
+ </portlet>
+<portlet name="demo::CSSDemoPortlet" displayName="CSS Demo Portlet" description="$portlet.Description">
+ </portlet>
+....
+<portlet name="rss::RSS" displayName="RSS Portlet" description="RSS Portlet">
+ </portlet>
+<portlet name="rss::RomeRSS" displayName="Rome RSS Portlet" description="Rome RSS Portlet">
+ </portlet>
+</portlets>
+</js>
+]]></source>
+ </td>
+ </tr>
+ </table>
+ </subsection>
+ </section>
+ <section name="Spring アセンブリ">
+ <p><code>AjaxRequestService</code> は、Ajax リクエストを扱う Spring のコンポーネントです。これは、Ajax リクエストの特別な処理のために、Ajax パイプライン内でフックされます。以下が Spring アセンブリです。それぞれの API は Ajax サービス内で設定されます。
+</p>
+ <source><![CDATA[
+<bean id="AjaxRequestService" class="org.apache.jetspeed.ajax.AjaxRequestServiceImpl">
+ <constructor-arg index="0">
+ <map>
+ <entry key="moveabs">
+ <ref bean="AjaxMovePortletAbsolute"/>
+ </entry>
+ <entry key="moveleft">
+ <ref bean="AjaxMovePortletLeft"/>
+ </entry>
+ <entry key="moveright">
+ <ref bean="AjaxMovePortletRight"/>
+ </entry>
+ <entry key="moveup">
+ <ref bean="AjaxMovePortletUp"/>
+ </entry>
+ <entry key="movedown">
+ <ref bean="AjaxMovePortletDown"/>
+ </entry>
+ <entry key="add">
+ <ref bean="AjaxAddPortlet"/>
+ </entry>
+ <entry key="remove">
+ <ref bean="AjaxRemovePortlet"/>
+ </entry>
+ <entry key="getportlets">
+ <ref bean="AjaxGetPortlets"/>
+ </entry>
+ <entry key="getpage">
+ <ref bean="AjaxGetPage"/>
+ </entry>
+ </map>
+ </constructor-arg>
+ <constructor-arg index="1">
+ <ref bean="AjaxVelocityEngine"/>
+ </constructor-arg>
+</bean>
+]]></source>
+ </section>
+ </body>
+</document>
Property changes on: pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/api.xml
___________________________________________________________________
Name: svn:eol-style
+ native
Copied: pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/guide.xml (from rev 1141, pal-portal/docs/ja/configuration-guide/trunk/xdocs/guides/guide-ajax-api.xml)
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/guide.xml (rev 0)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/ajax/guide.xml 2008-09-11 22:36:41 UTC (rev 1159)
@@ -0,0 +1,55 @@
+<?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>Ajax</title>
+ <subtitle>概要</subtitle>
+ <authors>
+ <person name="David Sean Taylor" email="taylo****@apach*****"/>
+ <person name="加藤泰文" email="karma****@prog*****"/>
+ <person name="菅谷信介" email="shins****@yahoo*****"/>
+ </authors>
+ </properties>
+ <body>
+ <section name="概要">
+ <p>
+PALポータルの XML Ajax API は、Ajax クライアントが、非同期のリクエストを PALポータルサービスに送ることができるようにするための XML ベースの API です。
+</p>
+ <p>
+典型的な使用例としては、
+</p>
+ <ul>
+ <li><b>ページのカスタマイズとポートレットの配置</b> - ページ上でのポートレットの移動、コピー、追加、削除。</li>
+ <li><b>レイアウトの選択</b> - ページのレイアウトの変更 (行や列の数の変更、列のサイズの変更)。</li>
+ <li><b>テーマとデコレータの選択</b> - ページのテーマやページ上のポートレットのデコレータの変更。</li>
+ <li><b>ポートレットのセレクタ</b> - エンドユーザへのポートレットの選択リストを提供。</li>
+ <li><b>セキュリティの設定</b> - リソース (ページ、ポートレット、フォルダ、リンク、フラグメント) もしくはポータル全体でのセキュリティ制約、またはポリシーの設定。</li>
+ <li><b>メニューの設定</b> - PALポータルサイトのメニューの生成や編集。</li>
+ <li><b>全体的な管理</b> - 全体的な管理を行う全てのユースケースはまだ検討されていません。</li>
+ </ul>
+ <subsection name="保証されたアクセス">
+ <p>
+Ajax XML API リクエストの全ては、Ajax 用に登録されているのパイプラインを通して実行されます。
+これは、通常の PALポータルコンポーネントのバルブ配列を用いて、Ajax リクエストを構成可能であることを意味します。
+デフォルトの Ajax パイプラインは、全てのリクエストへのアクセスを保証します。
+Ajax アクションのそれぞれは、自身のセキュリティ制約を持ちます。
+ページを生成する全てのリクエストは、本来のアクションに依存する、編集もしくは表示モードの元で実行されます。
+</p>
+ </subsection>
+ </section>
+ </body>
+</document>
Deleted: pal-portal/docs/ja/configuration-guide/trunk/xdocs/guides/guide-ajax-api.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/guides/guide-ajax-api.xml 2008-09-11 13:04:16 UTC (rev 1158)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/guides/guide-ajax-api.xml 2008-09-11 22:36:41 UTC (rev 1159)
@@ -1,541 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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> AJAX XML API</title>
- <subtitle> PALポータルの AJAX XML API についての文書</subtitle>
- <authors>
- <person name="David Sean Taylor" email="taylo****@apach*****"/>
- </authors>
- <translators>
- <person name="加藤泰文" email="karma****@prog*****" />
- </translators>
- </properties>
- <body>
-<section name=" AJAX XML API の概要">
-
-<p>
-PALポータルの XML AJAX API は、AJAX クライアントが、非同期のリクエストを PALポータルサービスに送ることができるようにするための XML ベースの API です。
-</p>
-
-<p>
-典型的な使用例としては、
-</p>
-
-<ul>
- <li><b>ページのカスタマイズとポートレットの配置</b> - ページ上でのポートレットの移動、コピー、追加、削除。</li>
- <li><b>レイアウトの選択</b> - ページのレイアウトの変更 (行や列の数の変更、列のサイズの変更)。</li>
- <li><b>テーマとデコレータの選択</b> - ページのテーマやページ上のポートレットのデコレータの変更。</li>
- <li><b>ポートレットのセレクタ</b> - エンドユーザへのポートレットの選択リストを提供。</li>
- <li><b>セキュリティの設定</b> - リソース (ページ、ポートレット、フォルダ、リンク、フラグメント) もしくはポータル全体でのセキュリティ制約、またはポリシーの設定。</li>
- <li><b>メニューの設定</b> - PALポータルサイトのメニューの生成や編集。</li>
- <li><b>全体的な管理</b> - 全体的な管理を行う全てのユースケースはまだ検討されていません。</li>
-</ul>
-<subsection name=' 保証されたアクセス'>
-
-<p>
-AJAX XML API リクエストの全ては、標準の PALポータル<a href='guide-pipeline.html'>パイプライン</a>リクエストを通して実行されます。これは、通常の PALポータルコンポーネントの配列を用いて、AJAX リクエストを構成可能であることを意味します。デフォルトの AJAX パイプラインは、全てのリクエストへのアクセスを保証します。AJAX アクションのそれぞれは、自身のセキュリティ制約を持ちます。ページを生成する全てのリクエストは、本来のアクションに依存する、編集もしくは閲覧モードの元で実行されます。
-</p>
-</subsection>
-</section>
-<section name=' API'>
-
-<p>
-AJAX XML API は、単純な HTTP リクエストベースの API で、単純な REST (Representational State Transfer) プロトコル上での通信を行います。API へは、以下のようなポータル URL パスの "ajaxapi" サーブレット経由で HTTP を使ってアクセスします。
-<source><![CDATA[
-http://hostname/contextname/ajaxapi
-]]></source>
-</p>
-<subsection name=' リクエストパラメータとページ'>
-
-<p>リクエストパラメータは、リクエストした API の動作と、追加の API パラメータを指定します。リクエストが参照しているページは、HTTP URL 内に含まれます。なので、もしページを変更するリクエストを作成したい場合、ページは以下のような HTTP URL 内で指定します。
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/db-browser.psml
-]]></source>
-標準の PALポータルプロファイリングを使ったページの配置アルゴリズムが、ページを配置します。ページは、実際は URL 中には不要です。<a href='guide-profiler.html'>PALポータルプロファイラ</a> が、ユーザのためのページを配置するからです。例えば、
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi
-]]></source>
-という URL は、現在のユーザのデフォルトページを表示します。
-</p>
-
-<p>リクエストパラメータは、API それぞれで固有です。大体の場合、"action" パラメータというリクエストパラメータだけは、必要になります (デフォルトの場合を除く)。デフォルトのアクションは "action=getpage" です。これは、<a href='guide-psml.html'>PSML</a> 内のプロファイルが示すページの XML 表現を返します (PSML は XML フォーマットです)。リクエストパラメータのそれぞれの例は以下の表を参照してください。
-</p>
-
-<p>現時点で利用可能な API を示します。</p>
-</subsection>
-<subsection name=' ページの取得'>
-
-<table>
- <tr>
- <td>API:</td>
- <td>getpage</td>
- </tr>
- <tr>
- <td>コンポーネント:</td>
- <td>AjaxGetPage</td>
- </tr>
- <tr>
- <td>説明:</td>
- <td>getpage は、ページマネージャから、<a href='guide-psml.html'>PSML</a> に保存されたページを取得します。
- </td>
- </tr>
- <tr>
- <td>パラメータ:</td>
- <table>
- <tr>
- <td>page</td>
- <td>URL に含まれます</td>
- </tr>
- <tr>
- <td>action</td>
- <td>getportlets (省略可、これがデフォルトのアクションです)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API の例:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/content.psml
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML レスポンス:</td>
- <td>
-<source><![CDATA[
-<js>
-<status>success</status>
-<action>getpage</action>
- <page hidden="false">
- <defaults layout-decorator="tigris" portlet-decorator="tigris"/>
- <name>public.psml</name>
- <path>/Public/public.psml</path>
- <title>Public Share</title>
- <short-title>Public Share</short-title>
- <metadata name="title" xml:lang="es">Carpeta compartida</metadata>
- <fragment id="ps-1000" type="layout" name="jetspeed-layouts::VelocityTwoColumns" decorator="">
- <fragment id="ps-1001" type="portlet" name="rss::RSS" decorator="">
- <property name="row" value="0"/>
- <property name="column" value="0"/>
- </fragment>
- <fragment id="ps-1002" type="portlet" name="demo::BookmarkPortlet" decorator="">
- <property name="row" value="1"/>
- <property name="column" value="1"/>
- </fragment>
- <fragment id="ps-1003" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
- <property name="row" value="0"/>
- <property name="column" value="1"/>
- </fragment>
- <fragment id="P-1080bff9b03-10000" type="portlet" name="jsf-demo::CalendarPortlet" decorator="">
- <property name="row" value="1"/>
- <property name="column" value="0"/>
- </fragment>
- </fragment>
-</page>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name=' 絶対位置で移動'>
-
-<table>
- <tr>
- <td>API:</td>
- <td>moveabs</td>
- </tr>
- <tr>
- <td>コンポーネント:</td>
- <td>AjaxMovePortletAbsolute</td>
- </tr>
- <tr>
- <td>説明:</td>
- <td>ページ上のポートレットの絶対位置をリクエストパラメータで指定した row と col に従って移動する。</td>
- </tr>
- <tr>
- <td>パラメータ:</td>
- <table>
- <tr>
- <td>page</td>
- <td>URL に含まれます</td>
- </tr>
- <tr>
- <td>action</td>
- <td>moveabs</td>
- </tr>
- <tr>
- <td>id</td>
- <td>移動させたいポートレットのポートレット PSML フラグメント ID</td>
- </tr>
- <tr>
- <td>row</td>
- <td>ポートレットフラグメントを置きたい位置の絶対的な行位置 (ゼロベース)</td>
- </tr>
- <tr>
- <td>col</td>
- <td>ポートレットフラグメントを置きたい位置の絶対的な列位置 (ゼロベース)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API の例:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=moveabs&id=ps-1003&row=0&col=1
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML レスポンス:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>moveabs</action>
- <id>ps-1003</id>
- <old_position>
- <col>1</col>
- <row>1</row>
- </old_position>
- <new_position>
- <col>1</col>
- <row>0</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name=' 移動'>
-
-<table>
- <tr>
- <td>API:</td>
- <td>moveleft, moveright, moveup, movedown</td>
- </tr>
- <tr>
- <td>コンポーネント:</td>
- <td>AjaxMovePortletLeft, AjaxMovePortletRight, AjaxMovePortletUp, AjaxMoveDown</td>
- </tr>
- <tr>
- <td>説明:</td>
- <td>アクションを指定して、ページ上のポートレットを相対的なある位置から移動する。</td>
- </tr>
- <tr>
- <td>パラメータ:</td>
- <table>
- <tr>
- <td>page</td>
- <td>URL に含まれます</td>
- </tr>
- <tr>
- <td>action</td>
- <td>moveleft, moveright, moveup, movedown</td>
- </tr>
- <tr>
- <td>id</td>
- <td>移動させたいポートレットのポートレット PSML フラグメント ID</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API の例:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=movedown&id=ps-1003
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML レスポンス:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>movedown</action>
- <id>ps-1003</id>
- <old_position>
- <col>1</col>
- <row>0</row>
- </old_position>
- <new_position>
- <col>1</col>
- <row>1</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-
-</table>
-</subsection>
-<subsection name=' ポートレットの追加'>
-
-<table>
- <tr>
- <td>API:</td>
- <td>add</td>
- </tr>
- <tr>
- <td>コンポーネント:</td>
- <td>AjaxAddPortlet</td>
- </tr>
- <tr>
- <td>説明:</td>
- <td>現在のページに新しいポートレットを追加します。ポートレットは指定する行と列の場所に追加することが可能です。もし、行も列も指定されない場合は、デフォルトでそれぞれ 0 に設定されます。</td>
- </tr>
- <tr>
- <td>パラメータ:</td>
- <table>
- <tr>
- <td>page</td>
- <td>URL に含まれます</td>
- </tr>
- <tr>
- <td>action</td>
- <td>add</td>
- </tr>
- <tr>
- <td>id</td>
- <td>ページに配置したいポートレットのフルネーム。PALポータルのポートレットの命名規則を使って指定します (ポートレットアプリケーション名::ポートレット名)</td>
- </tr>
- <tr>
- <td>row</td>
- <td>省略可: 新しいポートレットフラグメントを置きたい場所の行位置の絶対指定 (ゼロベース)</td>
- </tr>
- <tr>
- <td>col</td>
- <td>省略可: 新しいポートレットフラグメントを置きたい場所の列位置の絶対指定 (ゼロベース)</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API の例:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=add&id=jsf-demo::CalendarPortlet
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML レスポンス:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>add</action>
- <id>jsf-demo::CalendarPortlet</id>
- <new_position>
- <col>0</col>
- <row>0</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name=' ポートレットの削除'>
-
-<table>
-
- <tr>
- <td>API:</td>
- <td>remove</td>
- </tr>
- <tr>
- <td>コンポーネント:</td>
- <td>AjaxRemovePortlet</td>
- </tr>
- <tr>
- <td>説明:</td>
- <td>現在のページから新たにポートレットを削除する。</td>
- </tr>
- <tr>
- <td>パラメータ:</td>
- <table>
- <tr>
- <td>page</td>
- <td>URL に含まれる</td>
- </tr>
- <tr>
- <td>action</td>
- <td>remove</td>
- </tr>
- <tr>
- <td>id</td>
- <td>削除したいポートレットのポートレット PSML ID</td>
- </tr>
- </table>
- </tr>
- <tr>
- <td>API の例:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi/Public/public.psml?action=remove&id=ps-1003
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML レスポンス:</td>
- <td>
-<source><![CDATA[
-<js>
- <status>success</status>
- <action>remove</action>
- <id>jsf-demo::CalendarPortlet</id>
- <new_position>
- <col>0</col>
- <row>0</row>
- </new_position>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-<subsection name=' ポートレットの取得'>
-
-<table>
-
- <tr>
- <td>API:</td>
- <td>getportlets</td>
- </tr>
- <tr>
- <td>コンポーネント:</td>
- <td>AjaxGetPortlets</td>
- </tr>
- <tr>
- <td>説明:</td>
- <td>ポートレットの取得は、現在のサブジェクトで利用可能な (ソートされた) ポートレットのリストを返します。ポートレットリストはフィルタリングされ、現在のサブジェクトで表示可能なポートレットが返されます。PALポータルセキュリティポリシー (JAAS) は、このフィルタリングを実行します。ポートレット (のリスト) は、それぞれのポートレットの名前、表示名、説明の記述された XML フォーマットで返されます。</td>
- </tr>
- <tr>
- <td>パラメータ:</td>
- <table>
- <tr>
- <td>page</td>
- <td>URL に含まれる</td>
- </tr>
- <tr>
- <td>action</td>
- <td>getportlets</td>
- </tr>
- <tr>
- <td>filter</td>
- <td>まだ実装されていません。照会のフィルタを定義します。</td>
- </tr>
-
- </table>
- </tr>
- <tr>
- <td>API の例:</td>
- <td>
-<source><![CDATA[
-http://localhost:8080/jetspeed/ajaxapi?action=getportlets
-]]></source>
- </td>
- </tr>
- <tr>
- <td>XML レスポンス:</td>
- <td>
-<source><![CDATA[
-<js>
-<status>success</status>
-<action>getportlets</action>
--
- <portlets>
-<portlet name="demo::AttributeScopePortlet" displayName="Attribute Scope Demo" description="$portlet.Description">
- </portlet>
-<portlet name="demo::BookmarkPortlet" displayName="Bookmark Portlet" description="Bookmark Portlet">
- </portlet>
-<portlet name="demo::BookmarkPortletForXHTMLBasic" displayName="Bookmark Portlet for XHTML Basic" description="Bookmark Portlet for XHTML Basic">
- </portlet>
-<portlet name="demo::CSSDemoPortlet" displayName="CSS Demo Portlet" description="$portlet.Description">
- </portlet>
-....
-<portlet name="rss::RSS" displayName="RSS Portlet" description="RSS Portlet">
- </portlet>
-<portlet name="rss::RomeRSS" displayName="Rome RSS Portlet" description="Rome RSS Portlet">
- </portlet>
-</portlets>
-</js>
-]]></source>
-
- </td>
- </tr>
-</table>
-</subsection>
-</section>
-
-<section name=' Spring アセンブリ'>
-
-<p>
-<code>AjaxRequestService</code> は、AJAX リクエストを扱う Spring のコンポーネントです。これは、AJAX リクエストの特別な処理のために、AJAX <a href='guide-pipeline.html'>パイプライン</a>内でフックされます。以下が Spring アセンブリです。それぞれの API は Ajax サービス内で設定されます。
-</p>
-
-<source><![CDATA[
-<bean id="AjaxRequestService" class="org.apache.jetspeed.ajax.AjaxRequestServiceImpl">
- <constructor-arg index="0">
- <map>
- <entry key="moveabs">
- <ref bean="AjaxMovePortletAbsolute"/>
- </entry>
- <entry key="moveleft">
- <ref bean="AjaxMovePortletLeft"/>
- </entry>
- <entry key="moveright">
- <ref bean="AjaxMovePortletRight"/>
- </entry>
- <entry key="moveup">
- <ref bean="AjaxMovePortletUp"/>
- </entry>
- <entry key="movedown">
- <ref bean="AjaxMovePortletDown"/>
- </entry>
- <entry key="add">
- <ref bean="AjaxAddPortlet"/>
- </entry>
- <entry key="remove">
- <ref bean="AjaxRemovePortlet"/>
- </entry>
- <entry key="getportlets">
- <ref bean="AjaxGetPortlets"/>
- </entry>
- <entry key="getpage">
- <ref bean="AjaxGetPage"/>
- </entry>
- </map>
- </constructor-arg>
- <constructor-arg index="1">
- <ref bean="AjaxVelocityEngine"/>
- </constructor-arg>
-</bean>
-]]></source>
-</section>
-</body>
-</document>
-
Modified: pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml
===================================================================
--- pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml 2008-09-11 13:04:16 UTC (rev 1158)
+++ pal-portal/docs/ja/configuration-guide/trunk/xdocs/navigation.xml 2008-09-11 22:36:41 UTC (rev 1159)
@@ -40,12 +40,15 @@
<item name="デコレータユーティリティ" href="design/jpt.html"/>
<item name="ログインデザイン" href="design/login.html"/>
</menu>
+ <menu name="Ajax">
+ <item name="概要" href="ajax/guide.html"/>
+ <item name="API" href="ajax/api.html"/>
+ </menu>
<menu name="バッチ処理">
<item name="概要" href="batch/guide.html"/>
<item name="ユーザー情報" href="batch/usermanager.html"/>
</menu>
<!--
-Ajax
ログインプロセス JAAS
プロファイラ
配備