最初に、$ANT_HOME と $JAVA_HOME が正しく設定され、 Ant が正しくインストールされたことを確認してください。 次に、Seam をインストールしたルートフォルダにある build.properties ファイルに JBoss AS 4.0.5 のロケーションを設定してください。 まだ起動していなければ、 JBoss のルートディレクトリから bin/run.sh もしくは、bin/run.bat とタイプして JBoss アプリケーションサーバを起動してください。

さあ、examples/registration ディレクトリから、 ant deploy とタイプしてサンプルのビルド、デプロイを行いましょう。

ブラウザから、 http://localhost:8080/seam-registration/ に、 アクセスしてみましょう。

最初に、$ANT_HOME と $JAVA_HOME が正しく設定され、 Ant が正しくインストールされたことを確認してください。 次に、Seam をインストールしたルートフォルダにある build.properties ファイルに Tomcat 5.5 のロケーションを設定してください。

さあ、examples/registration ディレクトリから、 ant deploy とタイプしてサンプルのビルド、デプロイを行いましょう。

最後に、Tomcat を起動してください。

ブラウザから、 http://localhost:8080/jboss-seam-registration/ にアクセスしてみましょう。

サンプルを Tomcat にデプロイした場合、 EJB3 コンポーネントは、JBoss 組み込み EJB3 コンテナ (完全なスタンドアローン EJB コンテナ環境) 内部で作動します。

ほとんどのサンプルは TestNG 統合テストスイートに対応しています。 一番簡単なテスト実行は、 examples/registration ディレクトリから、 ant testexample として起動させてください。 また、お使いの IDE から TestNG プラグインを利用してテスト実行することも可能です。

このサンプルは、2 つの JSP ページ、1 つのエンティティ Bean と、1 つのステートレスセッション Bean で実装されています。

基本から始めるために、コードを見てみましょう。

@Entity                                                                                  (1)
@Name("user")                                                                            (2)
@Scope(SESSION)                                                                          (3)
@Table(name="users")                                                                     (4)
public class User implements Serializable
{
   private static final long serialVersionUID = 1881413500711441951L;
   
   private String username;                                                              (5)
   private String password;
   private String name;
   
   public User(String name, String password, String username)
   {
      this.name = name;
      this.password = password;
      this.username = username;
   }
   
   public User() {}                                                                      (6)
   
   @NotNull @Length(min=5, max=15)                                                       (7)
   public String getPassword()
   {
      return password;
   }

   public void setPassword(String password)
   {
      this.password = password;
   }
   
   @NotNull
   public String getName()
   {
      return name;
   }

   public void setName(String name)
   {
      this.name = name;
   }
   
   @Id @NotNull @Length(min=5, max=15)                                                   (8)
   public String getUsername()
   {
      return username;
   }

   public void setUsername(String username)
   {
      this.username = username;
   }

}

@Stateless                                                                               (1)
@Name("register")
public class RegisterAction implements Register
{

   @In                                                                                   (2)
   private User user;
   
   @PersistenceContext                                                                   (3)
   private EntityManager em;
   
   @Logger                                                                               (4)
   private Log log;
   
   public String register()                                                              (5)
   {
      List existing = em.createQuery(
         "select username from User where username=#{user.username}")                    (6)
         .getResultList();
         
      if (existing.size()==0)
      {
         em.persist(user);
         log.info("Registered new user #{user.username}");                               (7)
         return "/registered.jsp";                                                       (8)
      }
      else
      {
         FacesMessages.instance().add("User #{user.username} already exists");           (9)
         return null;
      }
   }

}

@Local
public interface Register
{
   public String register();
}

<components xmlns="http://jboss.com/products/seam/components"
            xmlns:core="http://jboss.com/products/seam/core">
     <core:init jndi-pattern="@jndiPattern@"/>
</components>

<?xml version="1.0" encoding="UTF-8"?>
<web-app version="2.5"
    xmlns="http://java.sun.com/xml/ns/javaee"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://java.sun.com/xml/ns/javaee 
                        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">

    <!-- Seam -->

    <listener>
        <listener-class>org.jboss.seam.servlet.SeamListener</listener-class>
    </listener>

    <!-- MyFaces -->

    <listener>
        <listener-class>
            org.apache.myfaces.webapp.StartupServletContextListener
        </listener-class>
    </listener>

    <context-param>
        <param-name>javax.faces.STATE_SAVING_METHOD</param-name>
        <param-value>client</param-value>
    </context-param>

    <servlet>
        <servlet-name>Faces Servlet</servlet-name>
        <servlet-class>javax.faces.webapp.FacesServlet</servlet-class>
        <load-on-startup>1</load-on-startup>
    </servlet>

    <!-- Faces Servlet Mapping -->
    <servlet-mapping>
        <servlet-name>Faces Servlet</servlet-name>
        <url-pattern>*.seam</url-pattern>
    </servlet-mapping>

</web-app>

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE faces-config 
PUBLIC "-//Sun Microsystems, Inc.//DTD JavaServer Faces Config 1.0//EN"
                            "http://java.sun.com/dtd/web-facesconfig_1_0.dtd">
<faces-config>

    <!-- A phase listener is needed by all Seam applications -->
    
    <lifecycle>
        <phase-listener>org.jboss.seam.jsf.SeamPhaseListener</phase-listener>
    </lifecycle>

</faces-config>

<ejb-jar xmlns="http://java.sun.com/xml/ns/javaee" 
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/ejb-jar_3_0.xsd"
         version="3.0">
         
   <interceptors>
     <interceptor>
       <interceptor-class>org.jboss.seam.ejb.SeamInterceptor</interceptor-class>
     </interceptor>
   </interceptors>
   
   <assembly-descriptor>
      <interceptor-binding>
         <ejb-name>*</ejb-name>
         <interceptor-class>org.jboss.seam.ejb.SeamInterceptor</interceptor-class>
      </interceptor-binding>
   </assembly-descriptor>
   
</ejb-jar>

<?xml version="1.0" encoding="UTF-8"?>
<persistence xmlns="http://java.sun.com/xml/ns/persistence" 
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd" 
             version="1.0">
    <persistence-unit name="userDatabase">
      <provider>org.hibernate.ejb.HibernatePersistence</provider>
      <jta-data-source>java:/DefaultDS</jta-data-source>
      <properties>
         <property name="hibernate.hbm2ddl.auto" value="create-drop"/>
      </properties>
    </persistence-unit>
