Contents

List of Figures

List of Tables

Title and Copyright Information

Preface

• Intended Audience
• Documentation Accessibility
• Related Documents
• Conventions

1 Introduction to Oracle Containers for J2EE (OC4J)

• Overview of OC4J
• J2EE Support in OC4J
• New and Changed Features in OC4J
  • New Features in OC4J
    • Support for Web Services
    • Support for New J2EE 1.4 Application Management and Deployment Specifications
    • Support for Enterprise JavaBeans 3.0
    • Support for Oracle Application Server TopLink
    • OracleAS Job Scheduler
    • New Two-Phase Commit Transaction Coordinator Functionality
    • Generic JMS Resource Adapter Enhancements
    • New admin_client.jar Commands and Remote Client
  • Configuration File Changes from Previous Releases
• OC4J in a Standalone Configuration
• OC4J in an Oracle Application Server Configuration
• Overview of the Application Hierarchy in OC4J
  • The system Application
  • The default Application
  • The Global Web Application
  • J2EE Applications

2 Installing Standalone OC4J

• Meeting Installation Prerequisites for a Standalone OC4J Server
• Installing the Standalone OC4J Distribution

3 Tools for Administering OC4J

• Oracle Enterprise Manager 10g Application Server Control Console
  • Accessing Application Server Control Console in Standalone OC4J
  • Accessing the Application Server Control Console in Oracle Application Server
  • Functional Overview of the Application Server Control Console Interface
• The admin_client.jar Command Line Utility
• The admin.jar Command Line Utility
• The oc4j Executable Scripts
• Oracle Process Manager and Notification Server (OPMN)
• Changing the oc4jadmin Account Password

4 OC4J Runtime Configuration

• Specifying the JDK Version
  • Specifying the JDK in a Standalone Configuration
  • Specifying the JDK in a Managed Configuration
• Setting OC4J Runtime Options at Startup
  • Setting Runtime Options in a Standalone OC4J Configuration
  • Setting Runtime Options in a Managed OC4J Configuration
  • Overview of OC4J Runtime Options
• Setting System Properties at Startup
  • Setting System Properties in a Standalone OC4J Configuration
  • Setting System Properties in an OPMN-Managed OC4J Configuration
  • Overview of General System Properties
  • Overview of Debug Properties
  • Managing stdout/stderr Log Files
• Enabling Remote Debugging from an Integrated Development Environment
  • Enabling Remote Debugging for an OC4J Instance Through Application Server Control Console
  • Specifying Debug Start Parameters in the opmn.xml File
  • Specifying Debug Start Parameters on a Startup Command Line
  • Debugging Web Applications Remotely
    • Setting Up for Remote Debugging of Servlets
    • Setting Up for Remote Debugging of JSPs

5 Starting and Stopping OC4J

• Starting OC4J in a Standalone Environment
  • Starting OC4J with an oc4j Script
  • Starting OC4J with oc4j.jar
• Starting OC4J in an Oracle Application Server Environment
• Stopping OC4J in a Standalone Environment
  • Stopping Standalone OC4J with admin_client.jar
  • Stopping OC4J with admin.jar
  • Stopping OC4J with an oc4j Script
• Stopping OC4J in an Oracle Application Server Environment
• Restarting an OC4J Instance in a Standalone Environment
• Restarting an OC4J Instance in an Oracle Application Server Environment

6 Using the admin_client.jar Utility

• Preparing to Use admin_client.jar
  • Understanding the admin_client.jar Syntax and URI Specification
    • Performing Operations on a Group of OC4J Instances Within a Cluster
    • Performing Operations on a Specific OC4J Instance
    • Performing Operations on a Standalone OC4J Server
    • Validating a URI
  • Downloading and Extracting the Remote Administration Client
  • Printing Usage Text to the Console
  • Enabling Logging
• Deploying an Archive
  • Deploying a J2EE Application (EAR)
  • Deploying a J2EE Application from a Remote Client
  • Deploying a Standalone Web Module (WAR)
  • Deploying a Standalone Resource Adapter (RAR)
  • Using a Script File for Batch Deployment
• Binding Web Modules to a Web Site After Deployment
  • Bind All Web Modules to a Single Web Site
  • Bind a Specific Web Module to a Specific Web Site and Set the Context Root
• Redeploying an Archive
• Undeploying an Archive
  • Undeploying an EAR or Standalone WAR
  • Undeploying a Standalone RAR
• Updating Modified Classes in a Deployed EJB Module
• Creating and Managing Shared Libraries
  • Installing a Shared Library
  • Modifying an Existing Shared Library
  • Viewing the Contents of a Shared Library
  • Listing All Shared Libraries
  • Removing a Shared Library
• Starting, Restarting, and Stopping Applications
• Restarting and Stopping OC4J Instances
  • Restarting an OC4J Instance or Group of Instances
  • Stopping an OC4J Instance or Instances
