Seam ページアクションはページのレンダリング直前に発生するイベントです。 ページアクションは WEB-INF/pages.xml で宣言します。 特定の JSF ビュー id に対してページアクションを定義することができます。

<pages>
    <page view-id="/hello.jsp" action="#{helloWorld.sayHello}"/>
</pages>

あるいは、 ワイルドカードを使ってパターンに一致するすべてのビュー ID に適用されるアクションを指定することもできます。

<pages>
    <page view-id="/hello/*" action="#{helloWorld.sayHello}"/>
</pages>

現在のビュー ID に一致するページアクションがワイルドカードを使って指定すると複数ある場合、 Seam は曖昧な指定から明確な指定への順でそれらすべてのアクションを呼び出します。

ページアクションのメソッドは JSF outcome を返すことができます。 その outcome が null 以外の場合、 Seam はビューのナビゲートに定義済みナビゲーション規則を使用します。

さらに、 <page> 要素で指定されたビュー id は実際の JSP や Facelets ページに対応する必要がありません。 このため、 ページアクションを使用した Struts や WebWork のような従来のアクション指向フレームワークの機能を再現することができます。

TODO: translate struts action into page action

non-facesリクエスト (たとえば、 HTTP Get リクエスト) に対するレスポンスで複雑な処理をしたい場合などに非常に便利です。

<pages>
    <page view-id="/hello.jsp" action="#{helloWorld.sayHello}">
        <param name="firstName" value="#{person.firstName}"/>
        <param name="lastName" value="#{person.lastName}"/>
    </page>
</pages>

<pages>
    <page view-id="/hello.jsp">
        <param name="firstName" value="#{person.firstName}"/>
        <param name="lastName" value="#{person.lastName}"/>
    </page>
</pages>

<pages>
    <page view-id="/calculator.jsp" action="#{calculator.calculate}">
        <param name="x" value="#{calculator.lhs}"/>
        <param name="y" value="#{calculator.rhs}"/>
        <param name="op" converterId="com.my.calculator.OperatorConverter" value="#{calculator.op}"/>
    </page>
</pages>

<pages>
    <page view-id="/calculator.jsp" action="#{calculator.calculate}">
        <param name="x" value="#{calculator.lhs}"/>
        <param name="y" value="#{calculator.rhs}"/>
        <param name="op" converter="#{operatorConverter}" value="#{calculator.op}"/>
    </page>
</pages>

<navigation-rule>
    <from-view-id>/editDocument.xhtml</from-view-id>
    
    <navigation-case>
        <from-action>#{documentEditor.update}</from-action>
        <from-outcome>success</from-outcome>
        <to-view-id>/viewDocument.xhtml</to-view-id>
        <redirect/>
    </navigation-case>
    
</navigation-rule>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <rule if-outcome="success">
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}" 
                   evaluate="#{documentEditor.errors.size}">
        <rule if-outcome="0">
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <end-conversation/>
            <redirect view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <end-conversation/>
            <render view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <rule if="#{documentEditor.errors.empty}">
            <end-conversation/>
            <redirect view-id="/viewDocument.xhtml">
                <param name="documentId" value="#{documentEditor.documentId}"/>
            </redirect>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <rule>
            <render view-id="/viewDocument.xhtml"/>
        </rule>
    </navigation>
    
</page>

<page view-id="/editDocument.xhtml">
    
    <navigation from-action="#{documentEditor.update}">
        <render view-id="/viewDocument.xhtml"/>
    </navigation>
    
</page>

<page action="#{calculator.calculate}">
    <param name="x" value="#{calculator.lhs}"/>
    <param name="y" value="#{calculator.rhs}"/>
    <param name="op" converter="#{operatorConverter}" value="#{calculator.op}"/>
</page>

Seam コンポーネント同士は互いのメソッドを呼ぶだけでやりとりができます。 ステートフルコンポーネントは observer/observable パターンを実装することすらできます。 しかし、 コンポーネントが互いにメソッドを直接呼ぶときより疎結合な方法でやりとりできるようにするためには、 Seam はコンポーネント駆動イベントを提供します。

イベントリスナー (observers) を components.xml で指定します。

<components>
    <event type="hello">
        <action expression="#{helloListener.sayHelloBack}"/>
        <action expression="#{logger.logHello}"/>
    </event>
</components>

ここで event type は単なる任意の文字列です。

イベントが発生すると、 そのイベント用に登録されたアクションは components.xml に出現した順番で呼び出されます。 コンポーネントはどのようにイベントを発行するのでしょうか？ Seam はこのために組み込みコンポーネントを提供します。

@Name("helloWorld")
public class HelloWorld {
    public void sayHello() {
        FacesMessages.instance().add("Hello World!");
        Events.instance().raiseEvent("hello");
    }
}

あるいは、 アノテーションを使うことも可能です。

@Name("helloWorld")
public class HelloWorld {
    @RaiseEvent("hello")
    public void sayHello() {
        FacesMessages.instance().add("Hello World!");
    }
}

このイベント供給側はイベント消費側になんら依存していないことに注意してください。 これでまったく供給側と依存関係がないようにイベントリスナーを実装することが可能になります。

@Name("helloListener")
public class HelloListener {
    public void sayHelloBack() {
        FacesMessages.instance().add("Hello to you too!");
    }
}

上述の components.xml に定義されるメソッドバインディングは消費者側にイベントのマッピングを行います。 components.xml ファイル内をいじくり回したくない場合、 代わりにアノテーションを使うことができます。

@Name("helloListener")
public class HelloListener {
    @Observer("hello")
    public void sayHelloBack() {
        FacesMessages.instance().add("Hello to you too!");
    }
}

