Contents

List of Examples

List of Figures

List of Tables

Title and Copyright Information

Preface

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

1 Overview of GlassFish Server Administration

• Default Settings and Locations
• Configuration Tasks
  • Initial Configuration Tasks
  • How Dotted Names Work for Configuration
  • Configuration Files
  • Impact of Configuration Changes
    • To Determine Whether the DAS or an Instance Requires Restart
    • Configuration Changes That Require Restart
    • Dynamic Configuration Changes
    • Changes That Affect Applications
• Administration Tools
  • Administration Console
  • asadmin Utility
  • REST Interfaces
  • Update Tool
  • OSGi Module Management Subsystem
    • To Enable the Apache Felix Gogo Remote Shell
    • To Start the Apache Felix Gogo Remote Shell
    • To Download and Install the GlassFish OSGi Web Console
    • To Access the GlassFish OSGi Web Console Through the GlassFish Server Administration Console
    • To Access the GlassFish OSGi Web Console as a Standalone Web Application
  • keytool Utility
  • Java Monitoring and Management Console (JConsole)
• Instructions for Administering GlassFish Server

Part I Runtime Administration

2 General Administration

• Using the asadmin Utility
  • Path to the asadmin Utility
  • asadmin Utility Syntax
    • Subcommands of the asadmin Utility
    • asadmin Utility Options and Subcommand Options
    • Operands of asadmin Utility Subcommands
  • To Run an asadmin Utility Subcommand in Single Mode
  • To Display Help Information for the asadmin Utility or a Subcommand
  • To Start a Multimode Session
  • To End a Multimode Session
  • To Run a Set of asadmin Subcommands From a File
• Administering System Properties
  • To Create System Properties
  • To List System Properties
  • To Delete a System Property
• Administering Resources
  • To Add Resources From an XML File
• Listing Various System Elements
  • To Display the GlassFish Server Version
  • To List Applications
  • To List Containers
  • To List Modules
  • To List Subcommands
  • To List Timers
  • To Show Component Status
• Using REST Interfaces to Administer GlassFish Server
  • Using REST URLs to Administer GlassFish Server
    • REST URLs to Resources for Configuration and Monitoring Objects
    • REST URLs for Accessing the Log File
  • Using REST Resource Methods to Administer GlassFish Server
    • To Determine the Methods and Method Parameters That an Object in the Tree Supports
    • To Retrieve Data for an Object in the Tree
    • To Add an Object to the Tree
    • To Update an Object in the Tree
    • To Delete an Object From the Tree
  • Resources for asadmin Subcommands That Perform Non-CRUD Operations
  • Securing GlassFish Server REST Interfaces
    • Setting Up Basic Authentication Over a Secure Connection
    • To Secure REST Interfaces by Using Session Tokens
  • Formats for Resource Representation of Configuration Objects
    • JSON Resource Representation for Configuration Objects
    • XML Resource Representation for Configuration Objects
    • HTML Resource Representation for Configuration Objects
  • Formats for Resource Representation of Monitoring Objects
    • JSON Resource Representation for Monitoring Objects
    • XML Resource Representation for Monitoring Objects
    • HTML Resource Representation for Monitoring Objects
  • Formats for Resource Representation of Log File Details
    • JSON Resource Representation for Log File Details
    • XML Resource Representation for Log File Details
  • Supported Content Types in Requests to REST Resources

3 Administering Domains

• About Administering Domains
  • GlassFish Server Instances
  • Domains for Administering GlassFish Server
  • Domain Administration Server (DAS)
• Creating, Logging In To, and Deleting a Domain
  • To Create a Domain
  • To Create a Domain From a Custom Template
  • To List Domains
  • To Log In to a Domain
  • To Delete a Domain
• Starting and Stopping a Domain
  • To Start a Domain
  • To Stop a Domain
  • To Restart a Domain
• Configuring a DAS or a GlassFish Server Instance for Automatic Restart
  • To Configure a DAS or an Instance for Automatic Restart on Windows
  • To Configure a DAS or an Instance for Automatic Restart on Linux
  • To Configure a DAS or an Instance for Automatic Restart on Oracle Solaris
  • To Prevent Service Shutdown When a User Logs Out on Windows
