Sun Java logo     Copyright      Index      Next     

Sun logo
Sun Java System Application Server Standard and Enterprise Edition 7 2004Q2 Update 3 Administration Guide 

Contents


List of Figures

List of Tables

About This Guide
Who Should Use This Guide
Using the Documentation
How This Guide Is Organized
Part I: Server Basics and Administering Global Settings
Part II: Managing an Individual Server Instance
Part III: Managing HTTP Server Features and Virtual Servers
Part lV: Configuring Multiple Server Instances
Part V: Appendixes
Product Line Overview
Standard Edition
Enterprise Edition
Documentation Conventions
General Conventions
Conventions Referring to Directories
Contacting Sun
Give Us Feedback
Obtain Training
Contact Product Support

Part I Server Basics and Administering Global Settings

Chapter 1   Getting Started with Sun Java System Application Server Administration
About Sun Java System Application Server
Using the Administration Interface
Accessing the Administration Interface
Using Tabs
Using Buttons
Accessing Online Help
Exiting the Administration Interface
Using the Command-line Interface
Accessing the Administration Server
Accessing Sun Java System Application Server Instances
Using Sun ONE Studio
About Configuration Files
Using the License Commands

Chapter 2   Setting Administration Server Preferences
About the Administration Server
Starting the Administration Server
Starting Using the startserv Script
Starting Using the Command-Line Interface
Starting Using the Services Window (Windows)
Starting Using the Start Menu (Windows)
Shutting Down the Administration Server
Shutting Down Using the Administration Interface
Shutting Down Using the stopserv Script
Shutting Down Using the Command-Line Interface
Shutting Down Using the Services Window (Windows)
Accessing the Administration Server Settings
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

Chapter 3   Configuring Administrative Domains
About Administrative Domains
Implementing Administrative Domains
Directory Structure
Process/Port Structure
Configuring Domains
Creating Domains
Example: creating a domain in the default location
Example: creating a domain somewhere other than the default location
Example: creating a domain for another user (UNIX only)
User Permissions on UNIX Platforms
Deleting Domains
Example: deleting a domain
Listing Domains
Example: listing the domains on a local machine
Example: listing the domains on the local machine using the remote option:
Starting Domains
Example: starting the only domain on a machine:
Stopping Domains
Example: Stopping all instances in a domain except for the admin server instance.
Recreating the Domain Registry

Part II Managing an Individual Server Instance

Chapter 4   Using Sun Java System Application Server Instances
About Sun Java System Application Server Instances
Starting and Stopping an Application Server Instance
Using the Start and Stop Buttons in the Administration Interface
Using the start-instance and stop-instance Commands
Using the Windows Services (Windows)
Using the startserv and stopserv Scripts
Starting the Application Server Instance in Debug Mode
Setting the Termination Timeout
Restarting an Application Server Instance Automatically (UNIX)
About Restarting Automatically
Restarting Automatically with /etc/inittab (UNIX)
Restarting Automatically with the System RC Scripts (UNIX)
Restarting an Application Server Instance Manually (UNIX)
Restarting the Server Instance Using the Restart Button (UNIX)
Restarting the Server Instance Using the restart-instance Command (UNIX)
Restarting the Server Instance Using the restartserv Script (UNIX)
About the Watchdog
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 Path Settings
Configuring JVM Options
Configuring the JVM Profiler
Configuring JVM Settings Using the Command-Line Interface
Configuring Logging Setting and Monitoring Settings
Changing Application Server Instance Advanced Settings

Chapter 5   Using Logging
About Logging
Logging on the UNIX and Windows Platform
Default Logging in server.log
Example of server.log
Changing Default Log File Location
Logging Using syslog
Configuring syslog
To configure syslog:
Example of syslog messages
Logging Using the Windows eventlog
Using Log Levels
About Log Levels
Log Levels Used for syslog Configuration
About Virtual Servers and Logging
About Loggers
About Client Side Logging
Redirecting Application and Server Log Output
Log File Management
Internal-daemon Log Rotation
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 Command-line Interface
Configuring Logging Through the Administration Interface
Configuring the Log Service
Configuring Logging for Application Server Components and Subsystems
To Specify a Log Level
To Specify a Log File: (Virtual Server)
To Specify a Transaction Log Location: (Java Transaction Service)
Configuring the Directives for Error Logging
Viewing the Access Log File
Viewing the Event Log File
Setting Log Preferences
Running the Log Analyzer
Viewing Events (Windows)

