This topic provides instructions to successfully install GlassFish ESB 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 attempting an installation, review Planning for GlassFish ESB Installation. It provides pertinent information such as supported platforms, operating system limitations, and parameter definitions. If you have any questions or problems, go to the GlassFish ESB web site at http://www.glassfish-esb.org.
To access all the GlassFish ESB documentation in HTML format, go to the GlassFish ESB web site at http://wiki.open-esb.java.net/Wiki.jsp?page=GlassFishESBDocs.
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 GlassFish ESB.
Before beginning the installation, read Planning for GlassFish ESB Installation, which contains information that is necessary for you to complete a successful install of GlassFish ESB 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 generating the XML state file and then invoking the installation script. The command–line installation performs a complete installation of GlassFish ESB.
Installation ProcessYou can perform a CLI installation in one of three ways. In a default installation, you create a default state file and run the installation all in one step, or you can run the installation without creating a state file. In a custom installation, you create a default state file, customize the state file for your environment, and then run the installation using the updated state file.
To perform an installation using the default settings without creating a state file, follow the instructions under Installing GlassFish ESB Silently Using Default Settings.
To perform an installation using the default setting and create a state file for later use, follow the instructions under Generating the State File for Silent Installations.
To perform an installation using custom settings, follow these instructions in the order given:
Installation Command Summary
You can run the installation command using three combinations of options. The options you use depend on whether you want to generate a state file and whether you need to customize the installation. In the following commands, OS is the operating system, ext is the file extension, and StateFile is the path and name of the state file.
glassfishesb-v2.1-full-installer-OS.extension --silent
This installs GlassFish ESB with the default settings, but does not generate a state file.
glassfishesb-v2.1-full-installer-OS.extension --silent --record StateFile
This generates a state file that you can modify for custom installations and also installs GlassFish ESB with the default settings.
glassfishesb-v2.1-full-installer-OS.extension --silent --stateStateFile
This installs GlassFish ESB using the settings defined in the state file you specified in the command.
Complete Command Line Interface InstallationThe following software is installed:
NetBeansTM IDE 6.5 ML
GlassFish v2.1
Open ESB core components
Java Business Integration (JBI) service engines
Java Business Integration (JBI) binding components
Java Business Integration (JBI) component tooling
Sun Uninstallation software
IDE is an acronym for an integrated development environment. It consists of a number of components, such as a compiler, source code editor, build tools, debugger, browser, object inspector, class hierarchy diagram, and so on. These components can be used when performing object-oriented software development. The integrated tools can also be used to build a graphical user interface (GUI).
Important Installation Notes
GlassFish ESB does not support spaces in the installation directory path.
You must have the JDKTM (Java Development Kit) software installed and JAVA_HOME set prior to installing GlassFish ESB or the Installer will halt the installation. See Installing the JDK Software and Setting JAVA_HOME for details.
If you do not already have the JDK software installed or if JAVA_HOME is not set, the GlassFish ESB installation will not be successful. The following tasks provide the information you need to install the JDK software and set JAVA_HOME on UNIX or Windows systems. To find out which JDK versions are supported for the operating system you are using, see JDK and JAVA_HOME in Planning for GlassFish ESB Installation.
The GlassFish ESB Installer does not support JDK release 1.6.0_04 in the 64–bit version on the Solaris SPARC or AMD 64–bit environments.
Install the JDK software.
Set JAVA_HOME.
Change the permissions to enable you to run the GlassFish ESB Installer.
chmod 755 JavaCAPS.bin
Install the JDK software.
Set JAVA_HOME:
In order to run a custom silent command line installation, you must first generate a state file that stores all of the user-defined installation configuration parameters. This step also performs a default installation. To perform a default installation without generating a state file, skip to Installing GlassFish ESB Silently Using Default Settings
If you want to skip this step, you can download a sample state file that you can customize and use for a custom installation. Sample files are available for multiple operating systems. You can download the files from http://wiki.open-esb.java.net/Wiki.jsp?page=Inst_cli_statefile_t.txt.
Download the installation executable file for your platform from https://open-esb.dev.java.net/Downloads.html.
Navigate to the location of the file.
Run the file from the command line with the --silent and --record options, specifying where you want to save the state file.
For example:
glassfishesb-v2.1-full-installer-solaris-sparc.sh --silent --record /home/glassfishesb/state.xml
A log file is generated in your home directory under /.glassfishesb-v2.1-full-installer-hostname_date/log so you can track the progress of the installation. For Windows, this file is located in \Documents and Settings\user_name.
When the installer is finished, run the GlassFish ESB uninstaller
and remove the GUI installation.
For detailed information about running the GlassFish ESB uninstaller, see Uninstalling GlassFish ESB.
Using a text editor or XML editor, open the state file and modify the installation properties to correspond to your custom requirements.
Ensure that items such as user names, passwords, directories, and so on are correct. You can view a sample state file following these instructions.
Save any changes, and close the state file.
After creating the state file, note the file location and name, and then continue to Installing GlassFish ESB Silently Using Custom Settings.
<?xml version="1.0" encoding="UTF-8"?> <state xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="state-file.xsd"> <properties> <property name="street.address.windows-x86.en_US"/> <property name="country.windows-x86.en_US">United States</property> <property name="company.windows-x86.en_US"/> <property name="password.windows-x86.en_US"/> <property name="email.address.windows-x86.en_US"/> <property name="first.name.windows-x86.en_US"/> <property name="last.name.windows-x86.en_US"/> <property name="register.choice.windows-x86.en_US">skip</property> <property name="zip.code.windows-x86.en_US"/> <property name="city.windows-x86.en_US"/> </properties> <components> <product platform="windows linux solaris-sparc solaris-x86 macosx-ppc macosx-x86" status="to-be-installed" uid="nb-base" version="6.1.0.0.200809090101"> <properties> <property name="start.menu.shortcut.location.windows-x86.en_US">all.users</property> <property name="desktop.shortcut.location.windows-x86.en_US">all.users</property> <property name="jdk.location.windows-x86.en_US">C:\Program Files\Java\jdk1.6.0_07</property> <property name="installation.location">$N{install}/netbeans</property> <property name="installation.location.windows">$N{install}/netbeans</property> <property name="installation.location.macosx">$N{install}/netbeans.app</property> <property name="installation.location.windows-x86.en_US">C:\GlassFishESB\netbeans</property> </properties> </product> <product platform="windows linux solaris-sparc solaris-x86 macosx-ppc macosx-x86" status="to-be-installed" uid="nb-soa" version="6.1.0.0.80909"> <properties> <property name="installation.location.windows-x86.en_US">C:\GlassFishESB\netbeans</property> </properties> </product> <product platform="windows" status="to-be-installed" uid="glassfish" version="9.1.0.4.20080411"> <properties> <property name="admin.port.windows-x86.en_US">4848</property> <property name="jdk.location.windows-x86.en_US">C:\Program Files\Java\jdk1.6.0_07</property> <property name="http.port.windows-x86.en_US">8080</property> <property name="https.port.windows-x86.en_US">8181</property> <property name="password.windows-x86.en_US">adminadmin</property> <property name="installation.location">$N{install}/glassfish</property> <property name="username.windows-x86.en_US">admin</property> <property name="installation.location.windows-x86.en_US">C:\GlassFishESB\glassfish</property> </properties> </product> <product platform="windows linux solaris-sparc solaris-x86 macosx-ppc macosx-x86" status="to-be-installed" uid="openesb" version="2.0.0.80909.0"> <properties> <property name="password.windows-x86.en_US">adminadmin</property> <property name="username.windows-x86.en_US">admin</property> <property name="installation.location.windows-x86.en_US"> C:\GlassFishESB\glassfish\addons\jbi-components</property> </properties> </product> <product platform="windows linux solaris-sparc solaris-x86 macosx-ppc macosx-x86" status="to-be-installed" uid="jbicomponents" version="2.0.0.80909.1"> <properties> <property name="password.windows-x86.en_US">adminadmin</property> <property name="username.windows-x86.en_US">admin</property> <property name="installation.location.windows-x86.en_US"> C:\GlassFishESB\glassfish\addons\jbi-components</property> </properties> </product> </components> </state> |
You can use the GlassFish ESB command-line installation script to perform a complete custom 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.
This process uses the state file you generated and customized earlier.
GlassFish ESB does not support spaces in the installation directory path.
Plan your installation by reading Planning for GlassFish ESB Installation, which contains information necessary for you to complete a successful installation of GlassFish ESB such as supported platforms, operating system limitations, and parameter definitions.
Install the JDK software and set JAVA_HOME. For more information, see Installing the JDK Software and Setting JAVA_HOME
Generate and customize the state file. For more information, see Generating the State File for Silent Installations.
Navigate to the directory where you downloaded the installation executable file.
Run the installation file from the command line with the --silent and --state options, specifying where the state file is located.
For example:
glassfishesb-v2.1-full-installer-windows.exe --silent --state C:\glassfishesb\state.xml
GlassFish ESB is installed in the directory you specified.
A log file is generated in your home directory under /.glassfishesb-v2.1-full-installer-hostname_date/log so you can track the progress of the installation. For Windows, this file is located in \Documents and Settings\user_name.
You can use the GlassFish ESB command-line installation script to perform a complete default 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. When performing a default installation, there is no need to generate the state file first.
If you want to perform a default installation but also generate a state file, perform the steps under Generating the State File for Silent Installations but do not perform the uninstallation step.
Plan your installation by reading Planning for GlassFish ESB Installation, which contains information necessary for you to complete a successful installation of GlassFish ESB such as supported platforms, operating system limitations, and parameter definitions.
Install the JDK software and set JAVA_HOME. For more information, see Installing the JDK Software and Setting JAVA_HOME
Navigate to the directory where you downloaded the installation executable file.
Run the installation file with the --silent option.
For example:
glassfishesb-v2.1-full-installer-windows.exe --silent
GlassFish ESB is installed in the default directory.
A log file is generated in your home directory under /.glassfishesb-v2.1-full-installer-hostname_date/log so you can track the progress of the installation. For windows, this file is located in \Documents and Settings\user_name.
To start NetBeans and the GlassFish server after the initial installation, navigate to the GlassFish ESB install directory or to the directory where the component is installed that you want to start. Run the appropriate command.
Component |
From GlassFish ESB Installation Directory |
---|---|
NetBeans IDE |
Windows GUI: Double-click the NetBeans desktop icon, select NetBeans from the Start menu, or run install-directory\start_netbeans.bat Mac OSX GUI: Select the NetBeans icon in the Dock or double-click NetBeans.app in the GlassFish ESB home directory UNIX: Run the executable file in install-directory/netbeans/bin |
GlassFish Server |
Windows GUI:install-directory\start_glassfish_domain_name.bat Mac OSX GUI:install-directory\start_glassfish_domain_name UNIX:Run asadmin start-domain from install-directory/glassfish/bin Note – You can also start the GlassFish server from the Services tab on the NetBeans IDE. |