Oracle9iAS Containers for J2EE Support for JavaServer Pages Developer's Guide -- Index

_jspService() method, A-12

action tags

forward tag, 1-21

getProperty tag, 1-19

in JSP XML pages, 5-10

include tag, 1-20

overview of standard actions, 1-16

param tag, 1-19

plugin tag, 1-22

setProperty tag, 1-18

useBean tag, 1-17

activation.jar, Java activation files for e-mail, 3-7

addclasspath, ojspc option, 7-20

alias translation, JServ

alias_translation config param, B-9

overview, B-21

Apache JServ--see JServ

application events

servlet application lifecycles, A-7

with globals.jsa, B-37

application framework for JServ, B-18

application hierarchy, A-9

application object (implicit), 1-14

application root functionality, 3-2

application scope (JSP objects), 1-15

application support

servlet application lifecycles, A-7

through globals.jsa, B-33

application_OnEnd tag, globals.jsa, B-38

application_OnStart tag, globals.jsa, B-37

application-relative path, 1-29

application.xml, OC4J configuration file, 3-23

appRoot, ojspc option, 7-21

autoreload-jsp-pages, autoreload-jsp-beans (not supported), 3-21

batch pre-translation

ojspc -batchMask option, 7-22

ojspc -deleteSource option, 7-24

ojspc -output option, 7-27

overview of ojspc batch features, 7-14

batch updates--see update batching

batchMask, ojspc option, 7-22

binary data, reasons to avoid in JSP, 6-15

binary file deployment, 7-40

binary file location, ojspc d option, 7-23

bypass_source config param (JServ), B-10

cache.jar, for Java Object Cache, 3-7

caching support, overview, 2-21

call servlet from JSP, JSP from servlet, 4-2

check_page_scope config param, 3-12

checker pages, 6-6

class naming, translator, 7-5

classesXX.zip, for JDBC, 3-7

classpath

classpath config param (JServ), B-10

JSP classpath functionality, 3-3

classpath configuration (JServ), B-2

clustering (OC4J), 2-3

code, generated by translator, 7-2

comments (in JSP code), 1-11

compilation

javaccmd config param, 3-15

ojspc noCompile option, 7-26

config object (implicit), 1-14

configuration

JSP configuration in Oracle Enterprise Manager, 3-25

JSP configuration parameters, 3-9

JSP configuration parameters for JServ, B-4

JSP container setup, 3-8

JSP-related OC4J configuration parameters, 3-21

key JAR and ZIP files, 3-7

key OC4J configuration files, 3-23

map file name extensions, JServ, B-3

optimization of execution, 6-18

setting JSP configuration parameters, 3-20

setting JSP-related OC4J configuration parameters, 3-21

setting parameters, JServ, B-15

connection caching, overview, 4-11

containers

JSP containers, 1-26

servlet containers, A-3

content type settings

dynamic (setContentType method), 9-5

static (page directive), 9-2

context path, 3-2

context-relative path, 1-29

cookies, A-6

custom tags--see tag libraries

d, ojspc option (binary output dir), 7-23

data-access features, 4-7

data-sources.xml, OC4J configuration file, 3-23

debug_mode config param, 3-13

debugging

debug, ojspc option, 7-23

debug_mode config param, 3-13

emit_debuginfo config param, 3-13

through JDeveloper, 2-12

declarations

global declarations, globals.jsa, B-42

member variables, 1-9

method variable vs. member variable, 6-8

XML declaration elements, 5-9

default-web-site.xml, OC4J configuration file, 3-23

deleteSource, ojspc option, 7-24

deployment, general considerations

deploying pages with JDeveloper, 7-36

deployment of binary files only, 7-40

general pre-translation without execution, 7-40

ojspc for batch pre-translation, 7-39

ojspc for page pre-translation, 7-38

overview, 7-34

WAR deployment, 7-34

developer_mode config param (JServ), B-11

directives

forgive_dup_dir_attr config param, 3-14

global directives, globals.jsa, B-42

include directive, 1-8

ojspc forgiveDupDirAttr option, 7-25

overview, 1-7

page directive, 1-7

taglib directive, 1-9

XML directive elements, 5-8

directory alias translation--see alias translation

DMS support, 2-20

dynamic forward, special support for JServ, B-19

dynamic include

action tag, 1-20

for large static content, 6-7

logistics, 6-3

special support for JServ, B-19

vs. static include, 6-3

Dynamic Monitoring Service--see DMS

dynamic page retranslation, 6-17

