com.orientechnologies.orient.server

Class OServer

java.lang.Object

com.orientechnologies.orient.server.OServer

public class OServer
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
protected OContextConfiguration	contextConfiguration
protected ODistributedServerManager	distributedManager
protected OConfigurableHooksManager	hookManager
protected List<OServerLifecycleListener>	lifecycleListeners
protected ReentrantLock	lock
protected List<OServerNetworkListener>	networkListeners
protected Map<String,Class<? extends ONetworkProtocol>>	networkProtocols
protected Map<String,OServerSocketFactory>	networkSocketFactories
protected OServerPluginManager	pluginManager
protected boolean	rejectRequests
protected boolean	running
protected OServerConfigurationManager	serverCfg
protected OServerSecurity	serverSecurity
protected OServerShutdownHook	shutdownHook
protected Date	startedOn

Constructor Summary

Constructors

Constructor and Description
OServer()
OServer(boolean shutdownEngineOnExit)

Method Summary

Modifier and Type	Method and Description
OServer	activate()
void	addTemporaryUser(String iName, String iPassword, String iPermissions)
void	addUser(String iName, String iPassword, String iPermissions)
boolean	authenticate(String iUserName, String iPassword, String iResourceToCheck) Authenticate a server user.
protected OServerUserConfiguration	authenticateUser(String iUserName, String iPassword, String iResourceToCheck)
void	createDatabase(String databaseName, ODatabaseType type, OrientDBConfig config)
protected void	createDefaultServerUsers()
protected void	defaultSettings()
protected boolean	deinit()
void	dropDatabase(String databaseName)
void	dropUser(String iUserName)
boolean	existsDatabase(String databaseName)
boolean	existsStoragePath(String iURL)
Map<String,String>	getAvailableStorageNames()
OClientConnectionManager	getClientConnectionManager()
OServerConfiguration	getConfiguration()
OrientDB	getContext()
OContextConfiguration	getContextConfiguration()
String	getDatabaseDirectory()
OrientDBInternal	getDatabases()
ODistributedServerManager	getDistributedManager()
ClassLoader	getExtensionClassLoader() Get the preferred ClassLoader used to load extensions.
OConfigurableHooksManager	getHookManager()
OHttpSessionManager	getHttpSessionManager()
static OServer	getInstance(String iServerId)
static OServer	getInstanceByPath(String iPath)
<RET extends OServerNetworkListener> RET	getListenerByProtocol(Class<? extends ONetworkProtocol> iProtocolClass)
List<OServerNetworkListener>	getNetworkListeners()
Map<String,Class<? extends ONetworkProtocol>>	getNetworkProtocols()
<RET extends OServerPlugin> RET	getPlugin(String iName)
<RET extends OServerPlugin> RET	getPluginByClass(Class<RET> iPluginClass)
OServerPluginManager	getPluginManager()
Collection<OServerPluginInfo>	getPlugins()
OPushManager	getPushManager()
OServerSecurity	getSecurity()
String	getServerId()
ThreadGroup	getServerThreadGroup()
Date	getStartedOn()
OSystemDatabase	getSystemDatabase()
ThreadGroup	getThreadGroup()
OTokenHandler	getTokenHandler()
OServerUserConfiguration	getUser(String iUserName)
Object	getVariable(String iName)
protected void	initFromConfiguration()
boolean	isActive()
boolean	isAllowed(String iUserName, String iResourceToCheck) Checks if a server user is allowed to operate with a resource.
Set<String>	listDatabases()
protected void	loadDatabases() Opens all the available server's databases.
protected void	loadStorages() Load configured storages.
protected void	loadUsers()
ODatabaseDocumentInternal	openDatabase(String database)
ODatabaseDocumentInternal	openDatabase(String iDbUrl, OToken iToken)
ODatabaseDocumentInternal	openDatabase(String iDbUrl, String user, String password)
ODatabaseDocumentInternal	openDatabase(String iDbUrl, String user, String password, ONetworkProtocolData data)
ODatabaseDocumentInternal	openDatabase(String iDbUrl, String user, String password, ONetworkProtocolData data, boolean iBypassAccess)
OServer	registerLifecycleListener(OServerLifecycleListener iListener)
protected void	registerPlugins()
static void	registerServerInstance(String iServerId, OServer iServer)
boolean	rejectRequests()
void	removeShutdownHook()
void	restart()
void	restore(String name, String path)
void	saveConfiguration()
OServerUserConfiguration	serverLogin(String iUser, String iPassword, String iResource)
void	setExtensionClassLoader(ClassLoader extensionClassLoader) Set the preferred ClassLoader used to load extensions.
void	setServerRootDirectory(String rootDirectory)
OServer	setVariable(String iName, Object iValue)
boolean	shutdown()
static OServer	startFromClasspathConfig(String config)
static OServer	startFromFileConfig(String config)
static OServer	startFromStreamConfig(InputStream config)
OServer	startup()
OServer	startup(File iConfigurationFile)
OServer	startup(InputStream iInputStream)
OServer	startup(OServerConfiguration iConfiguration)
OServer	startup(String iConfiguration)
OServer	startupFromConfiguration()
OServer	unregisterLifecycleListener(OServerLifecycleListener iListener)
static void	unregisterServerInstance(String iServerId)
void	waitForShutdown()