</persistence>

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<%@ taglib uri="http://jboss.com/products/seam/taglib" prefix="s" %>
<html>
 <head>
  <title>Register New User</title>
 </head>
 <body>
  <f:view>
   <h:form>
     <table border="0">
       <s:validateAll>
         <tr>
           <td>Username</td>
           <td><h:inputText value="#{user.username}"/></td>
         </tr>
         <tr>
           <td>Real Name</td>
           <td><h:inputText value="#{user.name}"/></td>
         </tr>
         <tr>
           <td>Password</td>
           <td><h:inputSecret value="#{user.password}"/></td>
         </tr>
       </s:validateAll>
     </table>
     <h:messages/>
     <h:commandButton type="submit" value="Register" action="#{register.register}"/>
   </h:form>
  </f:view>
 </body>
</html>

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<html>
 <head>
  <title>Successfully Registered New User</title>
 </head>
 <body>
  <f:view>
    Welcome, <h:outputText value="#{user.name}"/>, 
    you are successfully registered as <h:outputText value="#{user.username}"/>.
  </f:view>
 </body>
</html>

<?xml version="1.0" encoding="UTF-8"?>
<application xmlns="http://java.sun.com/xml/ns/javaee" 
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/application_5.xsd"
             version="5">
             
    <display-name>Seam Registration</display-name>

    <module>
        <web>
            <web-uri>jboss-seam-registration.war</web-uri>
            <context-root>/seam-registration</context-root>
        </web>
    </module>
    <module>
        <ejb>jboss-seam-registration.jar</ejb>
    </module>
    <module>
        <java>jboss-seam.jar</java>
    </module>
    <module>
        <java>el-api.jar</java>
    </module>
    <module>
        <java>el-ri.jar</java>
    </module>
    
</application>

エンタープライズアプリケーション中のすべてのファイルを見終わりました。

フォームがサブミットされたとき、 JSF は、Seam に user という名前の変数を解決するよう要求します。 その名前にバインドされた値が存在しないため (どの Seam コンテキストにも)、 Seam は、user コンポーネントをインスタンス化し、 それを Seam セッションコンテキストに保管した後に、 User エンティティ Bean インスタンスを JSF に返します。

フォームの入力値は、 User エンティティで指定された Hibernate バリデータ制約に対応したデータ整合性検証されます。 制約に違反した場合、 JSF は、ページを再表示します。 そうでない場合、 JSF は、フォームの入力値を User エンティティ Bean のプロパティにバインドします。

次に、JSF は Seam に変数名 register の解決を要求します。 Seam は、ステートレスコンテキスト中の RegisterAction ステートレスセッション Bean を見つけ、 それを返します。 JSF は、register() アクションリスナメソッドを呼び出します。

Seam は、メソッド呼び出しをインターセプトし、呼び出しが進む前に、 Seam セッションコンテキストから User エンティティをインジェクトします。

register() メソッドは、 入力されたユーザ名が既に存在するかどうかを調べます。 存在した場合、エラーメッセージは、 FacesMessages コンポーネントにキューイングされ、 そして、null 結果 (outcome) が返され、ページが再表示されます。 FacesMessages コンポーネントは、 メッセージストリングに組み込まれた JSF 式を補完し、 view に JSF FacesMessage を追加します。

そのユーザ名のユーザが存在しない場合、 registered.jsp ページにブラウザリダイレクトする "/registered.jsp" 結果 (outcome) を発生させます。 JSF ページをレンダリングするとき、 Seam に、user という名前の変数の解決を要求し、 Seam のセッションスコープから返された User エンティティのプロパティ値を使用します。

この掲示板サンプルは、 1 つのエンティティ Bean である Message、 1 つのセッション Bean である MessageListBean、 そして 1 つの JSP から構成されています。

@Entity
@Name("message")
@Scope(EVENT)
public class Message implements Serializable
{
   private Long id;
   private String title;
   private String text;
   private boolean read;
   private Date datetime;
   
   @Id @GeneratedValue
   public Long getId() {
      return id;
   }
   public void setId(Long id) {
      this.id = id;
   }
   
   @NotNull @Length(max=100)
   public String getTitle() {
      return title;
   }
   public void setTitle(String title) {
      this.title = title;
   }
   
   @NotNull @Lob
   public String getText() {
      return text;
   }
   public void setText(String text) {
      this.text = text;
   }
   
   @NotNull
   public boolean isRead() {
      return read;
   }
   public void setRead(boolean read) {
      this.read = read;
   }
   
   @NotNull 
   @Basic @Temporal(TemporalType.TIMESTAMP)
   public Date getDatetime() {
      return datetime;
   }
   public void setDatetime(Date datetime) {
      this.datetime = datetime;
   }
   
}

@Stateful
@Scope(SESSION)
@Name("messageManager")
public class MessageManagerBean implements Serializable, MessageManager
{

   @DataModel                                                                            (1)
   private List<Message> messageList;
   
   @DataModelSelection                                                                   (2)
   @Out(required=false)                                                                  (3)
   private Message message;
   
   @PersistenceContext(type=EXTENDED)                                                    (4)
   private EntityManager em;
   
   @Factory("messageList")                                                               (5)
   public void findMessages()
   {
      messageList = em.createQuery("from Message msg order by msg.datetime desc").getResultList();
   }
   
   public void select()                                                                  (6)
   {
      message.setRead(true);
   }
   
   public void delete()                                                                  (7)
   {
      messageList.remove(message);
      em.remove(message);
      message=null;
   }
   
   @Remove @Destroy                                                                      (8)
   public void destroy() {}

}

@Local
public interface MessageManager
{
   public void findMessages();
   public void select();
   public void delete();
   public void destroy();
}

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<html>
 <head>
  <title>Messages</title>
 </head>
 <body>
  <f:view>
   <h:form>
     <h2>Message List</h2>
     <h:outputText value="No messages to display" rendered="#{messageList.rowCount==0}"/>
     <h:dataTable var="msg" value="#{messageList}" rendered="#{messageList.rowCount>0}">
        <h:column>
           <f:facet name="header">
              <h:outputText value="Read"/>
           </f:facet>
           <h:selectBooleanCheckbox value="#{msg.read}" disabled="true"/>
        </h:column>
        <h:column>
           <f:facet name="header">
              <h:outputText value="Title"/>
           </f:facet>
           <h:commandLink value="#{msg.title}" action="#{messageManager.select}"/>
        </h:column>
        <h:column>
           <f:facet name="header">
              <h:outputText value="Date/Time"/>
           </f:facet>
           <h:outputText value="#{msg.datetime}">
              <f:convertDateTime type="both" dateStyle="medium" timeStyle="short"/>
           </h:outputText>
        </h:column>
        <h:column>
           <h:commandButton value="Delete" action="#{messageManager.delete}"/>
        </h:column>
     </h:dataTable>
     <h3><h:outputText value="#{message.title}"/></h3>
     <div><h:outputText value="#{message.text}"/></div>
   </h:form>
  </f:view>
 </body>
</html>

