Sun ONE Application Server 7 Administrator's Guide |
816-7156-10 |
Updated: October 22, 2002 |
ContentsWhat's In This Guide?
How This Guide Is Organized
Server Basics and Administering Global Settings
Documentation Conventions
Managing an Individual Server Instance
Managing HTTP Server Features and Virtual Servers
Appendixes
General Conventions
Product Line Overview
Conventions Referring to Directories
Platform Edition
Using the Documentation
Standard Edition
Enterprise Edition
Product Support
Server Basics and Administering Global Settings
Getting Started with Sun ONE Application Server Administration
About Sun ONE Application Server
Configuring the Bundled Solaris Version
Creating an Administrative Domain
Using the Administration Interface
Starting the Administration Server
Creating an Application Server Instance
Deploying Applications
Accessing the Administration Interface
Using the Command-line Interface
Using Tabs
Using Buttons
Accessing Online Help
Exiting the Administration Interface
Accessing the Administration Server
Accessing Application Server Instances
Using Sun ONE Studio
About Configuration Files
Using the License Commands
Setting Administration Server Preferences
About the Administration Server
Starting the Administration Server
Using the startserv Script
Shutting Down the Administration Server
Using the Command-Line Interface
Using the Services Window (Windows)
Using the Start Menu (Windows)
Shutting Down Using the Administration Interface
Accessing the Administration Server Settings
Shutting Down Using the stopserv Script
Shutting Down Using the Command-Line Interface
Shutting Down Using the Services Window (Windows)
Viewing Administration Server Control Settings
Applying Changes to the Administration Server
Editing HTTP Listener Settings for the Administration Server
Setting SNMP, Logging, and Security Preferences
Configuring Administrative Domains
About Administrative Domains
Implementing Administrative Domains
Configuring Domains
Directory Structure
Process/Port Structure
Creating Domains
Recreating the Domain Registry
Example: creating a domain in the default location
Deleting Domains
Example: creating a domain somewhere other than the default location
Example: creating a domain for another user (UNIX only)
User Permissions on UNIX Platforms
Example: deleting a domain
Listing Domains
Example: listing the domains on a local machine
Starting Domains
Example: listing the domains on the local machine using the remote option:
Example: starting the only domain on a machine:
Stopping Domains
Example: Stopping all instances in a domain except for the admin server instance.
Managing an Individual Server Instance
Using Application Server Instances
About Application Server Instances
Starting and Stopping an Application Server Instance
Using the Start and Stop Buttons in the Administration Interface
Starting the Application Server Instance in Debug Mode
Using the start-instance and stop-instance Commands
Using the Windows Services (Windows)
Using the startserv and stopserv Scripts
Setting the Termination Timeout
Restarting an Application Server Instance Automatically (UNIX)
About Restarting Automatically
Restarting an Application Server Instance Manually (UNIX)
Restarting Automatically with /etc/inittab (UNIX)
Restarting Automatically with the System RC Scripts (UNIX)
Restarting the Server Instance Using the Restart Button (UNIX)
About the Watchdog
Restarting the Server Instance Using the restart-instance Command (UNIX)
Restarting the Server Instance Using the restartserv Script (UNIX)
Adding an Application Server Instance
Deleting an Application Server Instance
Applying Changes to an Application Server Instance
Viewing Application Server Instance Status
Configuring JVM Settings
Configuring General Settings
Configuring Logging Setting and Monitoring Settings
Configuring Path Settings
Configuring JVM Options
Configuring the JVM Profiler
Configuring JVM Settings Using the Command-Line Interface
Changing Application Server Instance Advanced Settings
About Logging
Logging on the UNIX and Windows Platform
Default Logging in server.log
Using Log Levels
Example of server.log
Logging Using syslog
Configuring syslog
Logging Using the Windows eventlog
To configure syslog:
Example of syslog messages
About Log Levels
About Virtual Servers and Logging
Log Levels Used for syslog Configuration
About Loggers
About Client Side Logging
Redirecting Application and Server Log Output
Log File Management
Internal-daemon Log Rotation
Configuring Logging Through the Command-line Interface
Scheduler Based Log Rotation
Rotation Using Solaris logadm Utility
Rotation Using Solaris "cron" Utility
About the crontab Entry Format
Using the Solaris cron Utility to Schedule Execution of logadm
Configuring Logging Through the Administration Interface
Configuring the Log Service
Viewing the Access Log File
Configuring Logging for Application Server Components and Subsystems
To Specify a Log Level
Configuring the Directives for Error Logging
To Specify a Log File: (Virtual Server)
To Specify a Transaction Log Location: (Java Transaction Service)
Viewing the Event Log File
Setting Log Preferences
Running the Log Analyzer
Viewing Events (Windows 2000 Pro)
Monitoring the Sun ONE Application Server
About Monitoring the Sun ONE Application Server
Statistics
Extracting Monitoring Data Using the CLI
SNMP
HTTP Server Monitoring
Application Components and Subsystems Monitoring
Monitoring for Container Subsystems
Quality of Service (QOS)
Monitoring for the ORB Service
Monitoring for the Transaction Service
The list --monitor Command
Administering the Transaction Service Using the CLI
The get --monitor Command
CLI Name Mapping
Petstore Example
HTTP Server Monitorable Objects
Monitorable Object Types
Monitorable Attribute Names
Monitorable HTTP Server Elements
Monitorable HTTP Server Attributes
Using HTTP Quality of Service
Quality of Service Example
About SNMP
Configuring Quality of Service (QOS)
Required Changes to the obj.conf File
Known Limitations to Quality of Service
Network Management Station (NMS)
Setting Up SNMP
Management Information Base (MIB) Objects
SNMP Messages
SNMP Trap Destinations
SNMP Agent Community
Using a Proxy SNMP Agent (UNIX/Linux)
Enabling and Starting the SNMP Master Agent
Installing the Proxy SNMP Agent
Installing the SNMP Master Agent
Starting the Proxy SNMP Agent
Restarting the Native SNMP Daemon
Starting the Master Agent on Another Port
Manually Configuring the SNMP Master Agent
Editing the Master Agent CONFIG File
Defining sysContact and sysLocation Variables
Configuring the SNMP Subagent
Starting the SNMP Master Agent
Manually Starting the SNMP Master Agent
Enabling the Subagent
Starting the SNMP Master Agent Using the Admin Server
Configuring the Web Server Plugin
About the Web Server Plugin
Handling Client Requests
HTTP Basics
Web Server Plugin Configuration
Steps in the Request Handling Process
The Web Server Plugin SAF Reference
init-passthrough
Using the Web Server Plugin
auth-passthrough
service-passthrough
check-passthrough
Configuring Microsoft IIS To Use the Web Server Plugin
Configuring the Web Server Plugin for IIS
Configuring IIS to Use the Web Server Plugin
Configuring Multiple Server Pools
Sample sun-passthrough.properties File
About the Web Container
Understanding the Web Container's Role
About the EJB Container
Web Application Configuration
Virtual Server Attributes
Web Application Deployment
Web-module Attributes
Dynamic Re-deployment and Hot Deployment
Single Sign-on Facility
Logging the Web Container
Understanding the EJB Container's Role
Types of Enterprise Java Beans
Configuring the EJB Container
About Message-driven Beans
Performing General Configuration
Configuring EJB Settings
Configuring MDB Pool Settings
What Is a Transaction?
Transactions in J2EE
Transactional Resource Managers
Databases
Local and Distributed Transactions
JMS Providers
J2EE Connectors
Container-Managed Transactions
Transaction Attributes
Bean-Managed Transactions
Required
Setting Transaction Attributes
RequiresNew
Mandatory
NotSupported
Supports
Never
Attribute Summary
Rolling Back a Container-Managed Transaction
Synchronizing a Session Bean's Instance Variables
Methods Not Allowed in Container-Managed Transactions
Transaction Service Administration
Administering Transactions Using the Administration Interface
Administering Transactions Using the Command-Line Interface
Listing In-Flight Transactions
Managing Transactions
Freezing the Transaction Service
Monitoring Transactions
Configuring Naming and Resources
About J2EE Naming Services and Resources
JDBC Datasources
About Java Naming and Directory Interface (JNDI)
Java Mail Sessions
JMS Destinations
JNDI Architecture
About Persistence Manager Resources
J2EE Naming Services
Naming References and Binding Information
Naming References in J2EE Standard Deployment Descriptor
Application Environment Entries
JNDI Connection Factories
EJB References
References to Resource Manager Connection Factories
Resource Environment References
UserTransaction References
Initial Naming Context
COSNaming Service
To Create a Custom Resource
To Create an External JNDI Resource
Accessing External JNDI Repositories
Mapping Application Resource References
About URL Connection Factory Resources
Mapping Application Resource Environment References
Mapping EJB References
What is Persistence?
About JDBC Resources
The Role of the Persistence Manager
Pre-Deployment Bean Configuration
Creating a New Persistence Manager
About the JDBC API
About Java Mail Resources
What Does The JDBC API Do?
About Database Access Models
About JDBC Datasources
Properties Of a DataSource Object
About JDBC Connections
Registering a JDBC Resource
About JDBC URLs
About JDBC Transactions
Configuring JDBC Connection Pools
About Connection Pooling
Monitoring JDBC Connection Pooling
About Connection Sharing
About the JavaMail Message-handling Process
About the Architectural Components of JavaMail
The Message Class
About JavaBeans Activation Framework (JAF)
Message Storage and Retrieval
Message Composition and Transport
About JavaMail Configuration Parameters
J2EE Deployment Descriptor for JavaMail Session References
Entries in Sun ONE Application Server Deployment Descriptor
Creating a New JavaMail Session
Configuring Advanced Resource Properties
About JMS
Basic Messaging System Concepts
The Built-in JMS Service
Message
The JMS Specification
Message Service Architecture
Message Delivery Models
JMS Message Structure
Message-driven Beans
JMS Programming Model
Administered Objects: Provider Independence
About Sun ONE Message Queue (MQ)
Administration of the Built-in JMS Service
MQ Message Server
Integration of MQ with Sun ONE Application Server
MQ Client Runtime
MQ Administered Objects
MQ Administration Tools
Architecture of the Built-in JMS Service
Disabling the Built-in JMS Service
Configuring the JMS Service
Managing Physical Destinations
Create a Queue or Topic Destination
Managing Administered Object Resources
List Physical Destinations
Delete a Physical Destination
Administered Object Attributes
Administering the Built-in JMS Service Using the Command-Line Interface
Administered Object Resource Management Tasks
Configuring the Server For Corba/IIOP Clients
About Support for CORBA/IIOP Clients
About Interoperabillity
Configuring the ORB
About the ORB
About the RMI/IIOP Functionality
About the Authentication Process
To Perform General ORB Configuration
To Configure IIOP Listener For the ORB
About J2EE Modules
About J2EE Applications
J2EE Standard Descriptors
Sun ONE Application Server Descriptors
Naming Standards
Deployment Directory Structure
Runtime Environments
About Classloaders
Module Runtime Environment
Application Runtime Environment
Deploying Modules and Applications
Deployment Names and Errors
The Application Deployment Descriptor Files
The Deployment Life Cycle
Dynamic Deployment
Tools for Deployment
Disabling a Deployed Application or Module
Dynamic Reloading
The asadmin Utility
Deployment of Module or Application
The Administration Interface
Sun ONE Studio
Deploying a WAR Module
Deploying an EJB JAR Module
Deploying a Lifecycle Module
The asadmin Utility
Deploying an RMI/IIOP Client
The Administration Interface
Deploying a J2EE CA Resource Adapter
Deploying Static Content
Access to Shared Frameworks
Managing HTTP Server Features and Virtual Servers
About the HTTP Features
Configuring the File Cache
Tuning Your Server for Performance
Configuring HTTP Quality of Service
Adding and Using Thread Pools
Editing Advanced Settings
Configuring MIME Types
Virtual Servers Overview
HTTP Listeners
Using Sun ONE Application Server Features with Virtual Servers
Virtual Servers
Types of Virtual Servers
The obj.conf File
IP-Address-Based Virtual Servers
URL-Host-Based Virtual Servers
Default Virtual Server
Virtual Server Selection for Request Processing
Document Root
Using SSL with Virtual Servers
Creating and Configuring HTTP Listeners
Using Access Log Files and Server Log Files
Using Access Control with Virtual Servers
Using CGIs with Virtual Servers
Creating an HTTP Listener
Creating and Configuring Virtual Servers
Editing HTTP Listener Settings
Deleting an HTTP Listener
Creating a Virtual Server
Deploying Virtual Servers
Required Settings
Editing Virtual Server Settings
Optional General Settings
Web Application Settings
CGI Settings
HTTP Quality of Service Settings
Editing General Settings Using the Administration Interface
Deleting a Virtual Server
Editing General Settings Using the Command-Line Interface
Editing CGI Settings
Editing Document Handling Settings, Document Directories Settings, and HTTP/HTML Settings
Example 1: Default Configuration
Example 2: Secure Server
Example 3: Intranet Hosting
Example 4: Mass Hosting
Managing Virtual Server Content
Changing the Document Root
Setting Additional Document Directories
Enabling Remote File Manipulation
Using htaccess
Restricting Symbolic Links (UNIX)
Customizing User Public Information Directories (UNIX)
Configuring Public Information Directories
Setting the Document Preferences
Restricting Content Publication
Loading the Entire Password File on Startup
Entering an Index Filename
Customizing Error Responses
Selecting Directory Indexing
Specifying a Server Home Page
Specifying a Default MIME Type
Changing the International Character Set
Setting the Document Footer
Configuring URL Forwarding
Setting up Server-Parsed HTML
Setting Cache Control Directives
Using Stronger Ciphers
Using the Command Line Interface
About the Command Line Interface
About the asadmin Utility
Using asadmin
About Ant Tasks
About Other Command Line Utilities
Understanding the Command Syntax
Security Considerations
Command
Using Singlemode and Multimode
Options
Boolean Options
Operands
Syntax Example
Singlemode
Using Interactive and Non-Interactive Options
Multimode
Multiple Multimode
Using the Environment Commands
Using the Password File Option
Running asadmin Locally or Remotely
Using Command Line Invocations
Using asadmin from the Command Line
Using Escape Characters
Using asadmin with Input from a File (Script)
Using asadmin with Standard Input (Pipe)
Escape Characters on UNIX in Singlemode
Using get and set Commands
Escape Characters on Windows in Singlemode
Escape Characters on All Platforms in Singlemode
Escape Characters on All Platforms in Multimode
get and set Command Examples
Using Help
Getting and Setting Multiple Values Examples
Monitoring Using get and set Commands
Viewing Output and Errors
Viewing the Exit Status
Viewing Usage
Concurrent Access Considerations
Command Reference
List of Commands
List of Dotted Names and Attributes
Dotted Names Used in asadmin
Service Names
Attributes
Resource Names
Application Names
Other Names
jms-service
Long and Short Option Formats, Default Values, and Environment Variable Equivalents
transaction-service
mdb-container
ejb-container
web-container
java-config
orb or iiop-service
orblistener or iiop-listener
log-service
security-service
http-service
jdbc-resource
jndi-resource
jdbc-connection-pool
custom-resource
jms-resource
persistence-manager-factory-resource
mail-resource
application
ejb-module
web-module
connector-module
http-listener or http-server.http-listener
mime
acl
virtual-server
auth-db
authrealm
lifecycle-module
profiler
server configuration (name of server instance)