Chapter 6   Monitoring Sun Java System Application Server
About Monitoring Sun Java System Application Server
Statistics
SNMP
HTTP Server Monitoring
Application Components and Subsystems Monitoring
Monitoring for Container Subsystems
Monitoring for the ORB Service
Monitoring for the Transaction Service
Administration Server Security Auditing
Configuring Administration Server to Use LDAP
Setting Up Audit Services Configuration Files
Audit Configuration Settings
Viewing Security Audit Output
Viewing Security Audit Logs on Non-Solaris 9 Platforms
Viewing Security Audit Logs Using BSM Auditing on Solaris
Quality of Service (QOS)
Extracting Monitoring Data Using the CLI
list --monitor Command
get --monitor Command
CLI Name Mapping
Petstore Example
Monitorable Object Types
Monitorable Attribute Names
HTTP Server Monitorable Objects
Monitorable HTTP Server Elements
Monitorable HTTP Server Attributes
Administering the Transaction Service Using the CLI
Using HTTP Quality of Service
Quality of Service Example
Configuring Quality of Service (QOS)
Required Changes to the obj.conf File
Known Limitations to Quality of Service
About SNMP
Network Management Station (NMS)
Management Information Base (MIB) Objects
SNMP Messages
SNMP Trap Destinations
SNMP Agent Community
Setting Up SNMP
Using a Proxy SNMP Agent
Installing the Proxy SNMP Agent
Starting the Proxy SNMP Agent
Restarting the Native SNMP Daemon
Installing the SNMP Master Agent
Enabling and Starting the SNMP Master Agent
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
Starting the SNMP Master Agent Using the Admin Server
Enabling the Subagent

Chapter 7   Configuring J2EE Containers
About the Web Container
Understanding the Web Container’s Role
Web Application Configuration
Virtual Server Attributes
Web-module Attributes
Web Application Deployment
Dynamic Re-deployment and Hot Deployment
Single Sign-on Facility
Logging the Web Container
Configuring Availability in the Web Container (Enterprise Edition)
About the EJB Container
Understanding the EJB Container’s Role
Types of Enterprise Java Beans
About Message-driven Beans
Configuring the EJB Container
Performing General EJB Container Configuration
Configuring EJB Settings
Configuring MDB Pool Settings
Configuring Availability in the EJB Container (Enterprise Edition)

Chapter 8   Using Transaction Services
What Is a Transaction?
Transactions in J2EE
Transactional Resource Managers
Databases
JMS Providers
J2EE Connectors
Local and Distributed Transactions
Container-Managed Transactions
Transaction Attributes
Required
RequiresNew
Mandatory
NotSupported
Supports
Never
Attribute Summary
Setting Transaction Attributes
Rolling Back a Container-Managed Transaction
Synchronizing a Session Bean’s Instance Variables
Methods Not Allowed in Container-Managed Transactions
Bean-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

Chapter 9   Configuring Naming and Resources
About J2EE Naming Services and Resources
JDBC Datasources
Java Mail Sessions
JMS Destinations
About Java Naming and Directory Interface (JNDI)
JNDI Architecture
J2EE Naming Services
Naming References and Binding Information
Naming References in J2EE Standard Deployment Descriptor
Application Environment Entries
EJB References
References to Resource Manager Connection Factories
Resource Environment References
UserTransaction References
Initial Naming Context
COSNaming Service
JNDI Connection Factories
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
About Persistence Manager Resources
What is Persistence?
Role of the Persistence Manager
Pre-Deployment Bean Configuration
Creating a New Persistence Manager
About JDBC Resources
About the JDBC API
What Does The JDBC API Do?
About Database Access Models
About JDBC Datasources
Properties Of a DataSource Object
Registering a JDBC Resource
About JDBC Connections
About JDBC URLs
Configuring JDBC Connection Pools
About Connection Pooling
Monitoring JDBC Connection Pooling
About Connection Sharing
About JDBC Transactions
About Java Mail Resources
About the JavaMail Message-handling Process
About the Architectural Components of JavaMail
Message Class
Message Storage and Retrieval
Message Composition and Transport
About JavaBeans Activation Framework (JAF)
About JavaMail Configuration Parameters
J2EE Deployment Descriptor for JavaMail Session References
Entries in Application Server Deployment Descriptor
Creating a New JavaMail Session
Configuring Advanced Resource Properties

Chapter 10   Using the JMS Service
About JMS
Basic Messaging System Concepts
Message
Message Service Architecture
Message Delivery Models
JMS Specification
JMS Message Structure
JMS Programming Model
Administered Objects: Provider Independence
Message-driven Beans
Built-in JMS Service
About Sun Java System Message Queue
Components of an MQ Messaging System
MQ Message Server
MQ Client Runtime
MQ Administered Objects
MQ Administration Tools
Integration of MQ with Sun Java System Application Server
Architecture of the Built-in JMS Service
Disabling the Built-in JMS Service
Administration of the Built-in JMS Service
Configuring the JMS Service
Managing Physical Destinations
Create a Physical Destination
List Physical Destinations
Delete a Physical Destination
Managing Administered Object Resources
Administered Object Attributes
Administered Object Resource Management Tasks
Viewing the JMS Log
Administering the Built-in JMS Service Using the Command-Line Interface