EAR file, 3-23, 7-34

EJBs

calling from JSP pages, 4-14

use of OC4J EJB tag library, 4-15

emit_debuginfo config param, 3-13

empty actions (tag libraries), 8-28

Enterprise Manager--see Oracle Enterprise Manager

error processing (runtime), 4-26

event-handling

servlet application lifecycles, A-7

with globals.jsa, B-37

with HttpSessionBindingListener, 4-20

exception object (implicit), 1-14

execution models for JSP pages, 1-26

execution of a JSP page, 1-26

explicit JSP objects, 1-12

expressions

expression syntax, 1-10

XML expression elements, 5-9

extend, ojspc option, 7-24

extensions

DMS support, 2-20

overview of caching support, 2-21

overview of data-access JavaBeans, 2-15

overview of extended types, 2-14

overview of global includes, 2-19

overview of JML tag library, 2-16

overview of JSP utility tags, 2-18

overview of JspScopeListener, 2-14

overview of Oracle-specific extensions, 2-19

overview of personalization tag library, 2-17

overview of portable extensions, 2-13

overview of programmatic extensions, 2-13

overview of SQL tag library, 2-16

overview of SQLJ support, 2-19

overview of Web services tag library, 2-18

overview of XML-related tags, 2-14

external resource file

for static text, 6-7

through external_resource parameter, 3-13

through ojspc extres option, 7-25

external_resource config param, 3-13

external_resource_timeout config param (JServ), B-12

extra_imports config param, 3-14

extraImports, ojspc option, 7-24

extres, ojspc option, 7-25

fallback tag (with plugin tag), 1-22

Feiner, Amy (welcome), 1-3

file naming conventions, JSP files, 3-6

files

generated by translator, 7-7

key JAR and ZIP files, 3-7

locations, ojspc d option, 7-23

locations, ojspc srcdir option, 7-30

locations, translator output, 7-8

forgive_dup_dir_attr config param, 3-14

forgiveDupDirAttr, ojspc option, 7-25

forward tag, 1-21

generated code, by translator, 7-2

generated output names, by translator, 7-4

getProperty tag, 1-19

global includes (Oracle extension)

general use, 7-9

use in migrating from translate_params, B-30

globalization support

charset settings of JSP writer, 9-6

content type settings (dynamic), 9-5

content type settings (static), 9-2

multibyte parameter encoding, 9-8

overview, 9-1

sample depending on translate_params, B-27

sample not depending on translate_params, B-29

globals.jsa

application and session lifecycles, B-34

application deployment, B-33

application events, B-37

distinct applications and sessions, B-33

event-handling, B-37

example, declarations and directives, B-43

extended support for servlet 2.0, B-32

file contents, structure, B-43

global declarations, B-42

global JavaBeans, B-42

global JSP directives, B-42

migration from, B-44

overview of functionality, B-32

overview of syntax and semantics, B-34

sample application, application and session events, B-50

sample application, application events, B-46

sample application, global declarations, B-52

sample applications, B-46

session events, B-39

global-web-application.xml, OC4J configuration file, 3-23

help, ojspc option, 7-26

HttpJspPage interface, A-12

HttpSession interface, A-4

HttpSessionBindingListener, 4-20

id attribute (XML view), 5-16

implement, ojspc option, 7-26

implicit JSP objects

overview, 1-13

using implicit objects, 1-15

imports, default packages, 3-5

include directive, 1-8

include tag, 1-20

inner class for static text, 7-3

interaction, JSP-servlet, 4-2

Internet Application Server--see Oracle9i Application Server

invoke servlet from JSP, JSP from servlet, 4-2

JavaBeans

global JavaBeans, globals.jsa, B-42

use for separation of business logic, 1-5

use with useBean tag, 1-17

vs. scriptlets, 6-2

javaccmd config param, 3-15

JDBC in JSP pages

performance enhancements, 4-10

sample of use, 4-8

JDeveloper

JSP support, 2-12

use for deploying JSP pages, 7-36

jndi.jar, for data sources and EJBs, 3-7

JServ

alias translation, B-21

classpath configuration, B-2

config, map file name extensions, B-3

configuration parameters, B-4

error processing, send_error config param, B-13

JSP application framework, B-18

JSP dynamic include support, B-19

mod_jserv module, B-17

overview of JSP-servlet session sharing, B-18

overview of special considerations, B-17

session sharing, session_sharing config param, B-13

setting configuration parameters, B-15

