Oracle DBA Tips Corner      Return to the Oracle DBA Tips Corner.

Administrative Commands

by Jeff Hunter, Sr. Database Administrator

Introduction

The following document provides a brief introduction to several of the most used commands that can be performed by the OC4J administrator. OC4J provides the admin.jar command-line utility that is used to performing actions like deploying applications, restarting OC4J, and shutting down the OC4J server. For the purpose of this document, I will provide all examples using a fictitious application called my_app.

admin.jar Overview

After starting the OC4J server, you can administer the server using the admin.jar command-line tool. The basic syntax for using the admin.jar tool is as follows:

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

The following listing is an overview of the variables used with the admin.jar tool:

• <oc4j_host>:<oc4j_ormi_port> - The host name and port of the OC4J server from which you want to manage. The admin.jar utility uses the OC4J Remote Method Invocation (ORMI) protocol to communicate with the OC4J server. Therefore, the host name and port identified by these variables are defined in the rmi.xml file for the OC4J server to which you are directing the request.

  The default port number for the ORMI protocol is 23791. Configure both the host name and port number - if not using the default - in the rmi.xml file in the attribute, as follows:

  <rmi-server port="<oc4j_ormi_port>" host="<oc4j_host>" > 

• <admin_id> <admin_password> - The administration identity and password, required to perform administrative functions. The file $OC4J_HOME/j2ee/home/config/principals.xml contains the usernames, passwords and groups that have access to the OC4J server. By default, OC4J defines the groups administrators, guests, and users. Also included by default are the users user, anonymous, admin, and scott.

• <options> - The admin.jar utility provides many options for managing the OC4J instance. The examples in this document provide the different options used when managing OC4J using admin.jar.

Example Administrative Commands

Starting OC4J Instance

% java -jar oc4j.jar
Node started with id=-2479157545
Oracle9iAS (9.0.3.0.0) Containers for J2EE initialized

Shutting Down OC4J

% java -jar admin.jar ormi://localhost admin manager -shutdown

Restarting OC4J

% java -jar admin.jar ormi://localhost admin manager -restart

Deploying an Application

Register the J2EE application (generally the EJBs / business logic):

% java -jar admin.jar ormi://localhost admin manager -deploy -file $OC4J_HOME/j2ee/home/applications/my_app.ear -deploymentName my_app -targetPath applications/

   This step creates the entry in the server.xml file for the my_app application

To bind the Web application through the admin.jar tool, use the following:

% java -jar admin.jar ormi://localhost admin manager -bindWebApp my_app my_app-web http-web-site /my_app

   This creates the <web-app> entry element in the http-web-site.xml configuration file.

Undeploy Application

% java -jar admin.jar ormi://localhost admin manager -undeploy my_app

Listing All Available Sites

% java -jar admin.jar ormi://localhost admin manager -site -list
All available sites:
Name    :       Default Oracle9iAS Containers for J2EE Web Site
Port    :       4169
Host    :       0.0.0.0
Secure  :       false

Name    :       Oracle9iAS Containers for J2EE HTTP Web Site
Port    :       8888
Host    :       0.0.0.0
Secure  :       false