org.opennms.web

Class ServletInitializer

java.lang.Object

org.opennms.web.ServletInitializer

public class ServletInitializer
extends Object

Encapsulates all initialization and configuration needed by the OpenNMS servlets and JSPs.

Version:

$Id: $

Author:

Lawrence Karnowski , OpenNMS , Lawrence Karnowski , OpenNMS

Field Summary

Fields

Modifier and Type	Field and Description
protected static DbConnectionFactory	factory A reference to the factory we set in Vaultduring initso we can destroy it in destroy.

Method Summary

Methods

Modifier and Type	Method and Description
static void	destroy(javax.servlet.ServletContext context) Releases all shared resources on the first invocation of this method.
static String	getHomeDir() Deprecated. Use Vault.getHomeDirinstead.
static void	init(javax.servlet.ServletContext context) Initialize servlet and JSP configuration on the first invocation of this method.

Methods inherited from class java.lang.Object

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

Field Detail

factory

protected static DbConnectionFactory factory

A reference to the factory we set in Vaultduring initso we can destroy it in destroy.

Maybe there's a better way to do this then storing a reference? Should we just add a method to Vault?

This reference also serves as a flag to determine whether or not this class has been initialized yet. If it is null, the class has not yet been initialized.

Method Detail

init

public static void init(javax.servlet.ServletContext context)
                 throws javax.servlet.ServletException

Initialize servlet and JSP configuration on the first invocation of this method. All other invocations are ignored. This method is synchronized to ensure only the first invocation performs the initialization.

Call this method in the init method of your servlet or JSP. It will read the servlet initialization parameters from the ServletConfig and ServletContext and OpenNMS configuration files.

Parameters:

context - the ServletContext instance in which your servlet is running

Throws:

javax.servlet.ServletException - if any.

destroy

public static void destroy(javax.servlet.ServletContext context)
                    throws javax.servlet.ServletException

Releases all shared resources on the first invocation of this method. All other invocations are ignored. This method is synchronized to ensure only the first invocation performs the destruction.

Call this method in the destroy method of your servlet or JSP.

Parameters:

context - the ServletContext instance in which your servlet is running

Throws:

javax.servlet.ServletException - if any.

getHomeDir

public static String getHomeDir()

Deprecated. Use Vault.getHomeDirinstead.

Return the absolute pathname of where OpenNMS's configuration can be found.

Returns:

a String object.