use of ojspc for JServ, B-16

use with Oracle9i Application Server, B-1

jsp fallback tag (with plugin tag), 1-22

jsp forward tag, 1-21

jsp getProperty tag, 1-19

jsp id attribute (XML view), 5-16

jsp include tag, 1-20

jsp param tag, 1-19

jsp plugin tag, 1-22

jsp root element (XML syntax), 5-7

jsp setProperty tag, 1-18

jsp text element (XML syntax), 5-10

JSP translator--see translator

jsp useBean tag

syntax, 1-17

JSP XML document, 5-2

JSP XML syntax--see XML syntax

JSP XML view--see XML view

JspPage interface, A-12

jsp-print-null flag, 3-21

JspScopeListener, overview, 2-14

jspService() method, A-12

JSP-servlet interaction

invoking JSP from servlet, request dispatcher, 4-3

invoking servlet from JSP, 4-2

passing data, JSP to servlet, 4-3

passing data, servlet to JSP, 4-4

sample code, 4-5

jsp-timeout flag, 3-21

JspWriter object, 1-14

JSTL, overview of support, 2-21

jta.jar, for Java Transaction API, 3-7

listeners, tag libraries, 8-50

mail.jar, for e-mail from applications, 3-7

member variable declarations, 6-8

method variable declarations, 6-8

migration

from globals.jsa, B-44

from translate_params, B-30

mods, Apache, 2-10

multibyte parameter encoding

general/standard, 9-8

JServ environment, B-24

namespaces (XML syntax), 5-7

naming conventions, JSP files, 3-6

National Language Support--see Globalization Support

NLS--see Globalization Support

no_tld_xml_validate config param, 3-16

noCompile, ojspc option, 7-26

non-empty actions (tag libraries), 8-28

noTldXmlValidate, ojspc option, 7-27

null data, print mode, 3-21

objects and scopes (JSP objects), 1-12

OC4J

general overview, 2-3

overview of JSP implementation, 2-6

standalone, 2-5

ojspc pre-translation tool

command-line syntax, 7-20

option descriptions, 7-20

option summary table, 7-16

output files, locations, related options, 7-32

overview, 7-13

overview of basic functionality, 7-13

overview of batch pre-translation, 7-14

use for batch pre-translation, 7-39

use for JServ, B-16

use for page pre-translation, 7-38

ojsp.jar, for JSP container, 3-7

ojsputil.jar, for JSP tag libraries and utilities, 3-7

old_include_from_top config param, 3-16

oldIncludeFromTop, ojspc option, 7-27

on-demand translation (runtime), 1-26, 1-27

optimization

not using HTTP session, 6-19

unbuffering a JSP page, 6-18

Oracle Enterprise Manager, use for JSP configuration, 3-25

Oracle HTTP Server

overview, use of Apache mods, 2-10

with mod_jserv, B-17

Oracle platforms supporting JSP

JDeveloper, 2-12

Oracle9i Application Server, 2-2

Oracle9i Application Server

brief overview, 2-2

JSP support, 2-2

use of JServ, B-1

out object (implicit), 1-14

output files

generated by translator, 7-7

locations, 7-8

locations and related options, ojspc, 7-32

ojspc d option (binary location), 7-23

ojspc srcdir option (source location), 7-30

output names, conventions, 7-4

output, ojspc option, 7-27

package imports, default, 3-5

package naming

by translator, 7-5

ojspc packageName option, 7-28

packageName, ojspc option, 7-28

page directive

characteristics, 6-10

contentType setting for globalization support, 9-2

overview, 1-7

page implementation class

generated code, 7-2

overview, 1-28

page object (implicit), 1-13

page retranslation, dynamic, 6-17

page scope (JSP objects), 1-15

pageContext object (implicit), 1-13

page-relative path, 1-29

param tag, 1-19

parent property (tag handlers), 8-30

plugin tag, 1-22

precompile_check config param, 3-17

prefetching rows--see row prefetching

pre-translation

ojspc utility, 7-13

without execution, general, 7-40

print null flag, 3-21

reduce_tag_code config param, 3-17

reduceTagCode, ojspc option, 7-28

req_time_introspection config param, 3-17

reqTimeIntrospection, ojspc option, 7-28

request dispatcher (JSP-servlet interaction), 4-3

request objects

JSP implicit request object, 1-13

overview, A-9

request scope (JSP objects), 1-15

RequestDispatcher interface, 4-3

requesting a JSP page, 1-28

resource management

