Orient (OrientDB 2.2.1-SNAPSHOT API)

java.lang.Object
- com.orientechnologies.common.listener.OListenerManger<OOrientListener>
- - com.orientechnologies.orient.core.Orient

public class Orient
extends OListenerManger<OOrientListener>

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`class`	`Orient.OShutdownEnginesHandler` Closes all storages and shutdown all engines.
`class`	`Orient.OShutdownWorkersHandler` Shutdown thread group which is used in methods `submit(Callable)` and `submit(Runnable)`.

Field Summary

Fields
Modifier and Type Field and Description

static String ORIENTDB_HOME

static String URL_SYNTAX

Fields
Modifier and Type	Field and Description
`static String`	`ORIENTDB_HOME`
`static String`	`URL_SYNTAX`

Constructor Summary

Constructors
Modifier Constructor and Description

protected Orient()

Constructors
Modifier	Constructor and Description
`protected`	`Orient()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDbLifecycleListener(ODatabaseLifecycleListener iListener)`
`void`	`addShutdownHandler(OShutdownHandler shutdownHandler)` Add handler which will be executed during `shutdown()` call.
`void`	`closeAllStorages()`
`ODatabaseThreadLocalFactory`	`getDatabaseThreadFactory()`
`Iterator<ODatabaseLifecycleListener>`	`getDbLifecycleListeners()`
`OEngine`	`getEngine(String engineName)` Returns the engine by its name.
`Set<String>`	`getEngines()`
`static String`	`getHomePath()`
`OLocalRecordCacheFactory`	`getLocalRecordCache()`
`OProfiler`	`getProfiler()`
`ORecordConflictStrategyFactory`	`getRecordConflictStrategy()`
`ORecordFactoryManager`	`getRecordFactoryManager()`
`OScriptManager`	`getScriptManager()`
`OSecuritySystem`	`getSecurity()`
`OStorage`	`getStorage(String dbName)`
`Collection<OStorage>`	`getStorages()`
`static String`	`getTempPath()`
`ThreadGroup`	`getThreadGroup()`
`Timer`	`getTimer()` Deprecated. This method is not thread safe please use `scheduleTask(java.util.TimerTask, long, long)` instead.
`ThreadPoolExecutor`	`getWorkers()` Deprecated. This method is not thread safe. Use `submit(java.util.concurrent.Callable)` instead.
`static Orient`	`instance()`
`boolean`	`isActive()`
`static boolean`	`isRegisterDatabaseByPath()` Tells if to register database by path.
`boolean`	`isRunningDistributed()`
`boolean`	`isSelfManagedShutdown()`
`boolean`	`isWindowsOS()`
`OStorage`	`loadStorage(String iURL)`
`void`	`registerListener(OOrientListener listener)`
`void`	`registerOrientStartupListener(OOrientStartupListener listener)`
`void`	`registerThreadDatabaseFactory(ODatabaseThreadLocalFactory iDatabaseFactory)`
`void`	`registerWeakOrientShutdownListener(OOrientShutdownListener listener)`
`void`	`registerWeakOrientStartupListener(OOrientStartupListener listener)`
`void`	`removeDbLifecycleListener(ODatabaseLifecycleListener iListener)`
`void`	`removeShutdownHook()`
`void`	`removeSignalHandler()`
`void`	`resetListeners()`
`void`	`scheduleTask(TimerTask task, Date firstTime, long period)`
`void`	`scheduleTask(TimerTask task, long delay, long period)`
`void`	`setProfiler(OProfiler iProfiler)`
`void`	`setRecordFactoryManager(ORecordFactoryManager iRecordFactoryManager)`
`static void`	`setRegisterDatabaseByPath(boolean iValue)` Register database by path.
`void`	`setRunningDistributed(boolean runningDistributed)`
`void`	`setSecurity(OSecuritySystem security)`
`Orient`	`shutdown()`
`Orient`	`startup()`
`<V> Future<V>`	`submit(Callable<V> callable)`
`Future<?>`	`submit(Runnable runnable)`
`void`	`unregisterListener(OOrientListener listener)`
`void`	`unregisterOrientStartupListener(OOrientStartupListener listener)`
`void`	`unregisterStorage(OStorage storage)`
`void`	`unregisterStorageByName(String name)`
`void`	`unregisterWeakOrientShutdownListener(OOrientShutdownListener listener)`
`void`	`unregisterWeakOrientStartupListener(OOrientStartupListener listener)`

Methods inherited from class com.orientechnologies.common.listener.OListenerManger
browseListeners, getListenersCopy

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

Field Detail
- ORIENTDB_HOME
```
public static final String ORIENTDB_HOME
```
  See Also:
  
  Constant Field Values
- URL_SYNTAX
```
public static final String URL_SYNTAX
```
  See Also:
  
  Constant Field Values

Constructor Detail
- Orient
```
protected Orient()
```

Method Detail

instance
```
public static Orient instance()
```

getHomePath
```
public static String getHomePath()
```

getTempPath
```
public static String getTempPath()
```

isRegisterDatabaseByPath
```
public static boolean isRegisterDatabaseByPath()
```
Tells if to register database by path. Default is false. Setting to true allows to have multiple databases in different path with the same name.

See Also:

setRegisterDatabaseByPath(boolean)

setRegisterDatabaseByPath
```
public static void setRegisterDatabaseByPath(boolean iValue)
```
Register database by path. Default is false. Setting to true allows to have multiple databases in different path with the same name.

getRecordConflictStrategy

public ORecordConflictStrategyFactory getRecordConflictStrategy()

startup
```
public Orient startup()
```