最初に、 messages.jsp ページに画面遷移させるとき、 JSF ポストバック (faces リクエスト) でも、 ブラウザからの直接的な GET リクエスト (non-faces リクエスト) でも、 ページは、messageList コンテキスト変数を解決しようと試みます。 このコンテキスト変数は、初期化されていないため、 Seam は、ファクトリーメソッド findMessages()を呼び出します。 それは、データベースにクエリー発行や、 アウトジェクト (outject) された DataModel の結果取得を行います。 この DataModel は、 <h:dataTable> をレンダリングするために必要な行データを提供します。

ユーザが <h:commandLink> をクリックしたとき、 JSF は、select() アクションリスナを呼び出します。 Seam は、この呼び出しをインターセプトし、 選択された行データを messageManager コンポーネントの message 属性にインジェクトします。 選択された Message を既読にマークし、アクションリスナは実行されます。 呼び出しの終わりに、 Seam は、選択された Message を message という名前のコンテキスト変数にアウトジェクトします。 次に、EJB コンテナは、トランザクションをコミットし、 Message の変更は、データベースにフラッシュされます。 最後に、このページは、再レンダリングされ、 メッセージリストの再表示とその下に選択されたメッセージ表示を行います。

ユーザが <h:commandButton> をクリックしたとき、 JSF は、delete() アクションリスナを呼び出します。 Seam は、この呼び出しをインターセプトし、 選択された行データを messageList コンポーネントの message 属性にインジェクトします。 選択された Message がリストから削除され、 EntityManager の remove() が呼ばれるとき、 アクションリスナは、実行します。 呼び出しの終わりに、 Seam は、messageList コンテキスト変数を更新し、 message という名前のコンテキスト変数をクリアします。 EJB コ ンテナは、トランザクションをコミットし、 データベースから Message を削除します。 最後に、このページは、再レンダリングされ、メッセージリストを再表示します。

このサンプルの中心は、jBPM のプロセス定義です。 2 つの JSP と 2 つのちょっとした JavaBean もあります。 (データベースアクセスやトランザクション特性がないので、 セッション Bean を使用する理由はありません。) それではプロセス定義から始めましょう。

<process-definition name="todo">
   
   <start-state name="start">                                                            (1)
      <transition to="todo"/>
   </start-state>
   
   <task-node name="todo">                                                               (2)
      <task name="todo" description="#{todoList.description}">                           (3)
         <assignment actor-id="#{actor.id}"/>                                            (4)
      </task>
      <transition to="done"/>
   </task-node>
   
   <end-state name="done"/>                                                              (5)
   
</process-definition>

JBossIDE に提供されたプロセス定義エディタを使用してプロセス定義を見た場合、 以下のようになります。

このドキュメントは、ノードのグラフとして ビジネスプロセス を定義します。 これはささいな現実にあり得るビジネスプロセスです。 実行されなければならない タスク は、1 つだけです。 タスクが完了したとき ビジネスプロセスは終了します。

最初の JavaBean は、ログイン画面 login.jsp を扱います。 その仕事は、actor コンポーネントを使用して jBPM actor id を初期化するだけです。 (実際のアプリケーションでは、ユーザ認証も必要です。)

@Name("login")
public class Login {
   
   @In
   private Actor actor;
   
   private String user;

   public String getUser() {
      return user;
   }

   public void setUser(String user) {
      this.user = user;
   }
   
   public String login()
   {
      actor.setId(user);
      return "/todo.jsp";
   }
}

ここでは、組み込み Actor コンポーネントをインジェクトするために、 @In を使用しているのがわかります。

次のJSPは取るに足らないものです。

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<html>
<head>
<title>Login</title>
</head>
<body>
<h1>Login</h1>
<f:view>
    <h:form>
      <div>
        <h:inputText value="#{login.user}"/>
        <h:commandButton value="Login" action="#{login.login}"/>
      </div>
    </h:form>
</f:view>
</body>
</html>

2 つめの JavaBean は、ビジネスプロセスインスタンスの開始とタスクの終了を担当します。

@Name("todoList")
public class TodoList {
   
   private String description;
   
   public String getDescription()                                                        (1)
   {
      return description;
   }

   public void setDescription(String description) {
      this.description = description;
   }
   
   @CreateProcess(definition="todo")                                                     (2)
   public void createTodo() {}
   
   @StartTask @EndTask                                                                   (3)
   public void done() {}

}

より現実的なサンプルでは、 @StartTask と @EndTask は同じメソッドの上には登場しません。 なぜなら、通常、タスクを完了するために、アプリケーションを使用して行われる仕事があるからです。

最後に、このアプリケーションのポイントは todo.jsp にあります。

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h" %>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f" %>
<%@ taglib uri="http://jboss.com/products/seam/taglib" prefix="s" %>
<html>
<head>
<title>Todo List</title>
</head>
<body>
<h1>Todo List</h1>
<f:view>
   <h:form id="list">
      <div>
         <h:outputText value="There are no todo items." rendered="#{empty taskInstanceList}"/>
         <h:dataTable value="#{taskInstanceList}" var="task" rendered="#{not empty taskInstanceList}">
            <h:column>
                <f:facet name="header">
                    <h:outputText value="Description"/>
                </f:facet>
                <h:inputText value="#{task.description}"/>
            </h:column>
            <h:column>
                <f:facet name="header">
                    <h:outputText value="Created"/>
                </f:facet>
                <h:outputText value="#{task.taskMgmtInstance.processInstance.start}">
                    <f:convertDateTime type="date"/>
                </h:outputText>
            </h:column>
            <h:column>
                <f:facet name="header">
                    <h:outputText value="Priority"/>
                </f:facet>
                <h:inputText value="#{task.priority}" style="width: 30"/>
            </h:column>
            <h:column>
                <f:facet name="header">
                    <h:outputText value="Due Date"/>
                </f:facet>
                <h:inputText value="#{task.dueDate}" style="width: 100">
                    <f:convertDateTime type="date" dateStyle="short"/>
                </h:inputText>
            </h:column>
            <h:column>
                <s:button value="Done" action="#{todoList.done}" taskInstance="#{task}"/>
            </h:column>
         </h:dataTable>
      </div>
      <div>
      <h:messages/>
      </div>
      <div>
         <h:commandButton value="Update Items" action="update"/>
      </div>
   </h:form>
   <h:form id="new">
      <div>
         <h:inputText value="#{todoList.description}"/>
         <h:commandButton value="Create New Item" action="#{todoList.createTodo}"/>
      </div>
   </h:form>
</f:view>
</body>
</html>

1 つずつ取り出しましょう。

ページはタスクリストをレンダリングしています。 これは、taskInstanceList と呼ばれる Seam 組み込みコンポーネントから取得します。 このリストはJSFフォームの中に定義されています。

