GlassFish Server Open Source Edition - GitHub Pages

GlassFish Server Open Source EditionQuick Start GuideRelease 5.0September 2017This book demonstrates key features of the GlassFish Serverproduct and enables you to quickly learn the basics.Step-by-step procedures introduce you to product featuresand GlassFish Server Open Source Edition 5.0 Quick StartGuideGlassFish Server Open Source Edition 5.0 Quick StartGuide you to use them immediately.

GlassFish Server Open Source Edition Quick Start Guide, Release 5.0Copyright 2013, 2017 Oracle and/or its affiliates. All rights reserved.This software and related documentation are provided under a license agreement containing restrictions onuse and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverseengineering, disassembly, or decompilation of this software, unless required by law for interoperability, isprohibited.The information contained herein is subject to change without notice and is not warranted to be error-free. Ifyou find any errors, please report them to us in writing.If this is software or related documentation that is delivered to the U.S. Government or anyone licensing iton behalf of the U.S. Government, the following notice is applicable:U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical datadelivered to U.S. Government customers are "commercial computer software" or "commercial technical data"pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. Assuch, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions andlicense terms set forth in the applicable Government contract, and, to the extent applicable by the terms ofthe Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer SoftwareLicense (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.This software or hardware is developed for general use in a variety of information managementapplications. It is not developed or intended for use in any inherently dangerous applications, includingapplications that may create a risk of personal injury. If you use this software or hardware in dangerousapplications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and othermeasures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damagescaused by use of this software or hardware in dangerous applications.Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks oftheir respective owners.Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarksare used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of AdvancedMicro Devices. UNIX is a registered trademark of The Open Group.This software or hardware and documentation may provide access to or information on content, products,and services from third parties. Oracle Corporation and its affiliates are not responsible for and expresslydisclaim all warranties of any kind with respect to third-party content, products, and services. OracleCorporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to youraccess to or use of third-party content, products, or services.

Contents1 Quick Start for Basic FeaturesAbout This Quick Start Guide. 1-1Default Paths and File Names . 1-2Default Administration Values . 1-2Starting and Stopping the Default Domain. 1-3To Start the Default Domain. 1-3To Stop the Default Domain . 1-3Starting and Stopping the Database Server . 1-3To Start the Apache Derby Server . 1-4To Stop the Apache Derby Server. 1-4Starting the Administration Console . 1-4To Start the Administration Console. 1-4Deploying and Undeploying Applications. 1-5To Obtain the Sample Application . 1-5Deploying and Undeploying the Sample Application From the Command Line . 1-5Deploying and Undeploying Applications by Using the Administration Console. 1-6Deploying and Undeploying the Sample Application Automatically. 1-7High Availability Clustering and Load Balancing . 1-8Clusters of GlassFish Server Instances. 1-8Session Persistence and Failover. 1-9Load Balancing for Clustered Configurations . 1-9For More Information. 1-10Product Documentation . 1-10GlassFish Communities. 1-10Tutorials. 1-10Java EE 8 Samples . 1-11iii

iv

PrefaceThis book demonstrates key features of the GlassFish Server product and enables youto quickly learn the basics. Step-by-step procedures introduce you to product featuresand enable you to use them immediately.This preface contains information about and conventions for the entire GlassFishServer Open Source Edition (GlassFish Server) documentation set.GlassFish Server 5.0 is developed through the GlassFish project open-sourcecommunity at https://javaee.github.io/glassfish/. The GlassFish projectprovides a structured process for developing the GlassFish Server platform that makesthe new features of the Java EE platform available faster, while maintaining the mostimportant feature of Java EE: compatibility. It enables Java developers to access theGlassFish Server source code and to contribute to the development of the GlassFishServer. The GlassFish project is designed to encourage communication between Oracleengineers and the community.The following topics are addressed here: GlassFish Server Documentation Set Typographic Conventions Symbol Conventions Documentation Searching Oracle Product Documentation Documentation AccessibilityGlassFish Server Documentation SetThe GlassFish Server documentation set describes deployment planning and systeminstallation. For an introduction to GlassFish Server, refer to the books in the order inwhich they are listed in the following table.Book TitleDescriptionRelease NotesProvides late-breaking information about the software and thedocumentation and includes a comprehensive, table-basedsummary of the supported hardware, operating system, JavaDevelopment Kit (JDK), and database drivers.Quick Start GuideExplains how to get started with the GlassFish Server product.Installation GuideExplains how to install the software and its components.v

viBook TitleDescriptionUpgrade GuideExplains how to upgrade to the latest version of GlassFish Server.This guide also describes differences between adjacent productreleases and configuration options that can result inincompatibility with the product specifications.Deployment Planning GuideExplains how to build a production deployment of GlassFishServer that meets the requirements of your system and enterprise.Administration GuideExplains how to configure, monitor, and manage GlassFish Serversubsystems and components from the command line by using theasadmin utility. Instructions for performing these tasks from theAdministration Console are provided in the AdministrationConsole online help.Security GuideProvides instructions for configuring and administering GlassFishServer security.Application DeploymentGuideExplains how to assemble and deploy applications to theGlassFish Server and provides information about deploymentdescriptors.Application DevelopmentGuideExplains how to create and implement Java Platform, EnterpriseEdition (Java EE platform) applications that are intended to runon the GlassFish Server. These applications follow the open Javastandards model for Java EE components and applicationprogrammer interfaces (APIs). This guide provides informationabout developer tools, security, and debugging.Embedded Server GuideExplains how to run applications in embedded GlassFish Serverand to develop applications in which GlassFish Server isembedded.High AvailabilityAdministration GuideExplains how to configure GlassFish Server to provide higheravailability and scalability through failover and load balancing.Performance Tuning GuideExplains how to optimize the performance of GlassFish Server.Troubleshooting GuideDescribes common problems that you might encounter whenusing GlassFish Server and explains how to solve them.Error Message ReferenceDescribes error messages that you might encounter when usingGlassFish Server.Reference ManualProvides reference information in man page format for GlassFishServer administration commands, utility commands, and relatedconcepts.Message Queue ReleaseNotesDescribes new features, compatibility issues, and existing bugs forOpen Message Queue.Message Queue TechnicalOverviewProvides an introduction to the technology, concepts, architecture,capabilities, and features of the Message Queue messagingservice.Message QueueAdministration GuideExplains how to set up and manage a Message Queue messagingsystem.Message Queue Developer'sGuide for JMX ClientsDescribes the application programming interface in MessageQueue for programmatically configuring and monitoring MessageQueue resources in conformance with the Java ManagementExtensions (JMX).Message Queue Developer'sGuide for Java ClientsProvides information about concepts and procedures fordeveloping Java messaging applications (Java clients) that workwith GlassFish Server.

Book TitleDescriptionMessage Queue Developer'sGuide for C ClientsProvides programming and reference information for developersworking with Message Queue who want to use the C languagebinding to the Message Queue messaging service to send, receive,and process Message Queue messages.Typographic ConventionsThe following table describes the typographic changes that are used in this book.TypefaceMeaningExampleAaBbCc123The names of commands, files,and directories, and onscreencomputer outputEdit your .login file.Use ls a to list all files.machine name% you have mail.AaBbCc123 What you type, contrasted withonscreen computer outputmachine name% suPassword:AaBbCc123A placeholder to be replaced with The command to remove a file is rm filename.a real name or valueAaBbCc123Book titles, new terms, and termsto be emphasized (note that someemphasized items appear boldonline)Read Chapter 6 in the User's Guide.A cache is a copy that is stored locally.Do not save the file.Symbol ConventionsThe following table explains symbols that might be used in this book.Symbol DescriptionExampleMeaning[ ]Contains optionalarguments andcommand options.ls [-l]The -l option is not required.{ }Contains a set ofchoices for a requiredcommand option.-d {y n}The -d option requires that youuse either the y argument or then argument. { }Indicates a variablereference. {com.sun.javaRoot}References the value of thecom.sun.javaRoot variable.-Joins simultaneousmultiple keystrokes.Control-APress the Control key while youpress the A key. Joins consecutivemultiple keystrokes.Ctrl A NPress the Control key, release it,and then press the subsequentkeys. File New TemplatesIndicates menu itemselection in a graphicaluser interface.From the File menu, chooseNew. From the New submenu,choose Templates.DocumentationThe documentation information is available at: Documentationvii