com.ashtonit.odb.jndi

Class OServerObjectFactory

java.lang.Object

com.ashtonit.odb.jndi.OServerObjectFactory

All Implemented Interfaces:

ObjectFactory

public class OServerObjectFactory
extends Object
implements ObjectFactory

Return a singleton OServer instance as a JNDI resource. When embedding the database in a container such as Tomcat it allows the server to be shutdown cleanly by calling the OServer.shutdown() method.

This resource is always a singleton regardless of the resource configuration. When using with Tomcat it should still be configured as a singleton however. This is so that the shutdown() method will be called appropriately by the container.

If the configFile attribute does not refer to a valid readable OrientDB server configuration file the OServer instance will not be created and started. Either a NamingException or RuntimeException will be thrown.

An example resource declaration:

 <Resource
   auth="Container"
   closeMethod="shutdown"
   configFile="/mnt/share/orientdb-community-2.1.3/config/orientdb-server-config.xml"
   factory="com.ashtonit.odb.jndi.OServerObjectFactory"
   name="oserver"
   singleton="true"
   type="com.orientechnologies.orient.server.OServer"
 />
 

Author:

Bruce Ashton

Constructor Summary

Constructors

Constructor and Description
OServerObjectFactory()

Method Summary

Modifier and Type	Method and Description
com.orientechnologies.orient.server.OServer	getObjectInstance(Object obj, Name name, Context nameCtx, Hashtable<?,?> environment) Starts and returns an embedded OServer instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

OServerObjectFactory

public OServerObjectFactory()

Method Detail

getObjectInstance

public com.orientechnologies.orient.server.OServer getObjectInstance(Object obj,
                                                                     Name name,
                                                                     Context nameCtx,
                                                                     Hashtable<?,?> environment)
                                                              throws NamingException

Starts and returns an embedded OServer instance. This instance is always a singleton, regardless of configuration. It is important to declare it as singleton in the resource declaration though, to ensure it is shut down cleanly.

Specified by:

getObjectInstance in interface ObjectFactory

Parameters:

obj - the naming reference

name - not used

nameCtx - not used

environment - not used

Returns:

the OServer instance

Throws:

NamingException - if the configuration file cannot be read

RuntimeException - if the OServer instance throws an exception during startup

See Also:

ObjectFactory.getObjectInstance(Object, Name, Context, Hashtable)