@Plugin(name="CouchDB", category="Core", printObject=true) public final class CouchDbProvider extends Object implements NoSqlProvider<CouchDbConnection>
NoSqlProvider
.Modifier and Type | Method and Description |
---|---|
static CouchDbProvider |
createNoSqlProvider(String databaseName,
String protocol,
String server,
String port,
String username,
String password,
String factoryClassName,
String factoryMethodName)
Factory method for creating an Apache CouchDB provider within the plugin manager.
|
CouchDbConnection |
getConnection()
Obtains a connection from this provider.
|
String |
toString()
All implementations must override
Object.toString() to provide information about the provider
configuration (obscuring passwords with one-way hashes). |
public CouchDbConnection getConnection()
NoSqlProvider
Where applicable, this method should return a connection from the connection pool as opposed to opening a brand new connection every time.
getConnection
in interface NoSqlProvider<CouchDbConnection>
NoSqlConnection
public String toString()
NoSqlProvider
Object.toString()
to provide information about the provider
configuration (obscuring passwords with one-way hashes).toString
in interface NoSqlProvider<CouchDbConnection>
toString
in class Object
@PluginFactory public static CouchDbProvider createNoSqlProvider(@PluginAttribute(value="databaseName") String databaseName, @PluginAttribute(value="protocol") String protocol, @PluginAttribute(value="server",defaultString="localhost") @ValidHost String server, @PluginAttribute(value="port",defaultString="0") @ValidPort String port, @PluginAttribute(value="username") String username, @PluginAttribute(value="password",sensitive=true) String password, @PluginAttribute(value="factoryClassName") String factoryClassName, @PluginAttribute(value="factoryMethodName") String factoryMethodName)
databaseName
- The name of the database to which log event documents will be written.protocol
- Either "http" or "https," defaults to "http" and mutually exclusive with
factoryClassName&factoryMethodName!=null
.server
- The host name of the CouchDB server, defaults to localhost and mutually exclusive with
factoryClassName&factoryMethodName!=null
.port
- The port that CouchDB is listening on, defaults to 80 if protocol
is "http" and 443 if
protocol
is "https," and mutually exclusive with
factoryClassName&factoryMethodName!=null
.username
- The username to authenticate against the MongoDB server with, mutually exclusive with
factoryClassName&factoryMethodName!=null
.password
- The password to authenticate against the MongoDB server with, mutually exclusive with
factoryClassName&factoryMethodName!=null
.factoryClassName
- A fully qualified class name containing a static factory method capable of returning a
CouchDbClient
or CouchDbProperties
.factoryMethodName
- The name of the public static factory method belonging to the aforementioned factory
class.Copyright © 1999-2017. 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.