• Suspending and Resuming a Domain
  • To Suspend a Domain
  • To Resume a Domain
• Setting Up Automatic Backups of a Domain
  • To Create a Backup Configuration
  • To List Backup Configurations
  • To Enable a Backup Configuration
  • To Disable a Backup Configuration
  • To Delete a Backup Configuration
  • To Create a Schedule
  • To List Schedules
  • To Delete a Schedule
• Backing Up and Restoring a Domain
  • To Back Up a Domain
  • To Restore a Domain
  • To List Domain Backups
• Re-Creating the Domain Administration Server (DAS)
  • To Migrate the DAS
• Additional Domain Tasks
  • To Display Domain Uptime
  • To Switch a Domain to Another Supported Java Version
  • To Change the Administration Port of a Domain

4 Administering the Virtual Machine for the Java Platform

• Administering JVM Options
  • To Create JVM Options
  • To List JVM Options
  • To Delete JVM Options
  • To Generate a JVM Report
• Administering the Profiler
  • To Create a Profiler
  • To Delete a Profiler

5 Administering Thread Pools

• About Thread Pools
• Configuring Thread Pools
  • To Create a Thread Pool
  • To List Thread Pools
  • To Update a Thread Pool
  • To Delete a Thread Pool

6 Administering Web Applications

• Invoking a Servlet by Alternate Means
• Changing Log Output for a Servlet
• Defining Global Features for Web Applications
  • To Use the default-web.xml File
• Redirecting a URL
• Administering mod_jk
  • To Enable mod_jk
  • To Load Balance Using mod_jk and GlassFish Server
  • To Enable SSL Between the mod_jk Load Balancer and the Browser
  • To Enable SSL Between the mod_jk Load Balancer and GlassFish Server
• Administering mod_proxy_ajp
  • To Enable mod_proxy_ajp
  • To Load Balance Using mod_proxy_ajp and GlassFish Server

7 Administering the Logging Service

• About Logging
  • Log Files
    • Log File Names and Locations
    • Log Records
    • Log Rotation
  • Logger Namespaces
  • Logging Targets
  • Logging Properties
• Configuring the Logging Service
  • Changing the Name and Location of Logging Service Files
    • To Change the Name and Location of the Log File
    • To Change the Name and Location of the Logging Properties File
  • Setting Log Levels
    • To List Log Levels
    • To Set the Global Log Level
    • To Set Module Log Levels
  • Setting Log File Rotation
    • To Change the Rotation File Size
    • To Change the File Rotation Interval
    • To Change the Limit Number of Retained Files
    • To Rotate Log Files Manually
  • Adding a Custom Logging Handler
    • To Add a Custom Log Handler
• Viewing Log Records
  • To Collect Log Files into a ZIP Archive

8 Administering the Monitoring Service

• About Monitoring
  • How the Monitoring Tree Structure Works
    • Tree Structure of Monitorable Objects
  • About Monitoring for Add-on Components
  • Tools for Monitoring GlassFish Server
• Configuring Monitoring
  • To Enable Monitoring
  • To Disable Monitoring
• Viewing Common Monitoring Data
  • To View Common Monitoring Data
  • Common Monitoring Statistics
    • HTTP Listener Common Statistics
    • JVM Common Statistics
    • Web Module Common Statistics
• Viewing Comprehensive Monitoring Data
  • Guidelines for Using the list and get Subcommands for Monitoring
  • To View Comprehensive Monitoring Data
  • Comprehensive Monitoring Statistics
    • EJB Statistics
    • HTTP Service Statistics
    • Jersey Statistics
    • JMS/Connector Service Statistics
    • JVM Statistics
    • Network Statistics
    • ORB Statistics (Connection Manager)
    • Resource Statistics (Connection Pool)
    • Security Statistics
    • Thread Pool Statistics
    • Transaction Service Statistics
    • Web Statistics
