<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <meta http-equiv="Content-Script-Type" content="text/javascript" />
    <meta http-equiv="Content-Style-Type" content="text/css" />
    <title>Pageクラス</title>
    <link rel="stylesheet" href="/css/style.css" type="text/css" media="all" />
    
    
  </head>
  <body>
    <div class="header">
      <div id="pane.left-header" class="pane left">
        <div id="org.seasar.kvasir.cms.toolbox.customPop-2" class="pop org.seasar.kvasir.cms.toolbox.customPop">
          <div class="body"><div class="wiki">
<ul>
<li><a href="/" class="pageNotFound">（サイトトップ）</a></li>
<li><a href="/download">ダウンロード</a></li>
<li><a href="/news/" class="pageNotFound">新着情報</a></li>
<li><a href="/docs/" class="pageNotFound">ドキュメント</a></li>
</ul>
</div>
</div>
        </div>
      </div>
      <div id="pane.right-header" class="pane right">
        <div id="org.seasar.kvasir.cms.toolbox.loginPop-1" class="pop org.seasar.kvasir.cms.toolbox.loginPop">
          <div class="body">
<form method="post" action="/plugins/toolbox/login.do/docs/0.9.x/ref/pageClass">
    <div class="row">
      <span class="label">Name</span>
      <span class="textinput"><input type="text" name="name" size="12" value="" /></span>
    </div>
    <div class="row">
      <span class="label">Password</span>
      <span class="textinput"><input type="password" name="password" size="12" value="" /></span>
    </div>
    <div class="row">
      <span class="submit"><input type="submit" value="Login" /></span>
    </div>
</form>
</div>
        </div><div id="org.seasar.kvasir.cms.pop.loginUserPop-1" class="pop org.seasar.kvasir.cms.pop.loginUserPop">
          <div class="body"></div>
        </div>
      </div>
    </div>
    <div class="page-frame">
      <div id="pane.left-sidebar" class="pane sidebar-frame sidebar subcontent">
        <div id="org.seasar.kvasir.cms.toolbox.searchPop-1" class="pop org.seasar.kvasir.cms.toolbox.searchPop">
          <h2 class="title">Search</h2>
          <div class="body"><form class="simple" method="get" action="/plugins/toolbox/search.do">
  <input type="text" name="query" size="12" />
  <input type="submit" value="Go!" />
</form>
</div>
        </div><div id="org.seasar.kvasir.cms.toolbox.customPop-1" class="pop org.seasar.kvasir.cms.toolbox.customPop">
          <h2 class="title">メニュー</h2>
          <div class="body"><ul>
  <li><a href="/" class="pageNotFound">（サイトトップ）</a></li>
  <li><a href="/download">ダウンロード</a></li>
  <li><a href="/news">新着情報</a></li>
  
    
    
      <li>
        <a href="/docs/1.0.x">ドキュメント（1.0.x系）</a>
        
      </li><li>
        <a href="/docs/0.9.x">ドキュメント（0.9.x系）</a>
        
      </li>
    
  
  <li><a href="/roadmap">ロードマップ</a></li>
  <li><a href="https://www.seasar.org/issues/browse/YMIR">既知の不具合を閲覧する・不具合を報告する</a></li>
  <li><a href="https://www.seasar.org/svn/ymir/">SVNリポジトリ</a></li>
  <li><a href="http://svn.seasar.org/browse/?root=ymir">SVNリポジトリを閲覧</a></li>
</ul>
</div>
        </div>
      </div>
      <div id="pane.main" class="pane main">
      
        <div id="org.seasar.kvasir.cms.toolbox.breadcrumbsPop-1" class="pop org.seasar.kvasir.cms.toolbox.breadcrumbsPop">
          
          <div class="body"><ul>
  <li class="first"><a href="/">(TOP)</a></li><li><a href="/docs">ドキュメント</a></li><li><a href="/docs/0.9.x">ドキュメント（0.9.x系）</a></li><li><a href="/docs/0.9.x/ref">リファレンスマニュアル</a></li><li>Pageクラス</li>
