Contents

List of Examples

List of Tables

Title and Copyright Information

Preface

• Oracle GlassFish Server Documentation Set
• Typographic Conventions
• Symbol Conventions
• Default Paths and File Names
• Documentation, Support, and Training
• Documentation Accessibility

1 High Availability in GlassFish Server

• Overview of High Availability
  • HTTP Load Balancer Plug-in
  • High Availability Session Persistence
  • High Availability Java Message Service
  • RMI-IIOP Load Balancing and Failover
• How GlassFish Server Provides High Availability
  • Storage for Session State Data
  • Highly Available Clusters
    • Clusters, Instances, Sessions, and Load Balancing
    • Protocols for Centralized Cluster Administration
• Recovering from Failures
  • Recovering the Domain Administration Server
  • Recovering GlassFish Server Instances
  • Recovering the HTTP Load Balancer and Web Server
  • Recovering Message Queue
    • Recovering From Power Failure and Failures Other Than Disk Storage
    • Recovering from Failure of Disk Storage
• More Information

2 Enabling Centralized Administration of GlassFish Server Instances

• About Centralized Administration of GlassFish Server Instances
  • Determining Whether to Enable Centralized Administration
  • Considerations for Using DCOM for Centralized Administration
  • Considerations for Using SSH for Centralized Administration
    • Obtaining SSH Software
    • Determining the SSH User
    • Requirements for the SSH User's Environment
    • File Access Permissions on UAC-Enabled Windows Systems
• Setting Up DCOM and Testing the DCOM Set Up
  • Windows Operating System Settings
  • To Enable the Windows User to Run Scripts on a Remote Host
  • To Set Up Password Authentication for the Windows User
  • To Test the Connection Over DCOM to a Remote Host
• Setting Up Cygwin SSH on Windows
  • To Download and Install Cygwin
  • To Set the Path for Windows and for the Cygwin Shell
  • To Set the Home Directory for the Cygwin SSH User
  • To Configure and Start the Cygwin SSH Server Daemon sshd
• Setting Up the MKS Toolkit on Windows
  • To Install the MKS Toolkit
  • To Set the Path for Windows and for the MKS Toolkit Shell
  • To Set the Home Directory for the MKS Toolkit SSH User
  • To Configure and Start the MKS Toolkit SSH Server Daemon sshd
• Setting Up SSH on UNIX and Linux Systems
  • To Set Up SSH on Oracle Solaris Systems
  • To Set Up SSH on MacOS Systems
  • To Set Up SSH on Linux systems
• Testing the SSH Setup on a Host
  • To Test the SSH Setup on a Host
• Setting Up SSH User Authentication
  • To Set Up Public Key Authentication Without Encryption
  • To Set Up Encrypted Public Key Authentication
  • To Set Up Password Authentication
• Installing and Removing GlassFish Server Software on Multiple Hosts
  • To Copy a GlassFish Server Installation to Multiple Hosts
  • To Remove GlassFish Server Software From Multiple Hosts

3 Administering GlassFish Server Nodes

• Types of GlassFish Server Nodes
• Creating, Listing, Testing, and Deleting DCOM Nodes
  • To Create a DCOM Node
  • To List DCOM Nodes in a Domain
  • To Test if a DCOM Node is Reachable
  • To Delete a DCOM Node
• Creating, Listing, Testing, and Deleting SSH Nodes
  • To Create an SSH Node
  • To List SSH Nodes in a Domain
  • To Test if an SSH Node is Reachable
  • To Delete an SSH Node
• Creating, Listing, and Deleting CONFIG Nodes
  • To Create a CONFIG Node
  • To List CONFIG Nodes in a Domain
  • To Delete a CONFIG Node
• Updating and Changing the Type of a Node
  • To Update a DCOM Node
  • To Update an SSH Node
  • To Update a CONFIG Node
  • To Change the Type of a Node

4 Administering GlassFish Server Clusters

• About GlassFish Server Clusters
• Group Management Service
  • Protocols and Transports for GMS
  • GMS Configuration Settings
  • Dotted Names for GMS Settings
  • To Preconfigure Nondefault GMS Configuration Settings
  • To Change GMS Settings After Cluster Creation
  • To Check the Health of Instances in a Cluster
  • To Validate That Multicast Transport Is Available for a Cluster
  • Discovering a Cluster When Multicast Transport Is Unavailable
    • To Discover a Cluster When Multiple Instances in a Cluster are Running on a Host
    • To Discover a Cluster When Each Instance in a Cluster Is Running on a Different Host
  • Using the Multi-Homing Feature With GMS
    • Traffic Separation Using Multi-Homing