• Configuring JConsole to View GlassFish Server Monitoring Data
  • To Connect JConsole to GlassFish Server

9 Writing and Running JavaScript Clients to Monitor GlassFish Server

• Running a Script for Monitoring GlassFish Server
  • To Run a Script for Monitoring GlassFish Server
• Writing Scripts in the JavaScript Language for Monitoring GlassFish Server
  • Obtaining Information About Events That Provide Monitoring Data
    • To Obtain a List of Events That Provide Monitoring Data
    • To Obtain Detailed Information About an Event That Provides Monitoring Data
  • To Register a Script as a Listener for an Event
  • To Display Information From a Script
  • Writing an Event Callback Function
    • To Generate Counter Statistics
    • To Generate a Timer Statistic
• Sample JavaScript Programs for Monitoring GlassFish Server
• JavaScript Monitoring Client API Reference
  • Object client
    • Method Summary
    • Method Detail
  • Object scriptContainer
    • Method Summary
    • Method Detail

10 Administering Life Cycle Modules

• About Life Cycle Modules
• Configuring Life Cycle Modules
  • To Create a Life Cycle Module
  • To List Life Cycle Modules
  • To Update a Life Cycle Module
  • To Delete a Life Cycle Module

11 Extending and Updating GlassFish Server

• About Add-On Components
• Preconfigured Repositories for GlassFish Server
  • Oracle GlassFish Server Repositories
    • Enabling the Oracle GlassFish Server Support Repository
  • GlassFish Server Open Source Edition Repositories
• Tools for Extending and Updating GlassFish Server
  • Update Tool
  • The pkg Command
  • Administration Console
• Adding Components
  • To Install an Add-on Component
• Updating Installed Components
  • To Update an Installed Component
  • To Update All Installed Components in an Image
• Removing Installed Components
  • To Uninstall an Installed Component
  • To Uninstall and Revert to an Older Version of a Component
• Upgrading to Oracle GlassFish Server From GlassFish Server Open Source Edition
  • To Upgrade to Oracle GlassFish Server by Using Update Tool
  • To Upgrade to Oracle GlassFish Server by Using the pkg Command
• Extending and Updating GlassFish Server Inside a Closed Network
  • To Install the Pre-Installed Toolkit Image Inside a Closed Network
  • To Configure a Local Repository Server Inside a Closed Network
  • To Configure a GlassFish Server Installation to Use a Local Repository Server Inside a Closed Network
  • To Install Updates From a Local Repository

Part II Resources and Services Administration

12 Administering Database Connectivity

• About Database Connectivity
• Setting Up the Database
  • To Install the Database and Database Driver
  • To Start the Database
  • To Stop the Database
  • Java DB Utility Scripts
    • To Configure Your Environment to Run Java DB Utility Scripts
• Configuring Access to the Database
  • Administering JDBC Connection Pools
    • To Create a JDBC Connection Pool
    • To List JDBC Connection Pools
    • To Contact (Ping) a Connection Pool
    • To Reset (Flush) a Connection Pool
    • To Update a JDBC Connection Pool
    • To Delete a JDBC Connection Pool
    • Configuring Specific JDBC Connection Pool Features
  • Administering JDBC Resources
    • To Create a JDBC Resource
    • To List JDBC Resources
    • To Update a JDBC Resource
    • To Delete a JDBC Resource
  • Enabling the jdbc/__default Resource in a Clustered Environment
    • To Enable the jdbc/__default Resource for a Clustered Environment
  • Integrating the JDBC Driver
    • Supported Database Drivers
    • Making the JDBC Driver JAR Files Accessible
    • Automatic Detection of Installed Drivers
