Manager (couchbase-lite-java-core API)

java.lang.Object
- com.couchbase.lite.Manager

```
public final class Manager
extends java.lang.Object
```
Top-level CouchbaseLite object; manages a collection of databases as a CouchDB server does.

Field Summary

Fields
Modifier and Type	Field and Description
`static ManagerOptions`	`DEFAULT_OPTIONS`
`static java.lang.String`	`FORESTDB_STORAGE`
`protected static java.lang.String`	`kDBExtension`
`protected static java.lang.String`	`kV1DBExtension`
`static java.lang.String`	`LEGAL_CHARACTERS`
`static java.lang.String`	`PRODUCT_NAME`
`static java.lang.String`	`SQLITE_STORAGE`
`static java.lang.String`	`USER_AGENT`
`static java.lang.String`	`VERSION`

Constructor Summary

Constructors
Constructor and Description

Manager()
Constructor

Manager(Context context, ManagerOptions options)
Constructor

Constructors
Constructor and Description
`Manager()` Constructor
`Manager(Context context, ManagerOptions options)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.util.Collection<Database>`	`allOpenDatabases()`
`void`	`close()` Releases all resources used by the Manager instance and closes all its databases.
`static void`	`enableLogging(java.lang.String tag, int logLevel)` Enable logging for a particular tag / loglevel combo
`protected void`	`forgetDatabase(Database db)`
`java.util.List<java.lang.String>`	`getAllDatabaseNames()` An array of the names of all existing databases.
`Context`	`getContext()`
`Database`	`getDatabase(java.lang.String name)` Returns the database with the given name, or creates it if it doesn't exist.
`Database`	`getDatabase(java.lang.String name, boolean mustExist)` Instantiates a database but doesn't open the file yet.
`HttpClientFactory`	`getDefaultHttpClientFactory()`
`java.io.File`	`getDirectory()` The root directory of this manager (as specified at initialization time.)
`java.util.Map<java.lang.String,java.lang.Object>`	`getEncryptionKeys()`
`int`	`getExecutorThreadPoolSize()`
`Database`	`getExistingDatabase(java.lang.String name)` Returns the database with the given name, or null if it doesn't exist.
`static java.lang.String`	`getFullVersionInfo()`
`static ObjectMapper`	`getObjectMapper()`
`Replication`	`getReplicator(java.util.Map<java.lang.String,java.lang.Object> properties)`
`static Manager`	`getSharedInstance()` Get shared instance
`java.lang.String`	`getStorageType()` Get the default storage type.
`static java.lang.String`	`getUserAgent()` Return User-Agent value Format: ex: CouchbaseLite/1.2 (Java Linux/MIPS 1.2.1/3382EFA)
`java.util.concurrent.ScheduledExecutorService`	`getWorkExecutor()`
`protected boolean`	`isAutoMigrateBlobStoreFilename()`
`static boolean`	`isValidDatabaseName(java.lang.String databaseName)` Returns YES if the given name is a valid database name.
`Database`	`openDatabase(java.lang.String name, DatabaseOptions options)` Returns the database with the given name.
`boolean`	`registerEncryptionKey(java.lang.Object keyOrPassword, java.lang.String databaseName)` This method has been superseded by `openDatabase(String, DatabaseOptions)`.
`void`	`replaceDatabase(java.lang.String databaseName, java.io.InputStream databaseStream, java.util.Map<java.lang.String,java.io.InputStream> attachmentStreams)` Replaces or installs a database from a file.
`boolean`	`replaceDatabase(java.lang.String databaseName, java.lang.String databaseDir)` Replaces or installs a database from a file.
`protected java.util.concurrent.Future`	`runAsync(java.lang.Runnable runnable)`
`java.util.concurrent.Future`	`runAsync(java.lang.String databaseName, AsyncTask function)` Asynchronously dispatches a callback to run on a background thread.
`void`	`setDefaultHttpClientFactory(HttpClientFactory defaultHttpClientFactory)`
`void`	`setStorageType(java.lang.String storageType)` Set default storage engine type for newly-created databases.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PRODUCT_NAME
```
public static final java.lang.String PRODUCT_NAME
```
    See Also:
    
    Constant Field Values
  - kV1DBExtension
```
protected static final java.lang.String kV1DBExtension
```
    See Also:
    
    Constant Field Values
  - kDBExtension
```
protected static final java.lang.String kDBExtension
```
    See Also:
    
    Constant Field Values
  - DEFAULT_OPTIONS
```
public static final ManagerOptions DEFAULT_OPTIONS
```
  - LEGAL_CHARACTERS
```
public static final java.lang.String LEGAL_CHARACTERS
```
    See Also:
    
    Constant Field Values
  - USER_AGENT
```
public static java.lang.String USER_AGENT
```
  - SQLITE_STORAGE
```
public static final java.lang.String SQLITE_STORAGE
```
    See Also:
    
    Constant Field Values
  - FORESTDB_STORAGE