• Creating, Listing, and Deleting Clusters
  • To Create a Cluster
  • To List All Clusters in a Domain
  • To Delete a Cluster

5 Administering GlassFish Server Instances

• Types of GlassFish Server Instances
• Administering GlassFish Server Instances Centrally
  • To Create an Instance Centrally
  • To List All Instances in a Domain
  • To Delete an Instance Centrally
  • To Start a Cluster
  • To Stop a Cluster
  • To Start an Individual Instance Centrally
  • To Stop an Individual Instance Centrally
  • To Restart an Individual Instance Centrally
• Administering GlassFish Server Instances Locally
  • To Create an Instance Locally
  • To Delete an Instance Locally
  • To Start an Individual Instance Locally
  • To Stop an Individual Instance Locally
  • To Restart an Individual Instance Locally
• Resynchronizing GlassFish Server Instances and the DAS
  • Default Synchronization for Files and Directories
  • To Resynchronize an Instance and the DAS Online
  • To Resynchronize Library Files
  • To Resynchronize Custom Configuration Files for an Instance
  • To Resynchronize Users' Changes to Files
  • To Resynchronize Additional Configuration Files
  • To Prevent Deletion of Application-Generated Files
  • To Resynchronize an Instance and the DAS Offline
• Migrating EJB Timers
  • To Enable Automatic EJB Timer Migration for Failed Clustered Instances
  • To Migrate EJB Timers Manually

6 Administering Named Configurations

• About Named Configurations
  • Types of Named Configurations
  • The default-config Configuration
  • Automatically Created Configurations
  • Directory for Configuration Synchronization
• Creating, Listing, and Deleting Named Configurations
  • To Create a Named Configuration
  • To List the Named Configurations in a Domain
  • To List the Targets of a Named Configuration
  • To Delete a Named Configuration
• Modifying Properties for Named Configurations and Instances
  • Properties for Port Numbers in a Named Configuration
  • To Modify a Named Configuration's Properties
  • To Modify Port Numbers of an Instance

7 Configuring Web Servers for HTTP Load Balancing

• Supported Operating Systems and Web Servers
• Configuring Oracle iPlanet Web Server
  • To Set up the HTTP Load Balancer in SSL Mode for Oracle iPlanet Web Server 7
• Configuring Apache HTTP Server
  • Configuring Apache Before Installing the GlassFish Loadbalancer Plug-In
    • To Build and Install Apache With SSL Support
    • To Create a Security Certificate for Apache
  • Configuring Apache After Installing the GlassFish Loadbalancer Plug-In
    • Configuring Security Files to Work With the Load Balancer
    • Providing Access Permissions to Apache User
    • Loadbalancer Plug-In Initialization
    • Modifying Directory Access Permissions to Enable Auto Apply
  • Starting Apache on Solaris and Linux
• Configuring Microsoft IIS
  • To Configure SSL for IIS 7.5+
  • Microsoft IIS 7.5+ Post-Install Configuration Steps
    • To Configure Microsoft IIS 7.5+ After Installing the GlassFish Loadbalancer Plug-In
  • Automatically Configured sun-passthrough Properties
• Configuring Oracle HTTP Server
  • To Configure Oracle HTTP Server to Use the Loadbalancer Plug-In
  • To Enable the Load Balancer Auto Apply Feature
• Installing the Loadbalancer Plug-In
  • To Install the Loadbalancer Plug-In
• Verifying Loadbalancer Plug-In Configuration
  • To Verify the Loadbalancer Plug-In Configuration

8 Configuring HTTP Load Balancing

• How the HTTP Load Balancer Works
  • Installing the Loadbalancer Plug-In
  • HTTP Load Balancing Algorithm
  • Features of the GlassFish Loadbalancer Plug-In
    • Auto Apply
    • Weighted Round Robin
    • User-Defined Load Balancing
