Netscape NETSCAPE ENTERPRISE SERVER 6.1 - PROGRAMMER GUIDE TO... Manual

Programmer’s Guide to Servlets

Netscape Enterprise Server

Version 6.1

April 2002 (Draft)

Netscape Communications Corporation ("Netscape") and its licensors retain all ownership rights to the software programs offered by

Netscape (referred to herein as "Software") and related documentation. Use of the Software and related documentation is governed

by the license agreement for the Software and applicable copyright law.

Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations orcompilation works is

prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without

notice.

THIS DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL NETSCAPE BE

LIABLE FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING FROM ANY

ERROR IN THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION ANY LOSS OR INTERRUPTION OF BUSINESS,

PROFITS, USE, OR DATA.

Netscape and the Netscape N logo are registered trademarks of Netscape Communications Corporation in the United States and

other countries. Other Netscape logos, product names and service names are also trademarks of Netscape and may be registered in

some countries. Sun, Sun Microsystems, and the Sun logo, iPlanet, and the iPlanet logo are trademarks or registered trademarks of

Sun Microsystems, Inc. in the United States and other countries. Other product and brand names are trademarks of their respective

owners.

The downloading, exporting, or reexporting of Netscape software or any underlying information or technology must be in full

compliance with all United States and other applicable laws and regulations. Any provision of Netscape software or documentation

to the U.S. government is with restricted rights as described in the license agreement for that Software.

Contents

AboutThisBook ................................................................7

WheretoFindRelatedInformation ........................................................ 8

Chapter 1 Servlets and JavaServer Pages ........................................11

WebApplications ...................................................................... 11

Servlets ............................................................................... 12

JavaServerPages ....................................................................... 12

Chapter 2 WebApplications....................................................15

WebApplicationStructure .............................................................. 15

DynamicReconfiguration ............................................................... 16

web.xmlClarifications .................................................................. 17

security-constraint................................................................... 17

session-timeout ..................................................................... 17

Theweb-apps.xmlFileandVirtualServers ................................................ 18

TheDefaultContextforaVirtualServer ................................................ 18

Exampleserver.xmlFile .............................................................. 18

Exampleweb-apps.xmlFile........................................................... 20

web-apps.xmlElementReference...................................................... 21

auth-native ......................................................................... 21

class-loader......................................................................... 22

description ......................................................................... 22

form-login-session................................................................... 22

init-param .......................................................................... 23

jsp-servlet .......................................................................... 23

param-name ........................................................................ 24

param-value ........................................................................ 24

parameter-encoding ................................................................. 24

response-buffer ..................................................................... 26

4 Netscape Enterprise Server Programmer’s Guide to Servlets • April 2002 (Draft)

response-cookie ..................................................................... 26

role-mapping ....................................................................... 26

session-cookie....................................................................... 27

session-manager..................................................................... 27

session-tracking ..................................................................... 27

tempdir ............................................................................ 28

vs ................................................................................. 28

web-app ........................................................................... 28

DeployingaWebApplicationusingwdeploy.............................................. 29

WebApplicationExamples.............................................................. 31

Chapter 3 UsingServlets...................................................... 33

WhatDoestheServerNeedtoRunServlets?............................................... 33

UsingtheUserInterface................................................................. 34

EnablingServlets....................................................................... 34

MakingServletsAvailabletoClients...................................................... 34

The<SERVLET>SHTMLTag............................................................ 35

ServletOutput ......................................................................... 36

ConfiguringJVM....................................................................... 37

MaximizingServletPerformance ......................................................... 37

Chapter 4 UsingJavaServerPages ............................................. 39

WhatDoestheServerNeedtoRunJSP?................................................... 39

ConfiguringJRE/JDKPaths ............................................................. 41

UsingtheUserInterface................................................................. 43

EnablingJSPs.......................................................................... 44

MakingJSPsAvailabletoClients ......................................................... 44

DeletingCacheVersionFiles............................................................. 44

TheJSPCommand-LineCompiler........................................................ 45

PackageNamesGeneratedbytheJSPCompiler ......................................... 48

SpecifyingthatJSPsArePrecompiled .................................................. 48

OtherJSPInitializationParameters .................................................... 49

JSPTagLibrariesandStandardPortableTags.............................................. 49

Chapter 5 Debugging Servlets and JSPs . ........................................ 51

ServletDebugging ..................................................................... 51

JSPDebugging......................................................................... 52

GeneratingaStackTraceforDebugging................................................... 53