</ul>
</div>
        </div><div id="org.seasar.kvasir.cms.pop.contentPop-1" class="pop org.seasar.kvasir.cms.pop.contentPop">
          <h2 class="title">Pageクラス</h2>
          <div class="body">
<ul class="information">
  
  <li>2008-07-31 17:46:17</li>
</ul>
<div class="content"><div class="document">
<p>Ymirではリクエストパスに対応するPageクラスのメソッドが呼び出されます。対応するPageクラスが存在しない場合、メソッド呼び出しは行なわれません。このクラスが存在する場合、以下のような処理が行なわれます。</p>
<ol>
<li>このクラスのインスタンスをS2Containerから取り出す（なおインスタンスはrequestスコープです）。</li>
<li>type=&quot;file&quot;以外のリクエストパラメータ（<a class="reference pageNotFound" href="/doc/ref/pathMapping#e38391e382b9e3818be38289e381aee38391e383a9e383a1e383bce382bfe381aee58f96e3828ae587bae38197">URIパラメータ</a>がマージされたもの）をPageインスタンスにinjectする。</li>
<li>type=&quot;file&quot;であるリクエストパラメータをPageインスタンスにinjectする。</li>
<li>@Inアノテーションが付与されているsetterメソッドがあれば、アノテーションに従ったオブジェクトスコープからオブジェクトを取り出してそのsetterメソッドを使ってセットする。</li>
<li>Pageクラスに書かれている制約アノテーションに従って制約（リクエストパラメータの正当性やアクセス権限）のチェックを行なう。</li>
<li>Pageインスタンスについてアクションを実行する。具体的には、マッチしたパスマッピングから構築したアクション名と同じ名前のメソッドを呼び出す。アクション名と同じ名前のメソッドが存在しない場合は<tt class="docutils literal"><span class="pre">_default()</span></tt>メソッドを呼び出す。<tt class="docutils literal"><span class="pre">_default()</span></tt>メソッドも存在しない場合はPermissionDeniedExceptionをスローする。</li>
<li>メソッドの返り値からResponseオブジェクトを構築する。構築したResponseのtypeがPASSTHROUGHでかつマッチしたパスマッピングから構築したデフォルトの返り値がnullでない場合は、Responseオブジェクトをデフォルトの返り値から構築したResponseオブジェクトで置き換える。</li>
<li>ResponseのtypeがPASSTHROUGHまたはFORWARDの場合、Pageインスタンスの<tt class="docutils literal"><span class="pre">_render()</span></tt>メソッドを呼び出す。（このメソッドの中で、テンプレートのレンダリングに必要なオブジェクトやプロパティの準備を行なうようにして下さい。）</li>
<li>@Outアノテーションが付与されているgetterメソッドがあれば、アノテーションに従ったオブジェクトスコープにgetterメソッドの返り値を格納する。</li>
</ol>
<p>なお、制約チェックで失敗した場合はアクションメソッドの呼び出しの代わりに、<tt class="docutils literal"><span class="pre">_validationFailed</span></tt>メソッドまたは<tt class="docutils literal"><span class="pre">_permissionDenied</span></tt>メソッドが呼び出されます。</p>
<p>具体的には、リクエストパラメータの正当性チェックに失敗した場合は<tt class="docutils literal"><span class="pre">_validationFailed(Notes)</span></tt>メソッド、なければ<tt class="docutils literal"><span class="pre">_validationFailed()</span></tt>メソッドが呼び出され、アクセス権限チェックに失敗した場合は<tt class="docutils literal"><span class="pre">_permissionDenied(PermissionDeniedException)</span></tt>メソッド、なければ<tt class="docutils literal"><span class="pre">_permissionDenied()</span></tt>メソッドが呼び出されます。</p>
<p>どちらの場合もメソッド呼び出しの後<tt class="docutils literal"><span class="pre">_render()</span></tt>メソッドの呼び出しが行なわれます。</p>
<p>なお、<tt class="docutils literal"><span class="pre">_validationFailed</span></tt>メソッドが存在しない場合は単にメソッド呼び出しがスキップされますが、<tt class="docutils literal"><span class="pre">_permissionDenied</span></tt>メソッドが存在しない場合はPermissionDeniedExceptionがスローされます。PermissionDeniedExceptionがスローされた場合は<tt class="docutils literal"><span class="pre">_render()</span></tt>メソッドの呼び出しは行なわれません。</p>
<div class="section" id="e4be8b">
<h3><a name="e4be8b">例</a></h3>
<p>標準のマッピングでは、例えばリクエストパスが/path.htmlある場合、アプリケーションのルートパッケージ名をcom.example.appとしてcom.example.app.web.PathPageクラスがPageクラスとなります。</p>
<p>今HTTPメソッドがPOSTであるようなリクエストが/path.htmlに対してなされた場合の処理の流れは以下のようになります。</p>
<div class="section" id="e588b6e7b484e38381e382a7e38383e382afe381a7e382a8e383a9e383bce381abe381aae38289e381aae38184e382b1e383bce382b9">
<h4><a name="e588b6e7b484e38381e382a7e38383e382afe381a7e382a8e383a9e383bce381abe381aae38289e381aae38184e382b1e383bce382b9">制約チェックでエラーにならないケース</a></h4>
<ol>
<li>PathPageインスタンスの取り出し</li>
<li>リクエストパラメータやスコープ内オブジェクトのinject</li>
<li><tt class="docutils literal"><span class="pre">PathPage#_post()</span></tt>、なければ<tt class="docutils literal"><span class="pre">PathPage#_default()</span></tt>の呼び出し</li>
<li><tt class="docutils literal"><span class="pre">PathPage#_render()</span></tt>の呼び出し</li>
</ol>
</div>
<div class="section" id="e383aae382afe382a8e382b9e38388e38391e383a9e383a1e383bce382bfe381aee6ada3e5bd93e680a7e38381e382a7e38383e382afe381a7e382a8e383a9e383bce381abe381aae3828be382b1e383bce382b9">
<h4><a name="e383aae382afe382a8e382b9e38388e38391e383a9e383a1e383bce382bfe381aee6ada3e5bd93e680a7e38381e382a7e38383e382afe381a7e382a8e383a9e383bce381abe381aae3828be382b1e383bce382b9">リクエストパラメータの正当性チェックでエラーになるケース</a></h4>
<ol>
<li>PathPageインスタンスの取り出し</li>
<li>リクエストパラメータやスコープ内オブジェクトのinject</li>
<li><tt class="docutils literal"><span class="pre">PathPage#_validationFailed(Notes)</span></tt>、なければ<tt class="docutils literal"><span class="pre">PathPage#_validationFailed()</span></tt>の呼び出し</li>
<li><tt class="docutils literal"><span class="pre">PathPage#_render()</span></tt>の呼び出し</li>
</ol>
</div>
<div class="section" id="e382a2e382afe382bbe382b9e6a8a9e99990e38381e382a7e38383e382afe381a7e382a8e383a9e383bce381abe381aae3828be382b1e383bce382b9">
<h4><a name="e382a2e382afe382bbe382b9e6a8a9e99990e38381e382a7e38383e382afe381a7e382a8e383a9e383bce381abe381aae3828be382b1e383bce382b9">アクセス権限チェックでエラーになるケース</a></h4>
<ol>
<li>PathPageインスタンスの取り出し</li>
<li>リクエストパラメータやスコープ内オブジェクトのinject</li>
<li><tt class="docutils literal"><span class="pre">PathPage#_permissionDenied(PermissionDeniedException)</span></tt>、なければ<tt class="docutils literal"><span class="pre">PathPage#_permissionDenied()</span></tt>の呼び出し、なければPermissionDeniedExceptionをスロー</li>
<li><tt class="docutils literal"><span class="pre">PathPage#_render()</span></tt>の呼び出し</li>
</ol>
</div>
</div>
<div class="section" id="e383aae382afe382a8e382b9e38388e38391e383a9e383a1e383bce382bfe381aee382a4e383b3e382b8e382a7e382afe38388">
<h3><a name="e383aae382afe382a8e382b9e38388e38391e383a9e383a1e383bce382bfe381aee382a4e383b3e382b8e382a7e382afe38388">リクエストパラメータのインジェクト</a></h3>
<p>リクエストパラメータはユーザが自由に外部から指定することができるため、アプリケーション設計者の意図しないGetter/Setterメソッドを使って外部からPageオブジェクトに値がセットされてしまう危険性があります。</p>
<p>Ymirではこの危険を回避するために、リクエストパラメータのインジェクトに使用できるGetter/Setterメソッドには明示的に@RequestParameterアノテーションを付与することになっています。このアノテーションが付与されていないGetter/Setterはリクエストパラメータのインジェクトには用いられません。</p>
<p>アノテーションのついていないGetter/Setterについてもリクエストパラメータのインジェクトを許可したい場合は、app.propertiesに書かれている以下の行を削除して下さい:</p>
<pre class="literal-block">
core.requestParameter.strictInjection=true
</pre>
<p>なおこの行をアプリケーションの開発途中に変えると脆弱性が混入する危険性がありますので十分注意して下さい！</p>
</div>
<div class="section" id="e38395e382a7e383bce382bae6af8ee381aee382abe382b9e382bfe383a0e383a1e382bde38383e38389e591bce381b3e587bae38197">
<h3><a name="e38395e382a7e383bce382bae6af8ee381aee382abe382b9e382bfe383a0e383a1e382bde38383e38389e591bce381b3e587bae38197">フェーズ毎のカスタムメソッド呼び出し</a></h3>
<p>Pageコンポーネントに関する処理フェーズ毎に特定のメソッドを呼ぶようにすることができます。</p>
<p>ある処理フェーズの時点で呼び出したいメソッドには<tt class="docutils literal"><span class="pre">org.seasar.ymir.annotation.Invoke</span></tt>アノテーションを付与します。アノテーションのプロパティとして、フェーズを表すEnum（<tt class="docutils literal"><span class="pre">org.seasar.ymir.Phase</span></tt>）を指定します。以下に例を示します:</p>
<pre class="literal-block">
@Invoke(Phase.PAGECOMPONENT_CREATED)
public void initialize() {
    ...
}
</pre>
<p>フェーズには以下のものがあります。</p>
<table border="1" class="docutils">
<colgroup>
<col width="35%" />
<col width="65%" />
</colgroup>
<thead valign="bottom">
<tr>
<th>フェーズ名</th>
<th>説明</th>
</tr>
</thead>
<tbody valign="top">
<tr>
<td>PAGECOMPONENT_CREATED</td>
<td>Pageコンポーネントの生成直後（1.の直後）</td>
</tr>
<tr>
<td>SCOPEOBJECT_INJECTING</td>
<td>スコープオブジェクトのインジェクション処理の前（5.の直前）</td>
</tr>
<tr>
<td>ACTION_INVOKING</td>
<td>アクションの実行前（6.の直前）</td>
</tr>
<tr>
<td>ACTION_INVOKED</td>
<td>アクションの実行後（8.の直後）</td>
</tr>
<tr>
<td>SCOPEOBJECT_OUTJECTING</td>
<td>スコープオブジェクトのアウトジェクション処理の前（10.の直前）</td>
</tr>
<tr>
<td>SCOPEOBJECT_OUTJECTED</td>
<td>スコープオブジェクトのアウトジェクション処理の後（10.の直後）</td>
</tr>
</tbody>
</table>
<p>Invokeアノテーションをつけるメソッドは、引数がないメソッドである必要があります。またメソッドが返り値を持つ場合、返り値は無視されます。</p>
</div>
</div>
</div>
</div>
        </div>
      
    </div>
    </div>
    <div class="footer-delimiter"></div>
    <div id="pane.footer" class="pane footer">
      <div id="org.seasar.kvasir.cms.pop.poweredByPop-1" class="pop org.seasar.kvasir.cms.pop.poweredByPop">
        <div class="body">Powered by Kvasir/Sora</div>
      </div>
    </div>
  </body>
</html>
