Using the Java CAPS 6 Installation CLI

Using the Java CAPS 6 Installation CLI

This topic provides information and instructions for installing the JavaTM Composite Application Platform Suite (Java CAPS) using a command-line interface (CLI). This interface allows you to interact with software or an operating system using a terminal, remote shell, or command prompt.

Prior to installing Java CAPS, read Planning for Java CAPS Installation. It provides pertinent information such as supported platforms, operating system limitations, and parameter definitions. If you have any questions or problems, see the Java CAPS web site at http://goldstar.stc.com/support.

To access all the Java CAPS documentation in HTML or PDF format, see the Java CAPS documentation on DSC.

What You Need to Know

This topic contains conceptual information about the installation.

What You Need to Do

These topics contain the procedures for installing a Java Development Kit (JDK) and Java CAPS.

Overview of CLI Installations

Before beginning the installation, read Planning for Java CAPS Installation, which contains information that is necessary for you to complete a successful installation of Java CAPS such as supported platforms, operating system limitations, and parameter definitions. You can use a command–line installation script on any of the supported operating systems by first setting the configuration properties file and then invoking the installation script.

The command–line installation installs any or all of the Suite components. For a complete list of the components installed by default, see Overview of the Installation Process in Planning for Java CAPS Installation . The installation process also installs Sun Uninstaller software.

Java CAPS does not support:

You can specify three types of installations with the command-line syntax:

JavaCAPS.bin [-i {silent | gui | console} ] [-help] [-f filename]

The –i options are:


Note –

If you run the command-line installation executable file without setting any options, the Java CAPS GUI Installer will launch.


You do not have to install all components at the same time. You can install additional Java CAPS products and components at any time after completing the initial installation by setting the configuration properties file and then invoking the command–line installation script to install specific items or by running the Java CAPS Uploader followed by the NetBeans Update Center.

You must have the JDK software installed and JAVA_HOME set prior to installing Java CAPS; otherwise, the Installer will halt the installation. See Installing the JDK Software and Setting JAVA_HOME.

Installing the JDK Software and Setting JAVA_HOME

If you do not already have the JDK software installed or if JAVA_HOME is not set, the Java CAPS installation will not be successful. The following tasks provide the information you need to install JDK software and set JAVA_HOME on UNIX or Windows systems.

For a list of supported JDK versions on each supported operating system, see Java CAPS Supported JDK Versions in Planning for Java CAPS Installation .

ProcedureTo Install the JDK Software and Set JAVA_HOME on a UNIX System

  1. Install the JDK software.

    1. Go to http://java.sun.com/javase/downloads/index.jsp.

    2. Select the appropriate JDK software version and click Download.

      The JDK software is installed on your computer, for example, /usr/jdk/jdk1.6.0_02. You can change this location.

  2. Set JAVA_HOME.

    • Korn and bash shells:

      export JAVA_HOME=jdk-install-dir

      export PATH=$JAVA_HOME/bin:$PATH

    • Bourne shell:

      JAVA_HOME=jdk-install-dir

      export JAVA_HOME

      PATH=$JAVA_HOME/bin:$PATH

      export PATH

    • C shell:

      setenv JAVA_HOME jdk-install-dir

      setenv PATH $JAVA_HOME/bin:$PATH

      export PATH=$JAVA_HOME/bin:$PATH

  3. Change the permissions to enable you to run the Java CAPS Installer.

    chmod 755 JavaCAPS.bin

ProcedureTo Install the JDK Software and Set JAVA_HOME on a Windows System

  1. Install the JDK software.

    1. Go to http://java.sun.com/javase/downloads/index.jsp.

    2. Select the appropriate JDK software and click Download.

      The JDK software is installed on your computer, for example, at C:\Program Files\Java\jdk1.6.0_02. You can move the JDK software to another location if desired.

  2. To set JAVA_HOME:

    1. Right click My Computer and select Properties.

    2. On the Advanced tab, select Environment Variables, and then edit JAVA_HOME to point to where the JDK software is located, for example, C:\Program Files\Java\jdk1.6.0_02.

Creating the Configuration Properties File for Silent Installations

