test

Sun GlassFish Communications Server 2.0 Installation Guide

Chapter 1 Installing Sun GlassFish Communications Server

This chapter provides instructions for installing the Sun GlassFish Communications Server software available from the Sun download site. It also has instructions on how to install SailFin , the open source implementation of Sun GlassFish Communications Server.

You can choose to use either the file-based installer available from the Sun Download site or the JAR-based installer available from java.net. The following topics are discussed:

Distribution Types and Their Components

The various distributions and their components are as follows:

Installing Sun GlassFish Communications Server With File-based Installer

If you are using the Sun GlassFish Communications Server file-based installer available from the Sun Download page , use one of the following procedures:

ProcedureTo Install Sun GlassFish Communications Server in GUI or CLI Mode

Before You Begin

Use this procedure if you are using the Graphic User Interface (GUI) or Command-Line Interface (CLI) mode of the file-based installer for Sun GlassFish Communications Server. Verify that your system meets the requirements specified in the Release Notes.

Solaris and Linux installations support both root and non-root user installations. Users of Windows installations should have Power User or Administrator access. If you are installing as a non-root user on Solaris or Linux, you must have read-write access to the following directories:

  1. Navigate to the directory where you downloaded the distribution file.

  2. If you have downloaded a .bin file, change the permission of the distribution file so that you have execute access:

    chmod +x distribution_filename

  3. Run the installation program.

    • If you are installing from a .bin file on Solaris or Linux, use the following command to run the installation program :

      ./distribution_filename

      Use the -console option to run the installation program in command-line mode. It is recommended that you use the -javahome option if you are running the installation program on Solaris x86 platform.

    • If you are installing from an .exe file on Windows, double-click the file.

    Note –

    If you are installing Sun GlassFish Communications Server on a 64–bit machine (running a 64–bit operating system), use a 32–bit JDK to install Sun GlassFish Communications Server on your 64–bit machine. You will need to use the following command: ./distribution_filename —javahome path to 32–bit JDK location

    After installation, download the 64–bit JDK from java.sun.com. Edit the value of the AS_JAVA variable in the asenv.conf file to point to the 64–bit JDK installation, so that Sun GlassFish Communications Server uses the 64–bit JDK.

  4. Read and accept the license agreement.

  5. Choose the components you want to install.

    You can choose to install the Domain Administrative Server (DAS) or the node agent, or both.

  6. In the Administration Configuration page (or when prompted at the command line), enter the following fields and click Next.

    • Admin User Name – Name of the user who administers the server.

    • Password – Admin user’s password to access the Admin Server (8-character minimum).

    • Choose whether you want to be prompted for the Admin User Name and Password.

    • Admin Port – Administration port number for initial server instance. The default value is 4848.

    • HTTP Port - Port number to access the default server instance. The default is 8080

    • HTTPS Port - Secure port number to access the default server instance. The default is 8181

  7. In the SIP Configuration page, provide the following configuration information and click Next.

    • SIP Port – The port on which SIP listener listens for SIP requests. The default value is 5060.

    • SIPS Port – Secure SIP port. The default value is 5061.

    • Choose whether you want an installation with clustering capabilities or an installation without clustering capabilities.

      For more information on clustering, see the Clustering section in the High-Availability Administration guide.

    Note –

    The installation program automatically detects ports in use and suggests unused ports for the default settings.

    In addition, five other ports are automatically assigned. You can change the automatically assigned values after installation using the Admin Console. The ports are assigned with the following default values:

    • Message Queue – The default is 7676

    • IIOP – The default is 3700 for IIOP, and 3820 and 3890 for IIOP/SSL

    • JMXTM – The default is 8686

    If these default port numbers are in use, the installation program assigns random port numbers from the dynamic port range. This number may not be the next available port number.

  8. In the Installation Options page, select the options that you want. Click Next

    The following installation options are available:

    • Upgrade from a Previous Version – Select this option to upgrade from a previous version of Communications Server.

      The Upgrade Tool is launched if you choose this option.

    • Enable UpdateCenter Client – Select this option to enable Updatecenter to check for available updates and collect system data.

    • Create Desktop Shortcut to the AutoDeploy directory – Select this option to automatically deploy items dragged to this directory. You see this option only if you are using Windows.

    • Add bin Directory to PATH – Select this option to add as-install/bin to the PATH variable for simplifying the process of running the server and tools from the command line. You see this option only if you are using Windows.

    • Create Windows Service – Select this option to create a Windows service to start and stop Application Server,

      Note –

      To create a Windows service, the sc.exe utility must be available on the system. Windows 2000 users may need to install the Windows 2000 Resource Kit to get this utility. For other supported Windows versions, the utility is included in the operating system.

  9. On the Ready to Install page, click Install Now.

  10. After installation completes, use the Registration Options screen for registering your installation of application server. For instructions, see To Register Your Installation of Sun GlassFish Communications Server.

  11. Verify the installation by following the procedures in the Sun GlassFish Communications Server 2.0 Quick Start Guide, located in as-install/docs/QuickStart.html or on docs.sun.com.