• Managing Data Sources
  • Adding, Testing, and Removing Data Source Connection Pools
    • Adding a Data Source Connection Pool
    • Testing a Data Source Connection Pool
    • Removing a Data Source Connection Pool
  • Adding, Testing, and Removing Data Sources
    • Adding a Managed Data Source
    • Removing a Managed Data Source
    • Adding a Native Data Source
    • Removing a Native Data Source
    • Testing a Database Connection
    • Testing a Data Source
    • Getting the Data Sources Descriptor for an Application
• Managing JMS Resources
  • Managing JMS Connection Factories
    • Adding a JMS Connection Factory
    • Removing a JMS Connection Factory
    • Getting Information About JMS Connection Factories
  • Managing JMS Destinations
    • Adding a JMS Destination
    • Removing a JMS Destination
    • Getting Information About JMS Destinations
• Managing OC4J Through a Remote Client
  • Using admin_client.jar Commands Remotely
  • Connecting to a Remote Oracle Application Server Instance Using JConsole
  • Using a JMX Programmatic Client to Manage OC4J Remotely

7 Using the admin.jar Utility

• Overview of admin.jar Usage
  • Understanding the admin.jar Syntax
  • Printing Help to the Console
• Managing a Standalone OC4J Instance
  • Stopping and Restarting OC4J in a Standalone Environment
  • Forcing OC4J to Check for Modified Files
• Deploying or Undeploying Applications
• Managing Applications
  • Starting, Stopping, or Restarting an Application
  • Updating an EJB Module Within an Application
• Managing Data Sources
  • Creating an Application-Specific Data Source
  • Listing/Testing/Removing Existing Data Sources
  • Converting Existing Data Sources to the New Configuration
    • Convert a data-sources.xml File with Standalone OC4J Running or Not Running
    • Check Consistency Between the Application and the New data-sources.xml File
• Deploying or Undeploying Connectors

8 Configuring and Managing Clusters and OC4J Groups

• Clustering Overview
  • How Clustering Works
  • Supported Clustering Models
  • Changes in Clustering
• Creating and Managing OC4J Groups Within Oracle Application Server Clusters
  • Creating Groups of OC4J Instances
  • Managing OC4J Instances in a Group
    • Creating an Additional OC4J Instance
    • Accessing and Managing a New Instance
    • Removing an OC4J Instance from a Group
  • Replicating Changes Across a Cluster
• Configuring a Cluster
  • Configuring Dynamic Node Discovery Using Multicast
    • Configuring Multicast Discovery with opmnctl
    • Configuring Multicast Discovery with opmnassociate
  • Configuring Static Discovery Servers
    • Configuring a Static Discovery Server Connection with opmnctl
  • Configuring Cross-Topology Gateways
  • Configuring a Machine to Work With and Without a Network Connection
  • Configuring Static Node-to-Node Communication
• Viewing the Status of a Cluster
  • Viewing Cluster Status with opmnctl
  • Viewing Cluster Status in Application Server Control Console
• Configuring Routing and Load Balancing with Oracle HTTP Server
  • Using Web Server Routing IDs to Control OC4J Request Routing
    • Changing Routing IDs Through the Application Server Control Console
    • Changing Routing IDs in the opmn.xml file
  • Setting mod_oc4j Load Balancing Options
• Configuring Application Mount Points
  • Enabling Dynamic Configuration of Application Mount Points
  • Changing the Mount Point Configuration Algorithm
  • Viewing Mount Point Configuration Data
• Running an OC4J Instance on Multiple JVMs
  • Creating Additional JVMs for an OC4J Instance
  • Monitoring Multiple JVMs
    • Monitoring Dynamic Monitoring Service JVM Metrics
    • Setting the jmxremote System Property for Monitoring J2SE JVM 5.0 Metrics
    • Monitoring J2SE 5.0 JVM Metrics in an Oracle Application Server Environment
    • Monitoring J2SE 5.0 JVM Metrics in a Standalone OC4J Environment

9 Application Clustering in OC4J

• Overview of Application Clustering in OC4J
• How Application Clustering Differs from Previous OC4J Releases
  • Islands No Longer Supported
  • loadbalancer.jar No Longer Used
  • Application-Clustering-Specific XML Elements Deprecated
• Configuring Application Clustering
  • Enabling Application Clustering
  • Setting Replication Policies
  • Managing the Number of JVMs to Which Application State Data Is Replicated
  • Using Synchronous or Asynchnronous Replication
  • Configuring Multicast Replication
    • Using an Existing JavaGroups Configuration for Multicast Replication
  • Configuring Peer-to-Peer Replication
    • Configuring Dynamic OPMN-Managed Peer-to-Peer Replication
    • Configuring Static Peer-to-Peer Replication
  • Configuring Database Replication
  • Disabling Clustering
  • Overview of the <cluster> Element

10 Task Manager and Thread Pool Configuration

• Configuring the OC4J Task Manager
• Configuring OC4J Thread Pools
  • Changing the Thread Pool Configuration
    • Changing the Thread Pool Configuration Through the Application Server Control Console
    • Changing the Thread Pool Configuration Through MBeans
    • Adding <thread-pool> Elements to server.xml
  • Configuring Custom Thread Pools for Applications
  • Converting from the Older Thread Pool Format

