Package org.nuxeo.runtime.deployment

Class NuxeoStarter

java.lang.Object

org.nuxeo.runtime.deployment.NuxeoStarter

All Implemented Interfaces:

jakarta.servlet.ServletContextListener, EventListener

public class NuxeoStarter
extends Object
implements jakarta.servlet.ServletContextListener

This is called at WAR startup and starts the Nuxeo OSGi runtime and registers the Nuxeo bundles with it.

This class must be configured as a <listener>/<listener-class> in META-INF/web.xml.

It uses servlet init parameters defined through <context-param>/<param-name>/<param-value> in web.xml. Allowable parameter names come from Environment, mainly NUXEO_RUNTIME_HOME and NUXEO_CONFIG_DIR, but also NUXEO_DATA_DIR, NUXEO_LOG_DIR, NUXEO_TMP_DIR and NUXEO_WEB_DIR.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<File>	bundleFiles
protected final Map<String,Object>	env
static final String	NUXEO_BUNDLES_LIST	Name of the file listing Nuxeo bundles.

Constructor Summary

Constructors

Constructor	Description
NuxeoStarter()

Method Summary

Modifier and Type	Method	Description
void	contextDestroyed(jakarta.servlet.ServletContextEvent event)
void	contextInitialized(jakarta.servlet.ServletContextEvent event)
protected void	findBundles(jakarta.servlet.ServletContext servletContext)
protected void	findEnv(jakarta.servlet.ServletContext servletContext)
protected void	start(jakarta.servlet.ServletContextEvent event)
protected void	stop()

Methods inherited from class java.lang.Object

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

Field Details

NUXEO_BUNDLES_LIST

public static final String NUXEO_BUNDLES_LIST

Name of the file listing Nuxeo bundles. If existing, this file will be used at start, else "/WEB-INF/lib/" will be scanned.

Since:

5.9.3

See Also:

• findBundles(ServletContext)
• Constant Field Values

env

protected final Map<String,Object> env

bundleFiles

protected List<File> bundleFiles

Constructor Details

NuxeoStarter

public NuxeoStarter()

Method Details

contextInitialized

public void contextInitialized(jakarta.servlet.ServletContextEvent event)

Specified by:

contextInitialized in interface jakarta.servlet.ServletContextListener

contextDestroyed

public void contextDestroyed(jakarta.servlet.ServletContextEvent event)

Specified by:

contextDestroyed in interface jakarta.servlet.ServletContextListener

start

protected void start(jakarta.servlet.ServletContextEvent event)
              throws IOException,
org.osgi.framework.BundleException

Throws:

IOException

org.osgi.framework.BundleException

stop

protected void stop()
             throws org.osgi.framework.BundleException

Throws:

org.osgi.framework.BundleException

findBundles

protected void findBundles(jakarta.servlet.ServletContext servletContext)
                    throws IOException

Throws:

IOException

findEnv

protected void findEnv(jakarta.servlet.ServletContext servletContext)