overview of JSP extensions, 4-25

standard session management, 4-20

response objects

JSP implicit response object, 1-13

overview, A-9

retranslation of page, dynamic, 6-17

root element (XML syntax), 5-7

row prefetching, 4-13

rowset caching, 4-13

runtimeXX.zip, for SQLJ, 3-7

S, ojspc option (for SQLJ options), 7-29

sample applications

custom tag definition and use, 8-57

globalization, depending on translate_params, B-27

globalization, not depending on translate_params, B-29

globals.jsa samples, B-46

globals.jsa, application and session events, B-50

globals.jsa, application events, B-46

globals.jsa, global declarations, B-52

HttpSessionBindingListener sample, 4-21

IterationTag definition and use, 8-53

JSP-servlet interaction, 4-5

SQLJ example, 4-16

traditional vs. XML syntax, 5-11

transformation to XML view, 5-17

scopes (JSP objects), 1-15

scripting elements

comments, 1-11

declarations, 1-9

expressions, 1-10

overview, 1-9

scriptlets, 1-10

scripting variables (tag libraries)

declaration through TEI class, 8-44

declaration through TLD, 8-42

scopes, 8-42

using, 8-41

scriptlets

scriptlet syntax, 1-10

vs. JavaBeans, 6-2

XML scriptlet elements, 5-9

security

considerations in JServ, B-24

general considerations, 3-4

send_error config param (JServ), B-13

server.xml, OC4J configuration file, 3-23

service method, JSP, A-12

servlet 2.0 environments

added support through globals.jsa, B-32

globals.jsa sample applications, B-46

JSP container features for application root functionality, B-17

servlet containers, A-3

servlet contexts

overview, A-6

servlet context objects, A-10

servlet path, 3-2

servlet sessions

HttpSession interface, A-4

session tracking, A-6

servlet-JSP interaction

invoking JSP from servlet, request dispatcher, 4-3

invoking servlet from JSP, 4-2

passing data, JSP to servlet, 4-3

passing data, servlet to JSP, 4-4

sample code, 4-5

servlets

application lifecycle management, A-7

request and response objects, A-9

review of servlet technology, A-2

servlet configuration objects, A-11

servlet containers, A-3

servlet context objects, A-10

servlet contexts, A-6

servlet interface, A-3

servlet invocation, A-8

servlet objects, A-9

servlet sessions, A-4

session objects, A-10

session sharing, JSP, JServ, B-18

technical background, A-2

wrapping servlet with JSP page, B-20

session events

with globals.jsa, B-39

with HttpSessionBindingListener, 4-20

session objects

JSP implicit session object, 1-14

overview, A-10

session scope (JSP objects), 1-15

session sharing, overview, JSP-servlet, JServ, B-18

session support through globals.jsa (JServ), B-33

session tracking, A-6

session_OnEnd tag, globals.jsa, B-40

session_OnStart tag, globals.jsa, B-39

session_sharing config param (JServ), B-13

setCharacterEncoding() method, 9-8

setContentType() method, globalization support, 9-5

setProperty tag, 1-18

setReqCharacterEncoding() method, multibyte parameter encoding (JServ), B-24

setWriterEncoding() method, globalization support, 9-6

shortcut URI (tag librarires), 8-21

simple tag handlers (tag libraries)

with body iteration, 8-31

without body iteration, 8-30

source file location, ojspc srcdir option, 7-30

SQLJ

JSP code example, 4-16

JSP support for, 4-15

ojspc S option for SQLJ options, 7-29

setting Oracle SQLJ options, 4-19

sqljcmd config param, 3-18

sqljsp files, 4-18

triggering SQLJ translator, 4-18

sqljcmd config param, 3-18

sqljsp files for SQLJ, 4-18

srcdir, ojspc option, 7-30

SSL sessions, A-6

statement caching, 4-12

static include

directive, 1-8

logistics, 6-3

vs. dynamic include, 6-3

static text

external resource file, 6-7

external resource, ojspc extres option, 7-25

external_resource parameter, 3-13

generated inner class, 7-3

workaround for large static content, 6-7

static_text_in_chars config param, 3-18

staticTextInChars, ojspc option, 7-31

syntax (overview), 1-7

tag handlers (tag libraries)

access to outer tag handlers, 8-37

accessing body content, 8-33

body processing, 8-27

changes between JSP 1.1 and 1.2, 8-7

constants for body processing, 8-29

empty actions, 8-28

non-empty actions, 8-28

OC4J tag handler code generation, 8-40