addShutdownHandler
```
public void addShutdownHandler(OShutdownHandler shutdownHandler)
```
Add handler which will be executed during shutdown() call.

Parameters:

shutdownHandler - Shutdown handler instance.

shutdown
```
public Orient shutdown()
```

scheduleTask

public void scheduleTask(TimerTask task,
                         long delay,
                         long period)

scheduleTask

public void scheduleTask(TimerTask task,
                         Date firstTime,
                         long period)

closeAllStorages
```
public void closeAllStorages()
```

isActive
```
public boolean isActive()
```

getWorkers
```
@Deprecated
public ThreadPoolExecutor getWorkers()
```
Deprecated. This method is not thread safe. Use submit(java.util.concurrent.Callable) instead.

submit

public Future<?> submit(Runnable runnable)

submit

public <V> Future<V> submit(Callable<V> callable)

loadStorage

public OStorage loadStorage(String iURL)

isWindowsOS
```
public boolean isWindowsOS()
```

getStorage

public OStorage getStorage(String dbName)

getEngine
```
public OEngine getEngine(String engineName)
```
Returns the engine by its name.

Parameters:

engineName - Engine name to retrieve

Returns:

OEngine instance of found, otherwise null

getEngines
```
public Set<String> getEngines()
```

unregisterStorageByName

public void unregisterStorageByName(String name)

unregisterStorage

public void unregisterStorage(OStorage storage)

getStorages

public Collection<OStorage> getStorages()

getTimer
```
@Deprecated
public Timer getTimer()
```
Deprecated. This method is not thread safe please use scheduleTask(java.util.TimerTask, long, long) instead.

removeShutdownHook
```
public void removeShutdownHook()
```

removeSignalHandler
```
public void removeSignalHandler()
```

isSelfManagedShutdown

public boolean isSelfManagedShutdown()

getDbLifecycleListeners

public Iterator<ODatabaseLifecycleListener> getDbLifecycleListeners()

addDbLifecycleListener

public void addDbLifecycleListener(ODatabaseLifecycleListener iListener)

removeDbLifecycleListener

public void removeDbLifecycleListener(ODatabaseLifecycleListener iListener)

getThreadGroup
```
public ThreadGroup getThreadGroup()
```

getDatabaseThreadFactory

public ODatabaseThreadLocalFactory getDatabaseThreadFactory()

getRecordFactoryManager

public ORecordFactoryManager getRecordFactoryManager()

setRecordFactoryManager

public void setRecordFactoryManager(ORecordFactoryManager iRecordFactoryManager)

getProfiler
```
public OProfiler getProfiler()
```

setProfiler

public void setProfiler(OProfiler iProfiler)

getSecurity
```
public OSecuritySystem getSecurity()
```

setSecurity

public void setSecurity(OSecuritySystem security)

registerThreadDatabaseFactory

public void registerThreadDatabaseFactory(ODatabaseThreadLocalFactory iDatabaseFactory)

getScriptManager

public OScriptManager getScriptManager()

registerListener
```
public void registerListener(OOrientListener listener)
```
Overrides:

registerListener in class OListenerManger<OOrientListener>

unregisterListener
```
public void unregisterListener(OOrientListener listener)
```
Overrides:

unregisterListener in class OListenerManger<OOrientListener>

registerOrientStartupListener

public void registerOrientStartupListener(OOrientStartupListener listener)

registerWeakOrientStartupListener

public void registerWeakOrientStartupListener(OOrientStartupListener listener)

unregisterOrientStartupListener

public void unregisterOrientStartupListener(OOrientStartupListener listener)

unregisterWeakOrientStartupListener

public void unregisterWeakOrientStartupListener(OOrientStartupListener listener)

registerWeakOrientShutdownListener

public void registerWeakOrientShutdownListener(OOrientShutdownListener listener)

unregisterWeakOrientShutdownListener

public void unregisterWeakOrientShutdownListener(OOrientShutdownListener listener)

resetListeners
```
public void resetListeners()
```
Overrides:

resetListeners in class OListenerManger<OOrientListener>

getLocalRecordCache

public OLocalRecordCacheFactory getLocalRecordCache()

isRunningDistributed
```
public boolean isRunningDistributed()
```

setRunningDistributed

public void setRunningDistributed(boolean runningDistributed)

Class Orient

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.orientechnologies.common.listener.OListenerManger

Methods inherited from class java.lang.Object

Field Detail

ORIENTDB_HOME

URL_SYNTAX

Constructor Detail

Orient

Method Detail

instance

getHomePath

getTempPath

isRegisterDatabaseByPath

setRegisterDatabaseByPath

getRecordConflictStrategy

startup

addShutdownHandler

shutdown

scheduleTask

scheduleTask

closeAllStorages

isActive

getWorkers

submit

submit

loadStorage

isWindowsOS

getStorage

getEngine

getEngines

unregisterStorageByName

unregisterStorage

getStorages

getTimer

removeShutdownHook

removeSignalHandler

isSelfManagedShutdown

getDbLifecycleListeners

addDbLifecycleListener

removeDbLifecycleListener

getThreadGroup

getDatabaseThreadFactory

getRecordFactoryManager

setRecordFactoryManager

getProfiler

setProfiler

getSecurity

setSecurity

registerThreadDatabaseFactory

getScriptManager

registerListener

unregisterListener

registerOrientStartupListener

registerWeakOrientStartupListener

unregisterOrientStartupListener

unregisterWeakOrientStartupListener

registerWeakOrientShutdownListener

unregisterWeakOrientShutdownListener

resetListeners

getLocalRecordCache

isRunningDistributed

setRunningDistributed