The silent installation requires a properties file to determine the configuration of the Java CAPS environment. This file is not required for commend-line installation using the console or GUI mode. The properties file includes properties such as the JDK home, installation directory, Repository and Enterprise Manager information, and so on. Use the sample file below to set up your configuration properties file, and copy the customized file to the directory where you are going to install Java CAPS.


Note –

When installing using the silent option, the scripted file, file.properties, is automatically generated by the Java CAPS Installer if the product has already been installed.


You can set the file to install only runtime components or only design-time components.

ProcedureTo Create the Properties File for a Command-Line Installation

  1. Copy the sample properties file following this procedure into a text file on the computer where you are installing Java CAPS.


    Tip –

    If you have an existing Java CAPS installation, you can find additional properties files at JavaCAPS_Home/install/docs. The file is also included in the /documentation directory under the installer on the installation media.


  2. Configure the following properties:

    Property or Section 

    Description 

    CHOSEN_INSTALL_ FEATURE_LIST

    The list of primary components to install. Include any of the following in the list, separated by commas with no spaces: 

    • Repository – The Java CAPS Repository and Repository-based components

    • Appserver – The GlassFish Enterprise Server and associated runtime components

    • NetBeans – The NetBeans IDE and associated design-time components

    • STCMS – The Sun Java JMS IQ Manager

    • UDDI – The UDDI server

    • EM – The Java CAPS Enterprise Manager.

    CHOSEN_INSTALL_SET

    Whether to perform a complete or custom installation. Specify Complete to install all components; or specify Custom to specify which components to install. If you specify custom, be sure to change the property above to only list the components you want to install. In the sections below, comment out the configuration properties (using a hashmark) for those components you removed from the above list.

    USER_JDK__HOME

    The path to your JDK software.  

    USER_INSTALL_DIR

    The path where you want to install Java CAPS. 

    REPOSITORY_NAME

    The name of the Repository. You can change the default repository of repository1 but do not use “repository” because assigning a name that is the same as the component name in lowercase can cause connection problems.

    REPOSITORY_ADMIN_PORT

    The port number for the repository. There must be 10 consecutive port numbers that are not in use, beginning with this number. 

    NETBEANS_INSTALL_NBMS

    An indicator of whether to install NetBeans NBMs. Enter 1 to install the Repository-based components in NetBeans; otherwise specify 0.

    Appserver Get User Input Properties

    In this section, enter the login credentials, domain name, and port numbers to use for the GlassFish server, or accept the default values. 

    STCMS Get User Input

    In this section, enter information for the Sun Java JMS IQ Manager. The possible values for the STCMS_OS_TYPE property are listed below. If you want to migrate the JMS IQ Manager from a previous version of Java CAPS, type the root directory of the previous installation in the STCMS_MIGRATION_FROM_DIR property.

    STCMS_OS_TYPE

    The name of the operating system on which you are installing the Sun Java JMS IQ Manager. Specify any of the following values: 

    • solx86 – Solaris 10 x86 (32/64-bit), Intel

    • solamd64 – Solaris 10 x86 (64-bit), AMD

    • solaris64 – Solaris 10 (64-bit), SPARC

    • aix32 – IBM AIX 5L 5.3 (32-bit)

    • aix64 – IBM AIX 5L 5.3 (64-bit)

    • linux7 – Red Hat Enterprise Linux Advanced Server 3, 4, and 5 (32/64-bit), Intel

    • linuxamd64 – Red Hat Enterprise Linux Advanced Server 3, 4, and 5 (64-bit), AMD

    • redhat5_64 – Red Hat Enterprise Linux 5 Advanced Server (Intel and AMD x86-64)

    • suse8 – SUSE Linux Enterprise Server 9 and 10 (32/64-bit), Intel

    • win32 – Windows (32-bit)

    • donotinstall – Do not install the STCMS component

    EM Get USer Input

    In this section, enter the name of the computer on which you are installing Java CAPS and enter the port number to access the Enterprise Manager. 


    Note –

    The default port number is 15000. This port assignment requires five consecutive available ports and the system selects four additional port numbers that sequentially follow the initial port number (15001–15004 for the default). Port checking performed at installation only detects ports in use at that time, so the installation will not detect ports used by other applications that are not currently running. Use caution if you change the default port value.


  3. To install only runtime components:

    • Change the install set from Complete to Custom (CHOSEN_INSTALL_SET=Custom).

    • Specify the runtime components that you want to install in the CHOSEN_INSTALL_FEATURE_LIST property. The runtime components are Appserver, Repository, and STCMS.

    • In the lower part of the file, comment out the configuration for the components you do not want to install.

  4. To install only design-time components:

    • Change the install set from Complete to Custom (CHOSEN_INSTALL_SET=Custom).

    • Specify NetBeans in the CHOSEN_INSTALL_FEATURE_LIST property.

    • In the lower part of the file, comment out the configuration for the components you do not want to install.

  5. When you are done configuring the properties, save and close the file.

  6. Continue to Installing Java CAPS Silently Using CLI.