Chapter 11   Configuring the Server For Corba/IIOP Clients
About Support for CORBA/IIOP Clients
About Interoperabillity
About the ORB
About the RMI/IIOP Functionality
About the Authentication Process
Configuring the ORB
To Perform General ORB Configuration
To Configure IIOP Listener For the ORB

Chapter 12   Configuring the Web Server Plug-in
About the Web Server Plug-in
Handling Client Requests
HTTP Basics
Steps in the Request Handling Process
Web Server Plug-in Configuration
Web Server Plug-in SAF Reference
init-passthrough
auth-passthrough
service-passthrough
check-passthrough
Using The Web Server Plug-in
Configuring Sun Java System Web Server
Changes to Sun Java System Web Server
Changes to Sun Java System Application Server
Configuring Application Server as a Proxy
Configuring Microsoft IIS
Configuring the Web Server Plug-in for IIS
Configuring IIS to Use the Web Server Plug-in
Configuring Multiple Server Pools
Sample sun-passthrough.properties File
Configuring Apache Web Server
Minimum Requirements
Compiling Apache With mod_proxy Module
Modifying the httpd.conf File
Starting And Stopping Apache

Chapter 13   Deploying Applications
About J2EE Modules
About J2EE Applications
J2EE Standard Descriptors
Application Server Descriptors
Naming Standards
Deployment Directory Structure
Runtime Environments
Module Runtime Environment
Application Runtime Environment
About Classloaders
Deploying Modules and Applications
Deployment Names and Errors
The Deployment Life Cycle
Dynamic Deployment
Disabling a Deployed Application or Module
Dynamic Reloading
Using Availability Features (Enterprise Edition)
Tools for Deployment
The asadmin Utility
The Administration Interface
Sun ONE Studio
Deploying a Module or Application
Deploying a WAR Module
Deploying an EJB JAR Module
Deploying a Lifecycle Module
The asadmin Utility
The Administration Interface
Deploying an RMI/IIOP Client
Deploying a J2EE CA Resource Adapter
Deploying Static Content
Access to Shared Frameworks
The Application Deployment Descriptor Files

Part III Managing HTTP Server Features and Virtual Servers

Chapter 14   Configuring HTTP Features
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

Chapter 15   Using Virtual Servers
Virtual Servers Overview
HTTP Listeners
Virtual Servers
Types of Virtual Servers
IP-Address-Based Virtual Servers
URL-Host-Based Virtual Servers
Default Virtual Server
obj.conf File
Virtual Server Selection for Request Processing
Document Root
Using Sun Java System Application Server Features with Virtual Servers
Using SSL with Virtual Servers
Using Access Log Files and Server Log Files
Using Access Control with Virtual Servers
Using CGIs with Virtual Servers
Creating and Configuring HTTP Listeners
Creating an HTTP Listener
Editing HTTP Listener Settings
Deleting an HTTP Listener
Creating and Configuring Virtual Servers
Creating a Virtual Server
Required Settings
Optional General Settings
Web Application Settings
CGI Settings
HTTP Quality of Service Settings
Editing Virtual Server Settings
Editing General Settings Using the Administration Interface
Editing General Settings Using the Command-Line Interface
Editing CGI Settings
Editing Document Handling Settings, Document Directories Settings, and HTTP/HTML Settings
Deleting a Virtual Server
Deploying Virtual Servers
Example 1: Default Configuration
Example 2: Secure Server
Example 3: Intranet Hosting
Example 4: Mass Hosting

Chapter 16   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
Restricting Content Publication
Loading the Entire Password File on Startup
Setting the Document Preferences
Entering an Index Filename
Selecting Directory Indexing
Specifying a Server Home Page
Specifying a Default MIME Type
Customizing Error Responses
Changing the International Character Set
Setting the Document Footer
Configuring URL Forwarding
Setting up Server-Parsed HTML
Setting Cache Control Directives
Using Stronger Ciphers

Part IV Configuring Multiple Server Instances