ProcedureTo Install Sun GlassFish Communications Server in Silent Mode

You can use this procedure only with the Sun GlassFish Communications Server file-based installer. SailFin does not offer silent mode installation. The silent mode involves using a installation configuration file for installing in a non-interactive mode.

  1. Create the installation configuration file by running one of the following commands:

    • On Solaris or Linux for GUI mode:

      ./distribution_filename -savestate configuration_filename

    • On Solaris or Linux for CLI mode:

      ./distribution_filename -console -savestate configuration_filename

    • On Windows for GUI mode:

      distribution_filename -savestate configuration_filename

    • On Windows for CLI mode:

      distribution_filename -console -savestate configuration_filename

    The installation configuration file is created when you use the savestate option when starting an interactive installation. During the interactive installation, your input is collected and stored in the configuration file you specified. This file forms the template for silent installation, which you can use later to install the product on one or more machines. If needed, you can modify the installation configuration file.

    Note –

    If you do not include a path to the installation configuration file, the file is created in the directory where you are running the installation program.

  2. Modify the following variables in the installation configuration file, as required.

    Variable Name 

    Valid Values  

    Content 

    Comments 

    Build ID

    		 

    The string of characters following the distribution in the STATE_BEGIN and STATE_END sections. This value is automatically generated. 

    No need to alter this value unless installing a different distribution file than the one that produced the configuration file. To find the build ID, enter distribution_filename -id at the command prompt.

    defaultInstallDirectory

    		 

    Default installation directory path. 

    		 

    currentInstallDirectory

    		 

    Selected absolute installation directory path. 

    		 

    INST_ASADMIN_USERNAME

    		 

    Administrator user name for initial server instance. 

    		 

    INST_ASADMIN_PASSWORD

    		 

    Administrator password for initial server instance. 

    This entry is obfuscated by default. 

    See also:ADMIN_PASSWORD_ENCRYPTED.

    INST_ASADMIN_PORT

    0 - 65535 

    Administration server port number for initial server instance. 

    Default value is 4848. 

    INST_ASWEB_PORT

    0 - 65535 

    HTTP port number for initial server instance. 

    Default value is 8080. 

    INST_HTTPS_PORT

    0 - 65535 

    HTTPS port number for initial server instance. 

    Default value is 8081.  

    STORE_ADMIN_AUTH

    TRUE, FALSE 

    Whether to create admin authentication user preference file. 

    		 

    ADMIN_PASSWORD_ENCRYPTED

    TRUE, FALSE 

    Obfuscated admin password flag. 

    In the initial statefile created by the product installer, this flag is set to TRUE, since the admin password value is obfuscated for security reasons. 

    To override the value for admin password, enter INST_ASADMIN_PASSWORD value in clear text and set this flag to FALSE to enable silent installation to process it correctly.

    INST_JMS_PORT

    0 - 65535 

    JMS port number for initial server instance. 

    If the configuration file does not include this entry, default value of 7676 is used. 

    INST_ORB_PORT

    0 - 65535 

    ORB port number for initial server instance. 

    If the configuration file does not include this entry, default value of 3700 is used. 

    INST_ORB_SSL_PORT

    0 - 65535 

    Secure ORB port number for initial server instance. 

    If the configuration file does not include this entry, default value of 3820 is used. 

    INST_ORB_MUTUALAUTH_PORT

    0 - 65535 

    Mutual authentication ORB port number for initial server instance. 

    If the configuration file does not include this entry, default value of 3920 is used. 

    INST_JMX_PORT

    0 - 65535 

    JMX port number for initial server instance. 

    If the configuration file does not include this entry, default value of 8686 is used. 

    CREATE_DESKTOP_SHORTCUT

    TRUE, FALSE 

    Whether to create autodeploy folder desktop shortcut. 

    Valid for Windows platforms only and is disregarded otherwise. 

    UPDATE_PATH

    TRUE, FALSE 

    Whether to update PATH environment variable to include Communications Server bin directory.

    Valid only for Windows platforms and is disregarded otherwise. 

    If this entry is not present, default value of FALSE is used. 

    CREATE_WINDOWS_SERVICE

    TRUE, FALSE 

    Whether to create the server as a Windows service. 

    Valid for Windows platforms only and is disregarded otherwise. 

    SELECTED_ADDONS

    JBI 

    Add-ons selected for installation. If no add-ons are selected, the value is blank. 

    Valid for Java EE SDK SOA Starter Kit Preview installations only and is disregarded otherwise. 

    CREATE_DAS

    TRUE, FALSE 

    Creates a DAS if set to TRUE. The default domain is named domain1 and is created under default domain-root-dir.

    Creates the default domain and installs the software components that are required to run the DAS.  

    CREATE_NA

    TRUE, FALSE 

    Creates a node agent if set to TRUE. The default node agent would be named agent1 and is created under default node agents root.

    Creates the default node agent and installs the software components that are required to run the node agent. 

    WEBSERVER_INSTALL_DIR

    A valid, read- writable directory location. 

    Installation directory of a supported Web server. 

    Used only when the load balancing plug-in component is selected for installation. 

    WEBSERVER_INSTANCE_DIR

    A valid read- writable directory location.  

    Instance directory of selected web server where the load balancing plug-in will be configured. 

    Used when load balancing plug-in component is selected to be installed on Sun Java System Web Server. Not applicable for other web servers. 

    PLUGIN_TYPE

    Sun Java System Web Server, Apache HTTP Server, or Microsoft IIS Web Server.

    Type of web server on which the load balancing plug-in will be installed/configured. 

    Used only when the load balancing plug-in component is selected for installation. 

    PLUGIN_CERTIFICATE_FILE

    A valid path to a certificate file. 

    		 

    Used only when Apache HTTP Server is selected for load balancing plug-in installation. Not supported or is ignored for other web servers. 

  3. Modify the following Communications Server variables in the installation configuration file, as required.

    Variable Name 

    Valid Values  

    Content 

    Comments 

    SIP_PORT

    0 - 65535 

    SIP port number. 

    Default value is 5060.  

    SIPS_PORT

    0 - 65535 

    Secure SIP port number. 

    Default value is 5061. 

    IS_CLUSTER

    TRUE, FALSE 

    Whether to set up Communications Server with clustering capabilities.  

    Default value is TRUE. If this variable is set to TRUE, the default domain will be set up with cluster profile. If this variable is set to FALSE, the default domain will be set up with developer profile. 

    Ensure that this value is set to TRUE if you choose to install the node agent and the DAS.  

    SELECTED_COMPONENTS

    Domain Admin Server#Node Agent#, Node Agent#

    Whether the node agent and DAS have been chosen for installation.  

    To install the node agent and the DAS, set this option to Domain Admin Server#Node Agent#.

    To install only the node agent, set this value to Node Agent#.

    If this variable is not set, only the DAS is installed.  

    INST_DAS_HOSTNAME

    		 

    Name of the DAS host.  

    Default value is localhost 

  4. Modify the following product registration variables in the installation configuration file, as required.

    Product registration values are REGISTRATION_OPTION, PROXY_HOST, PROXY_PORT, USER_NAME, USER_PASSWORD, FIRST_NAME, LAST_NAME, CCOMPANY_NAME,and COUNTRY.

  5. Copy your installation configuration file to each machine where you plan to install the software.

  6. Copy the Communications Server distribution file to each machine where you plan to install the software.

  7. Navigate to the directory where you copied the distribution file.

  8. Start silent installation at the command line using one of the following command formats:

    • On Solaris or Linux:

      ./distribution_filename -silent configuration_filename

    • On Windows:

      distribution_filename -silent configuration_filename

    The installation program reads the specified configuration_filename, checks for adequate disk space, then installs the product based on the data in configuration_filename.

    When the prompt is returned, the silent installation is complete and the installation components are installed on your systems.

