C H A P T E R 8 - Setting Up the Java Studio Enterprise IDE

C H A P T E R 8

Setting Up the Java Studio Enterprise IDE

After you have installed the IDE, use the information in this chapter to start, set up, and register your software.

This chapter covers the following topics:

Starting the IDE

Setting Up the IDE

Using the Collaboration Runtime

Using the Startup Options

Java Studio Enterprise IDE User Directory

Troubleshooting During Setup of the IDE

Starting the IDE

At the end of installation of the Tools Components, you see an option to launch the IDE. This option is selected by default on Microsoft Windows machines. It is not recommended for usage on Solaris OS machines, as you might encounter file permission issues.

When you first start the IDE, you are prompted to do the following tasks:

Indicate whether you would like automatic update checking

To Start the IDE (Microsoft Windows Systems)

Use one of these methods:

Double-click the Java Studio Enterprise icon located on your desktop.

Choose Start Programs Sun Microsystems Java Studio Enterprise 7 2004Q4 Start Java Studio Enterprise.

Start the IDE at the command line by following these steps:

1. In the Command Prompt window, change to the installation directory containing the IDE executable. For example

C:\> cd java-studio-install-dir\Ent_04Q4\bin

2. Start the IDE using one of the following commands:

Use runidew.exe to start the IDE with the default launcher used by the desktop icon.

C:\> runidew.exe

To start the IDE and display messages in the Windows Console, type:

C:\> runide.exe

The runide.exe command options can be specified on the command line or in the java-studio-install-dir\Ent_04Q4\bin\ide.cfg file. See Using the Startup Options.

To Start the IDE (Solaris Systems)

1. Change to the installation directory containing the IDE executable. For example:

% cd java-studio-install-dir/Ent_04Q4/bin

2. Start the IDE.

% ./runide.sh

The runide.sh command options can be specified on the command line or in the java-studio-install-dir/Ent_04Q4/bin/ide.cfg file. See Using the Startup Options.

Setting Up the IDE

The IDE has the following wizards that enable you to control aspects of the IDE environment:

Import Settings Wizard

Setup Wizard

Registration Wizard

Import Settings Wizard

The Settings Import wizard appears the first time that you start the IDE if you have previous versions of the IDE on your machine. The wizard enables you to import settings from prior versions of the IDE for use with Java Studio Enterprise. If you do not need to import settings, then select No, and click Start IDE.

Setup Wizard

You can access the Setup wizard by choosing Tools right arrow Setup Wizard from the main IDE window.

In the Setup wizard you can do the following:

Set the IDE display window mode (MDI or SDI)

Specify the web browser to use for internal and external web pages

Set the web proxy settings to use if you are behind a firewall

Use the Module Installation page to enable or disable IDE modules

Use the Update Center page to control the following:

Automatic update checking

Frequency of automatic updates

Update Center URL to check

Registration Wizard

The Registration wizard appears the first time that you start the IDE. This wizard enables you to register with the Sun Developer Resources web site.

Registering your software provides the following benefits:

Access to the Update Center to download and install new modules and updates

Access to preview modules, patches and bug fixes

If you decide to register with Sun Developer Resources at a later time, choose Help right arrow Other Resources Registration Wizard from the main window of the IDE.

To Enable or Disable IDE Modules

1. Choose Tools > Setup Wizard from the main menu.

2. Click Next until the Module Installation page is displayed.

3. Expand the module category node for a list of modules.

Click on the module icon to see a short description of the module function.

4. Disable or enable a module by toggling the Enabled property value to true or false.

By default, all the modules installed with the IDE are enabled except the WebLogic Server Deployment Module (the WebLogic plug-in). For information on enabling this module, look for WebLogic technical articles at http://developers.sun.com/prodtech/javatools/jsenterprise/reference/techart/index.html.

Using the Collaboration Runtime

Sun Java Studio Enterprise 7 2004Q4 introduces new functionality for enterprise collaboration. To enable the collaboration functions in the IDE, install the Collaboration Runtime when you install the IDE from the Tools Components disk (or file) and start it. See Selecting What to Install.

Start the Collaboration Runtime from the Start Menu (Windows) or the command line (Solaris OS). The Collaboration Runtime is configured to start automatically when a Microsoft Windows system is rebooted. You can change this configuration using the Microsoft Windows Control panel. See To Configure Collaboration Runtime (Microsoft Windows).

Once the runtime is started, start the IDE and then create an account from within the IDE. Use the following procedure.

