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.nosql; 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. 30 * 31 * @return a connection that can be used to create and persist objects to this database. 32 * @see NoSQLConnection 33 */ 34 C getConnection(); 35 36 /** 37 * All implementations must override {@link Object#toString()} to provide information about the provider 38 * configuration (obscuring passwords with one-way hashes). 39 * 40 * @return the string representation of this NoSQL provider. 41 */ 42 @Override 43 String toString(); 44 }