• Configuration Specifics for JDBC Drivers
  • IBM DB2 Database Type 2 Driver
  • IBM DB2 Database Type 4 Driver
  • Java DB/Derby Type 4 Driver
  • MySQL Server Database Type 4 Driver
  • Oracle 10 Database Driver
  • Oracle 11 Database Driver
  • PostgreSQL Type 4 Driver
  • DataDirect Type 4 Driver for IBM DB2 Database
  • DataDirect Type 4 Driver for IBM Informix
  • DataDirect Type 4 Driver for Microsoft SQL Server Database
  • DataDirect Type 4 Driver for MySQL Server Database
  • DataDirect Type 4 Driver for Oracle 11 Database
  • DataDirect Type 4 Driver for Sybase Database
  • Inet Oraxo Driver for Oracle Database
  • Inet Merlia Driver for Microsoft SQL Server Database
  • Inet Sybelux Driver for Sybase Database
  • JConnect Type 4 Driver for Sybase ASE 12.5 Database

13 Administering EIS Connectivity

• About EIS Connectivity
• Administering Connector Connection Pools
  • To Create a Connector Connection Pool
  • To List Connector Connection Pools
  • To Connect to (Ping) or Reset (Flush) a Connector Connection Pool
  • To Update a Connector Connection Pool
  • To Delete a Connector Connection Pool
• Administering Connector Resources
  • To Create a Connector Resource
  • To List Connector Resources
  • To Update a Connector Resource
  • To Delete a Connector Resource
• Administering the Resource Adapter Configuration
  • To Create Configuration Information for a Resource Adapter
  • To List Resource Adapter Configurations
  • To Update a Resource Adapter Configuration
  • To Delete a Resource Adapter Configuration
• Administering Connector Security Maps
  • To Create a Connector Security Map
  • To List Connector Security Maps
  • To Update a Connector Security Map
  • To Delete a Connector Security Map
• Administering Connector Work Security Maps
  • To Create a Connector Work Security Map
  • To List Connector Work Security Maps
  • To Update a Connector Work Security Map
  • To Delete a Connector Work Security Map
• Administering Administered Objects
  • To Create an Administered Object
  • To List Administered Objects
  • To Update an Administered Object
  • To Delete an Administered Object

14 Administering Internet Connectivity

• About Internet Connectivity
  • About HTTP Network Listeners
  • About Virtual Servers
• Administering HTTP Network Listeners
  • To Create an Internet Connection
  • Administering HTTP Protocols
    • To Create a Protocol
    • To List Protocols
    • To Delete a Protocol
  • Administering HTTP Configurations
    • To Create an HTTP Configuration
    • To Delete an HTTP Configuration
  • Administering HTTP Transports
    • To Create a Transport
    • To List Transports
    • To Delete a Transport
  • Administering HTTP Network Listeners
    • To Create an HTTP Network Listener
    • To List HTTP Network Listeners
    • To Update an HTTP Network Listener
    • To Delete an HTTP Network Listener
    • To Configure an HTTP Listener for SSL
    • To Configure Optional Client Authentication for SSL
    • To Configure a Custom SSL Implementation
    • To Delete SSL From an HTTP Listener
    • To Assign a Default Virtual Server to an HTTP Listener
• Administering Virtual Servers
  • To Create a Virtual Server
  • To List Virtual Servers
  • To Update a Virtual Server
  • To Delete a Virtual Server
  • To Assign a Default Web Module to a Virtual Server
  • To Assign a Virtual Server to an Application or Module
  • To Set JSESSIONIDSSO Cookie Attributes

15 Administering the Object Request Broker (ORB)

• About the ORB
• Configuring the ORB
• Administering IIOP Listeners
  • To Create an IIOP Listener
  • To List IIOP Listeners
  • To Update an IIOP Listener
  • To Delete an IIOP Listener

16 Administering the JavaMail Service

• About JavaMail
• Administering JavaMail Resources
  • To Create a JavaMail Resource
  • To List JavaMail Resources
  • To Update a JavaMail Resource
  • To Delete a JavaMail Resource

17 Administering the Java Message Service (JMS)

• About the JMS Service
  • JMS Service High Availability
• Updating the JMS Service Configuration
  • Setting Message Queue Broker Properties in the JMS Service Configuration
• Administering JMS Hosts
  • About JMS Host Types
  • Configuring Embedded and Local JMS Hosts
  • To Create a JMS Host
  • To List JMS Hosts
  • To Update a JMS Host
  • To Delete a JMS Host
