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     */
017    package org.apache.logging.log4j.nosql.appender;
018    
019    /**
020     * Implementations of this class are plugins for configuring the {@link NoSqlAppender} with the proper provider
021     * (MongoDB, etc.).
022     *
023     * @param <C> Specifies which implementation of {@link NoSqlConnection} this provider provides.
024     */
025    public interface NoSqlProvider<C extends NoSqlConnection<?, ? extends NoSqlObject<?>>> {
026        
027        /**
028         * Obtains a connection from this provider. The concept of a connection in this case is not strictly an active
029         * duplex UDP or TCP connection to the underlying database. It can be thought of more as a gateway, a path for
030         * inserting objects that may use a persistent connection or may use HTTP web service calls, etc.
031         * <p>
032         * Where applicable, this method should return a connection from the connection pool as opposed to opening a
033         * brand new connection every time.
034         * </p>
035         * 
036         * @return a connection that can be used to create and persist objects to this database.
037         * @see NoSqlConnection
038         */
039        C getConnection();
040    
041        /**
042         * All implementations must override {@link Object#toString()} to provide information about the provider
043         * configuration (obscuring passwords with one-way hashes).
044         *
045         * @return the string representation of this NoSQL provider.
046         */
047        @Override
048        String toString();
049    }