org.apache.logging.log4j.nosql.appender

Interface NoSqlConnection<W,T extends NoSqlObject<W>>

    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void close()
      Closes the underlying connection.
      T[] createList(int length)
      Creates an array of the specified length typed to match the NoSqlObject implementation appropriate for this provider.
      T createObject()
      Instantiates and returns a NoSqlObject instance whose properties can be configured before ultimate insertion via insertObject(NoSqlObject).
      void insertObject(NoSqlObject<W> object)
      Inserts the given object into the underlying NoSQL database.
      boolean isClosed()
      Indicates whether the underlying connection is closed.
    • Method Detail

      • createList

        T[] createList(int length)
        Creates an array of the specified length typed to match the NoSqlObject implementation appropriate for this provider.
        Parameters:
        length - the length of the array to create.
        Returns:
        a new array.
        See Also:
        NoSqlObject
      • insertObject

        void insertObject(NoSqlObject<W> object)
        Inserts the given object into the underlying NoSQL database.
        Parameters:
        object - The object to insert.
      • close

        void close()
        Closes the underlying connection. This method call should be idempotent. Only the first call should have any effect; all further calls should be ignored. It's possible the underlying connection is stateless (such as an HTTP web service), in which case this method would be a no-op. This method should also commit any open transactions, if applicable and if not already committed.

        If this connection is part of a connection pool, executing this method should commit the transaction and return the connection to the pool, but it should not actually close the underlying connection.

        Specified by:
        close in interface AutoCloseable
        Specified by:
        close in interface Closeable
      • isClosed

        boolean isClosed()
        Indicates whether the underlying connection is closed. If the underlying connection is stateless (such as an HTTP web service), this method would likely always return true. Essentially, this method should only return true if a call to insertObject(NoSqlObject) will fail due to the state of this object.
        Returns:
        true if this object is considered closed.

Copyright © 1999-2017 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.