• Administering JMS Connection Factories and Destinations
  • To Create a Connection Factory or Destination Resource
  • To List JMS Resources
  • To Delete a Connection Factory or Destination Resource
• Administering JMS Physical Destinations
  • To Create a JMS Physical Destination
  • To List JMS Physical Destinations
  • To Purge Messages From a Physical Destination
  • To Delete a JMS Physical Destination
• Special Situations When Using the JMS Service
• Troubleshooting the JMS Service
• Using the Generic Resource Adapter for JMS to Integrate Supported External JMS Providers
  • Configuring GenericJMSRA for Supported External JMS Providers
    • To Deploy and Configure GenericJMSRA
    • GenericJMSRA Configuration Properties
    • Connection Factory Properties
    • Destination Properties
    • Activation Spec Properties
  • Using GenericJMSRA with WebLogic JMS
    • Deploy the WebLogic Thin T3 Client JAR in GlassFish Server
    • Configure WebLogic JMS Resources for Integration
    • Create a Resource Adapter Configuration for GenericJMSRA to Work With WebLogic JMS
    • Deploy the GenericJMSRA Resource Archive
    • Configuring an MDB to Receive Messages from WebLogic JMS
    • Accessing Connections and Destinations Directly
    • Limitations When Using GenericJMSRA with WebLogic JMS
    • Configuration Reference of GenericJMSRA Properties for WebLogic JMS
  • Using GenericJMSRA with IBM WebSphere MQ
    • Preliminary Setup Procedures for WebSphere MQ Integration
    • Configure the WebSphere MQ Administered Objects
    • Create a Resource Adapter Configuration for GenericJMSRA to Work With WebSphere MQ
    • Deploy the GenericJMSRA Archive
    • Create the Connection Factories and Administered Objects in GlassFish Server
    • Configuring an MDB to Receive Messages from WebSphere MQ

18 Administering the Java Naming and Directory Interface (JNDI) Service

• About JNDI
  • Java EE Naming Environment
  • How the Naming Environment and the Container Work Together
  • Naming References and Binding Information
• Administering JNDI Resources
  • Administering Custom JNDI Resources
    • To Create a Custom JNDI Resource
    • To List Custom JNDI Resources
    • To Update a Custom JNDI Resource
    • To Delete a Custom JNDI Resource
  • Administering External JNDI Resources
    • To Register an External JNDI Resource
    • To List External JNDI Resources
    • To List External JNDI Entries
    • To Update an External JNDI Resource
    • To Delete an External JNDI Resource
    • Example of Using an External JNDI Resource
    • To Disable GlassFish Server v2 Vendor-Specific JNDI Names

19 Administering Transactions

• About Transactions
  • Transaction Resource Managers
  • Transaction Scope
• Configuring the Transaction Service
• Managing the Transaction Service for Rollbacks
  • To Stop the Transaction Service
  • To Roll Back a Transaction
  • To Restart the Transaction Service
  • Determining Local Transaction Completion at Shutdown
• Recovering Transactions
  • Automatic Transaction Recovery
  • To Manually Recover Transactions
  • Distributed Transaction Recovery
  • Recovery Workarounds and Limitations
    • General Recovery Limitations
    • Oracle Setup for Transaction Recovery
    • Oracle Thin Driver
    • Delegated Recovery After Server Crash Doesn't Work on MySQL
    • Call to XATeminator.recover() During ResourceAdapter.start() Hangs If Automatic Recovery Is Enabled
• Transaction Logging
  • To Store Transaction Logs in a Database

Part III Appendixes

A Subcommands for the asadmin Utility

• General Administration Subcommands
• Connectivity Subcommands
• Domain Subcommands
• Internet Connectivity Subcommands
• JavaMail Subcommands
• JMS Subcommands
• JNDI Subcommands
• JVM Subcommands
• Life Cycle Module Subcommands
• Logging and Monitoring Subcommands
• ORB Subcommands
• Thread Pool Subcommands
• Transaction Service Subcommands