| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>NoSqlConnection (Apache Log4j Core 2.23.1 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.logging.log4j.core.appender.nosql, interface: NoSqlConnection"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/NoSqlConnection.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.logging.log4j.core.appender.nosql</a></div> |
| <h1 title="Interface NoSqlConnection" class="title">Interface NoSqlConnection<W,<wbr>T extends <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql">NoSqlObject</a><W>></h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>Type Parameters:</dt> |
| <dd><code>T</code> - Specifies which implementation of <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a> this connection provides.</dd> |
| <dd><code>W</code> - Specifies which type of database object is wrapped by the <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a> implementation provided.</dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| </dl> |
| <dl class="notes"> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="AbstractNoSqlConnection.html" title="class in org.apache.logging.log4j.core.appender.nosql">AbstractNoSqlConnection</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">NoSqlConnection<W,<wbr>T extends <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql">NoSqlObject</a><W>></span><span class="extends-implements"> |
| extends <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></span></div> |
| <div class="block">Represents a connection to the NoSQL database. Serves as a factory for new (empty) objects and an endpoint for |
| inserted objects.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#close()" class="member-name-link">close</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Closes the underlying connection.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="NoSqlConnection.html" title="type parameter in NoSqlConnection">T</a>[]</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createList(int)" class="member-name-link">createList</a><wbr>(int length)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Creates an array of the specified length typed to match the <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a> implementation appropriate for |
| this provider.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="NoSqlConnection.html" title="type parameter in NoSqlConnection">T</a></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#createObject()" class="member-name-link">createObject</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Instantiates and returns a <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a> instance whose properties can be configured before ultimate |
| insertion via <a href="#insertObject(org.apache.logging.log4j.core.appender.nosql.NoSqlObject)"><code>insertObject(NoSqlObject)</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#insertObject(org.apache.logging.log4j.core.appender.nosql.NoSqlObject)" class="member-name-link">insertObject</a><wbr>(<a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql">NoSqlObject</a><<a href="NoSqlConnection.html" title="type parameter in NoSqlConnection">W</a>> object)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Inserts the given object into the underlying NoSQL database.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#isClosed()" class="member-name-link">isClosed</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"> |
| <div class="block">Indicates whether the underlying connection is closed.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="createObject()"> |
| <h3>createObject</h3> |
| <div class="member-signature"><span class="return-type"><a href="NoSqlConnection.html" title="type parameter in NoSqlConnection">T</a></span> <span class="element-name">createObject</span>()</div> |
| <div class="block">Instantiates and returns a <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a> instance whose properties can be configured before ultimate |
| insertion via <a href="#insertObject(org.apache.logging.log4j.core.appender.nosql.NoSqlObject)"><code>insertObject(NoSqlObject)</code></a>.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>a new object.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="createList(int)"> |
| <h3>createList</h3> |
| <div class="member-signature"><span class="return-type"><a href="NoSqlConnection.html" title="type parameter in NoSqlConnection">T</a>[]</span> <span class="element-name">createList</span><wbr><span class="parameters">(int length)</span></div> |
| <div class="block">Creates an array of the specified length typed to match the <a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a> implementation appropriate for |
| this provider.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>length</code> - the length of the array to create.</dd> |
| <dt>Returns:</dt> |
| <dd>a new array.</dd> |
| <dt>See Also:</dt> |
| <dd> |
| <ul class="see-list"> |
| <li><a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql"><code>NoSqlObject</code></a></li> |
| </ul> |
| </dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="insertObject(org.apache.logging.log4j.core.appender.nosql.NoSqlObject)"> |
| <h3>insertObject</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">insertObject</span><wbr><span class="parameters">(<a href="NoSqlObject.html" title="interface in org.apache.logging.log4j.core.appender.nosql">NoSqlObject</a><<a href="NoSqlConnection.html" title="type parameter in NoSqlConnection">W</a>> object)</span></div> |
| <div class="block">Inserts the given object into the underlying NoSQL database.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>object</code> - The object to insert.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="close()"> |
| <h3>close</h3> |
| <div class="member-signature"><span class="return-type">void</span> <span class="element-name">close</span>()</div> |
| <div class="block">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. |
| <p> |
| 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. |
| </p></div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html#close--" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html" title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> |
| <dt>Specified by:</dt> |
| <dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html#close--" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html" title="class or interface in java.io" class="external-link">Closeable</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isClosed()"> |
| <h3>isClosed</h3> |
| <div class="member-signature"><span class="return-type">boolean</span> <span class="element-name">isClosed</span>()</div> |
| <div class="block">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 |
| <code>true</code> if a call to <a href="#insertObject(org.apache.logging.log4j.core.appender.nosql.NoSqlObject)"><code>insertObject(NoSqlObject)</code></a> <b>will</b> fail due to the state of this object.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd><code>true</code> if this object is considered closed.</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small><p align="center"> Copyright © 1999-2024 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.<br/> 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. </p></small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
