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 com.orientechnologies.orient.core.config.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	running
protected OServerConfigurationManager	serverCfg
protected OServerSecurity	serverSecurity
protected OServerShutdownHook	shutdownHook

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)
protected void	createDefaultServerUsers()
protected void	defaultSettings()
protected boolean	deinit()
void	dropUser(String iUserName)
boolean	existsStoragePath(String iURL)
Map<String,String>	getAvailableStorageNames()
OClientConnectionManager	getClientConnectionManager()
OServerConfiguration	getConfiguration()
com.orientechnologies.orient.core.config.OContextConfiguration	getContextConfiguration()
String	getDatabaseDirectory()
com.orientechnologies.orient.core.db.OPartitionedDatabasePoolFactory	getDatabasePoolFactory()
ODistributedServerManager	getDistributedManager()
ClassLoader	getExtensionClassLoader() Get the preferred ClassLoader used to load extensions.
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()
OServerSecurity	getSecurity()
ThreadGroup	getServerThreadGroup()
String	getStoragePath(String iName)
OSystemDatabase	getSystemDatabase()
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.
protected void	loadDatabases() Opens all the available server's databases.
protected void	loadStorages() Load configured storages.
protected void	loadUsers()
com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx	openDatabase(com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx database, String user, String password, ONetworkProtocolData data, boolean iBypassAccess)
com.orientechnologies.orient.core.db.ODatabaseInternal	openDatabase(com.orientechnologies.orient.core.db.ODatabaseInternal database)
com.orientechnologies.orient.core.db.ODatabase<?>	openDatabase(String iDbUrl, com.orientechnologies.orient.core.metadata.security.OToken iToken)
com.orientechnologies.orient.core.db.ODatabase<?>	openDatabase(String iDbUrl, String user, String password)
com.orientechnologies.orient.core.db.ODatabase<?>	openDatabase(String iDbUrl, String user, String password, ONetworkProtocolData data)
com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx	openDatabase(String iDbUrl, String user, String password, ONetworkProtocolData data, boolean iBypassAccess)
void	openDatabaseBypassingSecurity(com.orientechnologies.orient.core.db.ODatabaseInternal<?> database, ONetworkProtocolData data, String user)
OServer	registerLifecycleListener(OServerLifecycleListener iListener)
protected void	registerPlugins()
static void	registerServerInstance(String iServerId, OServer iServer)
void	removeShutdownHook()
void	restart()
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()
OServer	startup()
OServer	startup(File iConfigurationFile)
OServer	startup(InputStream iInputStream)
OServer	startup(OServerConfiguration iConfiguration)
OServer	startup(String iConfiguration)
OServer	startupFromConfiguration()
OServer	unregisterLifecycleListener(OServerLifecycleListener iListener)
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

serverCfg

protected OServerConfigurationManager serverCfg

contextConfiguration

protected com.orientechnologies.orient.core.config.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

Constructor Detail

OServer

public OServer()
        throws ClassNotFoundException,
               MalformedObjectNameException,
               NullPointerException,
               InstanceAlreadyExistsException,
               MBeanRegistrationException,
               NotCompliantMBeanException

Throws:

ClassNotFoundException

MalformedObjectNameException

NullPointerException

InstanceAlreadyExistsException

MBeanRegistrationException

NotCompliantMBeanException

OServer

public OServer(boolean shutdownEngineOnExit)
        throws ClassNotFoundException,
               MalformedObjectNameException,
               NullPointerException,
               InstanceAlreadyExistsException,
               MBeanRegistrationException,
               NotCompliantMBeanException

Throws:

ClassNotFoundException

MalformedObjectNameException

NullPointerException

InstanceAlreadyExistsException

MBeanRegistrationException

NotCompliantMBeanException

Method Detail

getInstance

public static OServer getInstance(String iServerId)

getInstanceByPath

public static OServer getInstanceByPath(String iPath)

registerServerInstance