Methods inherited from class java.lang.Object

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

Field Detail

lock

protected ReentrantLock lock

running

protected volatile boolean running

rejectRequests

protected volatile boolean rejectRequests

serverCfg

protected OServerConfigurationManager serverCfg

contextConfiguration

protected OContextConfiguration contextConfiguration

shutdownHook

protected OServerShutdownHook shutdownHook

networkProtocols

protected Map<String,Class<? extends ONetworkProtocol>> networkProtocols

networkSocketFactories

protected Map<String,OServerSocketFactory> networkSocketFactories

networkListeners

protected List<OServerNetworkListener> networkListeners

lifecycleListeners

protected List<OServerLifecycleListener> lifecycleListeners

pluginManager

protected OServerPluginManager pluginManager

hookManager

protected OConfigurableHooksManager hookManager

distributedManager

protected ODistributedServerManager distributedManager

serverSecurity

protected OServerSecurity serverSecurity

startedOn

protected Date startedOn

Constructor Detail

OServer

public OServer()

OServer

public OServer(boolean shutdownEngineOnExit)

Method Detail

startFromFileConfig

public static OServer startFromFileConfig(String config)
                                   throws ClassNotFoundException,
                                          InstantiationException,
                                          IOException,
                                          IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IOException

IllegalAccessException

startFromClasspathConfig

public static OServer startFromClasspathConfig(String config)
                                        throws ClassNotFoundException,
                                               InstantiationException,
                                               IOException,
                                               IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IOException

IllegalAccessException

startFromStreamConfig

public static OServer startFromStreamConfig(InputStream config)
                                     throws ClassNotFoundException,
                                            InstantiationException,
                                            IOException,
                                            IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IOException

IllegalAccessException

getInstance

public static OServer getInstance(String iServerId)

getInstanceByPath

public static OServer getInstanceByPath(String iPath)

registerServerInstance

public static void registerServerInstance(String iServerId,
                                          OServer iServer)

unregisterServerInstance

public static void unregisterServerInstance(String iServerId)

setExtensionClassLoader

public void setExtensionClassLoader(ClassLoader extensionClassLoader)

Set the preferred ClassLoader used to load extensions.

Since:

2.1

getExtensionClassLoader

public ClassLoader getExtensionClassLoader()

Get the preferred ClassLoader used to load extensions.

Since:

2.1

getSecurity

public OServerSecurity getSecurity()

isActive

public boolean isActive()

getClientConnectionManager

public OClientConnectionManager getClientConnectionManager()

getHttpSessionManager

public OHttpSessionManager getHttpSessionManager()

getPushManager

public OPushManager getPushManager()

saveConfiguration

public void saveConfiguration()
                       throws IOException

Throws:

IOException

restart

public void restart()
             throws ClassNotFoundException,
                    InvocationTargetException,
                    InstantiationException,
                    NoSuchMethodException,
                    IllegalAccessException,
                    IOException

Throws:

ClassNotFoundException

InvocationTargetException

InstantiationException

NoSuchMethodException

IllegalAccessException

IOException

getSystemDatabase

public OSystemDatabase getSystemDatabase()

getServerId

public String getServerId()

startup

public OServer startup()
                throws OConfigurationException

Throws:

OConfigurationException

startup

public OServer startup(File iConfigurationFile)
                throws OConfigurationException

Throws:

OConfigurationException

startup

public OServer startup(String iConfiguration)
                throws IOException

Throws:

IOException

startup

public OServer startup(InputStream iInputStream)
                throws IOException

Throws:

IOException

startup

public OServer startup(OServerConfiguration iConfiguration)
                throws IllegalArgumentException,
                       SecurityException,
                       IOException

Throws:

IllegalArgumentException

SecurityException

IOException

startupFromConfiguration

public OServer startupFromConfiguration()
                                 throws IOException

Throws:

IOException

activate

public OServer activate()
                 throws ClassNotFoundException,
                        InstantiationException,
                        IllegalAccessException

Throws:

ClassNotFoundException

InstantiationException

IllegalAccessException

removeShutdownHook

public void removeShutdownHook()

shutdown

public boolean shutdown()

deinit

protected boolean deinit()