```
public static final java.lang.String FORESTDB_STORAGE
```
    See Also:
    
    Constant Field Values
  - VERSION
```
public static final java.lang.String VERSION
```
- Constructor Detail
  - Manager
```
public Manager()
```
    Constructor
    
    Throws:
    
    java.lang.UnsupportedOperationException - - not currently supported
  - Manager
```
public Manager(Context context,
               ManagerOptions options)
        throws java.io.IOException
```
    Constructor
    
    Throws:
    
    java.lang.SecurityException - - Runtime exception that can be thrown by File.mkdirs()
    
    java.io.IOException
- Method Detail
  - getSharedInstance
```
public static Manager getSharedInstance()
```
    Get shared instance
    
    Throws:
    
    java.lang.UnsupportedOperationException - - not currently supported
  - getStorageType
```
public java.lang.String getStorageType()
```
    Get the default storage type.
    
    Returns:
    
    Storage type.
  - setStorageType
```
public void setStorageType(java.lang.String storageType)
```
    Set default storage engine type for newly-created databases. There are two options, "SQLite" (the default) or "ForestDB".
    
    Parameters:
    
    storageType -
  - enableLogging
```
public static void enableLogging(java.lang.String tag,
                                 int logLevel)
```
    Enable logging for a particular tag / loglevel combo
    
    Parameters:
    
    tag - Used to identify the source of a log message. It usually identifies the class or activity where the log call occurs.
    
    logLevel - The loglevel to enable. Anything matching this loglevel or having a more urgent loglevel will be emitted. Eg, Log.VERBOSE.
  - isValidDatabaseName
```
public static boolean isValidDatabaseName(java.lang.String databaseName)
```
    Returns YES if the given name is a valid database name. (Only the characters in "abcdefghijklmnopqrstuvwxyz0123456789_$()+-/" are allowed.)
  - getAllDatabaseNames
```
public java.util.List<java.lang.String> getAllDatabaseNames()
```
    An array of the names of all existing databases.
  - getDirectory
```
public java.io.File getDirectory()
```
    The root directory of this manager (as specified at initialization time.)
  - close
```
public void close()
```
    Releases all resources used by the Manager instance and closes all its databases.
  - getDatabase
```
public Database getDatabase(java.lang.String name)
                     throws CouchbaseLiteException
```
    Returns the database with the given name, or creates it if it doesn't exist. Multiple calls with the same name will return the same Database instance.
    
    This is equivalent to calling openDatabase(String, DatabaseOptions) with a default set of options with the `Create` flag set.
    
    NOTE: Database names may not contain capital letters.
    
    Throws:
    
    CouchbaseLiteException
  - getExistingDatabase
```
public Database getExistingDatabase(java.lang.String name)
                             throws CouchbaseLiteException
```
    Returns the database with the given name, or null if it doesn't exist. Multiple calls with the same name will return the same Database instance.
    
    This is equivalent to calling openDatabase(String, DatabaseOptions) with a default set of options.
    
    Throws:
    
    CouchbaseLiteException
  - openDatabase
```
public Database openDatabase(java.lang.String name,
                             DatabaseOptions options)
                      throws CouchbaseLiteException
```
    Returns the database with the given name. If the database is not yet open, the options given will be applied; if it's already open, the options are ignored. Multiple calls with the same name will return the same Database instance.
    
    Parameters:
    
    name - The name of the database. May NOT contain capital letters!
    
    options - Options to use when opening, such as the encryption key; if null, a default set of options will be used.
    
    Returns:
    
    The database instance.
    
    Throws:
    
    CouchbaseLiteException - thrown when there is an error.
  - registerEncryptionKey
```
public boolean registerEncryptionKey(java.lang.Object keyOrPassword,
                                     java.lang.String databaseName)
```
    This method has been superseded by openDatabase(String, DatabaseOptions). Registers an encryption key for a database. This must be called _before_ opening an encrypted database, or before creating a database that's to be encrypted. If the key is incorrect (or no key is given for an encrypted database), the subsequent call to open the database will fail with an error with code 401. To use this API, the database storage engine must support encryption, and the ManagerOptions.EnableStorageEncryption property must be set to true. Otherwise opening the database will fail with an error.
    
    Parameters:
    
    keyOrPassword - The encryption key in the form of an String (a password) or an byte[] object exactly 32 bytes in length (a raw AES key.) If a string is given, it will be internally converted to a raw key using 64,000 rounds of PBKDF2 hashing. A null value is legal, and clears a previously-registered key.
    
    databaseName - The name of the database.
    
    Returns:
    
    True if the key can be used, False if it's not in a legal form (e.g. key as a byte[] is not 32 bytes in length.)
  - replaceDatabase