public static void registerServerInstance(String iServerId,
                                          OServer iServer)

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()

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()

startup

public OServer startup()
                throws InstantiationException,
                       IllegalAccessException,
                       ClassNotFoundException,
                       IllegalArgumentException,
                       SecurityException,
                       InvocationTargetException,
                       NoSuchMethodException

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

IllegalArgumentException

SecurityException

InvocationTargetException

NoSuchMethodException

startup

public OServer startup(File iConfigurationFile)
                throws InstantiationException,
                       IllegalAccessException,
                       ClassNotFoundException,
                       IllegalArgumentException,
                       SecurityException,
                       InvocationTargetException,
                       NoSuchMethodException

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

IllegalArgumentException

SecurityException

InvocationTargetException

NoSuchMethodException

startup

public OServer startup(String iConfiguration)
                throws InstantiationException,
                       IllegalAccessException,
                       ClassNotFoundException,
                       IllegalArgumentException,
                       SecurityException,
                       InvocationTargetException,
                       NoSuchMethodException,
                       IOException

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

IllegalArgumentException

SecurityException

InvocationTargetException

NoSuchMethodException

IOException

startup

public OServer startup(InputStream iInputStream)
                throws InstantiationException,
                       IllegalAccessException,
                       ClassNotFoundException,
                       IllegalArgumentException,
                       SecurityException,
                       InvocationTargetException,
                       NoSuchMethodException,
                       IOException

Throws:

InstantiationException

IllegalAccessException

ClassNotFoundException

IllegalArgumentException

SecurityException

InvocationTargetException

NoSuchMethodException

IOException

startup

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

Throws:

IllegalArgumentException

SecurityException

InvocationTargetException

NoSuchMethodException

IOException

startupFromConfiguration

public OServer startupFromConfiguration()
                                 throws IllegalArgumentException,
                                        SecurityException,
                                        InvocationTargetException,
                                        NoSuchMethodException,
                                        IOException

Throws:

IllegalArgumentException

SecurityException

InvocationTargetException

NoSuchMethodException

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()

waitForShutdown

public void waitForShutdown()

getStoragePath

public String getStoragePath(String iName)

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 com.orientechnologies.orient.core.config.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 com.orientechnologies.orient.core.db.ODatabase<?> openDatabase(String iDbUrl,
                                                                      com.orientechnologies.orient.core.metadata.security.OToken iToken)

openDatabase

public com.orientechnologies.orient.core.db.ODatabase<?> openDatabase(String iDbUrl,
                                                                      String user,
                                                                      String password)

openDatabase

public com.orientechnologies.orient.core.db.ODatabase<?> openDatabase(String iDbUrl,
                                                                      String user,
                                                                      String password,
                                                                      ONetworkProtocolData data)

openDatabase

public com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx openDatabase(String iDbUrl,
                                                                                      String user,
                                                                                      String password,
                                                                                      ONetworkProtocolData data,
                                                                                      boolean iBypassAccess)

openDatabase

public com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx openDatabase(com.orientechnologies.orient.core.db.document.ODatabaseDocumentTx database,
                                                                                      String user,
                                                                                      String password,
                                                                                      ONetworkProtocolData data,
                                                                                      boolean iBypassAccess)

openDatabaseBypassingSecurity

public void openDatabaseBypassingSecurity(com.orientechnologies.orient.core.db.ODatabaseInternal<?> database,
                                          ONetworkProtocolData data,
                                          String user)

openDatabase

public com.orientechnologies.orient.core.db.ODatabaseInternal openDatabase(com.orientechnologies.orient.core.db.ODatabaseInternal database)

getDistributedManager

public ODistributedServerManager getDistributedManager()

getDatabasePoolFactory

public com.orientechnologies.orient.core.db.OPartitionedDatabasePoolFactory getDatabasePoolFactory()

setServerRootDirectory

public void setServerRootDirectory(String rootDirectory)

initFromConfiguration

protected void initFromConfiguration()

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()