Создание класса сущностей

В этом упражнении будет создан класс сущностей NewsEntity. Класс сущностей – это простой класс Java, как правило, соответствующий таблице в базе данных. При создании класса сущностей в среде IDE для определения класса как класса сущностей добавляется аннотация @Entity. После создания класса в нем создаются поля для представления требуемых данных в таблице.

Каждый класс сущностей должен иметь первичный ключ. При создании класса сущностей в среде IDE добавляется аннотация @Id для объявления, какое поле необходимо использовать в качестве первичного ключа. Также в среде IDE добавляется аннотация @GeneratedValue и указывается стратегия создания ключей для первичного идентификатора.

Для создания класса NewsEntity выполните следующие действия.

1. Щелкните правой кнопкой мыши модуль EJB в окне "Проекты" и выберите "Создать > Другие" для открытия мастера создания файла.
2. Выберите "Класс сущностей" из категории "Сохранение состояния" и нажмите "Далее".
3. В поле "Имя класса" введите NewsEntity.
4. В поле "Пакет" введите ejb.
5. В мастере создания класса сущностей оставьте тип первичного ключа Long.
6. Выберите пункт "Создать блок сохранения состояния". Нажмите кнопку "Далее".
7. Оставьте имя блока сохранения состояния по умолчанию.
8. Для Поставщика сохранения состояния выберите EclipseLink (JPA2.0)(по умолчанию).
9. В поле "Источник данных" укажите источник данных (например, выберите jdbc/sample, если необходимо использовать JavaDB).
10. Убедитесь в том, что для блока сохранения состояния используется интерфейс API транзакций Java и что для стратегии создания таблиц установлено значение "Создать", т. е. таблицы на основе классов сущностей создаются при развертывании приложения.
    
11. Нажмите кнопку "Готово".

При нажатии кнопки "Завершить" в среде IDE будет создан файл persistence.xml и класс сущностей NewsEntity.java. NewsEntity.java будет открыт средой IDE в редакторе исходного кода.

В редакторе исходного кода выполните следующие действия.

1. Добавьте к классу следующие объявления полей:

   private String title;
   private String body;

2. Щелкните правой кнопкой мыши в редакторе исходного кода, выберите пункт "Вставить код" (Alt-Insert; Ctrl-I на Mac) и выберите пункт "Методы получения и установки", чтобы открыть диалоговое окно "Создать методы получения и установки".
3. В диалоговом окне выберите поля body и title. Нажмите кнопку "Создать".
   

   При нажатии кнопки "Создать" в среде IDE добавляются методы получения и установки для полей.

4. Сохраните изменения в NewsEntity.java.

NewsEntity.java можно закрыть.

Для получения подробных сведений о классах сущностей см. главу Введение в интерфейс API сохранения состояния Java в Руководство по Java EE 6. Часть I.

Создание управляемого сообщениями компонента

В этом упражнении используется мастер создания управляемого сообщениями компонента NewMessage в модуле EJB. Кроме того, с помощью этого мастера можно создавать необходимые ресурсы JMS. Управляемый сообщениями компонент предназначен для получения и обработки сообщений, передаваемых в очередь сервлетом в веб-модуле.

Для создания управляемого сообщениями компонента выполните следующие действия:

1. Щелкните правой кнопкой мыши модуль EJB в окне "Проекты" и выберите "Создать > Прочее" для открытия мастера создания файла.
2. В категории "Enterprise JavaBeans" выберите тип файла "Компонент, определяемый сообщениями". Нажмите кнопку "Далее".

   Примечание. В NetBeans IDE 6.9 тип файла "Компонент, определяемый сообщениями" находится в категории Java EE.

3. В поле "Имя EJB" введите NewMessage.
4. В раскрывающемся списке "Пакет" выберите ejb.
5. Для открытия диалогового окна "Добавление адресата сообщения" нажмите кнопку "Добавить" рядом с полем "Адресат проекта".
6. В диалоговом окне "Добавление адресата сообщения" введите jms/NewMessage и выберите "Очередь" для типа адресата. Нажмите кнопку "ОК".
7. Подтвердите, что адресат проекта выбран правильно. Нажмите кнопку "Готово".

При нажатии кнопки "Завершить" в редакторе исходного кода откроется класс компонента NewMessage.java. При этом в среде IDE добавляется аннотация @MessageDriven и свойства настройки для класса.

       
@MessageDriven(mappedName = "jms/NewMessage", activationConfig =  {
        @ActivationConfigProperty(propertyName = "acknowledgeMode", propertyValue = "Auto-acknowledge"),
        @ActivationConfigProperty(propertyName = "destinationType", propertyValue = "javax.jms.Queue")
    })
