com.orientechnologies.orient.core.db

Class OrientDBEmbedded

java.lang.Object

com.orientechnologies.orient.core.db.OrientDBEmbedded

All Implemented Interfaces:

OrientDBInternal, AutoCloseable

Direct Known Subclasses:

OrientDBDistributed

public class OrientDBEmbedded
extends Object
implements OrientDBInternal

Created by tglman on 08/04/16.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	OrientDBEmbedded.DatabaseFound
static interface	OrientDBEmbedded.InstanceFactory<T>

Field Summary

Fields

Modifier and Type	Field and Description
protected String	basePath
protected OrientDBConfig	configurations
protected OEngine	disk
protected long	maxWALSegmentSize
protected OEngine	memory
protected Orient	orient
protected Set<ODatabasePoolInternal>	pools
protected Map<String,OAbstractPaginatedStorage>	storages

Constructor Summary

Constructors

Constructor and Description
OrientDBEmbedded(String directoryPath, OrientDBConfig configurations, Orient orient)

Method Summary

Modifier and Type	Method and Description
protected String	buildName(String name)
void	close() Close the factory with all related databases and pools.
void	create(String name, String user, String password, ODatabaseType type) Create a new database
void	create(String name, String user, String password, ODatabaseType type, OrientDBConfig config) Create a new database
void	drop(String name, String user, String password) Drop a database
boolean	exists(String name, String user, String password) Check if a database exists
void	forceDatabaseClose(String iDatabaseName)
protected int	generateStorageId()
OrientDBConfig	getConfigurations()
String	getDatabasePath(String iDatabaseName)
OEmbeddedDatabaseInstanceFactory	getFactory()
protected OAbstractPaginatedStorage	getOrInitStorage(String name)
OAbstractPaginatedStorage	getStorage(String name)
Collection<OStorage>	getStorages()
void	initAutoClose(long delay)
void	initCustomStorage(String name, String path, String userName, String userPassword)
void	internalClose() Should be called only by shutdown listeners
protected ODatabaseDocumentEmbedded	internalCreate(OrientDBConfig config, OAbstractPaginatedStorage storage)
boolean	isEmbedded()
boolean	isOpen() Check if the current instance is open
Set<String>	listDatabases(String user, String password) List of database exiting in the current environment
void	loadAllDatabases()
ODatabaseDocumentInternal	open(String name, String user, String password) Open a database specified by name using the username and password if needed
ODatabaseDocumentInternal	open(String name, String user, String password, OrientDBConfig config) Open a database specified by name using the username and password if needed, with specific configuration
ODatabaseDocumentEmbedded	openNoAuthenticate(String name, String user)
ODatabaseDocumentEmbedded	openNoAuthorization(String name)
ODatabasePoolInternal	openPool(String name, String user, String password) Open a pool of databases, similar to open but with multiple instances.
ODatabasePoolInternal	openPool(String name, String user, String password, OrientDBConfig config) Open a pool of databases, similar to open but with multiple instances.
ODatabaseDocumentInternal	poolOpen(String name, String user, String password, ODatabasePoolInternal pool) Internal api for request to open a database with a pool
void	removePool(ODatabasePoolInternal pool) Internal API for pool close
void	removeShutdownHook()
void	replaceFactory(OEmbeddedDatabaseInstanceFactory factory)
void	restore(String name, InputStream in, Map<String,Object> options, Callable<Object> callable, OCommandOutputListener iListener)
void	restore(String name, String user, String password, ODatabaseType type, String path, OrientDBConfig config)
protected OrientDBConfig	solveConfig(OrientDBConfig config)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.orientechnologies.orient.core.db.OrientDBInternal

distributed, embedded, extract, fromUrl, fullSync, newOrientDB, remote

Field Detail

storages

protected final Map<String,OAbstractPaginatedStorage> storages

pools

protected final Set<ODatabasePoolInternal> pools

configurations

protected final OrientDBConfig configurations

basePath

protected final String basePath

memory

protected final OEngine memory

disk

protected final OEngine disk

orient

protected final Orient orient

maxWALSegmentSize

protected final long maxWALSegmentSize

Constructor Detail

OrientDBEmbedded

public OrientDBEmbedded(String directoryPath,
                        OrientDBConfig configurations,
                        Orient orient)

Method Detail

initAutoClose

public void initAutoClose(long delay)

open

public ODatabaseDocumentInternal open(String name,
                                      String user,
                                      String password)

Description copied from interface: OrientDBInternal

Open a database specified by name using the username and password if needed

Specified by:

open in interface OrientDBInternal

Parameters:

name - of the database to open

user - the username allowed to open the database

password - related to the specified username

Returns:

the opened database

openNoAuthenticate

public ODatabaseDocumentEmbedded openNoAuthenticate(String name,
                                                    String user)

Specified by:

openNoAuthenticate in interface OrientDBInternal

openNoAuthorization

public ODatabaseDocumentEmbedded openNoAuthorization(String name)

Specified by:

openNoAuthorization in interface OrientDBInternal

open

public ODatabaseDocumentInternal open(String name,
                                      String user,
                                      String password,
                                      OrientDBConfig config)

Description copied from interface: OrientDBInternal

Open a database specified by name using the username and password if needed, with specific configuration

Specified by:

open in interface OrientDBInternal

Parameters:

name - of the database to open

user - the username allowed to open the database

password - related to the specified username

config - database specific configuration that override the factory global settings where needed.

Returns:

the opened database

solveConfig

protected OrientDBConfig solveConfig(OrientDBConfig config)

poolOpen

