2.2 The iManager Directory Structure

iManager files are placed in the appropriate directories within the NPS Web Application servlet document root directory. NPS follows the Java Servlet 2.3 Specification defined by JSR 53 of the Java Community Process. The Java Servlet Specification prescribes a general directory structure for Web applications implemented as Java servlets. If you are not familiar with this directory structure, we recommend that you study Chapter 9 of the Java Servlet 2.3 Specification.

The following table describes the directories in the document root of the NPS Web Application, which is SDK_HOME\tomcat\webapps\nps. Everything in the nps directory is directly accessible to client devices, with the exception of the WEB-INF subdirectory and its contents.

Table 2-1 Directories of the NPS Web application

Directory

Description

portal\modules

Module files, such as JSPs and registration files. Each subdirectory represents a module and is named with the module ID. For information about module IDs, see Section 2.4, Module ID.

portal\modules\modulename\applets

Applets that are used by plug-ins.

portal\modules\modulename\css

Cascading style sheets that are used to create the user interface of plug-ins.

portal\modules\modulename\errors

Error messages that are displayed to the user when iManager encounters an error.

portal\modules\modulename\help

Plug-in help files. This directory contains a subdirectory named with the ISO language code for each language for which help files exist.

portal\modules\modulename\images

Images used by plug-ins and the iManager framework. This directory contains a subdirectory named with the ISO language code for each language for which image files exist.

portal\modules\modulename\install

Registration files for plug-ins that are registered in eDirectory for role-based usage.

portal\modules\modulename\javascripts

JavaScript* files that can be inserted into JSPs.

portal\modules\modulename\plugins

Registration files for plug-ins that are for global, non-role-based usage.

portal\modules\modulename\skins

Plug-in UI pages and JSPs. A skin modifies the look and feel of the plug-in. There is a subdirectory for each skin supported by the plug-in, and each skin directory contains a subdirectory for each device supported by the plug-in. Must have, at a minimum, a default skin directory, and each skin must have a default device directory, each named “default.”

WEB‑INF

Configuration and application files. The content of this directory is accessible only by the Web application.

WEB‑INF\bin

Binary files required by iManager.

WEB‑INF\classes

Plug-in Java class files that are not in Java archive (JAR) files. The classes in this directory are automatically added to the classpath.

WEB‑INF\lib

JAR files required by plug-ins and the iManager framework. If you archive your plug-in Java class files into a JAR file, you should copy that JAR file to this directory. The JAR files in this directory are automatically added to the iManager classpath.

WEB‑INF\logs

Log files generated by iManager.