public class NewMessage implements MessageListener {

Аннотация @MessageDriven указывает на то, что данный компонент является управляемым сообщениями, а также определяет ресурс JMS, используемый компонентом. При создании класса в среде IDE отображаемое имя ресурса (jms/NewMessage) определяется на основе имени класса (NewMessage.java). Ресурс JMS привязан к имени JNDI адресата, от которого в компонент поступают сообщения. Мастер создания управляемого сообщениями компонента также добавляет в файл sun-resources.xml информацию о ресурсах JMS. Для указания ресурсов JMS не требуется настраивать дескрипторы развертывания. Если в среде IDE для развертывания приложения на сервере GlassFish выбрать операцию "Выполнить", то ресурсы JMS создаются на сервере при развертывании.

В спецификации EJB предусмотрена возможность ввода ресурсов непосредственно в класс с помощью аннотаций. В следующем примере показано, как можно использовать аннотации для ввода в класс ресурса MessageDrivenContext, а затем ресурса PersistenceContext, который используется в интерфейсе API EntityManager для управления устойчивыми экземплярами сущностей. В редакторе исходного кода к классу будут добавлены аннотации.

1. Введите в класс ресурс MessageDrivenContext посредством добавления к классу следующего аннотированного поля (выделено полужирным шрифтом):

   public class NewMessage implements MessageListener {
   
   @Resource
   private MessageDrivenContext mdc;

2. Введите диспетчер сущностей в этот класс, щелкнув правой клавишей в коде и выбрав пункт "Вставить код" (Alt-Insert; Ctrl-I на Mac) и выберите пункт "Использовать диспетчер сущностей" из всплывающего меню.

   Примечание. В NetBeans IDE 6.9 выберите пункт "Сохранение состояния" > "Использовать диспетчер сущностей".

   В среде IDE к исходному коду добавляется следующая аннотация @PersistenceContext.

   @PersistenceContext(unitName = "NewsApp-ejbPU")
   private EntityManager em;

   Кроме того, в среде IDE создается следующий метод persist.

   public void persist(Object object) {
       em.persist(object);
   }

3. Для изменения имени на save измените метод persist. В результате метод должен выглядеть следующим образом:

   public void save(Object object) {     
       em.persist(object);
   }

4. Измените метод onMessage путем добавления следующих строк кода (выделено полужирным шрифтом) в тело метода.