JPDAOptionsforDebugging ............................................................ 54

Chapter 6 Session Managers .................................................. 55

SessionOverview ...................................................................... 55

SpecifyingaSessionManager............................................................ 56

NESSessionManager.................................................................... 58

ParametersforNESSessionManager ................................................... 58

EnablingNESSessionManager ........................................................ 61

SourceCodeforNESSessionManager .................................................. 62

MMapSessionManager(UNIXOnly)...................................................... 63

Parameters ......................................................................... 63

EnablingMMapSessionManager ...................................................... 64

DeletingSessionDataVersionFiles..................................................... 65

DeprecatedSessionManagers ........................................................... 65

SimpleSessionManager............................................................... 65

JdbcSessionManager ................................................................. 67

LoadBalancing,SessionFailover,andSessionIDs .......................................... 70

Chapter 7 APIClarifications ....................................................73

ClarificationofHttpSessionScope........................................................ 73

ClarificationsforUsingMethods ......................................................... 74

HttpServlet.service .................................................................. 74

ServletContext.getAttribute ........................................................... 75

ServletRequest.setAttribute ........................................................... 75

ServletRequest.getParameter.......................................................... 75

ServletResponse.getOutputStreamandgetWriter ........................................ 77

RequestDispatcher.forwardandinclude ................................................ 77

OtherUsefulInformation ............................................................... 79

DatabaseConnectionPooling ......................................................... 79

FetchingtheClientCertificate ......................................................... 79

Chapter 8 LegacyServletandJSPConfiguration ..................................81

TheDefaultVirtualServer............................................................... 81

EnablingServletsandJSP ............................................................... 82

MakingJSPsAvailabletoClients ......................................................... 82

ConfiguringServletsintheDefaultVirtualServer .......................................... 82

ConfiguringGlobalServletAttributes .................................................. 83

RegisteringServletDirectories ........................................................ 83

RegisteringIndividualServlets........................................................ 85

SpecifyingServletVirtualPaths ....................................................... 86

SpecifyingServletContexts ........................................................... 88

UsingtheUserInterface................................................................. 88

LegacyConfigurationFiles .............................................................. 89

servlets.properties ................................................................... 90

rules.properties ..................................................................... 91

contexts.properties .................................................................. 92

6 Netscape Enterprise Server Programmer’s Guide to Servlets • April 2002 (Draft)

LegacyExamples....................................................................... 96

MaximizingLegacyServletPerformance .................................................. 97

Appendix A Servlet Settings in magnus.conf and obj.conf . . . ....................... 99

InitDirectivesinmagnus.conf ........................................................... 99

Objectsinobj.conf..................................................................... 100

DirectivesforRegisteredServletDirectories .............................................. 102

JSPDirectives......................................................................... 102

Appendix B ConvertingSSJSApplications ..................................... 103

DifferencesBetweenJavaScriptandJava ................................................. 103

JavaScripttoJavaClassConversions..................................................... 105

ConversionSteps...................................................................... 106

ExampleConversion .................................................................. 107

Appendix C JVMConfiguration ............................................... 109

Thejvm12.confFile.................................................................... 110

UsingJVMEnvironmentVariables ...................................................... 111

jvm12.confParameterReference......................................................... 112

Appendix D RemoteServletProfiling .......................................... 117

TheOptimizeit!Profiler ................................................................ 117

TheHPROFProfiler ................................................................... 118

Index ....................................................................... 123

About This Book

This book discusses how to enable and install Java™ servlets and JavaServer

Pages™ (JSP) in Netscape® Enterprise Server 6.1.

This book has the following chapters and appendices:

• Chapter 1, “Servlets and JavaServer Pages”

This chapter introduces web applications, servlets, and JavaServer Pages.

• Chapter 2, “Web Applications”

This chapter discusses the structure of web applications and how to deploy

them in Enterprise Server 6.1. It also lists example web applications and

describes the web-apps.xml file, which configures web applications for virtual

servers in Enterprise Server 6.1.

• Chapter 3, “Using Servlets”

This chapter discusses how to enable and install servlets in Enterprise Server

6.1.

• Chapter 4, “Using JavaServer Pages”

This chapter discusses how to enable and install JavaServer Pages in Enterprise

Server 6.1, including how to install the JDK.

• Chapter 5, “Debugging Servlets and JSPs”

This chapter discusses how to debug servlets and JSPs, and includes a section

on debugging using Forte™ for Java.

• Chapter 6, “Session Managers”