Installation Configuration File Example

Example 1–1 Installation Configuration File


#
# Install Wizard Statefile section for Sun GlassFish Communications Server
#
#
[STATE_BEGIN Sun GlassFish Communications Server 5688c4]
defaultInstallDirectory = /home/SUNWappserver
currentInstallDirectory = /home/SUNWappserver
SELECTED_COMPONENTS = Domain Admin Server#Node Agent#
INST_ASADMIN_USERNAME = admin
INST_ASADMIN_PASSWORD = nvittiwnepmndhrwqvqzvanqzva
INST_MASTER_PASSWORD = pwliqdfotklvggykbvixunatrvg
INST_ASADMIN_PORT = 4848
INST_ASWEB_PORT = 8080
INST_HTTPS_PORT = 8181
STORE_ADMIN_AUTH = TRUE
ADMIN_PASSWORD_ENCRYPTED = TRUE
INST_JMS_PORT = 7676
INST_ORB_PORT = 3700
INST_ORB_SSL_PORT = 3820
INST_ORB_MUTUALAUTH_PORT = 3920
INST_JMX_PORT = 8686
INST_SIP_PORT = 5060
INST_SIPS_PORT = 5061
IS_CLUSTER = true
INST_DAS_HOSTNAME = localhost
CREATE_DESKTOP_SHORTCUT = FALSE
UPDATE_PATH = FALSE
CREATE_UPDATE_ICON = 
CREATE_WINDOWS_SERVICE = FALSE
PROXY_HOST = 
PROXY_PORT = 
REGISTRATION_OPTION = 
USER_NAME = 
USER_PASSWORD = 
REGISTRATION_OPTION = 
USER_NAME = 
USER_PASSWORD = 
FIRST_NAME = 
LAST_NAME = 
COMPANY_NAME = 
COUNTRY = 
[STATE_DONE Sun GlassFish Communications Server 5688c43]

