/*
    * Licensed to the Apache Software Foundation (ASF) under one or more
    * contributor license agreements. See the NOTICE file distributed with
    * this work for additional information regarding copyright ownership.
    * The ASF licenses this file to You under the Apache license, Version 2.0
    * (the "License"); you may not use this file except in compliance with
    * the License. You may obtain a copy of the License at
    *
    *      http://www.apache.org/licenses/LICENSE-2.0
   *
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the license for the specific language governing permissions and
   * limitations under the license.
   */
  package org.apache.logging.log4j.core.appender.db.jdbc;
  
  import java.sql.Connection;
  import java.sql.SQLException;
  import java.util.Objects;
  
  import javax.naming.NamingException;
  import javax.sql.DataSource;
  
  import org.apache.logging.log4j.Logger;
  import org.apache.logging.log4j.core.Core;
  import org.apache.logging.log4j.core.config.plugins.Plugin;
  import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
  import org.apache.logging.log4j.core.config.plugins.PluginFactory;
  import org.apache.logging.log4j.core.net.JndiManager;
  import org.apache.logging.log4j.status.StatusLogger;
  import org.apache.logging.log4j.util.Strings;
  
  /**
   * A {@link JdbcAppender} connection source that uses a {@link DataSource} to connect to the database.
   */
  @Plugin(name = "DataSource", category = Core.CATEGORY_NAME, elementType = "connectionSource", printObject = true)
  public final class DataSourceConnectionSource extends AbstractConnectionSource {
      private static final Logger LOGGER = StatusLogger.getLogger();
  
      private final DataSource dataSource;
      private final String description;
  
      private DataSourceConnectionSource(final String dataSourceName, final DataSource dataSource) {
          this.dataSource = Objects.requireNonNull(dataSource, "dataSource");
          this.description = "dataSource{ name=" + dataSourceName + ", value=" + dataSource + " }";
      }
  
      @Override
      public Connection getConnection() throws SQLException {
          return this.dataSource.getConnection();
      }
  
      @Override
      public String toString() {
          return this.description;
      }
  
      /**
       * Factory method for creating a connection source within the plugin manager.
       *
       * @param jndiName The full JNDI path where the data source is bound. Must start with java:/comp/env or environment-equivalent.
       * @return the created connection source.
       */
      @PluginFactory
      public static DataSourceConnectionSource createConnectionSource(@PluginAttribute("jndiName") final String jndiName) {
          if (!JndiManager.isJndiJdbcEnabled()) {
              LOGGER.error("JNDI must be enabled by setting log4j2.enableJndiJdbc=true");
              return null;
          }
          if (Strings.isEmpty(jndiName)) {
              LOGGER.error("No JNDI name provided.");
              return null;
          }
          try {
              @SuppressWarnings("resource")
              final DataSource dataSource = JndiManager.getDefaultManager(DataSourceConnectionSource.class.getCanonicalName()).lookup(jndiName);
              if (dataSource == null) {
                  LOGGER.error("No DataSource found with JNDI name [" + jndiName + "].");
                  return null;
              }
              return new DataSourceConnectionSource(jndiName, dataSource);
          } catch (final NamingException e) {
              LOGGER.error(e.getMessage(), e);
              return null;
          }
      }
  }