<h:form id="list">
   <div>
      <h:outputText value="There are no todo items." rendered="#{empty taskInstanceList}"/>
      <h:dataTable value="#{taskInstanceList}" var="task" rendered="#{not empty taskInstanceList}">
         ...
      </h:dataTable>
   </div>
</h:form>

リストの各要素は jBPM クラス TaskInstance のインスタンスです。 以下のコードは単に、リスト中の各タスクの興味深いプロパティを表示しています。 記述内容、 優先順や、 納期の値については、 ユーザーがこれらの値を更新できるよう入力コントロールを使用します。

<h:column>
    <f:facet name="header">
       <h:outputText value="Description"/>
    </f:facet>
    <h:inputText value="#{task.description}"/>
</h:column>
<h:column>
    <f:facet name="header">
        <h:outputText value="Created"/>
    </f:facet>
    <h:outputText value="#{task.taskMgmtInstance.processInstance.start}">
        <f:convertDateTime type="date"/>
    </h:outputText>
</h:column>
<h:column>
    <f:facet name="header">
        <h:outputText value="Priority"/>
    </f:facet>
    <h:inputText value="#{task.priority}" style="width: 30"/>
</h:column>
<h:column>
    <f:facet name="header">
        <h:outputText value="Due Date"/>
    </f:facet>
    <h:inputText value="#{task.dueDate}" style="width: 100">
        <f:convertDateTime type="date" dateStyle="short"/>
    </h:inputText>
</h:column>

このボタンは、 @StartTask @EndTask アノテーション付きのアクションメソッドが呼び出されることにより終了します。 それは、task id をリクエストパラメータとして Seam に渡します。

<h:column>
    <s:button value="Done" action="#{todoList.done}" taskInstance="#{task}"/>
</h:column>

(seam-ui.jar パッケージから、 Seam <s:button> JSF コントロールを使用していることに留意してください。)

このボタンは、 タスクのプロパティを変更するために使用されます。 フォームがサブミットされたとき、 Seam と jBPM は、タスクに対するどのような変化も永続化します。 アクションリスナメソッドは全く不要です。

<h:commandButton value="Update Items" action="update"/>

ページの 2 つ目のフォームは新しいアイテムを作成するために使用されます。 @CreateProcessアノテーション付きアクションメソッドから呼び出されることにより行われます。

<h:form id="new">
    <div>
        <h:inputText value="#{todoList.description}"/>
        <h:commandButton value="Create New Item" action="#{todoList.createTodo}"/>
    </div>
</h:form>

このサンプルには、その他いくつか必要なファイルがありますが、 それらは 標準的な jBPM や Seam の設定であり特殊なものはありません。

TODO

このサンプルは 1 つのJavaBean、3 つの JSP ページ、それと jPDL プロセスフロー定義で実装されています。 ページフローから見始めましょう。

<pageflow-definition name="numberGuess">
   
   <start-page name="displayGuess" view-id="/numberGuess.jsp">
      <redirect/>
      <transition name="guess" to="evaluateGuess">
          <action expression="#{numberGuess.guess}" />
      </transition>                                                                      (1)
   </start-page>                                                                         (2)
                                                                                         (3)
   <decision name="evaluateGuess" expression="#{numberGuess.correctGuess}">
      <transition name="true" to="win"/>
      <transition name="false" to="evaluateRemainingGuesses"/>
   </decision>                                                                           (4)
   
   <decision name="evaluateRemainingGuesses" expression="#{numberGuess.lastGuess}">
      <transition name="true" to="lose"/>
      <transition name="false" to="displayGuess"/>
   </decision>
   
   <page name="win" view-id="/win.jsp">
      <redirect/>
      <end-conversation />
   </page>
   
   <page name="lose" view-id="/lose.jsp">
      <redirect/>
      <end-conversation />
   </page>
   
</pageflow-definition>

JBossIDE ページフローエディタでのページフローは以下のようになります。

ページフローを見終わりました。 アプリケーションの残りの部分を理解することはもう簡単です。

これはアプリケーションの主要なページ numberGuess.jsp です。

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<html>
<head>
<title>Guess a number...</title>
</head>
<body>
<h1>Guess a number...</h1>
<f:view>
    <h:form>
        <h:outputText value="Higher!" rendered="#{numberGuess.randomNumber>numberGuess.currentGuess}" />
        <h:outputText value="Lower!" rendered="#{numberGuess.randomNumber<numberGuess.currentGuess}" />
        <br />
        I'm thinking of a number between <h:outputText value="#{numberGuess.smallest}" /> and 
        <h:outputText value="#{numberGuess.biggest}" />. You have 
        <h:outputText value="#{numberGuess.remainingGuesses}" /> guesses.
        <br />
        Your guess: 
        <h:inputText value="#{numberGuess.currentGuess}" id="guess" required="true">
            <f:validateLongRange
                maximum="#{numberGuess.biggest}" 
                minimum="#{numberGuess.smallest}"/>
        </h:inputText>
        <h:commandButton type="submit" value="Guess" action="guess" />
        <br/>
        <h:message for="guess" style="color: red"/>
    </h:form>
</f:view>
</body>
</html>

アクションを直接呼び出す代わりに、 どのようにコマンドボタンはguess transitionを指定しているかに着目してください。

win.jsp ページはごく普通のものです。

<%@ taglib uri="http://java.sun.com/jsf/html" prefix="h"%>
<%@ taglib uri="http://java.sun.com/jsf/core" prefix="f"%>
<html>
<head>
<title>You won!</title>
</head>
<body>
<h1>You won!</h1>
<f:view>
    Yes, the answer was <h:outputText value="#{numberGuess.currentGuess}" />.
    It took you <h:outputText value="#{numberGuess.guessCount}" /> guesses.
    Would you like to <a href="numberGuess.seam">play again</a>?
  </f:view>
</body>
</html>

lose.jsp も同様です。 (コピー&ペーストができないのは困りますが) 最後は、JavaBean Seam コンポーネントです。

@Name("numberGuess")
@Scope(ScopeType.CONVERSATION)
public class NumberGuess {
   
   private int randomNumber;
   private Integer currentGuess;
   private int biggest;
   private int smallest;
   private int guessCount;
   private int maxGuesses;
   
   @Create                                                                               (1)
   @Begin(pageflow="numberGuess")                                                        (2)
   public void begin()
   {
      randomNumber = new Random().nextInt(100);
      guessCount = 0;
      biggest = 100;
      smallest = 1;
   }
   
   public void setCurrentGuess(Integer guess)
   {
      this.currentGuess = guess;
   }
   
   public Integer getCurrentGuess()
   {
      return currentGuess;
   }
   