Chapter 17   Configuring HTTP Load Balancing and Failover (Enterprise Edition)
About Load Balancing and Failover
Requirements for Load Balancing
Using Third Party Load Balancers
Understanding Assigned Requests and Unassigned Requests
HTTP Load Balancing Algorithm
About Sticky Round Robin Load Balancing Algorithm
Configuring HTTP Load Balancing and Failover
Configuration Changes to Web Servers
Modifications to Sun Java System Web Server
Modifications to Apache Web Server
Modifications to Microsoft IIS
Creating Load Balancer Configuration File
Configuring Multiple Web Server Instances
Configuring Multiple Sun Java System Web Server Instances
Configuring Multiple Apache Web Server Instances
Administering HTTP Load Balancing and Failover
Enabling/Disabling Application Server Instances
Restarting Application Server Instances
Enabling Dynamic Reconfiguration
Configuring HTTP/S Session Failover
About HTTPS Routing
Configuring HTTPS Routing
Configuring Response Timeout
Configuring Quiescence
Quiescing an Instance
Quiescing an Application
Configuring The Health-Checker
Configuring Idempotent URL Requests
Specifying an Idempotent URL
Characteristics of an Idempotent URL
Configuring HTML Error Pages
Rules Applicable for Displaying Error Pages
Monitoring the Load Balancer Plug-in
Configuring Log Messages
Types of Log Messages
Configurator Error Messages
Configuring Monitoring
Understanding Monitoring Messages
Known Issues in Load Balancing Requests

Chapter 18   Configuring RMI/IIOP Load Balancing and Failover (Enterprise Edition)
About RMI/IIOP Load Balancing and Failover
Requirements for Load Balancing and Failover
About RMI/IIOP Load Balancing and Failover Algorithm
Initial Context Based Failover Algorithm
Configuring RMI/IIOP Failover
Using Admin Console to Configure RMI/IIOP Load Balancing
Using CLI to Configure RMI/IIOP Load Balancing
Sample server.xml Configuration
Sample availability-service Configuration in server.xml

Chapter 19   Managing Clusters (Enterprise Edition)
About Application Server Clusters
Defining a Cluster
Requirements for Adding an Application Server Instance to a Cluster
Adding Application Server Instances to a Cluster
Defining Multiple Clusters
Administering Application Server Clusters
Starting a Cluster
Deploying a Web Application
Undeploying a Web Application
Redeploying an Existing Web Application on a Cluster
Stopping an Application Server Instance in a Cluster
Removing an Application Server Instance from a Cluster
Stopping a Cluster
Removing a Cluster
Sample Cluster Configuration in a loadbalancer.xml File
Online Reconfiguration of HTTP Clusters
Disabling and Quiescing an Application Server Instance in a Cluster
Disabling and Quiescing a Web Application in a Cluster
Modifying the Quiescing Period While Quiescing is On
Using Multiple Clusters for Online Upgrades Without Loss of Service
Reconfiguring an Application Server Instance in a Running Cluster
Using Multiple Load Balancers

Chapter 20   Configuring Session Persistence (Enterprise Edition)
About Session Persistence
Basic Session Persistence Configuration Steps
Setting Up Availability
Configuring JDBC Parameters for the HADB Database
Referencing the HADB Database’s JDBC Resource
Creating the Session Store
Clearing the Session Store
Before You Clear the Session Store
Using the asadmin clear-session-store Command
After You Clear the Session Store
Managing the Session Store for Clusters
Enabling and Disabling Availability
Server Instance and Container Levels
Application and Module Levels
The SFSB Level
Failover of J2EE Object References Stored in Sessions
Configuring SFSB Session Persistence
How SFSB Session Persistence Works When Availability Is Enabled
Setting the SFSB Session Store When Availability is Disabled
Configuring HTTP Session Persistence
Making a Web Application Distributable
Availability of Single Sign-on in the HTTP Session State
Session Availability for Applications Belonging to a Single Sign-On Group
Setting the Session Timeout
HTTP Session Persistence Options
About the asadmin configure-session-persistence Command
Using the cladmin Command to Configure Session Persistence for an Entire Cluster
Setting the Persistence Type
Comparison of Persistence Type Options
Setting the Persistence Frequency
Comparison of Persistence Frequency Options
Setting the Persistence Scope
Comparison of Persistence Scope Options
Configuring Other HTTP Session Persistence Properties
Overriding HTTP Session Persistence Settings

