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.appender.db.jdbc;
    18
    19  import java.sql.Connection;
    20  import java.sql.SQLException;
    21
    22  /**
    23   * Configuration element for {@link JdbcAppender}. If you want to use the {@link JdbcAppender} but none of the provided
    24   * connection sources meet your needs, you can simply create your own connection source.
    25   */
    26  public interface ConnectionSource {
    27      /**
    28       * This should return a new connection every time it is called.
    29       *
    30       * @return the SQL connection object.
    31       * @throws SQLException if a database error occurs.
    32       */
    33      Connection getConnection() throws SQLException;
    34
    35      /**
    36       * All implementations must override {@link Object#toString()} to provide information about the connection
    37       * configuration (obscuring passwords with one-way hashes).
    38       *
    39       * @return the string representation of this connection source.
    40       */
    41      @Override
    42      String toString();
    43  }