   public void onMessage(Message message) {
       ObjectMessage msg = null;
       try {
           if (message instanceof ObjectMessage) {
               msg = (ObjectMessage) message;
               NewsEntity e = (NewsEntity) msg.getObject();
               save(e);            
           }
       } catch (JMSException e) {
           e.printStackTrace();
           mdc.setRollbackOnly();
       } catch (Throwable te) {
           te.printStackTrace();
       }
   }

5. Щелкните правой клавишей в окне редактора и выберите пункт "Исправить выражения импорта" (Alt-Shift-I; ⌘-Shift-I на Mac) для создания любых необходимых выражений импорта. Сохраните изменения.

Примечание. При создании операторов импорта следует обязательно импортировать библиотеки javax.jms и javax.annotation.Resource.

Подробные сведения об управляемых сообщениями компонентах приведены в главе Что такое управляемый сообщениями компонент? в руководстве по Java EE 6. Часть I.

Создание фасада сеанса

В этом упражнении будет создан фасад сеанса для класса сущностей NewsEntity. В спецификации EJB 3.0 упрощено создание сеансных компонентов за счет сокращения объема работ по написанию кода и добавления возможности использования аннотаций для объявления класса как сеансного компонента. Кроме того, в спецификации EJB 3.1 упрощены требования к сеансным компонентам, поскольку выбор бизнес-интерфейсов не является обязательным. Локальные клиенты получают доступ к сеансным компонентам посредством представления с локальным интерфейсом или без интерфейса. В рамках этого руководства будет создан интерфейс для такого компонента. Сервлеты в веб-приложении получают доступ к компоненту через представление без интерфейса.

Для создания фасада сеанса выполните следующие действия:

1. Щелкните модуль EJB правой кнопкой мыши и выберите команду "Создать" > "Другие".
2. Из категории "Сохранение состояния" выберите "Сеансные компоненты для классов сущностей". Нажмите кнопку "Далее".
3. Из списка доступных классов сущностей выберите ejb.NewsEntity и нажмите кнопку "Добавить", чтобы переместить класс на панель "Выбранные классы сущностей". Нажмите кнопку "Далее".
4. Убедитесь в том, что для параметра "Пакет" установлено значение ejb. Нажмите кнопку "Завершить".

При нажатии кнопки "Готово" среда IDE создает класс фасада сеанса NewsEntityFacade.java и AbstractFacade.java и открывает файлы в редакторе. Как видите из созданного кода, аннотация @Stateless используется для объявления NewsEntityFacade.java в качестве простого сеансного компонента без сохранения состояния. Также в среде IDE добавляется аннотация PersistenceContext для внедрения ресурса непосредственно в элемент сеансного компонента. Класс NewsEntityFacade.java расширяет класс AbstractFacade.java, который содержит бизнес-логику и управляет транзакцией.

Примечание. Если доступ к компонентам осуществляется через удаленные клиенты, потребность в удаленных интерфейсах остается.

Для получения подробных сведений о сеансных компонентах см. главу Что такое сеансный компонент? в руководстве по Java EE 6, часть I.

Создание единичного сеансного компонента

В спецификацию EJB 3.1 добавлена возможность использования аннотации @Singleton, которая обеспечивает упрощенное создание единичных сеансных компонентов. В EJB 3.1 также определяются дополнительные аннотации для свойств настройки единичных сеансных компонентов, например, при создании экземпляра для компонента.

После создания экземпляра единичного сеансного компонента данный компонент доступен в жизненном цикле приложения. Как понятно из его названия, в приложении может быть только один экземпляр единичного сеансного компонента. Аналогично сеансным компонентам без сохранения состояния единичные сеансные компоненты могут иметь несколько клиентов.

Для создания единичного сеансного компонента выполните следующие действия.

1. Для открытия мастера создания файла щелкните веб-модуль правой кнопкой мыши и выберите "Создать" > "Другие".
2. Выберите "Сеансный компонент" в категории Enterprise JavaBeans.

   Примечание. В среде NetBeans IDE 6.9 сеансный компонент находится в категории Java EE.

3. В поле "Имя EJB" введите SessionManagerBean.
4. В качестве имени параметра "Пакет" введите ejb.
5. Выберите "Единичный". Нажмите кнопку "Завершить".

При нажатии кнопки "Завершить" в среде IDE будет создан класс единичного сеансного компонента, который откроется в редакторе. При этом в среде IDE добавляется аннотация @Singleton к классу для объявления единичного сеансного компонента. В мастере также создается аннотация @LocalBean для класса.

@Singleton
@LocalBean
public class SessionManagerBean {

}

1. Создайте аннотацию @WebListener для класса и реализуйте HttpSessionListener.

   @Singleton
   @LocalBean
   @WebListener
   public class SessionManagerBean implements HttpSessionListener{
   
   }

   Аннотация @WebListener является частью интерфейса API сервлета 3.0 и позволяет реализовать прослушивающий процесс непосредственно в коде.

   При реализации HttpSessionListener в среде IDE в поле отображается предупреждение.

2. Щелкните значок предупреждения в левом поле и выберите "Реализовать все абстрактные методы".
   

   В среде IDE добавляются методы sessionCreated и sessionDestroyed.

3. Добавьте статическое поле counter и установите начальное значение на 0.

   @LocalBean
   @WebListener
   public class SessionManagerBean implements HttpSessionListener{
       private static int counter = 0;

4. Измените созданные тела методов sessionCreated и sessionDestroyed для увеличения значения поля при запуске нового сеанса и для уменьшения значения при завершении сеанса. Значение сохраняется в поле counter.

   public void sessionCreated(HttpSessionEvent se) {
       counter++;
   }
   
   public void sessionDestroyed(HttpSessionEvent se) {
       counter--;
   }

5. Добавьте следующий метод, возвращающий текущее значение поля counter.

   public int getActiveSessionsCount() {
           return counter;
       }

   Этот метод вызывается из сервлета для отображения текущего количества пользователей/открытых сеансов.

6. Сохраните изменения.

Теперь код сеансного компонента должен выглядеть следующим образом.

@Singleton
@LocalBean
@WebListener
public class SessionManagerBean implements HttpSessionListener {
    private static int counter = 0;

    public void sessionCreated(HttpSessionEvent se) {
        counter++;
    }