Chapter 21   Administering the High-Availability Database (Enterprise Edition)
About the High-Availability Database
Prerequisites
Starting Management Agents
This section contains the following topics:
ma Command Syntax
Starting the Management Agent on Solaris and Linux
Starting the Management Agent on Windows
Management Agent configuration File Entries
Management Agent Options
Management Agent Operands
Using the hadbm Command
Configuring the HADB
Creating Management Domains
Example for Creating an HADB Management Domain
Registering and Unregistering HADB Packages
Registering HADB Packages
Unregistering HADB Packages
Creating a Database
Setting Heterogeneous Device Paths
Configuring Double Networks
Setting Up the JDBC Connection Pool
Getting the JDBC URL
Creating a Connection Pool
Connection Pool Example
Creating a JDBC Resource
Managing the HADB
Starting a Node
Stopping a Node
Restarting a Node
Starting the HADB
Stopping the HADB
Restarting the HADB
Listing Databases
Clearing the HADB
Removing a Database
Expanding the HADB
Adding Storage Space to Existing Nodes
Adding Machines
Adding Nodes to the HADB
Refragmenting the HADB
Adding Nodes by Recreating the Database
Monitoring the HADB
Getting the Status of the HADB
Database Status
Node Status
Getting Device Information
Getting HADB Runtime Resource Usage Information
Data Buffer Pool
Locks
Log Buffer
Node Internal Log Device
Maintaining the HADB Machines
Maintaining HADB on a Single Machine
Viewing and Modifying Configuration Attributes
Getting the Values of Configuration Attributes
Setting the Values of Configuration Attributes
Configuration Attributes
Clearing and Archiving History Files
Recovering from Session Data Corruption
hadbm Environment Variables
Changes Between HADB 4.3 and 4.4
General Improvements
Specific Changes
Using Sun Customer Support for the HADB

Part V Appendixes

Appendix A   Using the Command Line Interface
About the Command Line Interface
About the asadmin Utility
About Ant Tasks
About Other Command Line Utilities
Using asadmin
Understanding the Command Syntax
Command
Options
Boolean Options
Operands
Syntax Example
Using Singlemode and Multimode
Singlemode
Multimode
Multiple Multimode
Using Interactive and Non-Interactive Options
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 asadmin with Input from a File (Script)
Using asadmin with Standard Input (Pipe)
Using Escape Characters
Escape Characters on UNIX in Singlemode
Escape Characters on Windows in Singlemode
Escape Characters on All Platforms in Singlemode
Escape Characters on All Platforms in Multimode
Using get and set Commands
get and set Command Examples
Getting and Setting Multiple Values Examples
Monitoring Using get and set Commands
Using Help
Viewing Output and Errors
Viewing the Exit Status
Viewing Usage
Security Considerations
Concurrent Access Considerations
Command Reference
List of Commands
List of Dotted Names and Attributes
Dotted Names Used in asadmin
Service Names
Resource Names
Application Names
Other Names
Attributes
jms-service
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)
Long and Short Option Formats, Default Values, and Environment Variable Equivalents

Appendix B   Failover Scenarios (Enterprise Edition)
HTTP Session Failover
Assumptions and Requirements
Persistence Type Set to memory for Application Server Instances in Cluster
Persistence Type Set to memory for an Application Server Instance
Persistence Type Set to file for an Application Server Instance
Persistence Type Set to ha for Application Server Instances in a Cluster
Persistence Type Set to memory for a Web Application
Persistence Type Set to file for a Web Application
Persistence Type Set to ha for a Web Application
Stateful Session Bean Failover
Assumptions and Requirements
SFSB State Stored in the File System
SFSB State Stored in the HADB
Failover on RMI/IIOP Path
Assumptions and Requirements
RMI/IIOP Failover Scenario

Appendix C   Compiling and Configuring Apache Web Server (Enterprise Edition)
Minimum Requirements
Minimum Requirements for Apache 1.3
Minimum Requirements for Apache 2
Requirements Common to Apache 1.3 and 2
Installing SSL-aware Apache
Compiling and Building Open SSL
Configuring Apache with mod SSL
Compiling and Building Apache
Starting and Stopping Apache

Appendix D   Running Message Queue Broker with Trial Enterprise License
About Enterprise Edition
Running Message Queue Broker with Trial License of Enterprise Edition
Purchasing the Enterprise Edition License

Appendix E   HTTP Load Balancer Configuration File
sun-loadbalancer_1_1.dtd File
Subelements
Data
Attributes
Elements in the loadbalancer.xml File

Appendix F   Using the cladmin Command for Administration (Enterprise Edition)
About the cladmin Command
Cluster Operations Using cladmin Command
asadmin Commands Supported by cladmin
Requirements for Running the cladmin Command
Using cladmin Command
Input Files for the cladmin Command
clinstance.conf File
clpassword.conf File
Running the cladmin Command
cladmin Status Messages
Log file for the cladmin Command
Limitations of cladmin Command

Glossary

Index


Copyright      Index      Next     

Copyright 2005 Sun Microsystems, Inc. All rights reserved.