   public void guess()
   {
      if (currentGuess>randomNumber)
      {
         biggest = currentGuess - 1;
      }
      if (currentGuess<randomNumber)
      {
         smallest = currentGuess + 1;
      }
      guessCount ++;
   }
   
   public boolean isCorrectGuess()
   {
      return currentGuess==randomNumber;
   }
   
   public int getBiggest()
   {
      return biggest;
   }
   
   public int getSmallest()
   {
      return smallest;
   }
   
   public int getGuessCount()
   {
      return guessCount;
   }
   
   public boolean isLastGuess()
   {
      return guessCount==maxGuesses;
   }

   public int getRemainingGuesses() {
      return maxGuesses-guessCount;
   }

   public void setMaxGuesses(int maxGuesses) {
      this.maxGuesses = maxGuesses;
   }

   public int getMaxGuesses() {
      return maxGuesses;
   }

   public int getRandomNumber() {
      return randomNumber;
   }
}

お分かりの通り、この Seam コンポーネントは純粋なビジネスロジックです。 ユーザインタラクションのフローについてまったく知る必要がありません。 これは本質的にコンポーネントの再利用性を向上させます。

TODO

この予約アプリケーションは以下の特徴を持つ本格的なホテルの部屋予約システムです。

この予約アプリケーションは JSF、EJB 3.0、Seam とともにビューとして Facelet を使用しています。 JSF、Facelets、Seam、JavaBeans そして、Hibernate3 のアプリケーションの移植版もあります

このアプリケーションをある程度の期間、 いじってわかることの 1 つは、 それがとても 堅牢であることです。 戻るボタンをいじっても、 ブラウザの更新をしても、 複数のウィンドを開いても、 無意味なデータを好きなだけ入力しても、 アプリケーションをクラッシュさせることがとても困難であることがわかります。 これを達成するためにテストやバグ取りに何週間も掛かったと思われるかもしれません。 現実的にはそんなことありません。 Seam は、堅牢な WEB アプリケーションを簡単に構築できるように設計されています。 そして、これまでコーディングそのものによって得られていた堅牢性は、 Seam を使用することで自然かつ自動的に得られます。

サンプルアプリケーションのコードを見れば、 どのようにアプリケーションが動作しているか習得できます。 そして、この堅牢性の達成するために、 どのように宣言的状態管理や統合されたデータ妥当性検証が使用されているかを見ることができます。

プロジェクトの構成は以前のものと同じです。 項1.1. 「サンプルを試そう」 を参照してください。 うまくアプリケーションが起動したならば、 ブラウザから指定して http://localhost:8080/seam-booking/ をアクセスすることが可能です。

ちょうど 9 つのクラス (加えて、6 つのセッション Bean のインタフェースと 1 つのアノテーションのインタフェース) が、 このアプリケーションの実装のために使われています。 6 つのセッション Bean アクションリスナはリストに記載された特徴のためにすべてのビジネスロジックを含んでいます。

3 つのエンティティ Bean がアプリケーションの永続ドメインモデルを実装しています。

気が向いたならばソースコードを読まれることをお勧めします。 このチュートリアルでは、特定の機能 (ホテル検索、選択、予約と確認) に集中します。 ユーザの視点から見ると、 ホテルの選択から予約確認までのすべては、1 つの連続した仕事の単位、 つまり 対話 です。 しかし、検索は、対話の一部ではありません。 ユーザは、 異なるブラウザタブで同じ検索結果ページから複数のホテルを選択可能です。

ほとんどの WEB アプリケーションのアーキテクチャは、対話を公開するための構造を持っていません。 これは、対話に関連した状態を管理に関する大きな問題を引き起こします。 通常、Java WEB アプリケーションは 2 つの技術を組み合わせて使用します。 最初に、状態は、HttpSession に投げられ、 2 番目に、永続可能状態は各リクエストの後に、データベースに書き込みがされ、 そして、各リクエストの始めに、データベースから再構築がされます。

データベースは、最もスケーラビリティに乏しい層なので、 しばしば受けいれがたいスケーラビリティの不足を招きます。 加えて、リクエストごとにデータベースとやり取りする余分な転送量による待ち時間も問題です。 この冗長な転送量を減少させるために、 Java アプリケーションではしばしばリクエスト間で普通にアクセスされるデータを保管するデータキャッシュ (2 次レベル) を導入します。 このキャッシュは、必ずしも効率ではありません。 なぜなら データが無効化どうかの判断を、 ユーザがデータの操作を終了したかどうかをベースとする代わりに LRU ポリシーをベースとしているからです。 さらに、 キャッシュは多くの現在のトランザクションによって共有されているので、 キャッシュされた状態とデータベース間の一貫性を保つことに関連する多くの問題に対策を講じています。

さて、HttpSession に保管された状態を考察してみましょう。 注意深いプログラムによりセッションデータのサイズをコントロールできるかもしれません。 これは想像するよりずっと困難です。 なぜならば、WEB ブラウザはアドホックで非線形な画面操作を許しているからです。 しかし、もしシステムの開発途中に、 ユーザに複数の並列対話 を許可するというシステム要件を、 突然見つけたとします (私も同様の状況に遭遇しました) 。 セッションステートを関連する別の並行する対話から分離するための機構を開発することと ユーザがブラウザのウィンドウやタブを閉じることで対話の一つを異常終了させた場合に、 その対話状態を破棄することを保証するフェールセーフ機構を組み込むことは、 気が弱い者の仕事ではありません。 (私は 2 度ほど実装したことがあります。 1 つはクライアントアプリケーション、1 つはSeamです。 だけど、私は病的なことで有名です。)

もっとよい方法があります。

Seam はファーストクラスの構造として 対話コンテキストを導入しています。 コンテキスト中に安全に対話状態を維持すること、 そして十分に定義されたライフサイクルで保証されることが可能です さらに、アプリケーションサーバとデータベースの間でデータを連続的に行き来させる必要はありません。 なぜなら、対話コンテキストは、ユーザが現在作業しているデータの自然なキャッシュだからです。

通常、対話コンテキスト中で保持するコンポーネントはステートフルセッション Bean です。 (対話コンテキスト中でエンティティ Bean や JavaBean も保持できます。) Java コミュニティでは、ステートフルセッション Bean は、 スケーラビリティの殺し屋という古くからの作り話があります。 1988年、WebFoobar 1.0 がリリースされたときに、これは真実だったかもしれません。 こんにち、もはや真実ではありません。 JBoss 4.0 のようなアプリケーションサーバは、 ステートフルセッション Bean の レプリケーションのためのとても優れたメカニズムを持っています。 (例えば、JBoss EJB3 コンテナはきめ細かくレプリケーションを行い、 実際に属性値が変化した Bean のみレプリケーションを行います。) なぜステートフル Bean が非効率的かという、 すべての古典的な技術の議論は HttpSession にも等しく当てはまります。 従って、パフォーマンスを改善するために、 ビジネス層のステートフルセッション Bean から、 WEB セッションに変更する慣習は、 信じられないほど誤って指導されていますことに注意してください。 ステートフル Bean の誤った使用、あるいは不適切なものに使用することにより、 ステートフルセッション Bean を使用したスケーラブルでないアプリケーションを書く可能性も確かにあります。 しかし、これはそれらの使用を禁止していることを意味しません。 とにかく、Seam は安全な使用モデルに向かって誘導します。 Welcome to 2005.

