org.productivity.java.habitat4j.web.servlet
Class Habitat4JBootstrapServlet

java.lang.Object
  HttpServlet
      org.productivity.java.habitat4j.web.servlet.Habitat4JBootstrapServlet

public class Habitat4JBootstrapServlet
extends HttpServlet

Habitat4JBootstrapServlet provides an HttpServlet implementation for the use in initializing, or "bootstrapping," Habitat4J.

This class primarily wraps the Habitat4JBootstrap class.

For the servlet-class specification in the Serlvet Web Descriptor (web.xml):

• org.productivity.java.habitat4j.web.servlet.Habitat4JBootstrapServlet

For the

init-param

specification in the Servlet Web Descriptor (web.xml):

• applicationName - the name of your application
• bootstrapPropertyListPath - a path, either on the filesystem, or in the classpath (use slashes to delimit package paths)
• xsdValidationEnabled - a boolean value which determines whether Habitat4J should validate the server-identity and property-list files against the stock Habitat4J XSD files
• log4jEnabled - a boolean value which determines whether Habitat4J should use log4j
• logLevel - a String containing one of the following log levels: debug, info, warn, error, or fatal mainly used for setting Habitat4J's native logging level (non-log4j)
• serverIdentityFilePath - a String containing a single path or semicolon-delimited list of paths pointing to a server-identity.xml file or files
• serverIdentityMode - a String containing the ServerIdentity mode of operation (NULL, JVM, FILE)
• appPropertyListLoaderClassName - a String containing the fully qualified class for the customized implementation of ApplicationPropertyListLoaderIF

## LICENSE INFORMATION ##

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

Version:

$Id: Habitat4JBootstrapServlet.html,v 1.2 2008/11/24 15:15:20 cvs Exp $

Author:

Justin Yunke <habitat4j@productivity.org>

Constructor Summary

Habitat4JBootstrapServlet()

Method Summary

protected void	doBootstrapInitialize() doBootstrapInitialize() is used by the default init() method to setup Habitat4J in one step.
protected void	doBootstrapInitializePropertyLists() doBootstrapInitializePropertyLists() is used when subclassing Habitat4JBootstrapServlet and overriding the init() method.
protected void	doBootstrapInitializeServerIdentity() doBootstrapInitializeServerIdentity() is used when subclassing Habitat4JBootstrapServlet and overriding the init() method.
protected java.util.Map	getInitParametersAsMap()
void	init()

Methods inherited from class java.lang.Object

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

Constructor Detail

Habitat4JBootstrapServlet

public Habitat4JBootstrapServlet()

Method Detail

getInitParametersAsMap

protected java.util.Map getInitParametersAsMap()

Returns:

Returns all init-param name/value pairs in the form of a Map (HashMap).

doBootstrapInitializeServerIdentity

protected void doBootstrapInitializeServerIdentity()
                                            throws ServletException

doBootstrapInitializeServerIdentity() is used when subclassing Habitat4JBootstrapServlet and overriding the init() method. It allows one to initialize the ServerIdentity as a separate step in order to do things like tweak pragma values before doBootstrapInitializePropertyLists() method is called.

Throws:

ServletException

doBootstrapInitializePropertyLists

protected void doBootstrapInitializePropertyLists()
                                           throws ServletException

doBootstrapInitializePropertyLists() is used when subclassing Habitat4JBootstrapServlet and overriding the init() method. doBootstrapInitializeServerIdentity() should be called before this method.

Throws:

ServletException

doBootstrapInitialize

protected void doBootstrapInitialize()
                              throws ServletException

doBootstrapInitialize() is used by the default init() method to setup Habitat4J in one step.

Throws:

ServletException

init

public void init()
          throws ServletException

Throws:

ServletException