This topic provides information and instructions for installing the JavaTM Composite Application Platform Suite (Java CAPS) using a graphical user interface (GUI). If you have any questions or problems, see the Java CAPS Support web site at http://goldstar.stc.com/support.
To access all the Java CAPS documentation in PDF or HTML format, see the Java CAPS documentation on DSC or click the HELP tab in Enterprise Manager.
Before beginning the installation, be sure you are familiar with the information in Planning for Java CAPS Installation. It provides important information about installation requirements.
What You Need to Know
What You Need to Do
Installing Java CAPS Components Using the Java CAPS Uploader
Installing Plugins Using Enterprise Manager Web Applications Manager
Connecting to the Java CAPS Repository From the NetBeans IDE
Before beginning the installation, read Planning for Java CAPS Installation, which contains information such as supported platforms, operating system limitations, parameter definitions, and the like. This information is necessary for you to complete a successful installation of Java CAPS.
Complete Graphical User Interface Installation
For a complete list of software installed, see Overview of the Installation Process in Planning for Java CAPS Installation .
Certain adapters require additional installation procedures. For details, see Installing Third-Party JAR Files.
The GUI installation is divided into four installation segments:
The Java CAPS Installer installs the Sun GlassFish Enterprise Server, NetBeans IDE (which installs Java CAPS plugins), a subset of Java CAPS core products and Adapters, Java CAPS Repository, Enterprise Manager, Sun JMS IQ Manager, and the UDDI Server.
The CAPS Repository Update Center in NetBeans IDE downloads modules from the Java CAPS Repository.
If you install NetBeans IDE during the initial installation, you do not need to download modules yourself until updates become available or until you install additional Repository-based components.
After the above automated steps, you can use the Java CAPS Uploader (formerly known as the Suite Installer) to upload additional Java CAPS Repository-based components. These components include all SAR files that were not installed using the Java CAPS Installer. The Uploader also enables you to download and extract ZIP files. After uploading the components, you need to install them in NetBeans using the Update Center.
You can use the Java CAPS Enterprise Manager Web Applications Manager to install Java CAPS component plugins. These plugins are listed under the Downloads tab in the Java CAPS Uploader, and include adapter plugins, as well as plugins for other product components, such as the Web Services, Composite Page Designer, and Business Process Manager.
You do not have to install all of the software and components at the same time. You can install additional Java CAPS products and components at any time after completing the initial installation using the NetBeans IDE Update Center and Java CAPS Uploader and selecting the items from a list.
The process also installs the Sun Uninstallation software.
You must have the JDKTM (Java Development Kit) software installed and JAVA_HOME set prior to installing Java CAPS 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 Java CAPS 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.
For a list of supported JDK versions for each operating system, see Java CAPS Supported JDK Versions in Planning for Java CAPS Installation .
Install the JDK software.
Set JAVA_HOME.
Change the permissions to enable you to run the Java CAPS Installer.
chmod 755 JavaCAPS.bin
Install the JDK software.
To set JAVA_HOME:
This procedure installs the GlassFish ES, NetBeans IDE, Java CAPS core products such as the Sun Enterprise Service Bus, and Java CAPS add-on components such as adapters, Sun Java Repository version 6, Sun Java Enterprise Manager version 6, Sun JMS IQ Manager version 6, and the UDDI Server using Java CAPS Installer. The Sun Uninstallation software is also installed.
Although you can change the defaults, accepting most of them is a good practice, especially the port numbers.
Java CAPS Release 6 does not support spaces in the installation directory path.
Certain adapters require additional installation procedures. For details, see Installing Third-Party JAR Files.
Install Sun Java SDK. For more information, see Installing the JDK Software and Setting JAVA_HOME.
On UNIX systems, set the DISPLAY variable to install in GUI mode. How you do this depends on how you connect to your system.
If you receive the error message “No X11 DISPLAY variable was set, but this program performed an operation which requires it” and you use the SSH command to connect to your system from another UNIX machine, you need to set the DISPLAY variable. For example,
C shell with localhost as the host name
setenv DISPLAY localhost:0.0
Korn shell with localhost as the host name
DISPLAY localhost:0.0
export DISPLAY
If you use X Windows software, such as Exceed, the DISPLAY variable is set for you automatically.
Do not use telnet if you install on a Windows system.
A security alert may appear during installation. If so, unblock the tagged program to continue the installation.
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
For some operating systems, the installation files are packaged inside a ZIP file. Extract JavaCAPS.zip to a temporary directory.
If a /tmp directory is not accessible or there is not enough space to extract the installation files and install, the Java CAPS Installer asks for a new directory.
Exit from all programs prior to beginning the installation.
You can cancel the installation at any time during the process.
To start the installation, initiate the appropriate executable file:
UNIX or Linux: sh JavaCAPS.bin
Macintosh: JavaCAPS.app or sh ./JavaCAPS.app
Windows: JavaCAPS.exe
When the Java CAPS Installer wizard appears, click Next on the Introduction page to begin the installation.
Use the Next and Previous buttons to navigate forward and backward in the installation.
On the License Agreement page select “I accept the terms of the License Agreement” and then click Next.
On the Choose Install Directory page, accept the default or click Choose to browse to another directory and then click Next.
Java CAPS Release 6 does not support spaces in the installation directory path.
If you select the default directory and it does not exist, the Installer creates it for you. If you select another directory and want to return to the default directory, click Restore Default Folder.
On the Choose Install Set page, select the type of installation you want to perform (Complete or Custom) and then click Next.
If you selected Custom, on the Choose Components page deselect any of the components you do not want to install, and then click Next.
You should install all the components. Sun JMS IQ Manager is required if you have Projects from any product releases between version 5.0.5 and version 5.1.3. The JMS IQ Manager is not an option on Macintosh installations.
On the Choose Java Developer Kit (JDK) page, accept the default location or click Choose to navigate to the directory where your JDK software is located and then select it. Click Next.
You need to select a JDK directory and not a Java Runtime Environment (JRETM); otherwise you cannot install or configure GlassFish.
On the Java CAPS Repository Input page, accept the default port number or enter a new port number, and then click Next.
The default value is 12000. This port assignment requires ten consecutive available ports, and during installation the system selects nine additional port numbers that sequentially follow the initial port number (12001–12009 for the default). Port checking only detects ports in use at the 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.
On the NetBeans IDE Input page, deselect Install Repository NBMs only if you do not want to install Repository–based Java CAPS components such as Adapters. Click Next.
On the Sun Java System Application Server Input page, accept or change the defaults and then click Next.
This server is the GlassFish Java EE and JBI server on which you create and deploy Java CAPS applications. The fields are described below.
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. |
adminadmin |
Master password for the SSL certificate for AS Admin operations |
The key used to protect data in the GlassFish ES, that is, the password of the secure keystore. The password 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 |
Secure IIOP port number for the initial server instance |
The port on which the GlassFish listens for secure CORBA requests. |
3820 |
Mutual Authentication IIOP port number for the initial server instance |
3920 |
Record the administrator name, password, and master password, as well as the port numbers, for later use. You need the passwords when starting the GlassFish Admin Console, among other things.
On the Sun JMS IQ Manager Input page, specify how to install JMS IQ Manager.
Use the JMS IQ Manager for Java CAPS projects that require the same messaging behavior found in releases 5.0.5 through 5.1.3. It can be installed in addition to JMQ, the JMS server that ships with GlassFish. You can also install JMS IQ Manager manually to a different instance of GlassFish after this installation completes.
The JMS IQ Manager is not an option on Macintosh systems.
Select the operating system for the JMS IQ Manager.
The Sun JMS IQ Manager uses native binaries, which are different for different operating systems and processor architectures. Choose the binary that matches the platform on which you want to install JMS IQ Manager.
Specify the Port number that JMS IQ Manager will listen on or accept the default.
Specify the SSL port number that JMS IQ Manager will listen on or accept the default.
To migrate the JMS IQ Manager from a previous version of Java CAPS, type the root directory of the previous installation in the Migration From Directory field.
Click Next.
On the Java CAPS Enterprise Manager Input page, specify the Host Name and Admin Port or accept the default values. Click Next.
The Host Name is the name of the computer on which you are installing. Although this is usually the name of the computer Enterprise Manager is running on, you can specify the name of a proxy server.
The Admin Port is the port on which Enterprise Manager listens to HTTP requests.
The default value is 15000. This port assignment requires five consecutive available ports. During installation, the system selects four additional port numbers that sequentially follow the initial port number (15001–15004 for the default). Port checking only detects ports in use at the 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.
Record the port number for later use.
On the Pre-Installation Summary page, click Install if you are satisfied with your selections. Otherwise, use the Previous button to change your selections.
If a firewall blocks any of the components from installing, remove the block and continue installing the component.
The Installing Java CAPS page appears.
When the Installation Complete page appears, read the comments before you click Done to exit the Installer.
Java CAPS is configured for your system. For additional details about the installation, see the installation logs, located .
The Java CAPS Installer closes and a “Register Now!” page opens on your browser. When you register Java CAPS with the Sun Developer Network, the following benefits become available to you:
Notification of new versions, patches, and updates
Special offers on Sun developer products, services, and training
Access to early releases and documentation
Ability to track and manage your registered products on the Sun Inventory site
Register Java CAPS.
(Optional) If you do not already have a Sun account, under Create An Account click Sign Up Now to Register for a Sun Online Account.
The Registration form appears and asks for general information, such as name, email address, and so on. It requires that you set up a password for your account. Once you have filled out the form to your satisfaction, click Submit.
You must have a Sun account set up before you can register Java CAPS and receive the benefits of registration.
To register, under Use My Account, enter your User Name and Password, select “I accept the terms of use for registering Sun programs,” and click Register Now.
You can register at a later time. To do this, navigate to the base directory where you installed Java CAPS and initiate register.html. When a Sun Product Registration screen appears, click Register to access the “Register Now!” page.
If you deselected Install Repository NBMs on the NetBeans IDE Input page, you can install them now. See Installing Components Using the NetBeans IDE Update Center for details.
However, if you chose to install the Repository NBMs as part of the initial Java CAPS installation, all the modules have already been downloaded from the Repository to the NetBeans IDE.
This procedure installs Java CAPS Java EE components using the NetBeans IDE Update Center. These JBI-based Java CAPS components do not require a Repository.
If you ran the Java CAPS Installer without installing the Repository NetBeans modules (NBMs), those components were downloaded to the Repository but were not installed in NetBeans. You can add those components to NetBeans at any time. You can also install additional NetBeans components and community-developed components.
Certain adapters require additional installation procedures. For details, see Installing Third-Party JAR Files.
This task assumes that you have installed the NetBeans IDE and a Java CAPS Repository.
To start Repository and NetBeans IDE, navigate to the base directory where you installed Java CAPS and start the appropriate executable files.
From the NetBeans IDE menu bar choose Tools and then Plugins.
On the Plugins window, click the Settings tab.
In the Configuration of Update Centers panel, select the type of components you want to install. To install the Java CAPS Repository NBMs, select CAPS Repository Update Center. If CAPS Repository Update Center does not appear in the list, do the following:
On the Settings page, click Add.
The Update Center Customizer dialog box appears.
In the Name field, enter CAPS Repository Update Center.
In the URL field, enter the following:
http://HostName:PortNo/repository/RepName/data/files/InstallManager/catalog.xml
where HostName is the name of the Repository server (or localhost), PortNo is the Repository base port number, and RepName is the name of the Repository.
Click OK.
You might need to click Reload Catalog on the Installed tab in order to see the available Java CAPS plugins.
Click the Available Plugins tab.
Select the individual components to install, or right-click any of the entries and select Check All.
If you installed the Repository NBMs, there will be no available plugins for the CAPS Repository Update Center. These components were installed during the Java CAPS installation.
Click Install.
On the NetBeans IDE Installer, click Next, accept the license, and click Install.
Ignore any validation or unsigned warnings and continue with the installation.
When the installation completes, click Finish.
If an additional wizard appears before NetBeans IDE refreshes, follow the onscreen steps to install the plugin.
Use the Java CAPS Uploader to install additional Repository-based Java CAPS components. These components include all SAR files that were not installed using the Java CAPS Installer or the NetBeans IDE Update Center. The Uploader also enables you to download and extract ZIP files that are associated with or required for certain components.
The Enterprise Manager SVG Plugin for win32 is required when you use Internet Explorer and you want the Connectivity Map in Enterprise Manager to be able to zoom in and out. If you use Internet Explorer and do not install the SVG plugin, Enterprise Manager uses the JavaScriptTM language to display the Connectivity Map instead of SVG and does not have zoom-in and zoom-out capabilities. The Enterprise Manager SVG Plugin for win32 is located under Auxiliary in the Java CAPS Uploader. Firefox has a built-in SVG and does not require the plugin.
Certain adapters require additional installation procedures. For details, see Installing Third-Party JAR Files.
This task assumes that you have installed the Repository using the Java CAPS Installer. The Java CAPS Uploader installs non-JBI based Java CAPS components that require a Repository.
Start the Repository by navigating to the directory where you installed Java CAPS and starting the appropriate executable file.
In a browser window, go to http://HostName:PortNumber, where:
HostName is the TCP/IP host name of the server where you installed the Repository and not the name of the Repository itself.
PortNumber is the port number that you specified during the installation of the Repository.
On the Java CAPS Uploader login page, enter your username and password.
The defaults are admin for username and adminadmin for password.
The Java CAPS Uploader displays a list of components you have already installed.
To install additional Java CAPS components, select Click to Install Additional Products.
Under Select Java Composite Application Platform Suite Products to Install, expand a Product Name category such as Core Product or OTD.
Make your selections by selecting the box to the left of the component.
“eGate” and “eWay” are pre-Release 6 terms. To see their current equivalents, refer to Planning for Java CAPS Installation.
When you have selected all the components you want to install, click Next.
On the Selecting Files to Install page, browse to and select the appropriate SAR file, and then click Next.
For information about the location of the SAR files, see Planning for Java CAPS Installation.
If you decide you do not want to upload a particular component, click Skip to move on to the next component. However, sometimes you cannot skip an upload due to dependencies.
Repeat the previous step until you have selected all the necessary SAR files.
The Java CAPS Uploader uploads the selected components to the Repository.
To complete the installation, follow the steps under Installing Components Using the NetBeans IDE Update Center to install the new components to the NetBeans IDE.
Some Java CAPS components are delivered as ZIP files. When you copy the Java CAPS executable file to your installation directory, these ZIP files become available under the Downloads tab in the Java CAPS Uploader. For some components, tools or sample files are also delivered in this manner.
See Installing Plugins Using Enterprise Manager Web Applications Manager for information about how to install adapter plugins and some of the other plugins listed under the Downloads tab.
This task assumes that the Repository is running and that you have started the Java CAPS Uploader.
From the Java CAPS Uploader, click the Downloads tab.
A list of components that are available to download from the Repository appear.
This example downloads the Command Line Codegen.
In the list of components to download, click a component to download and extract, such as CommandLineCodegen.
On the dialog box that appears, choose to save or open the file.
If you saved the file, open it in an extraction program, such as WinZip.
Extract all the files to a target directory.
For example, you might extract the files to InstallDirectory\repository, where the InstallDirectory is the directory where you installed Java CAPS.
This procedure installs Java CAPS component plugins using the Java CAPS Enterprise Manager Web Applications Manager. These plugins are listed under the Downloads tab in the Java CAPS Uploader, and include adapter plugins as well as plugins for other product components, such as Web Services, Composite Page Designer, and Business Process Manager. You do not need to manually download these files; the Enterprise Manager accesses them directly from the Repository.
This task assumes that you have started Enterprise Manager.
Start Enterprise Manager by navigating to the directory where you installed Java CAPS and starting the appropriate executable file.
In a browser window, go to http://HostName:PortNumber, where:
HostName is the TCP/IP host name of the server where you installed Enterprise Manager.
PortNumber is the port number that you specified for Enterprise Manager during installation (the default port number is 15000).
In the Explorer pane on the left, click the Configuration icon.
A series of tabs appears in the right pane.
In the right pane, click the Web Applications Manager tab.
The Specify Repository Connection Properties page appears.
Enter the following values:
Host Address – The Repository address in the format http://HostName:PortNumber, where HostName is the name of the computer where the Repository is installed, and PortNumber is the Repository port number (12000, by default).
User Name – The Java CAPS administrator user name.
Password – The Java CAPS administrator password.
Click Connect.
A table appears with a list of plugins that are available to install.
Select the application plugins you want to install or click Select All.
Click Install.
After installation is complete, the results appear at the bottom of the page.
To start or 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.
Component |
From Java CAPS Installation Directory |
From Component Installation Directory |
---|---|---|
GlassFish Enterprise Server |
UNIX – sh start_appserver_domain1.sh UNIX – sh stop_appserver_domain1.sh Windows GUI – start_appserver_domain1 Windows GUI – stop_appserver_domain1 Windows CLI – start start_appserver_domain1 Windows CLI – start stop_appserver_domain1 | |
Repository |
UNIX – sh start_repository.sh UNIX – sh stop_repository.sh Windows GUI – start_repository Windows GUI – stop_repository Windows CLI – start start_repository Windows CLI – start stop_repository |
UNIX directory – install-directory/repository/repository CLI – sh startserver.sh CLI – sh stopserver.sh Windows directory – install-directory\repository\repository GUI – startserver.bat GUI – stopserver.bat
CLI – start startserver CLI – start stopserver |
Enterprise Manager |
UNIX – sh start_emanager.sh UNIX – sh stop_emanager.sh Windows GUI – start_emanager Windows GUI – stop_emanager Windows CLI – start start_emanager Windows CLI – start stop_emanager |
UNIX directory – install-directory/emanager CLI – sh startserver.sh CLI – sh stopserver.sh Windows directory – install-directory\emanager GUI – startserver.bat GUI – stopserver.bat CLI – start startserver CLI – start stopserver |
NetBeans IDE |
Windows GUI – start_netbeans Windows CLI – start start_netbeans To stop NetBeans click “X” in title bar |
Windows directory – install-directory\netbeans\bin GUI – netbeans.exe CLI – start netbeans |
Note – Windows provides a Repository Service Manager. To open it, navigate to install-directory\repository\repository and invoke servicemanager.bat to open the Sun Java CAPS Repository Server Service Manager dialog box. Use the dialog box options to install and uninstall services, and to start and stop the Repository Server. |
To work with Repository-based components in the NetBeans IDE, you need to connect to the Java CAPS Repository from within the NetBeans IDE.
This procedure assumes that the NetBeans IDE is running and that the Java CAPS Repository has been installed and is running.
On the NetBeans IDE tool bar, select Tools, point to CAPS Repository, and then click Connect.
On the Connect to Java CAPS Repository page, ensure that the information in the Repository URL field matches the Repository configuration you set during the installation.
Deselect the Remember Password box if you want to provide the password each time you log on to the Repository.
Click Connect.
If you have a security system, unblock any programs that are blocked, such as Sun JMS IQ Manager.
You are now ready to work with Repository-based components and with the CAPS Repository Update Center if you need to install any additional Java CAPS components.
Sample projects are available for implementation and product training. You can import the sample project files from the Sun Java Caps Tutorials page on the Sun Developers Network (SDN) web site at http://developers.sun.com/docs/javacaps/tutorials/samples.jsp.
For some components, such as the TCP/IP HL7 Adapter, the samples are available from the Downloads tab of the Java CAPS Uploader.
Make sure that the Java CAPS Repository is running and that all necessary components have been uploaded through the Java CAPS Uploader and installed through the NetBeans Update Center. Save all unsaved work before proceeding.
In a browser window, go to the Sun Java CAPS Tutorials page on the SDN web site (http://developers.sun.com/docs/javacaps/tutorials/samples.jsp).
The Tutorials page provides a list with links to each available sample.
Select the Sample Project Zip File link and save the archive file on your local machine.
Remember where you saved the file.
Start the NetBeans IDE and connect to the running Repository:
In the NetBeans IDE, select Tools->CAPS Repository->Import Project.
On the Import Project dialog box, click Yes.
The Import Manager appears.
In the From ZIP File field, browse to the location of the sample project archive file.
Some of the sample ZIP files might need to be extracted in order to access the ZIP file for the actual sample Project.
In the Destination Project field, select As Top-Level to import the Project at the top level, or select the name of an existing project to import it into.
Click Import.
When the sample project has successfully imported, click Close.
Repeat the above steps for other project files you want to import.