Example 1 Sample Configuration Properties File for Silent Installations

#[silent|gui|console]
CHOSEN_INSTALL_FEATURE_LIST=Repository,NetBeans,Appserver,STCMS,UDDI,EM
#[Complete|Custom]
CHOSEN_INSTALL_SET=Complete


#Choose JDK
#----------
USER_JDK_HOME=install-dir

#Choose Install Folder
#---------------------
USER_INSTALL_DIR=C:\\JavaCAPS6

#Repository Get User Input
#-------------------------
REPOSITORY_NAME=repository1
REPOSITORY_ADMIN_PORT=12000

#NetBeans Get User Input
#-----------------------
NETBEANS_INSTALL_NBMS=1

#Appserver Get User Input
#------------------------
APPSERVER_ADMIN_USER=admin
APPSERVER_ADMIN_PASSWORD=adminadmin
APPSERVER_MASTER_PASSWORD=changeit
APPSERVER_DOMAIN_NAME=domain1
# Basic Ports
APPSERVER_ADMIN_PORT=4848
APPSERVER_HTTP_PORT=8080
APPSERVER_HTTPS_PORT=8181
# Advanced Ports
APPSERVER_JMS_PORT=7676
APPSERVER_JMX_ADMIN_PORT=8686
APPSERVER_IIOP_PORT=3100
APPSERVER_IIOP_SSL_PORT=3820
APPSERVER_IIOP_MUTUALAUTH_PORT=3920

#STCMS Get User Input
#--------------------
STCMS_OS_TYPE=OS
STCMS_PORT=18007
STCMS_SSL_PORT=18008
STCMS_MIGRATION_FROM_DIR=

#EM Get User Input
#-----------------
EMANAGER_HOST_NAME=localhost
EMANAGER_ADMIN_PORT=15000

Installing Java CAPS Silently Using CLI

You can use the Java CAPS command-line installation script to perform a complete installation silently. A silent installation means that you will not interact with the Installer, nor will you see the process unless you open the directory to which you are installing.

Java CAPS Release 6 does not support the following:

ProcedureTo Install Java CAPS Silently Using CLI

Before You Begin
  1. Download the installation executable file from the delivery media to the installation directory.

    You can download the file from the following media:

    • The Sun Download Center (SDLC) URL supplied by Sun Support

    • The DVDs that come with the Java Composite Application Platform Suite Media Kit

  2. If you have not done so already, copy the configuration properties file to the directory where you are going to install Java CAPS.

  3. Extract the installation executable file to a temporary directory.

    • UNIX and Linux: JavaCAPS.bin

    • Windows: JavaCAPS.exe


    Caution – Caution –

    On UNIX systems, the Java CAPS Installer uses /tmp as its workspace by default even when /var/tmp is the system temporary directory, as is the case on Solaris SPARC systems. If you do not have access to /tmp, set the environment variable to IATEMPDIR=/var/tmp. The Java CAPS Installer will then use /var/tmp as its temporary directory.


  4. From a command line, navigate to the location of the executable file and run one of the following commands, specifying the relative path and filename for the properties file in place of file.properties:

    UNIX and Linux: sh ./JavaCAPS.bin -i silent -f file.properties

    Windows: JavaCAPS.exe -i silent -f file.properties

    Java CAPS is installed in the directory you specified. After several minutes, a console appears and provides general information about the installation process. It closes when the installation is complete.

Installing Java CAPS Using the CLI Console

You can use the Java CAPS command-line installation script to perform a complete installation using a text console interface. You do not need to create a properties file for this type of installation.