それでは、くどくど言うのは止めてチュートリアルに戻りましょう。

この予約サンプルアプリケーションは、 複雑な振る舞いを実現するために、 異なるスコープを持つステートフルコンポーネントがどのように連携することが可能であるかを示しています。 予約アプリケーションのメインページは、 ユーザにホテル検索を可能にしています。 検索結果は、Seam セッションスコープに保持されます。 ユーザがこれらのホテルの 1 つに遷移するとき、 対話は、開始します。 そして、対話スコープのコンポーネントは、 選択されたホテルを取得するために、 セッションスコープのコンポーネントを呼び返します。

手書きの JavaScript を使用することなくリッチクライアントの動作を実装するために、 Ajax4JSF を使用していることも示しています。

検索機能は、セッションスコープのステートフル Bean を使用して実装されます。 それは、上記のメッセージリストサンプルに見られるものと同様です。

@Stateful                                                                                (1)
@Name("hotelSearch")
@Scope(ScopeType.SESSION)
@Restrict("#{identity.loggedIn}")                                                        (2)
public class HotelSearchingAction implements HotelSearching
{
   
   @PersistenceContext
   private EntityManager em;
   
   private String searchString;
   private int pageSize = 10;
   private int page;
   
   @DataModel
   private List<Hotel> hotels;                                                           (3)
   
   public String find()
   {
      page = 0;
      queryHotels();   
      return "main";
   }

   public String nextPage()
   {
      page++;
      queryHotels();
      return "main";
   }
      
   private void queryHotels()
   {
      String searchPattern = searchString==null ? "%" : '%' + searchString.toLowerCase().replace('*', '%') + '%';
      hotels = em.createQuery("select h from Hotel h where lower(h.name) like :search or lower(h.city) like :search or lower(h.zip) like :search or lower(h.address) like :search")
            .setParameter("search", searchPattern)
            .setMaxResults(pageSize)
            .setFirstResult( page * pageSize )
            .getResultList();
   }
   
   public boolean isNextPageAvailable()
   {
      return hotels!=null && hotels.size()==pageSize;
   }
   
   public int getPageSize() {
      return pageSize;
   }

   public void setPageSize(int pageSize) {
      this.pageSize = pageSize;
   }

   public String getSearchString()
   {
      return searchString;
   }

   public void setSearchString(String searchString)
   {
      this.searchString = searchString;
   }
   
   @Destroy @Remove
   public void destroy() {}                                                              (4)

}

このアプリケーションの主なページは、Facelets ページです。 ホテルを検索に関連する抜粋を見てみましょう。

<div class="section">
<h:form>
  
  <span class="errors">
    <h:messages globalOnly="true"/>
  </span>
    
  <h1>Search Hotels</h1>
  <fieldset> 
     <h:inputText value="#{hotelSearch.searchString}" style="width: 165px;">
        <a:support event="onkeyup" actionListener="#{hotelSearch.find}"                  (1)
                   reRender="searchResults" />
     </h:inputText>
     &#160;
     <a:commandButton value="Find Hotels" action="#{hotelSearch.find}" 
                      styleClass="button" reRender="searchResults"/>
     &#160;
     <a:status>                                                                          (2)
        <f:facet name="start">
           <h:graphicImage value="/img/spinner.gif"/>
        </f:facet>
     </a:status>
     <br/>
     <h:outputLabel for="pageSize">Maximum results:</h:outputLabel>&#160;
     <h:selectOneMenu value="#{hotelSearch.pageSize}" id="pageSize">
        <f:selectItem itemLabel="5" itemValue="5"/>
        <f:selectItem itemLabel="10" itemValue="10"/>
        <f:selectItem itemLabel="20" itemValue="20"/>
     </h:selectOneMenu>
  </fieldset>
    
</h:form>
</div>

<a:outputPanel id="searchResults">                                                       (3)
  <div class="section">
  <h:outputText value="No Hotels Found" 
                rendered="#{hotels != null and hotels.rowCount==0}"/>
  <h:dataTable value="#{hotels}" var="hot" rendered="#{hotels.rowCount>0}">
    <h:column>
      <f:facet name="header">Name</f:facet>
      #{hot.name}
    </h:column>
    <h:column>
      <f:facet name="header">Address</f:facet>
      #{hot.address}
    </h:column>
    <h:column>
      <f:facet name="header">City, State</f:facet>
      #{hot.city}, #{hot.state}, #{hot.country}
    </h:column> 
    <h:column>
      <f:facet name="header">Zip</f:facet>
      #{hot.zip}
    </h:column>
    <h:column>
      <f:facet name="header">Action</f:facet>
      <s:link value="View Hotel" action="#{hotelBooking.selectHotel(hot)}"/>             (4)
    </h:column>
  </h:dataTable>
  <s:link value="More results" action="#{hotelSearch.nextPage}" 
          rendered="#{hotelSearch.nextPageAvailable}"/>
  </div>
</a:outputPanel>

このページは、タイプしたときに検索結果が動的に表示し、 ホテルの選択をさせ、 HotelBookingAction の selectHotel() メソッドに選択結果を渡します。 そこでは、本当に興味深いことが起こっています。

対話と関係する永続データを自然にキャッシュするために、 予約サンプルアプリケーションがどのように対話スコープのステートフル Bean を利用するか見てみましょう。 以下のサンプルコードは、ちょっとばかり長いです。 しかし、それを対話のステップを実装したスクリプト化されたアクションのリストと考えると、 理解しやすくなります。 クラスを物語のように徹底的に読みましょう。

@Stateful
@Name("hotelBooking")
@Restrict("#{identity.loggedIn}")
public class HotelBookingAction implements HotelBooking
{
   
   @PersistenceContext(type=EXTENDED)                                                    (1)
   private EntityManager em;
   
   @In                                                                                   (2)
   private User user;
   
   @In(required=false) @Out
   private Hotel hotel;
   
   @In(required=false) 
   @Out(required=false)
   private Booking booking;
     
   @In
   private FacesMessages facesMessages;
      
   @In
   private Events events;
   
   @Logger 
   private Log log;
   
