Supplied in the [install]/extra/ directory is an embedded NetKernel Servlet which allows
NetKernel to be hosted within a J2EE application server.
The servlet is configured to send requests to a fulcrum
called the
Servlet Fulcrum which is configured functionally equivalent to the Front-End
Fulcrum. It comes preconfigured with the addressbook and workbench modules exposed.
Note: The NetKernel Servlet is provided as an extra deployment option.
NetKernel is transport and hence servlet independent and does not require a J2EE application server to host applications.
Setting up
Install Servlet 2.4 compliant J2EE Application server The 2.4 compliant servlet will deploy to a
suitable J2EE application server. It has been tested on Tomcat 5.5.
(Please note of the 1060 Public License requirements
- if your app server is not OSI certified open-source you may require a commercial NetKernel license.)
Copy required libraries Copy [install]/lib/1060netkernel-2.x.x.jar and [install]/lib/1060netkernel-embedded-1.x.x.jar
into the [install]/extra/servlet/WEB-INF/lib directory. Also copy all the XML libraries from [install]/lib/endorsed/.
Deploy NetKernel Servlet Using the method documented in your choice of application server, deploy the
webapp at [install]/extra/servlet/. For compatibility deploy the servlet as the ROOT context so
that it will fulfill all requests below the path of /. This isn't strictly necessary but the sample applications
are configured assuming this and their paths will be incorrect otherwise.
Test it is running Request the page http://localhost:8080/ in your web browser (assuming your application server
is running on port 8080). You should see the message:
"If you're seeing this page via a web browser, it means you've successfully Setup NetKernel with your Servlet Engine. Congratulations!"
Configuration
This section describes how the servlet and the NetKernel instance behind it is configured.
/WEB-INF/web.xml The web.xml file specifies the basepath and kernel configuration file used by NetKernel as parameters. These
value is filled-in as part of the installation process but may be changed here.
<web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd">
<display-name>1060 NetKernel Servlet</display-name>
<description />
<servlet>
<servlet-name>NetKernel</servlet-name>
<servlet-class>com.ten60.netkernel.servlet.NetKernelServlet</servlet-class>
<init-param>
<param-name>basepath</param-name>
<param-value>C:\path\to\netkernel\</param-value>
</init-param>
<init-param>
<param-name>config</param-name>
<param-value>etc/system-servlet.xml</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>NetKernel</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</web-app>
[install]/etc/system-servlet.xml The system-servlet.xml file in this directory is used for the
Global Kernel Parameters.
[install]/etc/deployedModules-servlet.xml This file specifies the
list of modules which are deployed into NetKernel. This list is slightly different than the regular
deployedModules.xml to reflect the fact that the FrontEnd Fulcrum is not started but the Servlet Fulcrum is.
[install]/modules/mod-fulcrum-servlet/ This directory contains the Servlet Fulcrum which will
receive all requests from the servlet.
Servlet Bridge
The Servlet Fulcrum is configured to pass all requests through the Servlet Bridge. This adapts the
servlet API in a way as to be completely compatible with the http-bridge.
Backend Fulcrum
The Backend Fulcrum with all its associated documentation and tools is configured to run on port 1066 in the
default servlet configuration.
Common Problems
Backend Fulcrum fails to run This may be due to conflicting jar files supplied by the application
server and those in tpt-servlet-x.x.x.jar
Preface
Configuration
Deployment