This procedure installs the Sun Java System Application Server 9.1 (SJSAS). NetBeans IDE 6.1 ML, and Java CAPS core products such as the Sun Enterprise Service Bus, Java CAPS Repository version 6, Java CAPS Enterprise Manager version 6, Sun JMS IQ Manager version 6, and the UDDI Server using the Java CAPS Console command line installation.

Java CAPS Release 6 does not support:


Note –

You can cancel the installation at any time during the process.


ProcedureTo Install Java CAPS Components Using the Command Line Console

Before You Begin
  1. Download the installation executable file from the delivery media to the installation directory.

    You can download the file from the following media:

    • The Sun Download Center (SDLC) URL supplied by Sun Support

    • The DVDs that come with the Java Composite Application Platform Suite Media Kit

  2. Extract the installation executable file to a temporary directory.

    • UNIX and Linux: JavaCAPS.bin

    • Windows: JavaCAPS.exe


    Caution – Caution –

    On UNIX systems, the Java CAPS Installer uses /tmp as its workspace by default even when /var/tmp is the system temporary directory, as is the case on Solaris SPARC systems. If you do not have access to /tmp, set the environment variable IATEMPDIR=/var/tmp. The Java CAPS Installer will then use /var/tmp as its temporary directory.


  3. From a command line, navigate to the location of the executable file and run one of the following commands:

    UNIX and Linux: JavaCAPS.bin -i console

    Windows: JavaCAPS.exe -i console

    The text-based Console appears. This might take several minutes.

  4. Read the introduction to the installation, and press Enter to begin the installation.

  5. Read each section of the License Agreement, pressing Enter after each segment. Type Y to accept the terms.

  6. When asked to choose an installation directory, type an absolute path or press Enter to accept the default value that appears on the screen.

    • If a directory by the name you specified already exists, type I to confirm your selection.

    • If the directory by the name you specified already exists and you want to use another directory, type 2.

  7. Choose an installation set.

    • To install all of the Java CAPS components, type 1.

    • To select the components you want to install, type 2, and then enter a comma-separated list of numbers representing the components you do NOT want to install.

      The numbers corresponding to each components are listed on the Console.

  8. When asked to choose a Java Developer Kit (JDK), provide an absolute path to the JDK or press Enter to accept the default value that is listed at the prompt.

  9. Set up the Repository.

    1. Press Enter to accept the default name for the Repository (repository1), or provide a custom value and press Enter.

    2. Press Enter to accept the default port number for the Repository (12000), or provide a custom value and press Enter.

  10. For NetBeans IDE Input, press Enter to accept the default value (to install Repository NBMs), or type 2 and press Enter (Repository NBMs will not be installed).

    If you do not install the Repository NBMS, you will need to manually install them later if you want to use them.

  11. Specify the settings for the GlassFish server.


    Tip –

    Record your selections in this section for later use. To start the GlassFish server you need the administrator user name, password, and master password during the log in process.


    Setting 

    Description 

    Default 

    Admin user name 

    The name you use when you log in as administrator. 

    admin

    Admin password 

    The password you use when you log in as administrator. This password must be a minimum of eight characters. 

    adminadmin

    Master password for the SSL certificate for AS Admin operations 

    The key used to protect data in GlassFish, that is, the password of the secure keystore. This key must be at least 8 characters long. 

    changeit

    Admin port number 

    The port on which GlassFish listens for administrative HTTP requests. 

    4848

    HTTP port number 

    The port on which GlassFish listens for HTTP requests for web applications that you deploy. 

    8080

    Secure HTTPS port number 

    The port on which GlassFish listens for HTTPS requests for web applications that you deploy. 

    8181

    JMS port number 

    The port on which GlassFish listens for JMS IQ Manager requests. 

    7676

    JMX admin port number 

    The port on which GlassFish listens for JMX administration requests. 

    8686

    IIOP port number 

    The port on which GlassFish listens for CORBA requests. 

    3100

    IIOP SSL Port 

    The port on which GlassFish listens for secure CORBA requests. 

    3820

    IIOP Mutual Auth Port 

    The Mutual Authentication IIOP port number for the initial server instance. 

    3920

  12. Specify the settings for the Sun JMS IQ Manager.

    If you do not install the Sun JMS IQ Manager now, you can install the JMS IQ Manager manually to the same or a different GlassFish server after this installation completes.

    1. Enter one of the following operating system indicators:

      solx86

      Sun Solaris 10 x86 (32/64-bit), Intel

      solamd64

      Sun Solaris 10 x86 (64-bit), AMD

      solaris64

      Sun Solaris 10 (64-bit), SPARC

      aix32

      IBM AIX 5L 5.2 and 5.3 (32-bit)

      aix64

      IBM AIX 5L 5.2 and 5.3 (64-bit)

      linux7

      Red Hat Enterprise Linux Advanced Server 3, 4, and 5 (32/64-bit), Intel

      linuxamd64

      Red Hat Enterprise Linux Advanced Server 3, 4, and 5 (64-bit), AMD

      redhat5_64

      Red Hat Enterprise Linux 5 Advanced Server (Intel and AMD x86-64)

      suse8

      SUSE Linux Enterprise Server 9 and 10 (32/64-bit), Intel

      win32

      Windows (32-bit)

      donotinstall

      Does not install the Sun JMS IQ Manager

    2. Press Enter to accept the default Sun JMS IQ Manager port number of 18007, or provide a custom value and then press Enter.

    3. Press Enter to accept the default Sun JMS IQ Manager SSL port number of 18008, or provide a custom value and then press Enter.

    4. If you have a previous version of the Sun JMS IQ Manager, provide an absolute path to the previous directory to migrate it to your current installation directory, or press Enter to skip this step.

  13. Specify the settings for the Enterprise Manager:

    1. Press Enter to accept the default Host Name, or provide a custom value and then press Enter.


      Note –

      The Host Name is the name of the computer on which you are installing Java CAPS. Enterprise Manager relays this name to other components, such as the GlassFish server. These components then use this name to access Enterprise Manager. Although this value is usually the name of the computer Enterprise Manager is running on, you can specify the name of a proxy server.


    2. Press Enter to accept the default Admin Port for Enterprise Manager, or provide a custom value and then press Enter.


      Note –

      The default value is 15000. This port assignment requires five consecutive available ports and the system selects four additional port numbers that sequentially follow the initial port number (15001–15004 for the default). Port checking performed at installation only detects ports in use at that time, so the installation will not detect ports used by other applications that are not currently running. Use caution if you change the default port value.


    After setting the parameters for all the components you are installing, a Pre-Installation Summary appears that lists your selections for this installation.

  14. If you are satisfied with your installation selections, press Enter to continue and then press Enter a second time to begin the installation.


    Note –

    If you are not satisfied with your installation selections, type back and press enter to make the appropriate changes.


  15. After the installation completes, press Enter to exit from the Console Installer.


    Caution – Caution –

    Ensure that you exit from the Console Installer as directed. If you exit the program by pressing CTRL-C, the javacaps_install_log.xml file will not be placed in the installation directory.


    After you exit the Installer, a Sun Product Registration form opens on your browser. You can complete the Java CAPS product registration at that time, or you can return to the registration form at a later time by navigating to the base installation directory and typing register.html at the command prompt.

