| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (version 1.7.0_80) on Sun Nov 19 01:32:18 MST 2017 --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>MongoDbProvider (Apache Log4j MongoDB 2.10.0 API)</title> |
| <meta name="date" content="2017-11-19"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="MongoDbProvider (Apache Log4j MongoDB 2.10.0 API)"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar_top"> |
| <!-- --> |
| </a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../org/apache/logging/log4j/mongodb/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MongoDbProvider.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbObject.html" title="class in org.apache.logging.log4j.mongodb"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="class in org.apache.logging.log4j.mongodb"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/mongodb/MongoDbProvider.html" target="_top">Frames</a></li> |
| <li><a href="MongoDbProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.logging.log4j.mongodb</div> |
| <h2 title="Class MongoDbProvider" class="title">Class MongoDbProvider</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.logging.log4j.mongodb.MongoDbProvider</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd>org.apache.logging.log4j.core.appender.nosql.NoSqlProvider<<a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbConnection.html" title="class in org.apache.logging.log4j.mongodb">MongoDbConnection</a>></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>@Plugin(name="MongoDb", |
| category="Core", |
| printObject=true) |
| public final class <a href="../../../../../src-html/org/apache/logging/log4j/mongodb/MongoDbProvider.html#line.51">MongoDbProvider</a> |
| extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> |
| implements org.apache.logging.log4j.core.appender.nosql.NoSqlProvider<<a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbConnection.html" title="class in org.apache.logging.log4j.mongodb">MongoDbConnection</a>></pre> |
| <div class="block">The MongoDB implementation of <code>NoSqlProvider</code>.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="nested_class_summary"> |
| <!-- --> |
| </a> |
| <h3>Nested Class Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation"> |
| <caption><span>Nested Classes</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Class and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static class </code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="class in org.apache.logging.log4j.mongodb">MongoDbProvider.Builder</a><<a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="type parameter in MongoDbProvider.Builder">B</a> extends <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="class in org.apache.logging.log4j.mongodb">MongoDbProvider.Builder</a><<a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="type parameter in MongoDbProvider.Builder">B</a>>></strong></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span>Methods</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html" title="class in org.apache.logging.log4j.mongodb">MongoDbProvider</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html#createNoSqlProvider(java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String,%20java.lang.String)">createNoSqlProvider</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> collectionName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> writeConcernConstant, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> writeConcernConstantClassName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> databaseName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> server, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> port, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryClassName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryMethodName)</code> |
| <div class="block"><strong>Deprecated.</strong> |
| <div class="block"><i>in 2.8; use <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html#newBuilder()"><code>newBuilder()</code></a> instead.</i></div> |
| </div> |
| </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbConnection.html" title="class in org.apache.logging.log4j.mongodb">MongoDbConnection</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html#getConnection()">getConnection</a></strong>()</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <B extends <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="class in org.apache.logging.log4j.mongodb">MongoDbProvider.Builder</a><B>> <br>B</code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html#newBuilder()">newBuilder</a></strong>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><strong><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html#toString()">toString</a></strong>()</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method_detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getConnection()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getConnection</h4> |
| <pre>public <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbConnection.html" title="class in org.apache.logging.log4j.mongodb">MongoDbConnection</a> <a href="../../../../../src-html/org/apache/logging/log4j/mongodb/MongoDbProvider.html#line.76">getConnection</a>()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>getConnection</code> in interface <code>org.apache.logging.log4j.core.appender.nosql.NoSqlProvider<<a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbConnection.html" title="class in org.apache.logging.log4j.mongodb">MongoDbConnection</a>></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="toString()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>toString</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/logging/log4j/mongodb/MongoDbProvider.html#line.81">toString</a>()</pre> |
| <dl> |
| <dt><strong>Specified by:</strong></dt> |
| <dd><code>toString</code> in interface <code>org.apache.logging.log4j.core.appender.nosql.NoSqlProvider<<a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbConnection.html" title="class in org.apache.logging.log4j.mongodb">MongoDbConnection</a>></code></dd> |
| <dt><strong>Overrides:</strong></dt> |
| <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createNoSqlProvider(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createNoSqlProvider</h4> |
| <pre>@PluginFactory |
| public static <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html" title="class in org.apache.logging.log4j.mongodb">MongoDbProvider</a> <a href="../../../../../src-html/org/apache/logging/log4j/mongodb/MongoDbProvider.html#line.109">createNoSqlProvider</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> collectionName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> writeConcernConstant, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> writeConcernConstantClassName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> databaseName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> server, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> port, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> userName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> password, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryClassName, |
| <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> factoryMethodName)</pre> |
| <div class="block"><span class="strong">Deprecated.</span> <i>in 2.8; use <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.html#newBuilder()"><code>newBuilder()</code></a> instead.</i></div> |
| <div class="block">Factory method for creating a MongoDB provider within the plugin manager.</div> |
| <dl><dt><span class="strong">Parameters:</span></dt><dd><code>collectionName</code> - The name of the MongoDB collection to which log events should be written.</dd><dd><code>writeConcernConstant</code> - The <code>WriteConcern</code> constant to control writing details, defaults to |
| <code>WriteConcern.ACKNOWLEDGED</code>.</dd><dd><code>writeConcernConstantClassName</code> - The name of a class containing the aforementioned static WriteConcern |
| constant. Defaults to <code>WriteConcern</code>.</dd><dd><code>databaseName</code> - The name of the MongoDB database containing the collection to which log events should be |
| written. Mutually exclusive with <code>factoryClassName&factoryMethodName!=null</code>.</dd><dd><code>server</code> - The host name of the MongoDB server, defaults to localhost and mutually exclusive with |
| <code>factoryClassName&factoryMethodName!=null</code>.</dd><dd><code>port</code> - The port the MongoDB server is listening on, defaults to the default MongoDB port and mutually |
| exclusive with <code>factoryClassName&factoryMethodName!=null</code>.</dd><dd><code>userName</code> - The username to authenticate against the MongoDB server with.</dd><dd><code>password</code> - The password to authenticate against the MongoDB server with.</dd><dd><code>factoryClassName</code> - A fully qualified class name containing a static factory method capable of returning a |
| <code>DB</code> or a <code>MongoClient</code>.</dd><dd><code>factoryMethodName</code> - The name of the public static factory method belonging to the aforementioned factory |
| class.</dd> |
| <dt><span class="strong">Returns:</span></dt><dd>a new MongoDB provider.</dd></dl> |
| </li> |
| </ul> |
| <a name="newBuilder()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>newBuilder</h4> |
| <pre>@PluginBuilderFactory |
| public static <B extends <a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="class in org.apache.logging.log4j.mongodb">MongoDbProvider.Builder</a><B>> B <a href="../../../../../src-html/org/apache/logging/log4j/mongodb/MongoDbProvider.html#line.128">newBuilder</a>()</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar_bottom"> |
| <!-- --> |
| </a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../org/apache/logging/log4j/mongodb/package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/MongoDbProvider.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbObject.html" title="class in org.apache.logging.log4j.mongodb"><span class="strong">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/logging/log4j/mongodb/MongoDbProvider.Builder.html" title="class in org.apache.logging.log4j.mongodb"><span class="strong">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/logging/log4j/mongodb/MongoDbProvider.html" target="_top">Frames</a></li> |
| <li><a href="MongoDbProvider.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li><a href="#nested_class_summary">Nested</a> | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method_detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip-navbar_bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small><p align="center">Copyright © 1999-2017 <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> |
| </body> |
| </html> |
