View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements. See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache license, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License. You may obtain a copy of the License at
8    *
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the license for the specific language governing permissions and
15   * limitations under the license.
16   */
17  package org.apache.logging.log4j.core.net;
18  
19  import javax.jms.JMSException;
20  import javax.jms.ObjectMessage;
21  import javax.naming.Context;
22  import javax.naming.NameNotFoundException;
23  import javax.naming.NamingException;
24  
25  import org.apache.logging.log4j.LogManager;
26  import org.apache.logging.log4j.Logger;
27  import org.apache.logging.log4j.core.AbstractServer;
28  import org.apache.logging.log4j.core.LogEvent;
29  
30  /**
31   * Abstract base class for receiving LogEvents over JMS. This class expects all messages to be serialized log events.
32   */
33  public abstract class AbstractJMSReceiver extends AbstractServer implements javax.jms.MessageListener {
34  
35      /**
36       * Logger to capture diagnostics.
37       */
38      protected Logger logger = LogManager.getLogger(this.getClass().getName());
39  
40      /**
41       * Listener that receives the event.
42       * @param message The received message.
43       */
44      @Override
45      public void onMessage(final javax.jms.Message message) {
46  
47          try {
48              if (message instanceof ObjectMessage) {
49                  final ObjectMessage objectMessage = (ObjectMessage) message;
50                  log((LogEvent) objectMessage.getObject());
51              } else {
52                  logger.warn("Received message is of type " + message.getJMSType()
53                      + ", was expecting ObjectMessage.");
54              }
55          } catch (final JMSException jmse) {
56              logger.error("Exception thrown while processing incoming message.",
57                  jmse);
58          }
59      }
60  
61      /**
62       * Looks up an object from the Context.
63       * @param ctx The Context.
64       * @param name The name of the object to locate.
65       * @return The object.
66       * @throws NamingException if an error occurs.
67       */
68      protected Object lookup(final Context ctx, final String name) throws NamingException {
69          try {
70              return ctx.lookup(name);
71          } catch (final NameNotFoundException e) {
72              logger.error("Could not find name [" + name + "].");
73              throw e;
74          }
75      }
76  
77  }