To Enable the Collaboration Functionality

1. After installing the Tools Components, locate and start the runtime script.

(Microsoft Windows) Choose Start Programs Sun Microsystems Java Studio Enterprise 7 2004Q4 Collaboration Runtime Start Runtime.

(Solaris OS)

a. Change to the installation directory containing the executable. For example:

% cd java-studio-install-dir/CollabRuntime/bin

b. Start the Collaboration Runtime process.

% ./xmppd start

You need to be logged in as root to start this process.

2. Start the IDE.

3. Choose Collaborate right arrow Login from the IDE main menu.

The Collaboration window opens at the right-hand side of the IDE.

4. Click Add an account.

The Add Collaboration Account wizard is displayed.

5. Select "I want to register a new account" and click next.

6. Continue through the wizard to the Server Location pane.

Enter the location of the Collaboration Runtime. To confirm the actual port number and location used during your installation, review the Configuration_Data.html file. If you accepted the default installation directory, this file can be found at:

(Microsoft Windows) C:/Sun/jstudio_04Q4/Configuration_Data.html

(Solaris OS) /opt/SUNWjstudio/Configuration_Data.html

The Server Location is of the form, machinename:portnumber. If the default port number was available during installation, this location would be machinename:5222.

To Configure Collaboration Runtime (Microsoft Windows)

The Collaboration Runtime is installed as a Microsoft Windows service. The default setting is to start automatically when your Windows system starts. You can change this setting by following these steps:

1. Choose Start right arrow Settings Control Panel (or Start Control Panel).

The Control Panel dialog box is displayed.

2. Double-click on Administrative Tools.

The Administrative Tools dialog is displayed.

3. Double-click on Services.

4. Scroll down the list of Services and right-click the entry for Java Studio Enterprise 7 Collaboration Runtime.

5. Select properties from the contextual menu and select the Startup type from the drop-down list.

The Runtime default configuration is automatic, so the runtime will be started when Windows starts.

To Change the Collaboration Logging Options

1. Locate the Collaboration Runtime configuration file at:

java-studio-install-dir/CollabRuntime/config/xmppd.conf

2. To turn on debug log, open the configuration file in a text editor and set iim.log.iim_server.severity=DEBUG.

3. The Collaboration Runtime log file can be found at:java-studio-install-dir\CollabRuntime\log\xmppd.log.

To Find Additional Collaboration Documentation

You can find additional documentation for the Collaboration functionality in the IDE's online help.

Click Help Help (by Subject) and then choose the appropriate topic:

Developer Collaboration Help

Developer Collaboration Chat Help

Developer Collaboration Filesharing Help

To Stop the Collaboration Runtime

(Microsoft Windows) Choose Start Programs Sun Microsystems Java Studio Enterprise 7 2004Q4 Collaboration Runtime Stop Runtime.

(Solaris OS)

a. Change to the installation directory containing the executable. For example:

% cd java-studio-install-dir/CollabRuntime/bin

b. Start the Collaboration Runtime process.

% ./xmppd stop

Using the Startup Options

The runide startup scripts can be run with additional command-line options.

You can use the options in the following ways:

Type the options on the command line

Put the options in the java-studio-install-dir/Ent_04Q4/bin/ide.cfg file

The IDE reads the ide.cfg file before parsing any command-line options. You can type options on multiple lines in the ide.cfg file.

TABLE 8-1 lists the runide command-line options.