    public void sessionDestroyed(HttpSessionEvent se) {
        counter--;
    }

    public int getActiveSessionsCount() {
        return counter;
    }

}

Подробные сведения об единичных сеансных компонентах см. в главе Что такое сеансный компонент? в руководстве по Java EE 6, часть I.

Создание сервлета ListNews

В этом упражнении будет создан простой сервлет для отображения сохраненных сообщений. Аннотации используются для вызова компонента EJB NewsEntityFacade из сервлета.

1. Щелкните проект веб-модуля правой кнопкой мыши и выберите "Создать" > "Сервлет".
2. В поле "Имя класса" введите ListNews.
3. В качестве имени параметра "Пакет" введите web. Нажмите кнопку "Завершить".

При нажатии кнопки "Завершить" класс ListNews.java будет открыт в редакторе исходного кода. В редакторе исходного кода выполните следующие действия.

1. Щелкните правой кнопкой мыши в редакторе исходного кода, выберите пункт "Вставить код" (Alt-Insert; Ctrl-I на Mac) и выберите пункт "Вызов компонента EJB".
2. В диалоговом окне "Вызов компонента EJB" разверните узел NewsApp-ejb и выберите NewsEntityFacade. Нажмите кнопку "ОК".

   В среде IDE добавляется аннотация @EJB для ввода компонента EJB.

3. Используйте диалоговое окно "Вызов компонента EJB" еще раз для ввода компонента SessionManagerBean в узел NewsApp-war.

   В коде можно увидеть следующие аннотации для ввода двух компонентов EJB.

   @WebServlet(name = "ListNews", urlPatterns = {"/ListNews"})
   public class ListNews extends HttpServlet {
   
       @EJB
       private SessionManagerBean sessionManagerBean;
       @EJB
       private NewsEntityFacade newsEntityFacade;
                   

   Кроме того, можно увидеть, что аннотация @WebServlet используется для объявления класса сервлета и для указания имени сервлета. Аннотация @WebServlet является частью интерфейса API сервлета 3.0, представленного в спецификации Java EE 6. Сервлеты можно определить с помощью аннотации вместо дескриптора развертывания в web.xml. Приложение NewsApp не содержит web.xml.

4. В методе processRequest добавьте следующий код (выделено полужирным шрифтом) для возврата к текущему сеансу или создания нового.