public ODatabaseDocumentInternal poolOpen(String name,
                                          String user,
                                          String password,
                                          ODatabasePoolInternal pool)

Description copied from interface: OrientDBInternal

Internal api for request to open a database with a pool

Specified by:

poolOpen in interface OrientDBInternal

getOrInitStorage

protected OAbstractPaginatedStorage getOrInitStorage(String name)

generateStorageId

protected final int generateStorageId()

getStorage

public OAbstractPaginatedStorage getStorage(String name)

buildName

protected String buildName(String name)

create

public void create(String name,
                   String user,
                   String password,
                   ODatabaseType type)

Description copied from interface: OrientDBInternal

Create a new database

Specified by:

create in interface OrientDBInternal

Parameters:

name - database name

user - the username of a user allowed to create a database, in case of remote is a server user for embedded it can be left empty

password - the password relative to the user

type - can be plocal or memory

create

public void create(String name,
                   String user,
                   String password,
                   ODatabaseType type,
                   OrientDBConfig config)

Description copied from interface: OrientDBInternal

Create a new database

Specified by:

create in interface OrientDBInternal

Parameters:

name - database name

user - the username of a user allowed to create a database, in case of remote is a server user for embedded it can be left empty

password - the password relative to the user

type - can be plocal or memory

config - database specific configuration that override the factory global settings where needed.

restore

public void restore(String name,
                    String user,
                    String password,
                    ODatabaseType type,
                    String path,
                    OrientDBConfig config)

Specified by:

restore in interface OrientDBInternal

restore

public void restore(String name,
                    InputStream in,
                    Map<String,Object> options,
                    Callable<Object> callable,
                    OCommandOutputListener iListener)

Specified by:

restore in interface OrientDBInternal

internalCreate

protected ODatabaseDocumentEmbedded internalCreate(OrientDBConfig config,
                                                   OAbstractPaginatedStorage storage)

exists

public boolean exists(String name,
                      String user,
                      String password)

Description copied from interface: OrientDBInternal

Check if a database exists

Specified by:

exists in interface OrientDBInternal

Parameters:

name - database name to check

user - the username of a user allowed to check the database existence, in case of remote is a server user for embedded it can be left empty.

password - the password relative to the user

Returns:

boolean true if exist false otherwise.

drop

public void drop(String name,
                 String user,
                 String password)

Description copied from interface: OrientDBInternal

Drop a database

Specified by:

drop in interface OrientDBInternal

Parameters:

name - database name

user - the username of a user allowed to drop a database, in case of remote is a server user for embedded it can be left empty

password - the password relative to the user

listDatabases

public Set<String> listDatabases(String user,
                                 String password)

Description copied from interface: OrientDBInternal

List of database exiting in the current environment

Specified by:

listDatabases in interface OrientDBInternal

Parameters:

user - the username of a user allowed to list databases, in case of remote is a server user for embedded it can be left empty

password - the password relative to the user

Returns:

a set of databases names.

loadAllDatabases

public void loadAllDatabases()

Specified by:

loadAllDatabases in interface OrientDBInternal

openPool

public ODatabasePoolInternal openPool(String name,
                                      String user,
                                      String password)

Description copied from interface: OrientDBInternal

Open a pool of databases, similar to open but with multiple instances.

Specified by:

openPool in interface OrientDBInternal

Parameters:

name - database name

user - the username allowed to open the database

password - the password relative to the user

Returns:

a new pool of databases.

openPool

public ODatabasePoolInternal openPool(String name,
                                      String user,
                                      String password,
                                      OrientDBConfig config)

Description copied from interface: OrientDBInternal

Open a pool of databases, similar to open but with multiple instances.

Specified by:

openPool in interface OrientDBInternal

Parameters:

name - database name

user - the username allowed to open the database

password - the password relative to the user

config - database specific configuration that override the factory global settings where needed.

Returns:

a new pool of databases.

close

public void close()

Description copied from interface: OrientDBInternal

Close the factory with all related databases and pools.

Specified by:

close in interface OrientDBInternal

Specified by:

close in interface AutoCloseable

internalClose

public void internalClose()

Description copied from interface: OrientDBInternal

Should be called only by shutdown listeners

Specified by:

internalClose in interface OrientDBInternal

getConfigurations

public OrientDBConfig getConfigurations()

removePool

public void removePool(ODatabasePoolInternal pool)

Description copied from interface: OrientDBInternal

Internal API for pool close

Specified by:

removePool in interface OrientDBInternal

initCustomStorage

public void initCustomStorage(String name,
                              String path,
                              String userName,
                              String userPassword)

Specified by:

initCustomStorage in interface OrientDBInternal

removeShutdownHook

public void removeShutdownHook()

Specified by:

removeShutdownHook in interface OrientDBInternal

getStorages

public Collection<OStorage> getStorages()

Specified by:

getStorages in interface OrientDBInternal

forceDatabaseClose

public void forceDatabaseClose(String iDatabaseName)

Specified by:

forceDatabaseClose in interface OrientDBInternal

getDatabasePath

public String getDatabasePath(String iDatabaseName)

replaceFactory

public void replaceFactory(OEmbeddedDatabaseInstanceFactory factory)

Specified by:

replaceFactory in interface OrientDBInternal

getFactory

public OEmbeddedDatabaseInstanceFactory getFactory()

Specified by:

getFactory in interface OrientDBInternal

isOpen

public boolean isOpen()

Description copied from interface: OrientDBInternal

Check if the current instance is open

Specified by:

isOpen in interface OrientDBInternal

isEmbedded

public boolean isEmbedded()

Specified by:

isEmbedded in interface OrientDBInternal