TABLE 8-1 IDE Startup Options
Option	Description
`-h -help`	Prints a description of the available options and their usage.
`-jdkhome` jdk-home-dir	Specifies the location of a J2SE platform other than the default that was specified during installation.
`-cp:p` additional-classpath	Prepends the specified class path onto the IDE's class path.
`-cp:a` additional-classpath	Appends the specified class path to the IDE's class path.
`-userdir` IDE-user-dir	Specifies the IDE-user-dir (the location where your user settings are stored). If this option is not specified, the default location is used. See Java Studio Enterprise IDE User Directory.
`-J` jvm-flags	Passes specified flags directly to the Java Virtual Machine (JVM⁾software.
`-Xverify:none`	`-J` `-Xverify:none` tells the JVM software not to verify the correctness of the bytecode, thereby providing for faster startup time. Setting this flag removes some of protection that the Java language gives you. Refer to the JVM software documentation for more information.
`-Xms24m`	`-J` `-Xms24m` sets the initial heap size of the JVM software to 24 MB. This flag prevents the JVM software from extending the heap size during startup, thereby providing a faster startup time.
-`Xmx96m`	maximum Java heap size
`-Xss1024k`	Thread stack size
(Microsoft Windows only) `hotspot` or -`classic`	Specifies the Java virtual machine (JVM) variant to be used. The terms "Java virtual machine" and "JVM" mean a virtual machine for the Java platform.
`"-ui"` UI_class_name	Sets the specified UI class as the IDE's look and feel.
`"-fontsize"` size	Sets the font size, expressed in points, in the IDE's user interface. The default value is 11.

Java Studio Enterprise IDE User Directory

The IDE stores user-specific data in the user directory. Examples of this information are IDE settings and options and other necessary runtime data for personal development servers, such as the PointBase Server, UDDI Registry Server and Tomcat. The user directory also contains the ide.log file, which provides useful information when requesting technical support.

The default location for this directory on a Microsoft Windows system %SystemDrive%:\Documents and Settings\user-id\.jstudio\Ent04Q4

On a Solaris system, the default location is $HOME/.jstudio/Ent04Q4.

The minimum space requirement for this directory for initial installation is 5.5 MB. Actual runtime space usage varies depending on your component use within the IDE.

The first time that you start the IDE, you can specify an alternate location for the user directory by starting the IDE from the command line and using the command line -userdir option. See TABLE 8-1 for additional command-line options.

Troubleshooting During Setup of the IDE

This section describes problems you might receive during startup and configuration of the newly installed IDE.

1. You experience performance problems running the IDE.

Reason. You may not have sufficient virtual memory or swap space.

Solution. Increase your virtual memory or swap space to 1.5 to 2 times the amount of your machines's installed RAM.

2. Trying to access links from the IDE Welcome page, you see an exception such as:.

Could not access the URL through the external browser. Check the browser configuration...

Reason. Your external web browser may not be set correctly.

Solution. Follow these steps to set your external browser.

a. Choose Options from the Tools menu.

b. In the Options window, expand the IDE Configuration node.

c. Expand the Server and External Tool Settings node.

d. Expand the Web Browsers node.

e. Select the external browser type and modify the Browser Executable property and the DDE Server property to the proper value for your external browser.

If this does not fix the problem, then follow these steps:

(Windows)

a. Select the Java Studio Enterprise icon on the desktop and right-click.

b. Select properties.

c. Edit the Target field as follows:

C:\ java-studio-install-dir\bin\runidew.exe -userdir pathname-to-user-directory

(Solaris)

Start the IDE from the command line using the startup option -userdir. See also Java Studio Enterprise IDE User Directory.

3. When you select one of the IDE Start Menu items that take you to a web page, you see the following error message:

Error: Cannot find the file C:\Sun\jstudio_04Q4\AppServer7\docs\about.html. Make sure the path and filename are correct and that all required libraries are available.

Reason. This error is a Microsoft Windows error that occurs when using a Netscape browser. If you have Netscape set as the program to open HTML pages, but you don't set Netscape as your default browser, you may see this error.

Solution. Click OK to dismiss the error. Set Netscape as your default browser, or set Internet Explorer as the program to open HTML pages.

4. A subsequent error message appears after dismissing the one described above.

Error: Unable to run this command.

Click OK to dismiss this error. Set Netscape as your default browser.

5. After installing the Tools Components on a Solaris system and selecting the option "Start IDE", you see the following error message:

# java.io.IOException: Permission denied

at java.io.UnixFileSystem.createFileExclusively(Native Method)

at java.io.File.createNewFile(File.java:828)

at org.netbeans.CLIHandler.initialize(CLIHandler.java:358)

at org.netbeans.CLIHandler.initialize(CLIHandler.java:245)

at org.netbeans.Main.execute(Main.java:143)

at org.netbeans.Main.main(Main.java:33)

...

...

...

org.netbeans.core.NbTopManager.get(NbTopManager.java:188)

at org.netbeans.core.Main.start(Main.java:485)

at org.netbeans.core.TopThreadGroup.run(TopThreadGroup.java:90)

at java.lang.Thread.run(Thread.java:534)

Cannot add System filesystem: null, exiting...

Reason. This error mesage indicates that the IDE startup was unsuccessful due to a permissions problem. Most likely, the start IDE option was selected while installing the IDE as a superuser. This does not indicate an installation problem.

Solution. Exit the terminal window and superuser environment. Start the IDE as the standard user.