ここでイベントオブジェクトに関してまったく言及していないことに疑問を抱く方もいらっしゃることでしょう。 Seam では、 イベント供給側とリスナー間で状態を伝播するイベントオブジェクトは必要はありません。 状態は Seam コンテキスト上に保持され、 コンポーネント間で共有されます。 しかしながら、 どうしてもイベントオブジェクトを渡したい場合は、 次のように行うことができます。

@Name("helloWorld")
public class HelloWorld {
    private String name;
    public void sayHello() {
        FacesMessages.instance().add("Hello World, my name is #0.", name);
        Events.instance().raiseEvent("hello", name);
    }
}

@Name("helloListener")
public class HelloListener {
    @Observer("hello")
    public void sayHelloBack(String name) {
        FacesMessages.instance().add("Hello #0!", name);
    }
}

Seam は特殊な種類のフレームワーク統合を実現するためにアプリケーションが利用できる組み込みイベントを定義します。 そのイベントとは次のようなものです。

Seam コンポーネントは、 他のコンポーネント駆動イベントを監視するのとまったく同じようにこれらのいずれのイベントも監視することができます。

Bean のビジネスメソッドによって例外がスローされると、 その例外は現在のトランザクションに直ちにロールバックが必要として印を付けるかどうかを制御できるよう明確な規則を EJB は定義しています。 システム例外 は常にトランザクションロールバックとなり、 アプリケーション例外 はデフォルトではロールバックとはなりませんが @ApplicationException(rollback=true) が指定されるとロールバックとなります。 (アプリケーション例外とは、 チェックの付いた例外、 または @ApplicationException アノテーションが付いたチェックのない例外です。 システム例外とは、 @ApplicationException アノテーションが付いていずチェックも付いていない例外です。)

ロールバック用にトランザクションに印を付けるのと、 実際にロールバックを行うのとは異なります。 例外規則にはトランザクションにロールバックが必要であると印が付けられることだけしか言及していませんが、 例外がスローされた後でもそれはアクティブのままである可能性があるということに注意してください。

Seam は EJB 3.0 例外のロールバック規則を Seam JavaBean コンポーネントに対しても適用します。

しかし、 これらの規則は Seam コンポーネント層でのみ適用されるます。 では、 例外がキャッチされることなく Seam コンポーネント層の外部に伝播し、 さらに JSF 層の外に伝播したらどうなるでしょうか。 宙ぶらりんのトランザクションをオープンしたままで放置するのは間違いなので、 例外が発生し Seam コンポーネント層でキャッチされないと Seam はアクティブトランザクションを必ずロールバックします。

Seam の例外処理を有効にするには、 web.xml にマスターとなるサーブレットフィルターが宣言されていることを確認する必要があります。

<filter>
    <filter-name>Seam Filter</filter-name>
    <filter-class>org.jboss.seam.servlet.SeamFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>Seam Filter</filter-name>
    <url-pattern>*.seam</url-pattern>
</filter-mapping>

ご使用の例外ハンドラを機能させる場合は、 web.xml の Facelets 開発モードおよび components.xml の Seam デバッグモードも無効にする必要があります。

次の例外は Seam コンポーネント層の外部に伝播すると必ず HTTP 404 エラーになります。 スローされてもすぐには現在のトランザクションをロールバックしませんが、 別の Seam コンポーネントによって例外がキャッチされないとこのトランザクションはロールバックされます。

@HttpError(errorCode=404)
public class ApplicationException extends Exception { ... }

この例外は Seam コンポーネント層の外部に伝播すると必ずブラウザリダイレクトになります。 また、 現在の対話も終了させます。 これにより現在のトランザクションを即時ロールバックさせることになります。

@Redirect(viewId="/failure.xhtml", end=true)
@ApplicationException(rollback=true)
public class UnrecoverableApplicationException extends RuntimeException { ... }

@Redirect は JSF ライフサイクルのレンダリングフェーズ中に発生した例外に対しては動作しないので注意してください。

この例外は Seam コンポーネント層の外部に伝播すると必ずユーザへのメッセージを付けてリダイレクトされます。 また、 現在のトランザクションも即時ロールバックさせます。

@Redirect(viewId="/error.xhtml", message="Unexpected error")
public class SystemException extends RuntimeException { ... }

興味を持っている例外クラスすべてに対してアノテーションを付加することはできないので、 Seam は pages.xml でこの機能を指定できるようにしています。

<pages>
   
   <exception class="javax.persistence.EntityNotFoundException">
      <http-error error-code="404"/>
   </exception>
   
   <exception class="javax.persistence.PersistenceException">
      <end-conversation/>
      <redirect view-id="/error.xhtml">
          <message>Database access failed</message>
      </redirect>
   </exception>
   
   <exception>
      <end-conversation/>
      <redirect view-id="/error.xhtml">
          <message>Unexpected failure</message>
      </redirect>
   </exception>
   
</pages>

最後の <exception> 宣言はクラスを指定していないので、 アノテーションまたは pages.xml で指定されているもの以外すべての例外をキャッチします。

EL によってキャッチした例外インスタンスにアクセスすることができます。 Seamはそれを対話コンテキストに置きます。例外のメッセージにアクセスする例は次の通り。

...
throw new AuthorizationException("You are not allowed to do this!");

<pages>

    <exception class="org.jboss.seam.security.AuthorizationException">
        <end-conversation/>
        <redirect view-id="/error.xhtml">
            <message severity="WARN">#{handledException.message}</message>
        </redirect>
    </exception>

</pages>