src/org/mxchange/jcoreee/bean/ejb/BaseEnterpriseBean.java

   1 /*
   2  * Copyright (C) 2016 - 2022 Free Software Foundation
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.jcoreee.bean.ejb;
  18
  19 import java.io.Serializable;
  20 import java.text.MessageFormat;
  21 import javax.faces.FacesException;
  22 import javax.jms.Connection;
  23 import javax.jms.JMSException;
  24 import javax.jms.MessageProducer;
  25 import javax.jms.ObjectMessage;
  26 import javax.jms.Queue;
  27 import javax.jms.QueueConnectionFactory;
  28 import javax.jms.Session;
  29 import javax.naming.Context;
  30 import javax.naming.InitialContext;
  31 import javax.naming.NamingException;
  32 import javax.persistence.EntityManager;
  33 import javax.persistence.PersistenceContext;
  34 import org.mxchange.jcoreeelogger.beans.local.logger.Log;
  35 import org.mxchange.jcoreeelogger.beans.local.logger.LoggerBeanLocal;
  36
  37 /**
  38  * A helper class for beans that access the database.
  39  * <p>
  40  * @author Roland Häder<roland@mxchange.org>
  41  */
  42 public abstract class BaseEnterpriseBean implements Serializable {
  43
  44         /**
  45          * Serial number
  46          */
  47         private static final long serialVersionUID = 217_687_175_985_875L;
  48
  49         /**
  50          * Connection
  51          */
  52         private Connection connection;
  53
  54         /**
  55          * Entity manager
  56          */
  57         @PersistenceContext
  58         private EntityManager entityManager;
  59
  60         /**
  61          * Logger instance
  62          */
  63         @Log
  64         private LoggerBeanLocal loggerBeanLocal;
  65
  66         /**
  67          * Message producer
  68          */
  69         private MessageProducer messageProducer;
  70
  71         /**
  72          * Mailer message queue
  73          */
  74         private Queue queue;
  75
  76         /**
  77          * Session instance
  78          */
  79         private Session session;
  80
  81         /**
  82          * This class' default protected constructor. Please invoke
  83          * super("jms/project-queue-factory", "jms/project-email-queue"); if you
  84          * need to send emails.
  85          */
  86         protected BaseEnterpriseBean () {
  87                 // Init logger instance
  88                 this.initLoggerInstance();
  89         }
  90
  91         /**
  92          * Constructor with queue factory JNDI and queue JNDI names
  93          * <p>
  94          * @param factoryJndi JNDI name for queue factory
  95          * @param queueJndi   JNDI name for email queue
  96          */
  97         protected BaseEnterpriseBean (final String factoryJndi, final String queueJndi) {
  98                 // Invoke default constructor
  99                 this();
 100
 101                 // Try it out
 102                 try {
 103                         // Get initial context
 104                         Context context = new InitialContext();
 105
 106                         // Get factory from JMS resource
 107                         QueueConnectionFactory connectionFactory = (QueueConnectionFactory) context.lookup(factoryJndi);
 108
 109                         // Lookup queue
 110                         this.queue = (Queue) context.lookup(queueJndi);
 111
 112                         // Create connection
 113                         this.connection = connectionFactory.createConnection();
 114
 115                         // Init session instance
 116                         this.session = this.connection.createSession(false, Session.AUTO_ACKNOWLEDGE);
 117
 118                         // And message producer
 119                         this.messageProducer = this.session.createProducer(this.queue);
 120                 } catch (final NamingException | JMSException e) {
 121                         // Continued to throw
 122                         throw new FacesException(e);
 123                 }
 124         }
 125
 126         /**
 127          * Initializes logger instance
 128          */
 129         private void initLoggerInstance () {
 130                 try {
 131                         // Get initial context
 132                         Context context = new InitialContext();
 133
 134                         // Lookup logger
 135                         this.loggerBeanLocal = (LoggerBeanLocal) context.lookup("java:global/jcore-logger-ejb/logger!org.mxchange.jcoreeelogger.beans.local.logger.LoggerBeanLocal"); //NOI18N
 136                 } catch (final NamingException ex) {
 137                         // Continue to throw
 138                         throw new RuntimeException(MessageFormat.format("context.lookup() failed: {0}", ex.getMessage()), ex); //NOI18N
 139                 }
 140         }
 141
 142         /**
 143          * Getter for connection instance
 144          * <p>
 145          * @return Connection instance
 146          */
 147         protected EntityManager getEntityManager () {
 148                 return this.entityManager;
 149         }
 150
 151         /**
 152          * Getter for loggerBeanLocal
 153          * <p>
 154          * @return Logger instance
 155          */
 156         protected LoggerBeanLocal getLoggerBeanLocal () {
 157                 return this.loggerBeanLocal;
 158         }
 159
 160         /**
 161          * Getter for configured message producer instance
 162          * <p>
 163          * @return Message producer
 164          */
 165         protected MessageProducer getMessageProducer () {
 166                 return this.messageProducer;
 167         }
 168
 169         /**
 170          * Getter for configured session instance
 171          * <p>
 172          * @return Session
 173          */
 174         protected Session getSession () {
 175                 return this.session;
 176         }
 177
 178         /**
 179          * Sends given message to configured queue
 180          * <p>
 181          * @param message Message to send
 182          * <p>
 183          * @throws JMSException if something went wrong
 184          */
 185         protected void sendMessage (final ObjectMessage message) throws JMSException {
 186                 // Trace message
 187                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.sendMessage: message={1} - CALLED!", this.getClass().getSimpleName(), message)); //NOI18N
 188
 189                 // The parameter should be valid
 190                 if (null == message) {
 191                         // Throw NPE
 192                         throw new NullPointerException("message is null"); //NOI18N
 193                 } else if (this.getMessageProducer() == null) {
 194                         // Throw NPE again
 195                         throw new NullPointerException("this.messageProvider is null"); //NOI18N
 196                 }
 197
 198                 // Send it
 199                 this.getMessageProducer().send(message);
 200
 201                 // Trace message
 202                 this.getLoggerBeanLocal().logTrace(MessageFormat.format("{0}.sendMessage: EXIT!", this.getClass().getSimpleName())); //NOI18N
 203         }
 204
 205 }