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.nosql.appender; 18 19 /** 20 * Implementations of this class are plugins for configuring the {@link NoSqlAppender} with the proper provider 21 * (MongoDB, etc.). 22 * 23 * @param <C> Specifies which implementation of {@link NoSqlConnection} this provider provides. 24 */ 25 public interface NoSqlProvider<C extends NoSqlConnection<?, ? extends NoSqlObject<?>>> { 26 /** 27 * Obtains a connection from this provider. The concept of a connection in this case is not strictly an active 28 * duplex UDP or TCP connection to the underlying database. It can be thought of more as a gateway, a path for 29 * inserting objects that may use a persistent connection or may use HTTP web service calls, etc.<br /> 30 * <br /> 31 * Where applicable, this method should return a connection from the connection pool as opposed to opening a 32 * brand new connection every time. 33 * 34 * @return a connection that can be used to create and persist objects to this database. 35 * @see NoSqlConnection 36 */ 37 C getConnection(); 38 39 /** 40 * All implementations must override {@link Object#toString()} to provide information about the provider 41 * configuration (obscuring passwords with one-way hashes). 42 * 43 * @return the string representation of this NoSQL provider. 44 */ 45 @Override 46 String toString(); 47 }