=============================================
Oracle Application Server Containers for J2EE 
=============================================

Standalone Distribution Readme 

Contents
--------

    * Introduction
    * Pre-Requisites
    * Basic Installation 
    * Documentation
    * Starting OC4J 
    * Stopping OC4J 
    * Testing the OC4J Installation
    * Using the Command Line Utility 
    * Release Notes and More Information 

Introduction
------------
    
The Oracle Application Server Containers for J2EE (OC4J) standalone 
distribution provides a complete J2EE server environment, distributed 
as a simple zip file. The OC4J standalone distribution includes an 
HTTP(S) server, the required J2EE services, and Web Services capabilities 
all of which are executed from one Java process.

Pre-Requisites
--------------
    
In order to use OC4J standalone, you must have a Java2 Standard Edition 
(J2SE) version 1.4 or later installed on your system. 

Basic Installation
------------------

To install, unzip the oc4j_extended.zip file using the archive utility
of your choice. The jar utility in your J2SE installation can also be used. 

The following directory structure has been created for you:

    <install-dir>
        /bin
        /j2ee
        /javacache
        /javavm
        /jdbc
        /jdk
        /jlib
        /lib
        /rdbms
        /soap
        /sqlj
        /webservices

Where <install-dir> is the directory in which you unzipped the 
oc4j_extended.zip file.

To complete the installation of OC4J change to the <install-dir>j2ee/home 
directory, and issue the following command:

    > cd <install-dir>/j2ee/home
    > java -jar oc4j.jar -install

The <install-dir>/j2ee/home directory is referred to as <J2EE_HOME>.

The installation prompts you to enter and verify an administration password, 
which is used for the administration console command-line tool. The 
administration username defaults to "admin". Enter any administration 
password. 

OC4J is installed with a default configuration that includes a default
Web site and a default application. These are provided so that you can start 
and use OC4J immediately.

Documentation
------------- 

The OC4J User's Guide for this distribution is accessible at 
<J2EE_HOME>/default-web-app/standaloneguide.pdf

The User's Guide is also available online from your OC4J installation
at http://localhost:8888/standaloneguide.pdf.

The complete set of documentation for OC4J is available from the 
Oracle Technology Network at
http://otn.oracle.com/documentation/index.html.

Starting OC4J
-------------

Start OC4J server by changing to the J2EE_HOME directory and issuing one of 
the following commands:

1. Starts OC4J using the default configuration files, which are located in the 
j2ee/home/config directory.

    > cd <J2EE_HOME>
    > java -jar oc4j.jar

2. Start OC4J using the server.xml file located in /mypath.

    > cd <J2EE_HOME>
    > java -jar oc4j.jar -config /mypath/server.xml

The server outputs an initialization string with the version number when it
is ready to accept requests. For example:

    Oracle Application Server Containers for J2EE 10g (10.1.2.0.0) initalized

Stopping OC4J
-------------

Stop OC4J by pressing ^c (Ctrl+c) in the window where the process was 
started, or by using the shutdown command in the admin.jar command-line 
utility (described below), or by using the process termination command (for
example "kill" on Unix/Linux) for your operating system.
    
Testing the OC4J Installation
-----------------------------

Test the server by starting the OC4J process and accessing the URL 
http://localhost:8888 from a Web browser. There are a couple of sample links
at the bottom of the page that run JSP and Servlet sample applications.

If you changed the default port number in the http-web-site.xml file,
access the Web server using http://localhost:<portnumber> where
<portnumber> is the value you specified for the <web-site> element.

Using the Command-Line Utility
------------------------------

OC4J provides a command-line utility called admin.jar that can be used
to perform operations on a running OC4J instance. Among other things,
you can use admin.jar to restart and stop OC4J, deploy applications, and
gather information on current resource usage.

The admin.jar utility uses RMI to connect to a running OC4J process.
This means OC4J must be started before using admin.jar. OC4J can't be
started using admin.jar.

The admin.jar utility is exercised using the following command:

    > java -jar admin.jar ormi://<oc4j_host>:<oc4j_ormi_port> <admin_id>
      <admin_password> <options>

Where:
 
   - The oc4j_ormi_port defaults to 23791 and can be omitted if not changed.

   - The admin_id defaults to admin (configurable in principals.xml).

   - The admin_password is the password you configured during the basic
     installation section.

To see all of the available options, use the -help option.

Example usages of admin.jar 
---------------------------

To restart OC4J using admin.jar execute the following command from the
<J2EE_HOME> directory:

    > java -jar admin.jar ormi://<oc4j_host>:<oc4j_ormi_port> <admin>
      <admin_password> -restart

To shut down OC4J using admin.jar execute the following command:

    > java -jar admin.jar ormi://<oc4j_host>:<oc4j_ormi_port> <admin>
      <admin-password> -shutdown

This command provides a graceful shutdown of the container. If it does
not shut down the container, you can force a rapid shutdown by passing
the -force argument, as follows:

    > java -jar admin.jar ormi://<oc4j_host>:<oc4j_ormi_port> <admin>
      <admin-password> -shutdown force


Copyright 2004 Oracle Corporation. All Rights Reserved.              
 
