Interface NoSqlProvider<C extends NoSqlConnection<?,​? extends NoSqlObject<?>>>

  • Type Parameters:
    C - Specifies which implementation of NoSqlConnection this provider provides.
    All Known Implementing Classes:
    CouchDbProvider

    public interface NoSqlProvider<C extends NoSqlConnection<?,​? extends NoSqlObject<?>>>
    Implementations of this class are plugins for configuring the NoSqlAppender with the proper provider (MongoDB, etc.).
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      C getConnection()
      Obtains a connection from this provider.
      java.lang.String toString()
      All implementations must override Object.toString() to provide information about the provider configuration (obscuring passwords with one-way hashes).
    • Method Detail

      • getConnection

        C getConnection()
        Obtains a connection from this provider. The concept of a connection in this case is not strictly an active duplex UDP or TCP connection to the underlying database. It can be thought of more as a gateway, a path for inserting objects that may use a persistent connection or may use HTTP web service calls, etc.

        Where applicable, this method should return a connection from the connection pool as opposed to opening a brand new connection every time.

        Returns:
        a connection that can be used to create and persist objects to this database.
        See Also:
        NoSqlConnection
      • toString

        java.lang.String toString()
        All implementations must override Object.toString() to provide information about the provider configuration (obscuring passwords with one-way hashes).
        Overrides:
        toString in class java.lang.Object
        Returns:
        the string representation of this NoSQL provider.