   @Begin                                                                                (3)
   public String selectHotel(Hotel selectedHotel)
   {
      hotel = em.merge(selectedHotel);
      return "hotel";
   }
   
   public String bookHotel()
   {      
      booking = new Booking(hotel, user);
      Calendar calendar = Calendar.getInstance();
      booking.setCheckinDate( calendar.getTime() );
      calendar.add(Calendar.DAY_OF_MONTH, 1);
      booking.setCheckoutDate( calendar.getTime() );
      
      return "book";
   }

   public String setBookingDetails()
   {
      if (booking==null || hotel==null) return "main";
      if ( !booking.getCheckinDate().before( booking.getCheckoutDate() ) )
      {
         facesMessages.add("Check out date must be later than check in date");
         return null;
      }
      else
      {
         return "confirm";
      }
   }

   @End                                                                                  (4)
   public String confirm()
   {
      if (booking==null || hotel==null) return "main";
      em.persist(booking);
      facesMessages.add("Thank you, #{user.name}, your confimation number for #{hotel.name} is #{booking.id}");
      log.info("New booking: #{booking.id} for #{user.username}");
      events.raiseEvent("bookingConfirmed");
      return "confirmed";
   }
   
   @End
   public String cancel()
   {
      return "main";
   }
   
   @Destroy @Remove                                                                      (5)
   public void destroy() {}

}

HotelBookingAction は、 ホテル検索、選択、予約、予約確認を実装したすべてのアクションリスナを持っており、 そして、この操作に関連する状態をインスタンスに保持しています。 このコードが、 HttpSession 属性から get/set するものと比較して、 よりクリーンで簡単なコードであることに同意してもらえると考えています。

さらに良くするために、ユーザは、ログインセッション毎に複数の分離された対話を持つことが可能です。 試してみてください。 同時に 2 つの異なるホテル予約を作成することが可能です。 対話を長時間、放置した場合、 Seam は、最終的に対話をタイムアウトし、状態を破棄します。 対話が終了した後に、その対話ページに戻るボタンを押し、アクションの実行を試みた場合、 Seam は、対話が既に終了したことを検出し、検索ページにリダイレクトします。

予約アプリケーションの WAR ファイルの中身をチェックすれば、 WEB-INF/lib ディレクトリ中に seam-ui.jar が見つかります。 このパッケージは、Seam と統合する多くの JSF カスタムコントロールを含んでいます。 この予約アプリケーションは、 検索画面からホテルページへの画面遷移制御に <s:link> を使用しています。

<s:link value="View Hotel" action="#{hotelBooking.selectHotel}"/>

ここで、<s:link> を使用することで、 ブラウザの "新しいウィンドウを開く" 機能を阻害することなく、 アクションリスナに HTML リンクを付けることが可能です。 標準 JSF <h:commandLink> は、"新しいウィンドウを開く" と連動しません。 <s:link> は、 対話伝播ルールを含むその他多くの便利な機能を提供します。

予約アプリケーションは、特に、/book.xhtml においていくつかの他の Seam コントロールと Ajax4JSF コントロールを使用します。 ここでは、それらコントロールの詳細には触れませんが、 このコードを理解したいならば、 JSF フォームバリデーションのための Seam の機能を対象とする章を参照してください。

WAR は、seam-debug.jar も含みます。 この JAR が Facelet とともに WEB-INF/lib にデプロイされ、 そして、web.xml あるいは、seam.properties 中に以下のように Seam プロパティを設定した場合、

<context-param>
    <param-name>org.jboss.seam.core.init.debug</param-name>
    <param-value>true</param-value>
</context-param>

Seam デバッグページが有効になります。 このページから現在のログインセッションに関する Seam コンテキスト中の Seam コンポーネントの閲覧と検査が可能です。 ブラウザから、http://localhost:8080/seam-booking/debug.seam と入力してください。 examples/booking/view ディレクトリに、 debug.xhtml と呼ばれる facelets ページがあります。 このページで現在のログインセッションに関する Seam コンテキスト中の Seam コンポーネントを見たり検査したりすることができます。 ブラウザに、http://localhost:8080/seam-booking/debug.seam. と入力してください。

index.xhtml facelets ページの一部は、 最新の Blog 登録のリストを表示しています。

<h:dataTable value="#{blog.recentBlogEntries}" var="blogEntry" rows="3">
   <h:column>
      <div class="blogEntry">
         <h3>#{blogEntry.title}</h3>
         <div>
            <h:outputText escape="false" 
                  value="#{blogEntry.excerpt==null ? blogEntry.body : blogEntry.excerpt}"/>
         </div>
         <p>
            <h:outputLink value="entry.seam" rendered="#{blogEntry.excerpt!=null}">
               <f:param name="blogEntryId" value="#{blogEntry.id}"/>
               Read more...
            </h:outputLink>
         </p>
         <p>
            [Posted on 
            <h:outputText value="#{blogEntry.date}">
               <f:convertDateTime timeZone="#{blog.timeZone}" locale="#{blog.locale}" type="both"/>
            </h:outputText>]
            &#160;
            <h:outputLink value="entry.seam">[Link]
               <f:param name="blogEntryId" value="#{blogEntry.id}"/>
            </h:outputLink>
         </p>
      </div>
   </h:column>
</h:dataTable>

ブックマークからこのページに移動する場合、 <h:dataTable> により使用されるデータは実際にはどのように初期化されるのでしょうか。 ここで何が起きているかというと、 Blog は Blog という名前の Seam コンポーネントによって、 必要なときに遅延して取得されて — 引き出されて — いるわけです。 これは、 Struts のような従来の WEB アクションに基づくフレームワークでは一般的なフロー制御と逆になっています。

@Name("blog")
@Scope(ScopeType.STATELESS)
public class BlogService 
{
   
   @In                                                                                   (1)
   private EntityManager entityManager;
  
   @Unwrap                                                                               (2)
   public Blog getBlog()
   {
      return (Blog) entityManager.createQuery("from Blog b left join fetch b.blogEntries")
            .setHint("org.hibernate.cacheable", true)
            .getSingleResult();
   }

}

これは、これまでのところ良いですが、 検索結果ページのようなフォームサブミットの結果のブックマークではどうでしょうか？

この Blog サンプルは、 各ページの右上にユーザの Blog 記事の検索を可能にする小さなフォームを持ちます。 これは、facelet テンプレート、template.xhtml に含まれる menu.xhtml ファイルに定義されます。

<div id="search">
   <h:form>
      <h:inputText value="#{searchAction.searchPattern}"/>
      <h:commandButton value="Search" action="/search.xhtml"/>
   </h:form>
</div>