11 Logging in OC4J

• Overview of Log Files Generated by OC4J
• Using Plain Text File Logging
  • Enabling or Disabling Text File Logging
  • Managing Text Log Files
  • Viewing Text Log Files
• Using Oracle Diagnostic Logging (ODL)
  • Enabling or Disabling ODL
  • Managing ODL Log Files
    • Size-Based Log Rotation
    • Time-Based Log Rotation
  • Viewing ODL Log Files
• Configuring OC4J Logging
  • Using and Configuring the OC4J Component Loggers
  • Viewing the OC4J Log File
  • Configuring the oracle Logger

12 Using MBeans in OC4J

• MBeans and Java Management Extensions (JMX) Support in OC4J
  • Overview of MBeans
  • Overview of the Top-Level OC4J System MBeans
  • When Changes Made Through MBeans Take Effect
  • How MBean Data Is Persisted
• Using the System MBean Browser
• Subscribing to JMX Notifications
• Using Application-Specific MBeans

13 Managing Web Sites in OC4J

• Overview of a Web Site in OC4J
• Configuring Web Site Connection Data
  • Configuring Web Site Data in a Standalone OC4J Installation
  • Configuring Web Site Data in OPMN-Managed OC4J Instances
    • Changing Port Ranges in Application Server Control Console
    • Manually Changing Protocols and Port Ranges in opmn.xml
    • Configuring Web Sites with opmnctl
• Creating a New Web Site in OC4J
  • Creating the Web Site Configuration File
  • Referencing the Web Site Configuration File in server.xml
  • Defining the Web Site Connection Data in opmn.xml
  • Sharing Web Applications Between Web Sites
  • Specifying the Cookie Domain
• Configuring a Secure Web Site in OC4J
  • Creating the Secure Web Site Configuration File
    • Requiring Client Authentication
    • Requesting Client Authentication with OC4J
• Starting and Stopping Web Sites
• Configuring Web Site Access Logging
  • Configuring Text-Based Access Logging
  • Viewing Text Access Log Files
  • Configuring ODL Access Logging
  • Viewing ODL Access Log Files
  • Enabling or Disabling Access Logging for a Web Module or Application

14 Registering DTDs and XSDs with OC4J

• Why XSDs Have to Be Registered
• Registering a DTD or XSD

A Troubleshooting OC4J

• Problems and Solutions
  • java.lang.OutOfMemory Errors
  • Application Performance Impacted by Garbage Collection Pauses
  • Invalid or Unneeded Library Elements Degrading Performance
  • ClassCastExceptions and ClassNotFound Errors
  • OC4J Fails to Start: Unable to Find Java Compiler
  • Error When Clustering an Application
  • Error When Downgrading from JDK 5.0 to JDK 1.4.2
  • Unsupported Methods in JMX MBeanServer and MBeanServerConnection Interfaces
  • OC4J Hanging When Starting Applications in Oracle Application Server
• Additional Help

B Configuration Files Used in OC4J

• Overview of the XML Configuration Files Used by OC4J
• Elements of the OC4J Server Configuration File (server.xml)
  • Example of a server.xml File
  • <application-server>
  • <application>
  • <code-source>
  • <custom-thread-pool>
  • <execution-order>
  • <global-application>
  • <global-thread-pool>
  • <global-web-app-config>
  • <import-shared-library>
  • <init-param>
  • <j2ee-logging-config>
  • <java-compiler>
  • <javacache-config>
  • <jms-config>
  • <log>
  • <rmi-config>
  • <shared-library>
  • <shutdown-class>
  • <startup-class>
  • <thread-pool>
  • <transaction-manager-config>
  • <web-site>
  • <work-manager-thread-pool>
• Overview of the Web Site Configuration Files (*-web-site.xml)
  • <web-site>
  • <description>
  • <frontend>
  • <web-app>
  • <default-web-app>
  • <user-web-apps>
  • <access-log>
  • <odl-access-log>
  • <ssl-config>

C Overview of the Session State Tables

D Third Party Licenses

• ANTLR
  • The ANTLR License
• Apache
  • The Apache Software License
• Apache SOAP
  • Apache SOAP License
• DBI Module
  • Perl Artistic License
    • Preamble
    • Definitions
• FastCGI
  • FastCGI Developer's Kit License
  • Module mod_fastcgi License
• Info-ZIP Unzip Package
  • The Info-ZIP Unzip Package License
• JSR 110
• Jaxen
  • The Jaxen License
• JGroups
  • The GNU License
• mod_mm and mod_ssl
• OpenSSL
  • OpenSSL License
• Perl
  • Perl Kit Readme
  • mod_perl 1.29 License
  • mod_perl 1.99_16 License
  • Perl Artistic License
    • Preamble
    • Definitions
• SAXPath
  • The SAXPath License
• W3C DOM
  • The W3C License

Index