OC4J tag handler instance reuse / pooling, 8-38

overview, 8-25

sample tag handler classes, 8-54, 8-58

simple tag handlers, with body iteration, 8-31

simple tag handlers, without body iteration, 8-30

tag libraries

defining and using, end-to-end example, 8-57

IterationTag, end-to-end example, 8-53

multiple tag libraries in a JAR file, 8-18

namespaces, XML support, 5-7

overview of functionality, 1-24

overview of standard implementation, 8-2

runtime vs. compile-time implementations, 8-62

scripting variables, 8-41

sharing across applications, 8-20

single tag library in a JAR file, 8-17

standard framework, 8-2

strategy, when to create, 6-5

tag handlers, 8-25

tag library descriptor files, 8-8

tag library listeners, 8-50

tag library namespaces (XML syntax), 5-7

taglib directive, 8-16

tag-library-validator classes, 8-46

web.xml use, 8-21

well-known URI, 8-20

tag library descriptor files

changes between JSP 1.1 and 1.2, 8-5

defining shortcut URI in web.xml, 8-21

listener element and subelements, 8-15

overview of functionality, 8-8

sample files, 8-56, 8-61

specifying individual TLD, 8-17

specifying single TLD in a JAR file, 8-17

specifying TLDs for multiple tag libraries in a JAR file, 8-18

tag element and subelements, 8-10

taglib directive, 8-16

TLD validation config param, 3-16

TLD validation ojspc option, 7-27

validator element and subelements, 8-15

tag-extra-info classes (tag libraries)

general use, getVariableInfo() method, 8-44

sample tag-extra-info class, 8-59

taglib directive

general use, 8-16

syntax, 1-9

tag-library-validator classes, 8-46

tags_reuse_default config param, 3-19

template data, 5-3

text element (XML syntax), 5-10

timeout settings

for JServ, B-12

for OC4J, 3-21

tips

avoid JSP use with binary data, 6-15

JavaBeans vs. scriptlets, 6-2

JSP page as servlet wrapper, B-20

JSP preservation of white space, 6-13

key configuration issues, 6-17

method vs. member variable declaration, 6-8

page directive characteristics, 6-10

static vs. dynamic includes, 6-3

using a "checker" page, 6-6

when to create tag libraries, 6-5

workaround, large static content, 6-7

TLD file--see tag library descriptor file

translate_params config param (JServ)

code equivalent, B-26

effect in overriding non-multibyte servlet containers, B-26

general information, B-14, B-25

globalization sample depending on it, B-27

globalization sample not depending on it, B-29

migration from, B-30

translation, on-demand (runtime), 1-27

translator

generated class names, 7-5

generated code features, 7-2

generated files, 7-7

generated inner class, static text, 7-3

generated names, general conventions, 7-4

generated package names, 7-5

Oracle JSP global includes, 7-9

output file locations, 7-8

translator.zip, for SQLJ, 3-7

type extensions, 2-14

unsafe_reload config param (JServ), B-14

update batching, 4-12

URL rewriting, A-6

useBean tag, 1-17

validation, tag libraries, 8-46

variable element (tag libraries), 8-42

verbose, ojspc option, 7-31

version, ojspc option, 7-31

WAR deployment, 7-34

WAR file, 3-23, 7-34

Web application hierarchy, A-9

web.xml, usage for tag libraries, 8-21

well-known URI (tag libraries), 8-20

wrapping servlet with JSP page, B-20

XML support

JSP XML document, 5-2

JSP XML documents and JSP XML view, overview, 5-2

JSP XML syntax, 5-4

XML validation config param, 3-20

XML validation ojspc option, 7-31

XML view, 5-15

XML syntax

custom action elements, 5-10

declaration elements, 5-9

directive elements, 5-8

expression elements, 5-9

root element and tag library namespaces, 5-7

sample, traditional vs. XML syntax, 5-11

scriptlet elements, 5-9

standard action elements, 5-10

summary table of JSP XML syntax, 5-5

text element and other elements, 5-10

XML view

jsp id attribute for validation, 5-16

sample transformation, 5-17

transformation from JSP page to XML view, 5-15

xml_validate config param, 3-20

xmlparserv2.jar, for XML validation, 3-7

xmlValidate, ojspc option, 7-31

xsu12.jar or xsu111.jar, for XML, 3-7

Index

Symbols

A

B

C

D

E

F

G

H

I

J

L

M

N

O

P

R

S

T

U

V

W

X