ブックマーク可能検索結果ページの実装のために、 検索フォームのサブミットを処理した後に、 ブラウザリダイレクトを実行する必要があります。 アクション結果 (outcome) として JSF ビュー ID を使用しているので、 Seam は、フォームがサブミットされたとき、自動的に ビュー ID にリダイレクトします。 別の方法として、以下のようなナビゲーションルールを定義することも可能です。

<navigation-rule>
   <navigation-case>
      <from-outcome>searchResults</from-outcome>
      <to-view-id>/search.xhtml</to-view-id>
      <redirect/>
   </navigation-case>
</navigation-rule>

フォームは、以下のような感じであったでしょう。

<div id="search">
   <h:form>
      <h:inputText value="#{searchAction.searchPattern}"/>
      <h:commandButton value="Search" action="searchResults"/>
   </h:form>
</div>

しかし、リダイレクトするとき、 http://localhost:8080/seam-blog/search.seam?searchPattern=seam のようなブックマーク URL を取得するために、 リクエストパラメータとしてフォームによってサブミットされた値を含む必要があります。 JSF は、これをする簡単な方法は提供しませんが、Seam は提供します。 WEB-INF/pages.xml で定義された Seam page parameter を使用します。

<pages>
   <page view-id="/search.xhtml">
      <param name="searchPattern" value="#{searchService.searchPattern}"/>
   </page>
   ...
</pages>

これは、ページにリダイレクトするときに、Seam に searchPattern の名前のリクエストパラメータとして #{searchService.searchPattern} の値を含み、ページをレンダリングする前に、パラメータの値をモデルに再適用するよう指示します。

リダイレクトによって search.xhtml ページに移動します。

<h:dataTable value="#{searchResults}" var="blogEntry">
   <h:column>
      <div>
         <h:outputLink value="entry.seam">
            <f:param name="blogEntryId" value="#{blogEntry.id}"/>
            #{blogEntry.title}
         </h:outputLink>
         posted on 
         <h:outputText value="#{blogEntry.date}">
            <f:convertDateTime timeZone="#{blog.timeZone}" locale="#{blog.locale}" type="both"/>
         </h:outputText>
      </div>
   </h:column>
</h:dataTable>

これも、また実際の検索結果を取得するために "PULL" 型 MVC を使用しています。

@Name("searchService")
public class SearchService 
{
   
   @In
   private EntityManager entityManager;
   
   private String searchPattern;
   
   @Factory("searchResults")
   public List<BlogEntry> getSearchResults()
   {
      if (searchPattern==null)
      {
         return null;
      }
      else
      {
         return entityManager.createQuery("select be from BlogEntry be where lower(be.title) like :searchPattern or lower(be.body) like :searchPattern order by be.date desc")
               .setParameter( "searchPattern", getSqlSearchPattern() )
               .setMaxResults(100)
               .getResultList();
      }
   }

   private String getSqlSearchPattern()
   {
      return searchPattern==null ? "" : '%' + searchPattern.toLowerCase().replace('*', '%').replace('?', '_') + '%';
   }

   public String getSearchPattern()
   {
      return searchPattern;
   }

   public void setSearchPattern(String searchPattern)
   {
      this.searchPattern = searchPattern;
   }

}

ごく希に、RESTful ページ処理のために PUSH 型 MVC を使用することが当然の場合があります。 そこで、Seam は、ページアクション の概念を提供します。 Blog サンプルは、 Blog 記入ページ、 entry.xhtml にページアクションを使用しています。 これは、少しわざとらしい感じで、ここでは、PULL 型 MVC を使用する方が容易かもしれません。

entryAction コンポーネントは、 Struts のような典型的な PUSH 型 MVC アクション指向フレームワークのように動作します。

@Name("entryAction")
@Scope(STATELESS)
public class EntryAction
{
   @In(create=true) 
   private Blog blog;
   
   @Out
   private BlogEntry blogEntry;
   
   public void loadBlogEntry(String id) throws EntryNotFoundException
   {
      blogEntry = blog.getBlogEntry(id);
      if (blogEntry==null) throw new EntryNotFoundException(id);
   }
   
}

ページアクションは、pages.xml でも宣言されます。

<pages>
   ...

   <page view-id="/entry.xhtml" action="#{entryAction.loadBlogEntry(blogEntry.id)}">
      <param name="blogEntryId" value="#{blogEntry.id}"/>
   </page>

   <page view-id="/post.xhtml" action="#{loginAction.challenge}"/>

   <page view-id="*" action="#{blog.hitCount.hit}"/>

</pages>

上記の例は、 その他の機能に対してページアクションを使っています — ログインチャレンジやページビューカウンタなど。 また、 ページアクションメソッドのバインディングにパラメータを使用しているのにも注目してください。 これは JSF EL の標準機能ではありませんが、 Seam ではページアクションだけでなく JSF メソッドのバインディングでも使用できるようになっています。

entry.xhtml ページがリクエストされると、 Seam は最初にページパラメータ blogEntryId をモデルにバインドし、 次に必要なデータ — blogEntry — を取得するページアクションを実行してから、 それを Seam イベントコンテキストに配置します。 最後に、以下がレンダリングされます。

<div class="blogEntry">
   <h3>#{blogEntry.title}</h3>
   <div>
      <h:outputText escape="false" value="#{blogEntry.body}"/>
   </div>
   <p>
      [Posted on&#160;
      <h:outputText value="#{blogEntry.date}">
         <f:convertDateTime timezone="#{blog.timeZone}" locale="#{blog.locale}" type="both"/>
      </h:outputText>]
   </p>
</div>

blog エントリがデータベースで見つからない場合、 EntryNotFoundException 例外がスローされます。 exception is thrown. この例外は 505 エラーではなく 404 であって欲しいので、 例外クラスのアノテーションを付けます。

@ApplicationException(rollback=true)
@HttpError(errorCode=HttpServletResponse.SC_NOT_FOUND)
public class EntryNotFoundException extends Exception
{
   EntryNotFoundException(String id)
   {
      super("entry not found: " + id);
   }
}

別実装のサンプルは、メソッドバインディングでパラメータを使用しません。

@Name("entryAction")
@Scope(STATELESS)
public class EntryAction
{
   @In(create=true) 
   private Blog blog;
   
   @In @Out
   private BlogEntry blogEntry;
   
   public void loadBlogEntry() throws EntryNotFoundException
   {
      blogEntry = blog.getBlogEntry( blogEntry.getId() );
      if (blogEntry==null) throw new EntryNotFoundException(id);
   }
   
}

<pages>
   ...

   <page view-id="/entry.xhtml" action="#{entryAction.loadBlogEntry}">
      <param name="blogEntryId" value="#{blogEntry.id}"/>
   </page>
   
   ...
</pages>

どの実装を選択するかは好みの問題です。