```
public void replaceDatabase(java.lang.String databaseName,
                            java.io.InputStream databaseStream,
                            java.util.Map<java.lang.String,java.io.InputStream> attachmentStreams)
                     throws CouchbaseLiteException
```
    Replaces or installs a database from a file.
    This is primarily used to install a canned database on first launch of an app, in which case you should first check .exists to avoid replacing the database if it exists already. The canned database would have been copied into your app bundle at build time. This property is deprecated for the new .cblite2 database file. If the database file is a directory and has the .cblite2 extension, use -replaceDatabaseNamed:withDatabaseDir:error: instead.
    
    Parameters:
    
    databaseName - The name of the target Database to replace or create.
    
    databaseStream - InputStream on the source Database file.
    
    attachmentStreams - Map of the associated source Attachments, or null if there are no attachments. The Map key is the name of the attachment, the map value is an InputStream for the attachment contents. If you wish to control the order that the attachments will be processed, use a LinkedHashMap, SortedMap or similar and the iteration order will be honoured.
    
    Throws:
    
    CouchbaseLiteException
  - replaceDatabase
```
public boolean replaceDatabase(java.lang.String databaseName,
                               java.lang.String databaseDir)
```
    Replaces or installs a database from a file. This is primarily used to install a canned database on first launch of an app, in which case you should first check .exists to avoid replacing the database if it exists already. The canned database would have been copied into your app bundle at build time. If the database file is not a directory and has the .cblite extension, use -replaceDatabaseNamed:withDatabaseFile:withAttachments:error: instead.
    
    Parameters:
    
    databaseName - The name of the database to replace.
    
    databaseDir - Path of the database directory that should replace it.
    
    Returns:
    
    YES if the database was copied, NO if an error occurred.
  - getObjectMapper
```
public static ObjectMapper getObjectMapper()
```
  - getDefaultHttpClientFactory
```
public HttpClientFactory getDefaultHttpClientFactory()
```
  - setDefaultHttpClientFactory
```
public void setDefaultHttpClientFactory(HttpClientFactory defaultHttpClientFactory)
```
  - allOpenDatabases
```
public java.util.Collection<Database> allOpenDatabases()
```
  - getEncryptionKeys
```
public java.util.Map<java.lang.String,java.lang.Object> getEncryptionKeys()
```
  - runAsync
```
public java.util.concurrent.Future runAsync(java.lang.String databaseName,
                                            AsyncTask function)
                                     throws CouchbaseLiteException
```
    Asynchronously dispatches a callback to run on a background thread. The callback will be passed Database instance. There is not currently a known reason to use it, it may not make sense on the Android API, but it was added for the purpose of having a consistent API with iOS.
    
    Throws:
    
    CouchbaseLiteException
  - getDatabase
```
public Database getDatabase(java.lang.String name,
                            boolean mustExist)
```
    Instantiates a database but doesn't open the file yet. in CBLManager.m - (CBLDatabase*) _databaseNamed: (NSString*)name mustExist: (BOOL)mustExist error: (NSError**)outError
  - getReplicator
```
public Replication getReplicator(java.util.Map<java.lang.String,java.lang.Object> properties)
                          throws CouchbaseLiteException
```
    Throws:
    
    CouchbaseLiteException
  - getWorkExecutor
```
public java.util.concurrent.ScheduledExecutorService getWorkExecutor()
```
  - getContext
```
public Context getContext()
```
  - getExecutorThreadPoolSize
```
public int getExecutorThreadPoolSize()
```
  - runAsync
```
protected java.util.concurrent.Future runAsync(java.lang.Runnable runnable)
```
  - forgetDatabase
```
protected void forgetDatabase(Database db)
```
  - isAutoMigrateBlobStoreFilename
```
protected boolean isAutoMigrateBlobStoreFilename()
```
  - getUserAgent
```
public static java.lang.String getUserAgent()
```
    Return User-Agent value Format: ex: CouchbaseLite/1.2 (Java Linux/MIPS 1.2.1/3382EFA)
  - getFullVersionInfo
```
public static java.lang.String getFullVersionInfo()
```

Class Manager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PRODUCT_NAME

kV1DBExtension

kDBExtension

DEFAULT_OPTIONS

LEGAL_CHARACTERS

USER_AGENT

SQLITE_STORAGE

FORESTDB_STORAGE

VERSION

Constructor Detail

Manager

Manager

Method Detail

getSharedInstance

getStorageType

setStorageType

enableLogging

isValidDatabaseName

getAllDatabaseNames

getDirectory

close

getDatabase

getExistingDatabase

openDatabase

registerEncryptionKey

replaceDatabase

replaceDatabase

getObjectMapper

getDefaultHttpClientFactory

setDefaultHttpClientFactory

allOpenDatabases

getEncryptionKeys

runAsync

getDatabase

getReplicator

getWorkExecutor

getContext

getExecutorThreadPoolSize

runAsync

forgetDatabase

isAutoMigrateBlobStoreFilename

getUserAgent

getFullVersionInfo