Installing Sun GlassFish Communications Server With JAR-based Installer

This section provides instructions for installing SailFindistribution, which is available as a JAR-based installer..

ProcedureTo Install Sun GlassFish Communications Server With JAR-Based Installer

Before You Begin

Get JDK 6 from http://java.sun.com/javase/, if you are using Solaris, Linux, or Windows.

If you are using Mac OS X, you need to download JDK from http://developer.apple.com/java/download/ and make JDK the default JVM.

  1. Download the SailFin distribution from https://sailfin.dev.java.net/downloads/downloads.html.

  2. Set the environment variable JAVA_HOME to point to the directory in which JDK is installed.

  3. Run the following command:

    java -Xmx256m -jar filename.jar

    Note –

    If you have trouble running this command, run this command with a higher —Xmx value. Example, java -Xmx512m -jar filename.jar

  4. Navigate to the sailfin directory:

    cd sailfin

  5. If you are using operating system that is a derivative of UNIX:

    chmod -R +x lib/ant/bin

  6. Run one of the following commands:

    • If you want SailFin with clustering, run the following command:

      lib/ant/bin/ant -f setup-cluster.xml

      Or, for Windows: lib\ant\bin\ant -f setup-cluster.xml

    • If you want SailFin without clustering, run the following command:

      lib/ant/bin/ant -f setup.xml

      Or, for Windows: lib\ant\bin\ant -f setup.xml

  7. Use the Admin Console to register your installation of SailFin. Start SailFin using the instructions in the Quick Start guide.

Registering Your Installation of Sun GlassFish Communications Server

This section explains how to register your installation of Sun GlassFish Communications Server with Sun Connection.

ProcedureTo Register Your Installation of Sun GlassFish Communications Server

You can register your installation of Communications Server from the file-based installer in GUI mode. Alternatively, you can register later by using the Registration node in the Admin Console of Communications Server or through the Update Center.

To register your installation of Communications Server with Sun Connection, you must have a Sun Online Account. If you do not have a Sun Online Account, the Communications Server installer enables you to create an account while registering Application Server.

Note –

If you create a Sun Online Account while registering Communications Server, you are prompted only for the required information. You can provide additional, optional information by updating your Sun Online Account.

  1. In the Product Registration screen, provide the required information as follows:

    • If you already have a Sun Online Account, provide the required information as follows:

      1. Select the I Already Have a Sun Online Account option.

      2. In the User Name field, type the user name that you specified when registered for your Sun Online Account.

      3. In the Password field, type that you specified when registered for your Sun Online Account.

      4. Click Register.

    • If you do not have a Sun Online Account, provide the required information as follows:

      1. Select the I Don't Have a Sun Online Account option.

      2. In the Email Address field, type your email address.

        Your email address will be your Sun Online Account user name.

      3. In the Password field, type the password to use for your Sun Online Account.

        The password is case sensitive and must be 6 – 10 characters long.

      4. In the Retype Password field, retype the password that you typed in the preceding step.

      5. Complete the remaining fields and click Register.

    • Choose the Skip Registration option if you want to register later through the Admin Console or through the Update Center.