• Setting Up HTTP Load Balancing
  • Prerequisites for Setting Up HTTP Load Balancing
  • Procedure for Setting Up HTTP Load Balancing
    • To Set Up Load Balancing Using the asadmin Tool
  • HTTP Load Balancer Deployments
    • Using Clustered Server Instances
    • Using Multiple Standalone Instances
• Configuring the HTTP Load Balancer
  • Configuring an HTTP Load Balancer on the DAS
  • Creating an HTTP Load Balancer Reference
  • Enabling Server Instances for HTTP Load Balancing
  • Enabling Applications for HTTP Load Balancing
  • Creating the HTTP Health Checker
    • Creating a Health Checker
    • Additional Health Check Properties for Healthy Instances
  • Changing the HTTP Load Balancer Configuration
    • Exporting the HTTP Load Balancer Configuration File
    • Enabling Dynamic Reconfiguration
  • Disabling (Quiescing) a Server Instance or Cluster
    • To Quiesce a Server Instance or Cluster
  • Disabling (Quiescing) an Application
    • To Quiesce an Application
  • Configuring HTTP and HTTPS Failover
    • HTTPS Routing
    • Configuring HTTPS Routing
    • Known Issues
  • Using Redirects with the HTTP Load Balancer
    • The auth-pass-through-enabled Attribute
    • The proxyHandler Property
    • The rewrite-location Property
  • Configuring Idempotent URLs
• Monitoring the GlassFish Loadbalancer Plug-In
  • Configuring Log Messages
  • Types of Log Messages
    • Load Balancer Configurator Log Messages
    • Request Dispatch and Runtime Log Messages
    • Configurator Error Messages
  • Enabling HTTP Load Balancer Logging
    • To Turn on HTTP Load Balancer Logging
  • Understanding Monitoring Messages

9 Upgrading Applications Without Loss of Availability

• Application Compatibility
• Upgrading In a Single Cluster
  • To Upgrade an Application in a Single Cluster
• Upgrading in Multiple Clusters
  • To Upgrade a Compatible Application in Two or More Clusters
• Upgrading Incompatible Applications
  • To Upgrade an Incompatible Application by Creating a Second Cluster

10 Configuring High Availability Session Persistence and Failover

• Overview of Session Persistence and Failover
  • Requirements
  • Restrictions
  • Scope
• Enabling the High Availability Session Persistence Service
  • To Enable Availability for a Cluster, Standalone Instance or Container
  • Configuring Availability for Individual Web Applications
    • Example
  • Configuring Replication and Multi-Threaded Concurrent Access to HttpSessions
    • Example
  • Using Single Sign-on with Session Failover
    • Single Sign-On Groups
  • Using Coherence*Web for HTTP Session Persistence
• Stateful Session Bean Failover
  • Configuring Availability for the EJB Container
    • Configuring the SFSB Session Store When Availability Is Disabled
  • Configuring Availability for an Individual Application or EJB Module
  • Configuring Availability for an Individual Bean
  • Specifying Methods to Be Checkpointed

11 Configuring Java Message Service High Availability

• Using Message Queue Broker Clusters With GlassFish Server
  • About Message Queue Broker Clusters
  • Configuring GlassFish Clusters to Use Message Queue Broker Clusters
  • To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster With Master Broker
  • To Configure a GlassFish Cluster to Use an Embedded or Local Conventional Broker Cluster of Peer Brokers
  • To Change the Master Broker in an Embedded or Local Broker Cluster
  • To Migrate Between Types of Embedded or Local Conventional Broker Clusters
  • To Configure a GlassFish Cluster to Use a Local Enhanced Broker Cluster
  • To Configure a GlassFish Cluster to Use a Remote Broker Cluster
• Connection Failover
• Load-Balanced Delivery to MDBs

12 RMI-IIOP Load Balancing and Failover

• Overview
  • General Requirements for Configuring Load Balancing
  • Load Balancing Models
• InitialContext Load Balancing
  • InitialContext Summary
  • InitialContext Algorithm
  • Enabling RMI-IIOP Hardware Load Balancing and Failover
    • To Enable RMI-IIOP Hardware Load Balancing for the Application Client Container
• Per-Request Load Balancing (PRLB)
  • PRLB Summary
  • Enabling Per-Request Load Balancing
    • To Enable RMI-IIOP Per-Request Load Balancing for a Stateless EJB