Links to Additional Installation Information

There are several additional tasks you can perform once you complete the initial installation of Java CAPS. The following sections provide links to information and instructions for these tasks:

Installing Additional Components

After you install Java CAPS, you can install additional Repository-based components using the Java CAPS Uploader and the NetBeans Update Center, and you can download sample files and component tools from the Java CAPS Uploader. You can also use Enterprise Manager to install the required monitoring plugins for each component.

See the following topics for more information and instructions on these procedures:

Starting and Stopping Java CAPS

Java CAPS provides shortcuts to the executable files that start the various components. To start and stop Java CAPS after the initial installation, navigate to the Java CAPS install directory or to the directory where the component is installed that you want to start or stop. Run the appropriate command. The commands are listed at Starting and Stopping Java CAPS in Using the Java CAPS 6 Installation GUI.

Working With the Repository

Once you have installed all components and have a running Repository, you need to connect to the Repository from NetBeans in order to work with Repository components and projects. For information and instructions, see Connecting to the Java CAPS Repository From the NetBeans IDE in Using the Java CAPS 6 Installation GUI.

After you connect to the Repository from NetBeans, you can import projects that were created in previous versions. For information and instructions, see Importing Non-JBI Based Java CAPS Sample Projects in Using the Java CAPS 6 Installation GUI.