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 java.io.Serializable;
20  import java.util.Properties;
21  import javax.jms.JMSException;
22  import javax.jms.Message;
23  import javax.jms.MessageProducer;
24  import javax.jms.ObjectMessage;
25  import javax.jms.Session;
26  import javax.jms.TextMessage;
27  import javax.naming.Context;
28  import javax.naming.InitialContext;
29  import javax.naming.NameNotFoundException;
30  import javax.naming.NamingException;
31  
32  import org.apache.logging.log4j.core.appender.AbstractManager;
33  
34  /**
35   * Base Class for Managers of JMS connections.
36   */
37  public abstract class AbstractJMSManager extends AbstractManager {
38  
39      /**
40       * The Constructor.
41       * @param name The name of the Appender.
42       */
43      public AbstractJMSManager(final String name) {
44          super(name);
45      }
46  
47      /**
48       * Create the InitialContext.
49       * @param factoryName The fully qualified class name of the InitialContextFactory.
50       * @param providerURL The URL of the provider to use.
51       * @param urlPkgPrefixes A colon-separated list of package prefixes for the class name of the factory class that
52       * will create a URL context factory
53       * @param securityPrincipalName The name of the identity of the Principal.
54       * @param securityCredentials The security credentials of the Principal.
55       * @return the InitialContext.
56       * @throws NamingException if a naming error occurs.
57       */
58      protected static Context createContext(final String factoryName, final String providerURL,
59                                             final String urlPkgPrefixes, final String securityPrincipalName,
60                                             final String securityCredentials)
61          throws NamingException {
62  
63          final Properties props = getEnvironment(factoryName, providerURL, urlPkgPrefixes, securityPrincipalName,
64                                            securityCredentials);
65          return new InitialContext(props);
66      }
67  
68      /**
69       * Looks up the name in the context.
70       * @param ctx The Context.
71       * @param name The name to locate.
72       * @return The object to be located.
73       * @throws NamingException If an error occurs locating the name.
74       */
75      protected static Object lookup(final Context ctx, final String name) throws NamingException {
76          try {
77              return ctx.lookup(name);
78          } catch (final NameNotFoundException e) {
79              LOGGER.warn("Could not find name [" + name + "].");
80              throw e;
81          }
82      }
83  
84      /**
85       * Sets up the properties to pass to the InitialContext.
86       * @param factoryName The fully qualified class name of the InitialContextFactory.
87       * @param providerURL The URL of the provider to use.
88       * @param urlPkgPrefixes A colon-separated list of package prefixes for the class name of the factory class that
89       * will create a URL context factory
90       * @param securityPrincipalName The name of the identity of the Principal.
91       * @param securityCredentials The security credentials of the Principal.
92       * @return The Properties.
93       */
94      protected static Properties getEnvironment(final String factoryName, final String providerURL,
95                                                 final String urlPkgPrefixes, final String securityPrincipalName,
96                                                 final String securityCredentials) {
97          final Properties props = new Properties();
98          if (factoryName != null) {
99              props.put(Context.INITIAL_CONTEXT_FACTORY, factoryName);
100             if (providerURL != null) {
101                 props.put(Context.PROVIDER_URL, providerURL);
102             } else {
103                 LOGGER.warn("The InitialContext factory name has been provided without a ProviderURL. " +
104                     "This is likely to cause problems");
105             }
106             if (urlPkgPrefixes != null) {
107                 props.put(Context.URL_PKG_PREFIXES, urlPkgPrefixes);
108             }
109             if (securityPrincipalName != null) {
110                 props.put(Context.SECURITY_PRINCIPAL, securityPrincipalName);
111                 if (securityCredentials != null) {
112                     props.put(Context.SECURITY_CREDENTIALS, securityCredentials);
113                 } else {
114                     LOGGER.warn("SecurityPrincipalName has been set without SecurityCredentials. " +
115                         "This is likely to cause problems.");
116                 }
117             }
118             return props;
119         }
120         return null;
121     }
122 
123     /**
124      * Send the message.
125      * @param object The Object to sent.
126      * @throws Exception if an error occurs.
127      */
128     public abstract void send(Serializable object) throws Exception;
129 
130     /**
131      * Send the Object.
132      * @param object The Object to send.
133      * @param session The Session.
134      * @param producer The MessageProducer.
135      * @throws Exception if an error occurs.
136      */
137     public synchronized void send(final Serializable object, final Session session, final MessageProducer producer)
138         throws Exception {
139         try {
140             Message msg;
141             if (object instanceof String) {
142                 msg = session.createTextMessage();
143                 ((TextMessage) msg).setText((String) object);
144             } else {
145                 msg = session.createObjectMessage();
146                 ((ObjectMessage) msg).setObject(object);
147             }
148             producer.send(msg);
149         } catch (final JMSException ex) {
150             LOGGER.error("Could not publish message via JMS " + getName());
151             throw ex;
152         }
153     }
154 }