001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.core.appender.db.jdbc; 018 019import java.sql.Connection; 020import java.sql.SQLException; 021 022import org.apache.logging.log4j.core.LifeCycle; 023 024/** 025 * Configuration element for {@link JdbcAppender}. If you want to use the {@link JdbcAppender} but none of the provided 026 * connection sources meet your needs, you can simply create your own connection source. 027 */ 028public interface ConnectionSource extends LifeCycle { 029 030 /** 031 * This should return a new connection every time it is called. 032 * 033 * @return the SQL connection object. 034 * @throws SQLException if a database error occurs. 035 */ 036 Connection getConnection() throws SQLException; 037 038 /** 039 * All implementations must override {@link Object#toString()} to provide information about the connection 040 * configuration (obscuring passwords with one-way hashes). 041 * 042 * @return the string representation of this connection source. 043 */ 044 @Override 045 String toString(); 046}