   protected void processRequest(HttpServletRequest request, HttpServletResponse response)
           throws ServletException, IOException {
           request.getSession(true);
           response.setContentType("text/html;charset=UTF-8");

5. Добавьте следующий код (выделен жирным шрифтом) к методу processRequest для вывода сообщений и добавления ссылки на сервлет PostMessage. (При необходимости удалите знак комментария для кода в методе.)

   out.println("<h1>Servlet ListNews at " + request.getContextPath () + "</h1>");
   
   List news = newsEntityFacade.findAll();
   for (Iterator it = news.iterator(); it.hasNext();) {
       NewsEntity elem = (NewsEntity) it.next();
       out.println(" <b>"+elem.getTitle()+" </b><br />");
       out.println(elem.getBody()+"<br /> ");
   }
   out.println("<a href='PostMessage'>Добавить новое сообщение</a>");
   
   out.println("</body>");
                       

6. Добавьте следующий код (выделено полужирным шрифтом) для получения и отображения количества пользователей/открытых сеансов.

   out.println("<a href='PostMessage'>Добавить новое сообщение</a>");
   
   out.println("<br><br>");
   out.println(sessionManagerBean.getActiveSessionsCount() + " user(s) reading the news.");
   
   out.println("</body>");
                       

7. Нажмите комбинацию клавиш Ctrl+Shift+I для создания обязательных операторов импорта для класса. При создании операторов импорта может потребоваться импортировать библиотеки java.util.
8. Сохраните измененный файл.

Создание сервлета PostMessage

В этом упражнении будет создан сервлет PostMessage, используемый для отправки сообщений. Для добавления созданных ресурсов JMS непосредственно в сервлет используются аннотации с указанием имени переменной и имени, на которое она отображается. Затем необходимо написать код для отправки сообщения JMS и код для формы HTML, предназначенной для добавления сообщения.

1. Щелкните проект веб-модуля правой кнопкой мыши и выберите "Создать" > "Сервлет".
2. В поле "Имя класса" введите PostMessage.
3. Для имени параметра "Пакет" введите web и нажмите "Завершить".

При нажатии кнопки "Завершить" будет открыт класс PostMessage.java в редакторе исходного кода. В редакторе исходного кода выполните следующие действия.

1. Используйте аннотации для ввода ресурсов ConnectionFactory и Queue путем добавления следующих объявлений полей (выделено полужирным шрифтом):

   @WebServlet(name="PostMessage", urlPatterns={"/PostMessage"})
   public class PostMessage extends HttpServlet {                
       @Resource(mappedName="jms/NewMessageFactory")
       private  ConnectionFactory connectionFactory;
   
       @Resource(mappedName="jms/NewMessage")
       private  Queue queue;

2. Теперь создадим код для передачи сообщения JMS путем добавления в метод processRequest следующих строк кода, выделенных полужирным шрифтом:

   response.setContentType("text/html;charset=UTF-8");
   
   // Добавьте следующий код для отправки сообщения JMS
   String title=request.getParameter("title");
   String body=request.getParameter("body");
   if ((title!=null) && (body!=null)) {
       try {
           Connection connection = connectionFactory.createConnection();
           Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
           MessageProducer messageProducer = session.createProducer(queue);
   
           ObjectMessage message = session.createObjectMessage();
           // здесь создается сущность NewsEntity, отправляемая в сообщении JMS
           NewsEntity e = new NewsEntity();
           e.setTitle(title);
           e.setBody(body);
   
           message.setObject(e);                
           messageProducer.send(message);
           messageProducer.close();
           connection.close();
           response.sendRedirect("ListNews");
   
       } catch (JMSException ex) {
           ex.printStackTrace();
       }
   }
                           
   PrintWriter out = response.getWriter();
                       

3. Добавьте следующие строки (выделены жирным шрифтом) к методу processRequest, чтобы добавить веб-форму добавления сообщения. (При необходимости, уберите знак комментария для вывода кода HTML)

   out.println("Servlet PostMessage at " + request.getContextPath() + "</h1>");
   
   // Следующий код служит для размещения формы на веб-странице
   out.println("<form>");
   out.println("Title: <input type='text' name='title'><br/>");
   out.println("Message: <textarea name='body'></textarea><br/>");
   out.println("<input type='submit'><br/>");
   out.println("</form>");
   
   out.println("</body>");
                   

4. Нажмите сочетание клавиш Ctrl+Shift+I для создания обязательных операторов импорта для класса.

   Примечание. При выборе библиотек для импорта вConnection, ConnectionFactory, Session и Queue подтвердите, что импортируются библиотеки javax.jms.

   
5. Сохраните измененный файл.

Проблема с ресурсами JMS

При создании ресурсов JMS с помощью мастера в окне вывода может появиться следующее сообщение об ошибке сервера:

[com.sun.enterprise.connectors.ConnectorRuntimeException:
                    JMS resource not created : jms/Queue]
                

Это сообщение указывает на то, что ресурс JMS не создан или не зарегистрирован на сервере приложений. Для проверки, создания и изменения ресурсов JMS используйте консоль администратора сервера приложений.

Для вызова консоли администратора необходимо выполнить следующие действия.

1. Убедитесь в том, что сервер приложений запущен. Для этого разверните узел "Серверы" в окне "Службы" среды IDE. Работающий сервер обозначается зеленой стрелкой рядом с узлом сервера приложений.
2. Щелкните правой кнопкой мыши узел сервера приложений и выберите "Просмотр консоли администратора" для открытия в обозревателе окна входа в систему.
3. Выполните вход в систему сервера. По умолчанию используется имя пользователя admin и пароль adminadmin.
4. Разверните узлы "Ресурсы" и "Ресурсы JMS" в левом поле консоли администратора в обозревателе.
5. Щелкните ссылки "Фабрики подключений" и "Ресурсы адресатов" в левом поле и проверьте, зарегистрированы ли ресурсы на сервере; при необходимости внесите требуемые изменения. Если ресурсы не существуют, их можно создать при помощи консоли администратора.

Необходимо убедиться в том, что ресурс фабрики подключений JMS в сервлете PostMessage связан с правильным именем JNDI ресурса фабрики подключений JMS, зарегистрированного на сервере приложений Sun Java System Application Server.

На сервере Sun Java System Application Server должны быть зарегистрированы следующие ресурсы:

• ресурс адресата с именем JNDI jms/NewMessage и типом javax.jms.Queue;
• ресурс фабрики подключений с именем JNDI jms/NewMessageFactory и типом javax.jms.QueueConnectionFactory.