rejectRequests

public boolean rejectRequests()

waitForShutdown

public void waitForShutdown()

getAvailableStorageNames

public Map<String,String> getAvailableStorageNames()

loadDatabases

protected void loadDatabases()

Opens all the available server's databases.

getDatabaseDirectory

public String getDatabaseDirectory()

getServerThreadGroup

public ThreadGroup getServerThreadGroup()

serverLogin

public OServerUserConfiguration serverLogin(String iUser,
                                            String iPassword,
                                            String iResource)

authenticate

public boolean authenticate(String iUserName,
                            String iPassword,
                            String iResourceToCheck)

Authenticate a server user.

Parameters:

iUserName - Username to authenticate

iPassword - Password in clear

Returns:

true if authentication is ok, otherwise false

authenticateUser

protected OServerUserConfiguration authenticateUser(String iUserName,
                                                    String iPassword,
                                                    String iResourceToCheck)

isAllowed

public boolean isAllowed(String iUserName,
                         String iResourceToCheck)

Checks if a server user is allowed to operate with a resource.

Parameters:

iUserName - Username to authenticate

Returns:

true if authentication is ok, otherwise false

getUser

public OServerUserConfiguration getUser(String iUserName)

dropUser

public void dropUser(String iUserName)
              throws IOException

Throws:

IOException

existsStoragePath

public boolean existsStoragePath(String iURL)

getConfiguration

public OServerConfiguration getConfiguration()

getNetworkProtocols

public Map<String,Class<? extends ONetworkProtocol>> getNetworkProtocols()

getNetworkListeners

public List<OServerNetworkListener> getNetworkListeners()

getListenerByProtocol

public <RET extends OServerNetworkListener> RET getListenerByProtocol(Class<? extends ONetworkProtocol> iProtocolClass)

getPlugins

public Collection<OServerPluginInfo> getPlugins()

getContextConfiguration

public OContextConfiguration getContextConfiguration()

getPluginByClass

public <RET extends OServerPlugin> RET getPluginByClass(Class<RET> iPluginClass)

getPlugin

public <RET extends OServerPlugin> RET getPlugin(String iName)

getVariable

public Object getVariable(String iName)

setVariable

public OServer setVariable(String iName,
                           Object iValue)

addTemporaryUser

public void addTemporaryUser(String iName,
                             String iPassword,
                             String iPermissions)

addUser

public void addUser(String iName,
                    String iPassword,
                    String iPermissions)
             throws IOException

Throws:

IOException

registerLifecycleListener

public OServer registerLifecycleListener(OServerLifecycleListener iListener)

unregisterLifecycleListener

public OServer unregisterLifecycleListener(OServerLifecycleListener iListener)

openDatabase

public ODatabaseDocumentInternal openDatabase(String iDbUrl,
                                              OToken iToken)

openDatabase

public ODatabaseDocumentInternal openDatabase(String iDbUrl,
                                              String user,
                                              String password)

openDatabase

public ODatabaseDocumentInternal openDatabase(String iDbUrl,
                                              String user,
                                              String password,
                                              ONetworkProtocolData data)

openDatabase

public ODatabaseDocumentInternal openDatabase(String iDbUrl,
                                              String user,
                                              String password,
                                              ONetworkProtocolData data,
                                              boolean iBypassAccess)

openDatabase

public ODatabaseDocumentInternal openDatabase(String database)

getDistributedManager

public ODistributedServerManager getDistributedManager()

setServerRootDirectory

public void setServerRootDirectory(String rootDirectory)

initFromConfiguration

protected void initFromConfiguration()

getHookManager

public OConfigurableHooksManager getHookManager()

loadUsers

protected void loadUsers()
                  throws IOException

Throws:

IOException

loadStorages

protected void loadStorages()

Load configured storages.

createDefaultServerUsers

protected void createDefaultServerUsers()
                                 throws IOException

Throws:

IOException

getPluginManager

public OServerPluginManager getPluginManager()

registerPlugins

protected void registerPlugins()
                        throws InstantiationException,
                               IllegalAccessException,
                               ClassNotFoundException

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

defaultSettings

protected void defaultSettings()

getTokenHandler

public OTokenHandler getTokenHandler()

getThreadGroup

public ThreadGroup getThreadGroup()

getDatabases

public OrientDBInternal getDatabases()

getContext

public OrientDB getContext()

dropDatabase

public void dropDatabase(String databaseName)

existsDatabase

public boolean existsDatabase(String databaseName)

createDatabase

public void createDatabase(String databaseName,
                           ODatabaseType type,
                           OrientDBConfig config)

listDatabases

public Set<String> listDatabases()

restore

public void restore(String name,
                    String path)

getStartedOn

public Date getStartedOn()