This chapter discusses the session managers provided with Enterprise Server

and explains how to customize session behavior to suit your own needs.

Where to Find Related Information

8 Netscape Enterprise Server Programmer’s Guide to Servlets • April 2002 (Draft)

• Chapter 7, “API Clarifications”

This chapter discusses methods in the Servlets API that behave marginally

differently in Enterprise Server than specified in the Sun Microsystems’

Servlets API documentation or where the behavior documented by Sun

Microsystemsisambiguous.

• Chapter 8, “Legacy Servlet and JSP Configuration”

This chapter discusses how to configure the default virtual server as in iPlanet

Web Server 4.x,andtheservlets.properties,rules.properties,and

contexts.properties files.

• Appendix A, “Servlet Settings in magnus.conf and obj.conf”

This appendix discusses how the configuration file obj.conf changes

depending on the settings for servlets and JSP.

• Appendix B, “Converting SSJS Applications”

This appendix discusses how to convert LiveWire applications to JSPs.

• Appendix C, “JVM Configuration”

This appendix discusses how to manually specify JVM configuration

information.

• Appendix D, “Remote Servlet Profiling”

This appendix discusses how to enable remote profiling for servlets.

Where to Find Related Information

Additional Enterprise Server documentation includes:

• Netscape Enterprise Server Installation and Migration Guide

• Netscape Enterprise Server Performance Tuning, Sizing, and Scaling Guide

• Netscape Enterprise Server Administrator’s Guide

• Netscape Enterprise Server Programmer’s Guide

NOTE Throughout this manual, all descriptions specific to UNIX® apply

to the Linux® operating system as well, except where Linux is

specifically mentioned.

Where to Find Related Information

About This Book 9

• Netscape Enterprise Server NSAPI Programmer’s Guide

•Netscape Enterprise Server Release Notes

You can find Enterprise Server documentation online in PDF and HTML formats

at:

http://enterprise.netscape.com/docs

Where to Find Related Information

10 Netscape Enterprise Server Programmer’s Guide to Servlets • April 2002 (Draft)

This manual suits for next models

Table of contents

Other Netscape Server manuals

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 User manual

Netscape

Netscape NETSCAPE ENTREPRISE SERVER 6.1 - INSTALLATION AND MIGRATION... User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY... User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.1 - DEPLOYMENT User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.1 - PLUG-IN User manual

Netscape

Netscape NETSCAPE ENTERPRISE SERVER 6.0 - PROGRAMMER GUIDE TO... Manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY... Service manual

Netscape

Netscape NETSCAPE ENTERPRISE SERVER 6.1 - NSAPI PROGRAMMER... User manual

Netscape

Netscape NETSCAPE ENTREPRISE SERVER 6.0 -... Service manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - GATEWAY... User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 Service manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.0 User manual

Netscape

Netscape NETSCAPE ENTREPRISE SERVER 6.0 - INSTALLATION AND MIGRATION... User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.1 - DEPLOYMENT Service manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.1 -... Service manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 -... Service manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.02 - PLUG-IN User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 User manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 - PLUG-IN User manual

Netscape

Netscape NETSCAPE ENTREPRISE SERVER 6.1 - 08-2002... Service manual

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.2 - DEPLOYMENT Quick reference guide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.02 - DEPLOYMENT Quick reference guide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 7.0 - DEPLOYMENT Quick reference guide

Netscape

Netscape NETSCAPE DIRECTORY SERVER 6.01 - PLUG-IN User manual

Popular Server manuals by other brands

HP AlphaServer ES47 Cli reference manual

Dell

Dell PowerEdge R410 Getting started

PowerNAS

PowerNAS CMA quick start guide

Supero

Supero FatTwin F617R3-FT user manual

MSI

MSI P1-109N-L70 user manual

Dell

Dell PowerEdge XE9640 Installation and service manual

Dell

Dell PS4100 Hardware

EtroVISION

EtroVISION EV3151 user manual

NEC

NEC Express5800/T110j System configuration guide

HP ProLiant Gen9 user guide

Compaq

Compaq ProLiant 3000 Maintenance and service guide

Dell

Dell PowerEdge 3YPMN Getting started guide

iRobo

iRobo IPC2U user manual

Nortel

Nortel 1000 Con?guration guide user manual

Asus

Asus AP7500 Hardware reference guide

Avid Technology

Avid Technology AirSpeed 5000 manual

HP Integrity rx2600 overview

Milestone

Milestone Husky IVO 350T Getting started