[jbosstools-commits] JBoss Tools SVN: r22024 - trunk/documentation/guides/GettingStartedGuide/en-US.

Author: smukhina Date: 2010-05-11 15:36:49 -0400 (Tue, 11 May 2010) New Revision: 22024 Modified: trunk/documentation/guides/GettingStartedGuide/en-US/getting_started.xml Log: TOOLSDOC-30 - fixing links Modified: trunk/documentation/guides/GettingStartedGuide/en-US/getting_started.xml =================================================================== --- trunk/documentation/guides/GettingStartedGuide/en-US/getting_started.xml 2010-05-11 19:19:40 UTC (rev 22023) +++ trunk/documentation/guides/GettingStartedGuide/en-US/getting_started.xml 2010-05-11 19:36:49 UTC (rev 22024) @@ -1,917 +1,917 @@ -<?xml version="1.0" encoding="UTF-8"?> -<chapter id="getting_started" xreflabel="getting_started"> - <?dbhtml filename="getting_started.html"?> - <chapterinfo> - <keywordset> - <keyword>JBoss Developer Studio</keyword> - <keyword>Eclipse</keyword> - <keyword>Java</keyword> - <keyword>JBoss</keyword> - </keywordset> - </chapterinfo> - <title>Getting Started with JBoss Developer Studio</title> - - <section id="intro1"> - <title>What is JBDS?</title> - <para><property>JBoss Developer Studio</property> is a set of eclipse-based development tools that - are pre-configured for JBoss Enterprise Middleware Platforms and Red Hat Enterprise Linux. - Developers are not required to use <property>JBoss Developer Studio</property> to develop on - JBoss Enterprise Middleware and/or Red Hat Linux. But, many find these pre-configured tools offer - significant time-savings and value, making them more productive and speeding time to deployment.</para> - <para>This guide covers the first steps to get started working with <property>JBoss Developer - Studio</property>. You will learn how to install and configure necessary software for your OS - (currently Linux, Microsoft Windows or Mac OSX).</para> - <para>Thus this guide will provide you with detailed info on how to start JDK, JBDS and JBoss - Tools.</para> - </section> - -<section> - <title>Key Features of JBoss Developer Studio and Requirements</title> - <para>For a start, we propose you to look through the table of main features of JBoss Developer Studio:</para> - - <table> - - <title>Key Functionality of JBoss Developer Studio</title> - <tgroup cols="2"> - - <colspec colnum="1" align="left" colwidth="2*"/> - <colspec colnum="2" colwidth="4*"/> - - - <thead> - <row> - <entry>Feature</entry> - <entry>Benefit</entry> - - </row> - </thead> - - <tbody> - - <row> - <entry><para>JBoss Enterprise Application Platform</para></entry> - <entry><para>JBoss Developer Studio includes and integrates JBoss Enterprise Application Platform, the same version of the middleware platform that Red Hat supports in production for 5 years.</para></entry> - </row> - - <row> - <entry><para>New Seam Tools</para></entry> - <entry><para>JBoss Developer Studio includes brand new tools for Seam. They provide wizards for creating new Seam projects, validation tools, expression language code completion, testing tools, and wizards for generating entity objects.</para></entry> - </row> - - <row> - <entry><para>Visual Page Editor</para></entry> - <entry><para>JBoss Developer Studio includes a Visual Page Editor for combined visual and source editing of Web pages. The Visual Page Editor even renders AJAX-enabled RichFaces components.</para></entry> - </row> - - <row> - <entry><para>AJAX Capabilities</para></entry> - <entry><para>JBoss Developer Studio includes a Technology Preview of JBoss RichFaces. RichFaces provides nearly 70 skinnable components, including calendar, tree, dropdown menu, drag-and-drop components, and more. JBoss Developer Studio’s Visual Page Editor can render RichFaces components.</para></entry> - </row> - - <row> - <entry><para>JBoss Tools Palette</para></entry> - <entry><para>The JBoss Tools Palette contains a developer’s project tag libraries and enables inserting tags into a JSP with one click. The Tools Palette supports custom and 3rd party tags.</para></entry> - </row> - - <row> - <entry><para>JBoss jBPM Tools</para></entry> - <entry><para>JBoss Developer Studio includes jBPM tooling for defining Seam page flows.</para></entry> - </row> - - <row> - <entry><para>Spring Tools</para></entry> - <entry><para>JBoss Developer Studio includes Spring IDE for developing Spring applications.</para></entry> - </row> - - <row> - <entry><para>Struts Tools</para></entry> - <entry><para>JBoss Developer Studio includes Struts tools for Struts 1.x applications.</para></entry> - </row> - - <row> - <entry><para>Optimized JBoss Application Server adapter</para></entry> - <entry><para>JBoss Developer Studio’s advanced JBoss AS adapter includes features like incremental deployment for fast development and is pre-configured for the included JBoss Application server.</para></entry> - </row> - - <row> - <entry><para>Red Hat Enterprise Linux and RHN Access</para></entry> - <entry><para>JBoss Developer Studio includes access to Red Hat Enterprise Linux, Linux development tools, and Red Hat Network for development purposes.</para></entry> - </row> - - <row> - <entry><para> Project Examples</para></entry> - <entry><para> Tooling for easy installation of Examples.</para></entry> - </row> - - <row> - <entry><para>JBossWeb Service</para></entry> - <entry><para>JBoss WS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para></entry> - </row> - </tbody> - </tgroup> - </table> - - <para><property>JBDS</property> requires JDK 5+ (JDK 6 in case of EAP 5.0). Also it&apos;s important that - the JVM&apos;s architecture matches the particular <property>JBDS</property> build, i.e. if you&apos;re on a - 64-bit system and use the 64-bit JVM, you need the 64-bit JBDS.</para> - - <para>For the 32-bit version of JBDS use the 32-bit JVM or just use <literal>-vm</literal> flag to - tell JBDS to use 32-bit java if the 64-bit one is found as the default.</para> - - <note> - <title>Note:</title> - <para>On Linux system with 64-bit JVM the visual editor may fail to start. In this case you need the <literal>libstdc++.so.5</literal> library. - See also the <link linkend="question_1">FAQ</link>.</para> - </note> -</section> - - <section id="ConfigJavaEnvironment"> - <?dbhtml filename="ConfigJavaEnvironment.html"?> - <title>Configuring Your Java Environment</title> - <para>You must have a working installation of JDK before you install <property>JBoss Developer - Studio</property>. Thus in this - guide we will show you how to install a 32-bit Sun JDK 5.0 on a Linux Platform and Microsoft - Windows Platform.</para> - - <section id="InstallJDK50onLinux"> - <title>Installing and Configuring 32-bit Sun JDK 5.0 on Linux</title> - <para>To install 32-bit Sun JDK 5.0 on Linux and configure it, you should follow the next steps:</para> - <itemizedlist> - <listitem> - <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 - (Java 2 Development Kit)</ulink> from Sun&apos;s website. Choose &quot;JDK 5.0 Update - &lt;x&gt;&quot; (where &quot;x&quot; is the latest update number) for - download and then select &quot;Red Hat Package Manager in self-extracting&quot; file - for Linux. Read the instructions on Sun&apos;s website for installing the JDK.</para> - </listitem> - <listitem> - <para>If you don&apos;t want to use SysV service scripts you can install the - &quot;self-extracting file&quot; for Linux instead of choosing the &quot;RPM in - self-extracting&quot; file. In that case you can skip the next step mentioned here. But it - is recommended to use the SysV service scripts for production servers.</para> - </listitem> - <listitem> - <para>Download and install the appropriate -compat RPM from JPackage <ulink url="ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-f...;. - Please ensure you choose a matching version of the -compat package to the JDK you've - installed.</para> - </listitem> - <listitem> - <para>Create an environment variable that points to the JDK installation directory and call it - JAVA_HOME. Add <emphasis> - <property>$JAVA_HOME/bin</property> - </emphasis> to the system path to be able to run java from the command line. You can do this - by adding the following lines to the .bashrc file in your home directory.</para> - <programlisting><![CDATA[#In this example /usr/java/jdk1.5.0_11 is the JDK installation directory. -export JAVA_HOME=/usr/java/jdk1.5.0_11 -export PATH=$PATH:$JAVA_HOME/bin]]></programlisting> - </listitem> - </itemizedlist> - - <note> - <title>Note:</title> - - <para>If you have JDK already installed and added in your system path, you should add - <emphasis>$JAVA_HOME/bin</emphasis> before the old <emphasis>$PATH</emphasis> (not after it) - so that the new version of JDK can be found first, i. e. <emphasis> - <emphasis>export PATH=$JAVA_HOME/bin:$PATH</emphasis> - </emphasis> This way, the machine will pick up the new JVM first. You only need to run - "alternative" as a safe guard for the right JVM. </para> - </note> - - <para>Set this variable for your account doing the installation and also for the user account - that will run the server.</para> - <itemizedlist> - <listitem> - <para>If you have more than one version of JVM installed on your machine, make sure you are - using the JDK 1.5 installation as the default java and javac. You can do this using the - alternatives system. The alternatives system allows different versions of Java from different - sources to co-exist on your system.</para> - </listitem> - </itemizedlist> - <section id="SelectAlternativesforJava"> - <title>Select alternatives for java, javac and java_sdk_1.5.0</title> - <itemizedlist> - <listitem> - <para>As a root user, type the following command at the shell prompt and you should see - something like this:</para> - </listitem> - </itemizedlist> - <programlisting><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config java -There are 2 programs that provide 'java'. -Selection Command ------------------------------------------------ - 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java -*+ 2 /usr/lib/jvm/jre-1.5.0-sun/bin/java -Enter to keep the current selection[+], or type selection number:]]></programlisting> - <para>Make sure the Sun version [jre-1.5.0-sun in this case] is selected (marked with a - &apos;+&apos; in the output), or select it by entering its number as prompted.</para> - <itemizedlist> - <listitem> - <para>Repeat the same for javac and java_sdk_1.5.0.</para> - </listitem> - </itemizedlist> - <programlisting><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config javac -There is 1 program that provides 'javac'. - Selection Command ------------------------------------------------ -*+ 1 /usr/lib/jvm/java-1.5.0-sun/bin/javac -Enter to keep the current selection[+], or type selection number: - -[root@vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.5.0 -There is 1 program that provide 'java_sdk_1.5.0'. - Selection Command ------------------------------------------------ -*+ 1 /usr/lib/jvm/java-1.5.0-sun -Enter to keep the current selection[+], or type selection number:]]></programlisting> - <para>You should verify that java, javac and java_sdk_1.5.0 all point to the same manufacturer - and version.</para> - <note> - <title>Note:</title> - <para>You can always override this step by setting the JAVA_HOME environment variable as - explained in the previous step.</para> - </note> - <itemizedlist> - <listitem> - <para>Make sure that the java executable is in your path and that you are using an appropriate - version. To verify your Java environment, type &quot;java -version&quot; at the shell - prompt and you should see something like this:</para> - </listitem> - </itemizedlist> - <programlisting><![CDATA[[root@vsr ~]$ java -version -java version "1.5.0_11" -Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_11-b03) -Java HotSpot(TM) Client VM (build 1.5.0_11-b03, mixed mode, sharing)]]></programlisting> - </section> - - </section> - <section id="InstallJDK50onWindows"> - <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Windows</title> - - <para>To install and configure 32-bit Sun JDK 5.0 on Microsoft Windows, follow these steps:</para> - <itemizedlist> - <listitem> - <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 - (Java 2 Development Kit)</ulink> from Sun&apos;s website. Choose &quot;JDK 5.0 Update - &lt;x&gt;&quot; (where &quot;x&quot; is the latest update number) for - download and then select your Windows Platform options to perform the installation.</para> - </listitem> - <listitem> - <para>Create an environment variable called JAVA_HOME that points to the JDK installation - directory, for example: - <emphasis>C:\Program Files\Java\jdk1.5.0_11\</emphasis> - </para> - </listitem> - </itemizedlist> - - <para>In order to run java from the command line, add the <emphasis>jre\bin</emphasis> directory - to your path, for example:</para> - <para> - <emphasis>C:\Program Files\Java\jdk1.5.0_11\jre\bin</emphasis> - </para> - <para>To do this, open the <emphasis> - <property>Control Panel</property> - </emphasis> from the <emphasis> - <property>Start</property> - </emphasis> menu, switch to Classic View if necessary, open the System Control Panel applet (<emphasis> - <property>System</property> - </emphasis>), select the <emphasis> - <property>Advanced</property> - </emphasis> Tab, and click on the <emphasis> - <property>Environment Variables</property> - </emphasis> button.</para> - <para>Now, when 32-bit Sun JDK 5.0 has been successfully installed, we can pass on to the next - step.</para> - </section> - - </section> - - <section id="InstallingJBDS"> - <?dbhtml filename="InstallingRHDS.html"?> - <title>JBoss Developer Studio Installation</title> - - <para>This chapter will provide you with detailed information on how to install <property>JBoss - Developer Studio</property>.</para> - - <para>JBDS comes with a simple installer, bundled with tested/pre-configured versions of Eclipse, - WTP, JBossEAP, Seam, and SpringIDE. Thus, to start perform the next steps:</para> - - <itemizedlist> - <listitem> - <para>First of all you need the appropriate installation file for your platform from - <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_st... Hat - website</ulink>.</para> - </listitem> - <listitem> - <para>Then run in console:</para> - <programlisting role="JAVA"><![CDATA[java -jar jbdevstudio-eap-linux-gtk-3.0.0.GA.jar -]]></programlisting> - </listitem> - <listitem> - <para>Follow the instructions presented by the installation wizard:</para> - </listitem> - </itemizedlist> - - <figure> - <title>JBoss Developer Studio Installation Wizard</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_1.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>Provide the installation path</para> - </listitem> - <listitem> - <para>Select Java VM</para> - </listitem> - </itemizedlist> - - <figure> - <title>Select Java VM</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_2.png"/> - </imageobject> - </mediaobject> - </figure> - - <tip> - <title>Tip:</title> - <para>By selecting <emphasis> - <property>Default Java VM</property> - </emphasis> you set default Java VM of your system (to verify your Java environment, type - &quot;java -version&quot; in console).</para> - </tip> - - <para>Selecting <emphasis> - <property>Specific Java VM</property> - </emphasis> you can provide the path to non-default Java VM.</para> - - <note> - <title>Note:</title> - <para>JBoss Developer Studio 3.0 comes integrated with JBoss EAP 5.0 that requires JDK 6.0 to run - and &quot;gij&quot; isn&apos;t available on every platform.</para> - </note> - - <itemizedlist> - <listitem> - <para>Installation process includes <ulink url="http://www.jboss.com/products/platforms/application">JBoss Enterprise Application - Platform</ulink>. Select <emphasis> - <property>Yes</property></emphasis> to use it in JBoss Developer Studio.</para> - <note> - <title>Note:</title> - <para>Like in the previous version of JBDS, JBDS 3.0.0.GA comes integrated with JBoss EAP 5.0 - that supports EAP 5 adapter and Seam 2.2.</para> - </note> - - <para>This step lets you configure locally available JBoss Application Servers: </para> - </listitem> - </itemizedlist> - - <figure> - <title>JBoss Enterprise Application Platform Installing</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_3.png"/> - </imageobject> - </mediaobject> - </figure> - -<itemizedlist> - <listitem><para>You can fill the list automatically using the <emphasis><property>Find</property></emphasis> button: click <emphasis><property>Find</property></emphasis>, select a folder where search of available JBoss Application Servers should be started and click on <emphasis><property>Ok</property></emphasis>: </para> </listitem> -</itemizedlist> - - <figure> - <title>Finding Servers in the Selected Directory</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_3_3_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para/> - - <itemizedlist> - <listitem><para> All available servers in the selected directory will be added to the list with the following information specified: Name, Type, Version and Location. - </para></listitem> - </itemizedlist> - - <itemizedlist> - <listitem><para>You can also add servers one by one using the - <emphasis><property>Add</property></emphasis> button:</para> - </listitem> - </itemizedlist> - - <figure> - <title>Add Server to be Configured</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_3_1.png"/> - </imageobject> - </mediaobject> - </figure> - <para/> - -<para>Click on <emphasis><property>Browse</property></emphasis> and select the server location. Fields Name, Type and Version will be filled in automatically:</para> - - <figure> - <title>Specify Server Location</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_3_2.png"/> - </imageobject> - </mediaobject> - </figure> - <para/> - - - <para>Click on <emphasis><property>Ok</property></emphasis>. The server is added to the list with the details on its type, version and location.</para> - - - - <para>The <emphasis><property>Remove</property></emphasis> button will the remove the selected server from the list. If necessary, you can edit the server details clicking on the <emphasis><property>Edit</property></emphasis> button:</para> - - <figure> - <title>Edit Server</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_3_4.png"/> - </imageobject> - </mediaobject> - </figure> - <para/> - - <!-- <note> - <title>Note:</title> - <para>The installer installs JBoss Enterprise Application Platform for running your applications - if you select this option during the installation process. If you want to use a different server - than ours, you can change the setting in JBoss Developer Studio.</para> - </note>--> - - <itemizedlist> - <listitem> - <para>Click <emphasis><property>Next</property></emphasis>. Check your installation paths and see the components to install. If you'd like to change - something, press the <emphasis> - <property>Previous</property> - </emphasis> button. Click <emphasis> - <property>Next</property> - </emphasis> to start installation. </para> - </listitem> - </itemizedlist> - - <para/> - - <figure> - <title>Summary Information</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4.png"/> - </imageobject> - </mediaobject> - </figure> - - </section> - - <section id="jbds_jbosstools"> - - <title>JBoss Developer Studio and JBoss Tools</title> - - <para>This section uncovers the points on the differences between <property>JBoss Developer - Studio</property> and <property>JBoss Tools</property> and provides the steps on <property>JBoss - Tools</property> installation as well.</para> - - <section id="WhatDifferenceBetweenJBDSAndJBossTools"> - <title>What is the difference?</title> - - <para><property>JBoss Tools</property> is what went into our <property>JBoss Developer - Studio</property> which comes as an easy-to-install Eclipse based IDE fully configured and ready - to run with the bundled <property>JBoss Enterprise Application Platform</property>.</para> - - <para>In short <property>JBoss Tools</property> are just a set of Eclipse plugins and - <property>JBoss Developer Studio</property> adds:</para> - <itemizedlist> - <listitem> - <para>An installer</para> - </listitem> - <listitem> - <para>Eclipse and Web Tools preconfigured</para> - </listitem> - <listitem> - <para>JBoss EAP with JBoss AS and Seam preconfigured</para> - </listitem> - <listitem> - <para>3rd party plugins bundled and configured</para> - </listitem> - <listitem> - <para>Access to RHEL and Red Hat Network</para> - </listitem> - <listitem> - <para>Access to the JBoss/Red Hat supported software</para> - </listitem> - </itemizedlist> - <para> For additional information see <ulink url="http://www.jboss.com/products/devstudio" - >JBoss.com</ulink></para> - </section> - - <section id="JBossToolsInstall"> - <title>JBoss Tools Installation and Update</title> - <para>Here, let&apos;s consider the installation of the <property>JBoss Tools</property> - modules.</para> - <para><property>JBoss Tools</property> is an umbrella project for the JBoss developed plugins - that will make it into <property>JBoss Developer Studio</property>. The JBoss Tools modules are:</para> - <itemizedlist> - <listitem> - <para>JBoss AS Tools</para> - </listitem> - <listitem> - <para>Seam Tools</para> - </listitem> - <listitem> - <para>Hibernate Tools</para> - </listitem> - <listitem> - <para>Visual Page Editor</para> - </listitem> - <listitem> - <para>JST Tools</para> - </listitem> - <listitem> - <para>JBPM Tools</para> - </listitem> - <listitem> - <para>Smooks Tools</para> - </listitem> - </itemizedlist> - - <para>To install the JBoss Tools plugins for Eclipse, you need the following:</para> - - <itemizedlist> - <listitem> - <para>Get Eclipse and Web Tools (make sure you have the - <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... version of Eclipse</ulink>).</para> - </listitem> - </itemizedlist> - <para>The current version of JBoss Tools (3.1.0.GA) targets at Eclipse 3.5.2 Galileo JEE Bundle which is available from <ulink url="http://www.eclipse.org/downloads/">eclipse.org</ulin... - - <tip> - <title>Tip:</title> - <para>We recommend you do not use Eclipse.org update site to go from old version of Eclipse to new one. - Instead we suggest that you download the full binary from <ulink url="http://www.eclipse.org/downloads/">here</ulink>.&... - </tip> - - <para>If you can only use Eclipse 3.3 use <ulink url="http://www.jboss.org/tools/download.html">JBoss Tools 2.1.2</ulink>, but - JBoss Tools 2.x will not have any of the new features.</para> - - <note> - <title>Note:</title> - <para>Remember to choose the download that matches your OS and use Java 6 when you run - it.</para> - </note> - <para>If you need to install any standalone plug-in from JBoss Tools visit a <ulink url="http://labs.jboss.com/wiki/InstallingJBossTools">JBoss Tools Wiki</ulink> page to read - about dependencies between standalone plug-ins.</para> - <para>For more information about how to install JBoss Tools 3.0 and JBoss Tools 3.1 please read the following docs: - </para> - <itemizedlist> - <listitem><para><ulink url="https://www.jboss.org/tools/download/installation/update_3_0.ht... Tools 3.0 Installation</ulink></para></listitem> - <listitem><para><ulink url="https://www.jboss.org/tools/download/installation/update_3_1.ht... Tools 3.1 Installation</ulink></para></listitem> - </itemizedlist> - - <section> - <title>Installation From Update Site</title> - - - <para>Instead of downloading installation/updating manually, it&apos;s also possible to - get the latest release of <property>JBoss Tools</property> from one of our update sites: - <itemizedlist id="sites"> - <listitem> - <para>Stable Updates: <ulink url="http://download.jboss.org/jbosstools/updates/stable" - >http://download.jboss.org/jbosstools/updates/stable</ulink></para> - </listitem> - <listitem> - <para> Development Updates: <ulink url="http://download.jboss.org/jbosstools/updates/development" - >http://download.jboss.org/jbosstools/updates/development</ulink></para> - </listitem> - <listitem> - <para> Nightly Builds: <ulink url="http://download.jboss.org/jbosstools/updates/nightly/trunk/" - >http://download.jboss.org/jbosstools/updates/nightly/trunk/</ulink></para> - </listitem> - </itemizedlist> - </para> -<itemizedlist> - <note> - <title>Note:</title> - <para>During the JBT installation/updating process using some of Jboss - update sites <emphasis>No repository found containing...</emphasis> error - can appear.It is a Eclipse P2 bug.To work around it try:1.Restart your Eclipse. 2. - Add the update site again. 3. - Do the update again.</para> - </note> - <para>To install/update Jboss Tools from one of the update sites you should follow the steps:</para> - <listitem><para>First, download the correct version of Eclipse - for your platform which is compatible with the version of JBoss - Tools you plan to install.For example if you want to install - 3.1.0.GA Eclipse 3.5.2 Galileo JEE Bundle is required.</para></listitem> - <listitem><para>If you do not already have Java 5 or 6 installed and in your path, - download and install it.</para></listitem> - <listitem><para>When Eclipse is started, go to <itemizedlist> - <listitem><para>Help->Software Updates... ->Available Software->Manage Sites...->Add...<emphasis>(Eclipse 3.4)</emphasis></para></listitem> - <listitem><para>Help->Install New Software->Add..<emphasis>(Eclipse 3.5)</emphasis></para></listitem> - </itemizedlist> - </para></listitem> - <listitem><para>After clicking <emphasis>Add</emphasis> button <property>Add Site</property> View should appear. - In the <property>Location</property> field you should paste one of the update sites described - <link linkend="sites">above</link>.On some platforms, - you can also drag and drop the link from your browser directly into Eclipse.In <property>Name</property> you can write any name you like. - In the end press the <property>Ok</property> button.</para> - <figure> - <title>Add Update Site</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4a.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem id="from_point"><para>In the <property>Install</property> View select features to install, then click <emphasis>Next</emphasis>.</para> - <figure> - <title>Jboss Tools installation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4b.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem> - <para>And the system checks whether all necessary requirements and - dependencies are installed on your Eclipse.</para> - <figure> - <title>Requirements and - dependencies check</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_10.png"/> - </imageobject> - </mediaobject> - </figure> - <para>If some of them are missing an error message will appear and - the installation process will be terminated. - </para> - <note> - <title>Note:</title> - <para>Sometimes when a user changes the list of plugins for download and clicks - <emphasis>Next</emphasis>, after required dependences check, - the list of missing dependencies of the previous attempt is showed. - In this case the completely close of the <emphasis>Install New Software</emphasis> dialog can help.</para> - </note> - <para>If Jboss Tools are already installed on your Eclipse and you are doing updating but not - installation the following messages will appear in your <emphasis>Details</emphasis> section. - Ignore them and press <emphasis>Next.</emphasis></para> - <figure> - <title>Possible messages</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4c.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem><para>When you click Finish the prosses of Installation/Updating starts up. </para></listitem> - <listitem><para>Install. Restart when prompted.</para> - <figure> - <title>Message dialog</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4d.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem><para>After fetching all the features and plugins for installation, - you may be prompted that your selection contains unsigned jars. - This is normal,simply accept the warning and continue. </para> - <figure> - <title>Warning Message</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4e.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> -</itemizedlist> - - <note> - <title>Note:</title> - <para>While installing JBoss Tools on GNU/Linux (64-bit) through the eclipse installation manager you may run into some problems which can interrupt your installation process. - Please, read the - <ulink url="http://www.jboss.org/community/wiki/ManualinstallationofJBossTo... installation of JBoss Tools 3.1.x on Eclipse 3.5 on GNU/Linux (64-bit)</ulink> - wiki article which provides you with the necessary steps to do it correct.</para> - </note> - </section> - <section> - <title>Installation From Zip file</title> - <para>You can download Jboss tools in a zip file from one of the pages below:</para> - <itemizedlist id="zip_sites"> - <listitem> - <para>Stable Releases: <ulink url="http://www.jboss.org/tools/download/stable.html" - >http://www.jboss.org/tools/download/stable.html</ulink></para> - </listitem> - <listitem> - <para> Development Updates: <ulink url="http://www.jboss.org/tools/download/dev.html" - >http://www.jboss.org/tools/download/dev.html</ulink></para> - </listitem> - <listitem> - <para> Nightly Builds: <ulink url="http://download.jboss.org/jbosstools/updates/nightly/" - >http://download.jboss.org/jbosstools/updates/nightly/</ulink></para> - </listitem> - </itemizedlist> - <para>When you downloaded Jboss Tools Zip please <emphasis>DO NOT UNZIP IT</emphasis> and follow the steps described below:</para> - <itemizedlist> - <listitem><para>When Eclipse is started, go to <property>Help -> Install New Software... -> Add... -> Archive...</property></para></listitem> - <listitem><para>Browse for the update site zip.In the <emphasis>Name</emphasis> field you can write any name you like. - In the end press <property>Ok</property> button.</para> - <figure> - <title>Installation from a zip file</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_4f.png"/> - </imageobject> - </mediaobject> - </figure> - </listitem> - <listitem><para>All the other steps are the same as it was described in the <link linkend="from_point"> - Installation From Update Site section</link>. </para> - </listitem> - </itemizedlist> - - </section> - - </section> - </section> - - <section id="Welcome"> - <title>Welcome to JBoss Developer Studio</title> - <para>In this section we'll show you how to work with the welcome page of the <property>JBoss - Developer Studio</property>.</para> - <para>The welcome page is the first page you see when you first launch <property>JBoss Developer - Studio</property>. </para> - - <figure> - <title>Welcome to JBoss Developer Studio</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_5.png"/> - </imageobject> - </mediaobject> - </figure> - - <para>With the help of its page you will be able:</para> - <itemizedlist> - <listitem> - <para>to get quick access to Getting Started Documentation (guides, tutorials and - viewlets)</para> - </listitem> - </itemizedlist> - - <figure> - <title>Getting Started Documentation</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_6.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>to create new Seam projects, jBPM Process, JSF or Struts projects using JBDS - wizards</para> - </listitem> - </itemizedlist> - - <figure> - <title>Create New...</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_7.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>to get short description of perspectives that JBDS offers for more productive - development</para> - </listitem> - </itemizedlist> - - <figure> - <title>Perspectives</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_8.png"/> - </imageobject> - </mediaobject> - </figure> - - <itemizedlist> - <listitem> - <para>to visit JBoss Developer Studio web resources.</para> - </listitem> - </itemizedlist> - - <figure> - <title>Web Resources</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/getting_started/getting_started_9.png" scale="90"/> - </imageobject> - </mediaobject> - </figure> - - <para>Start work with <property>JBoss Developer Studio</property> by clicking on <emphasis> - <property>Workbench</property> - </emphasis> button or simply close the Welcome page.</para> - - </section> - - <section id="Upgrading"> - <?dbhtml filename="Upgrading.html"?> - <title>Upgrading</title> - <para>As opposed to upgrading your JBDS from 2.0 to 2.1 using the update site, - to upgrade your JBDS from 2.1 to 3.0 you have to uninstall your 2.1 version and install the new one - because of some platform change.</para> -<!-- - <para>Now it&apos;s possible to upgrade from JBDS 2.0 to 2.1 using the update site - which is available at <ulink url="is available at - http://devstudio.jboss.com/updates/2.1">http://devstudio.jboss.co...;. - This is described more fully in the - <ulink url="http://www.jboss.com/products/devstudio/update/">JBDS Update Guide</ulink>.</para> - <note> - <title>Note:</title> - <para>You <emphasis><property>CAN NOT</property></emphasis> upgrade from 2.1 to 3.0 using update site because of some platform change. - Full installation is required.</para> - </note> ---> - </section> - - <section id="Uninstalling"> - <?dbhtml filename="Uninstalling.html"?> - <title>Uninstalling</title> - <itemizedlist> - <listitem> - <para>Make sure <property>JBoss Developer Studio</property> is not running</para> - </listitem> - <listitem> - <para>Uninstall your current version of <property>JBoss Developer Studio</property> by running - Uninstaller</para> - </listitem> - </itemizedlist> - </section> - - <section id="Support"> - <?dbhtml filename="Support.html"?> - <title>Support</title> - <para>If you have comments or questions, you can discuss them at our <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... - Developer Studio Forum</ulink>.</para> - <para>When writing to the forum for questions, please include the following information:</para> - <orderedlist> - <listitem> - <para>JBoss Developer Studio version</para> - </listitem> - <listitem> - <para>Exact error message</para> - </listitem> - <listitem> - <para>Steps to reproduce the issue</para> - </listitem> - </orderedlist> - - <para><property>JBDS</property> subscribers can get necessary support on our <ulink url="https://network.jboss.com/jbossnetwork/login.html">Support Portal</ulink>.</para> - </section> - - - <section id="OtherRelevantResourcesOnTheTopic33"> - <?dbhtml filename="OtherRelevantResourcesOnTheTopic33.html"?> - <title>Other relevant resources on the topic</title> - <para>JBDS on RedHat: <ulink url="http://www.redhat.com/developer_studio">JBoss Developer - Studio</ulink></para> - <para>Forum: <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... - Forum</ulink></para> - <para> - Wiki: <ulink url="http://www.jboss.org/community/wiki/JBossTools"> JBossToolsWiki </ulink> - </para> - <para>Subscription: <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_st... - Subscription</ulink></para> - - <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... - - <para> - <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... of supported platforms, runtimes and technologies in JBossTools/JBDS</ulink></para> - </section> - -</chapter> +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="getting_started" xreflabel="getting_started"> + <?dbhtml filename="getting_started.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Developer Studio</keyword> + <keyword>Eclipse</keyword> + <keyword>Java</keyword> + <keyword>JBoss</keyword> + </keywordset> + </chapterinfo> + <title>Getting Started with JBoss Developer Studio</title> + + <section id="intro1"> + <title>What is JBDS?</title> + <para><property>JBoss Developer Studio</property> is a set of eclipse-based development tools that + are pre-configured for JBoss Enterprise Middleware Platforms and Red Hat Enterprise Linux. + Developers are not required to use <property>JBoss Developer Studio</property> to develop on + JBoss Enterprise Middleware and/or Red Hat Linux. But, many find these pre-configured tools offer + significant time-savings and value, making them more productive and speeding time to deployment.</para> + <para>This guide covers the first steps to get started working with <property>JBoss Developer + Studio</property>. You will learn how to install and configure necessary software for your OS + (currently Linux, Microsoft Windows or Mac OSX).</para> + <para>Thus this guide will provide you with detailed info on how to start JDK, JBDS and JBoss + Tools.</para> + </section> + +<section> + <title>Key Features of JBoss Developer Studio and Requirements</title> + <para>For a start, we propose you to look through the table of main features of JBoss Developer Studio:</para> + + <table> + + <title>Key Functionality of JBoss Developer Studio</title> + <tgroup cols="2"> + + <colspec colnum="1" align="left" colwidth="2*"/> + <colspec colnum="2" colwidth="4*"/> + + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + + </row> + </thead> + + <tbody> + + <row> + <entry><para>JBoss Enterprise Application Platform</para></entry> + <entry><para>JBoss Developer Studio includes and integrates JBoss Enterprise Application Platform, the same version of the middleware platform that Red Hat supports in production for 5 years.</para></entry> + </row> + + <row> + <entry><para>New Seam Tools</para></entry> + <entry><para>JBoss Developer Studio includes brand new tools for Seam. They provide wizards for creating new Seam projects, validation tools, expression language code completion, testing tools, and wizards for generating entity objects.</para></entry> + </row> + + <row> + <entry><para>Visual Page Editor</para></entry> + <entry><para>JBoss Developer Studio includes a Visual Page Editor for combined visual and source editing of Web pages. The Visual Page Editor even renders AJAX-enabled RichFaces components.</para></entry> + </row> + + <row> + <entry><para>AJAX Capabilities</para></entry> + <entry><para>JBoss Developer Studio includes a Technology Preview of JBoss RichFaces. RichFaces provides nearly 70 skinnable components, including calendar, tree, dropdown menu, drag-and-drop components, and more. JBoss Developer Studio’s Visual Page Editor can render RichFaces components.</para></entry> + </row> + + <row> + <entry><para>JBoss Tools Palette</para></entry> + <entry><para>The JBoss Tools Palette contains a developer’s project tag libraries and enables inserting tags into a JSP with one click. The Tools Palette supports custom and 3rd party tags.</para></entry> + </row> + + <row> + <entry><para>JBoss jBPM Tools</para></entry> + <entry><para>JBoss Developer Studio includes jBPM tooling for defining Seam page flows.</para></entry> + </row> + + <row> + <entry><para>Spring Tools</para></entry> + <entry><para>JBoss Developer Studio includes Spring IDE for developing Spring applications.</para></entry> + </row> + + <row> + <entry><para>Struts Tools</para></entry> + <entry><para>JBoss Developer Studio includes Struts tools for Struts 1.x applications.</para></entry> + </row> + + <row> + <entry><para>Optimized JBoss Application Server adapter</para></entry> + <entry><para>JBoss Developer Studio’s advanced JBoss AS adapter includes features like incremental deployment for fast development and is pre-configured for the included JBoss Application server.</para></entry> + </row> + + <row> + <entry><para>Red Hat Enterprise Linux and RHN Access</para></entry> + <entry><para>JBoss Developer Studio includes access to Red Hat Enterprise Linux, Linux development tools, and Red Hat Network for development purposes.</para></entry> + </row> + + <row> + <entry><para> Project Examples</para></entry> + <entry><para> Tooling for easy installation of Examples.</para></entry> + </row> + + <row> + <entry><para>JBossWeb Service</para></entry> + <entry><para>JBoss WS is a web service framework developed as a part of the JBoss Application Server. It implements the JAX-WS specification that defines a programming model and run-time architecture for implementing web services in Java, targeted at the Java Platform, Enterprise Edition 5 (Java EE 5).</para></entry> + </row> + </tbody> + </tgroup> + </table> + + <para><property>JBDS</property> requires JDK 5+ (JDK 6 in case of EAP 5.0). Also it&apos;s important that + the JVM&apos;s architecture matches the particular <property>JBDS</property> build, i.e. if you&apos;re on a + 64-bit system and use the 64-bit JVM, you need the 64-bit JBDS.</para> + + <para>For the 32-bit version of JBDS use the 32-bit JVM or just use <literal>-vm</literal> flag to + tell JBDS to use 32-bit java if the 64-bit one is found as the default.</para> + + <note> + <title>Note:</title> + <para>On Linux system with 64-bit JVM the visual editor may fail to start. In this case you need the <literal>libstdc++.so.5</literal> library. + See also the <link linkend="question_1">FAQ</link>.</para> + </note> +</section> + + <section id="ConfigJavaEnvironment"> + <?dbhtml filename="ConfigJavaEnvironment.html"?> + <title>Configuring Your Java Environment</title> + <para>You must have a working installation of JDK before you install <property>JBoss Developer + Studio</property>. Thus in this + guide we will show you how to install a 32-bit Sun JDK 5.0 on a Linux Platform and Microsoft + Windows Platform.</para> + + <section id="InstallJDK50onLinux"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Linux</title> + <para>To install 32-bit Sun JDK 5.0 on Linux and configure it, you should follow the next steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun&apos;s website. Choose &quot;JDK 5.0 Update + &lt;x&gt;&quot; (where &quot;x&quot; is the latest update number) for + download and then select &quot;Red Hat Package Manager in self-extracting&quot; file + for Linux. Read the instructions on Sun&apos;s website for installing the JDK.</para> + </listitem> + <listitem> + <para>If you don&apos;t want to use SysV service scripts you can install the + &quot;self-extracting file&quot; for Linux instead of choosing the &quot;RPM in + self-extracting&quot; file. In that case you can skip the next step mentioned here. But it + is recommended to use the SysV service scripts for production servers.</para> + </listitem> + <listitem> + <para>Download and install the appropriate -compat RPM from JPackage <ulink url="ftp://jpackage.hmdc.harvard.edu/JPackage/1.7/generic/RPMS.non-f...;. + Please ensure you choose a matching version of the -compat package to the JDK you've + installed.</para> + </listitem> + <listitem> + <para>Create an environment variable that points to the JDK installation directory and call it + JAVA_HOME. Add <emphasis> + <property>$JAVA_HOME/bin</property> + </emphasis> to the system path to be able to run java from the command line. You can do this + by adding the following lines to the .bashrc file in your home directory.</para> + <programlisting><![CDATA[#In this example /usr/java/jdk1.5.0_11 is the JDK installation directory. +export JAVA_HOME=/usr/java/jdk1.5.0_11 +export PATH=$PATH:$JAVA_HOME/bin]]></programlisting> + </listitem> + </itemizedlist> + + <note> + <title>Note:</title> + + <para>If you have JDK already installed and added in your system path, you should add + <emphasis>$JAVA_HOME/bin</emphasis> before the old <emphasis>$PATH</emphasis> (not after it) + so that the new version of JDK can be found first, i. e. <emphasis> + <emphasis>export PATH=$JAVA_HOME/bin:$PATH</emphasis> + </emphasis> This way, the machine will pick up the new JVM first. You only need to run + "alternative" as a safe guard for the right JVM. </para> + </note> + + <para>Set this variable for your account doing the installation and also for the user account + that will run the server.</para> + <itemizedlist> + <listitem> + <para>If you have more than one version of JVM installed on your machine, make sure you are + using the JDK 1.5 installation as the default java and javac. You can do this using the + alternatives system. The alternatives system allows different versions of Java from different + sources to co-exist on your system.</para> + </listitem> + </itemizedlist> + <section id="SelectAlternativesforJava"> + <title>Select alternatives for java, javac and java_sdk_1.5.0</title> + <itemizedlist> + <listitem> + <para>As a root user, type the following command at the shell prompt and you should see + something like this:</para> + </listitem> + </itemizedlist> + <programlisting><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config java +There are 2 programs that provide 'java'. +Selection Command +----------------------------------------------- + 1 /usr/lib/jvm/jre-1.4.2-gcj/bin/java +*+ 2 /usr/lib/jvm/jre-1.5.0-sun/bin/java +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>Make sure the Sun version [jre-1.5.0-sun in this case] is selected (marked with a + &apos;+&apos; in the output), or select it by entering its number as prompted.</para> + <itemizedlist> + <listitem> + <para>Repeat the same for javac and java_sdk_1.5.0.</para> + </listitem> + </itemizedlist> + <programlisting><![CDATA[[root@vsr ~]$ /usr/sbin/alternatives --config javac +There is 1 program that provides 'javac'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun/bin/javac +Enter to keep the current selection[+], or type selection number: + +[root@vsr ~]$ /usr/sbin/alternatives --config java_sdk_1.5.0 +There is 1 program that provide 'java_sdk_1.5.0'. + Selection Command +----------------------------------------------- +*+ 1 /usr/lib/jvm/java-1.5.0-sun +Enter to keep the current selection[+], or type selection number:]]></programlisting> + <para>You should verify that java, javac and java_sdk_1.5.0 all point to the same manufacturer + and version.</para> + <note> + <title>Note:</title> + <para>You can always override this step by setting the JAVA_HOME environment variable as + explained in the previous step.</para> + </note> + <itemizedlist> + <listitem> + <para>Make sure that the java executable is in your path and that you are using an appropriate + version. To verify your Java environment, type &quot;java -version&quot; at the shell + prompt and you should see something like this:</para> + </listitem> + </itemizedlist> + <programlisting><![CDATA[[root@vsr ~]$ java -version +java version "1.5.0_11" +Java(TM) 2 Runtime Environment, Standard Edition (build 1.5.0_11-b03) +Java HotSpot(TM) Client VM (build 1.5.0_11-b03, mixed mode, sharing)]]></programlisting> + </section> + + </section> + <section id="InstallJDK50onWindows"> + <title>Installing and Configuring 32-bit Sun JDK 5.0 on Microsoft Windows</title> + + <para>To install and configure 32-bit Sun JDK 5.0 on Microsoft Windows, follow these steps:</para> + <itemizedlist> + <listitem> + <para>Download the <ulink url="http://java.sun.com/javase/downloads/index_jdk5.jsp">Sun JDK 5.0 + (Java 2 Development Kit)</ulink> from Sun&apos;s website. Choose &quot;JDK 5.0 Update + &lt;x&gt;&quot; (where &quot;x&quot; is the latest update number) for + download and then select your Windows Platform options to perform the installation.</para> + </listitem> + <listitem> + <para>Create an environment variable called JAVA_HOME that points to the JDK installation + directory, for example: + <emphasis>C:\Program Files\Java\jdk1.5.0_11\</emphasis> + </para> + </listitem> + </itemizedlist> + + <para>In order to run java from the command line, add the <emphasis>jre\bin</emphasis> directory + to your path, for example:</para> + <para> + <emphasis>C:\Program Files\Java\jdk1.5.0_11\jre\bin</emphasis> + </para> + <para>To do this, open the <emphasis> + <property>Control Panel</property> + </emphasis> from the <emphasis> + <property>Start</property> + </emphasis> menu, switch to Classic View if necessary, open the System Control Panel applet (<emphasis> + <property>System</property> + </emphasis>), select the <emphasis> + <property>Advanced</property> + </emphasis> Tab, and click on the <emphasis> + <property>Environment Variables</property> + </emphasis> button.</para> + <para>Now, when 32-bit Sun JDK 5.0 has been successfully installed, we can pass on to the next + step.</para> + </section> + + </section> + + <section id="InstallingJBDS"> + <?dbhtml filename="InstallingRHDS.html"?> + <title>JBoss Developer Studio Installation</title> + + <para>This chapter will provide you with detailed information on how to install <property>JBoss + Developer Studio</property>.</para> + + <para>JBDS comes with a simple installer, bundled with tested/pre-configured versions of Eclipse, + WTP, JBossEAP, Seam, and SpringIDE. Thus, to start perform the next steps:</para> + + <itemizedlist> + <listitem> + <para>First of all you need the appropriate installation file for your platform from + <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_st... Hat + website</ulink>.</para> + </listitem> + <listitem> + <para>Then run in console:</para> + <programlisting role="JAVA"><![CDATA[java -jar jbdevstudio-eap-linux-gtk-3.0.0.GA.jar +]]></programlisting> + </listitem> + <listitem> + <para>Follow the instructions presented by the installation wizard:</para> + </listitem> + </itemizedlist> + + <figure> + <title>JBoss Developer Studio Installation Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>Provide the installation path</para> + </listitem> + <listitem> + <para>Select Java VM</para> + </listitem> + </itemizedlist> + + <figure> + <title>Select Java VM</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <tip> + <title>Tip:</title> + <para>By selecting <emphasis> + <property>Default Java VM</property> + </emphasis> you set default Java VM of your system (to verify your Java environment, type + &quot;java -version&quot; in console).</para> + </tip> + + <para>Selecting <emphasis> + <property>Specific Java VM</property> + </emphasis> you can provide the path to non-default Java VM.</para> + + <note> + <title>Note:</title> + <para>JBoss Developer Studio 3.0 comes integrated with JBoss EAP 5.0 that requires JDK 6.0 to run + and &quot;gij&quot; isn&apos;t available on every platform.</para> + </note> + + <itemizedlist> + <listitem> + <para>Installation process includes <ulink url="http://www.jboss.com/products/platforms/application">JBoss Enterprise Application + Platform</ulink>. Select <emphasis> + <property>Yes</property></emphasis> to use it in JBoss Developer Studio.</para> + <note> + <title>Note:</title> + <para>Like in the previous version of JBDS, JBDS 3.0.0.GA comes integrated with JBoss EAP 5.0 + that supports EAP 5 adapter and Seam 2.2.</para> + </note> + + <para>This step lets you configure locally available JBoss Application Servers: </para> + </listitem> + </itemizedlist> + + <figure> + <title>JBoss Enterprise Application Platform Installing</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3.png"/> + </imageobject> + </mediaobject> + </figure> + +<itemizedlist> + <listitem><para>You can fill the list automatically using the <emphasis><property>Find</property></emphasis> button: click <emphasis><property>Find</property></emphasis>, select a folder where search of available JBoss Application Servers should be started and click on <emphasis><property>Ok</property></emphasis>: </para> </listitem> +</itemizedlist> + + <figure> + <title>Finding Servers in the Selected Directory</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_3_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + + <itemizedlist> + <listitem><para> All available servers in the selected directory will be added to the list with the following information specified: Name, Type, Version and Location. + </para></listitem> + </itemizedlist> + + <itemizedlist> + <listitem><para>You can also add servers one by one using the + <emphasis><property>Add</property></emphasis> button:</para> + </listitem> + </itemizedlist> + + <figure> + <title>Add Server to be Configured</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + +<para>Click on <emphasis><property>Browse</property></emphasis> and select the server location. Fields Name, Type and Version will be filled in automatically:</para> + + <figure> + <title>Specify Server Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + + + <para>Click on <emphasis><property>Ok</property></emphasis>. The server is added to the list with the details on its type, version and location.</para> + + + + <para>The <emphasis><property>Remove</property></emphasis> button will the remove the selected server from the list. If necessary, you can edit the server details clicking on the <emphasis><property>Edit</property></emphasis> button:</para> + + <figure> + <title>Edit Server</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_3_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para/> + + <!-- <note> + <title>Note:</title> + <para>The installer installs JBoss Enterprise Application Platform for running your applications + if you select this option during the installation process. If you want to use a different server + than ours, you can change the setting in JBoss Developer Studio.</para> + </note>--> + + <itemizedlist> + <listitem> + <para>Click <emphasis><property>Next</property></emphasis>. Check your installation paths and see the components to install. If you'd like to change + something, press the <emphasis> + <property>Previous</property> + </emphasis> button. Click <emphasis> + <property>Next</property> + </emphasis> to start installation. </para> + </listitem> + </itemizedlist> + + <para/> + + <figure> + <title>Summary Information</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="jbds_jbosstools"> + + <title>JBoss Developer Studio and JBoss Tools</title> + + <para>This section uncovers the points on the differences between <property>JBoss Developer + Studio</property> and <property>JBoss Tools</property> and provides the steps on <property>JBoss + Tools</property> installation as well.</para> + + <section id="WhatDifferenceBetweenJBDSAndJBossTools"> + <title>What is the difference?</title> + + <para><property>JBoss Tools</property> is what went into our <property>JBoss Developer + Studio</property> which comes as an easy-to-install Eclipse based IDE fully configured and ready + to run with the bundled <property>JBoss Enterprise Application Platform</property>.</para> + + <para>In short <property>JBoss Tools</property> are just a set of Eclipse plugins and + <property>JBoss Developer Studio</property> adds:</para> + <itemizedlist> + <listitem> + <para>An installer</para> + </listitem> + <listitem> + <para>Eclipse and Web Tools preconfigured</para> + </listitem> + <listitem> + <para>JBoss EAP with JBoss AS and Seam preconfigured</para> + </listitem> + <listitem> + <para>3rd party plugins bundled and configured</para> + </listitem> + <listitem> + <para>Access to RHEL and Red Hat Network</para> + </listitem> + <listitem> + <para>Access to the JBoss/Red Hat supported software</para> + </listitem> + </itemizedlist> + <para> For additional information see <ulink url="http://www.jboss.com/products/devstudio" + >JBoss.com</ulink></para> + </section> + + <section id="JBossToolsInstall"> + <title>JBoss Tools Installation and Update</title> + <para>Here, let&apos;s consider the installation of the <property>JBoss Tools</property> + modules.</para> + <para><property>JBoss Tools</property> is an umbrella project for the JBoss developed plugins + that will make it into <property>JBoss Developer Studio</property>. The JBoss Tools modules are:</para> + <itemizedlist> + <listitem> + <para>JBoss AS Tools</para> + </listitem> + <listitem> + <para>Seam Tools</para> + </listitem> + <listitem> + <para>Hibernate Tools</para> + </listitem> + <listitem> + <para>Visual Page Editor</para> + </listitem> + <listitem> + <para>JST Tools</para> + </listitem> + <listitem> + <para>JBPM Tools</para> + </listitem> + <listitem> + <para>Smooks Tools</para> + </listitem> + </itemizedlist> + + <para>To install the JBoss Tools plugins for Eclipse, you need the following:</para> + + <itemizedlist> + <listitem> + <para>Get Eclipse and Web Tools (make sure you have the + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... version of Eclipse</ulink>).</para> + </listitem> + </itemizedlist> + <para>The current version of JBoss Tools (3.1.0.GA) targets at Eclipse 3.5.2 Galileo JEE Bundle which is available from <ulink url="http://www.eclipse.org/downloads/">eclipse.org</ulin... + + <tip> + <title>Tip:</title> + <para>We recommend you do not use Eclipse.org update site to go from old version of Eclipse to new one. + Instead we suggest that you download the full binary from <ulink url="http://www.eclipse.org/downloads/">here</ulink>.&... + </tip> + + <para>If you can only use Eclipse 3.3 use <ulink url="http://www.jboss.org/tools/download.html">JBoss Tools 2.1.2</ulink>, but + JBoss Tools 2.x will not have any of the new features.</para> + + <note> + <title>Note:</title> + <para>Remember to choose the download that matches your OS and use Java 6 when you run + it.</para> + </note> + <para>If you need to install any standalone plug-in from JBoss Tools visit a <ulink url="http://community.jboss.org/wiki/InstallingJBossTools">J... Tools Wiki</ulink> page to read + about dependencies between standalone plug-ins.</para> + <para>For more information about how to install JBoss Tools 3.0 and JBoss Tools 3.1 please read the following docs: + </para> + <itemizedlist> + <listitem><para><ulink url="https://www.jboss.org/tools/download/installation/update_3_0.ht... Tools 3.0 Installation</ulink></para></listitem> + <listitem><para><ulink url="https://www.jboss.org/tools/download/installation/update_3_1.ht... Tools 3.1 Installation</ulink></para></listitem> + </itemizedlist> + + <section> + <title>Installation From Update Site</title> + + + <para>Instead of downloading installation/updating manually, it&apos;s also possible to + get the latest release of <property>JBoss Tools</property> from one of our update sites: + <itemizedlist id="sites"> + <listitem> + <para>Stable Updates: <ulink url="http://download.jboss.org/jbosstools/updates/stable" + >http://download.jboss.org/jbosstools/updates/stable</ulink></para> + </listitem> + <listitem> + <para> Development Updates: <ulink url="http://download.jboss.org/jbosstools/updates/development" + >http://download.jboss.org/jbosstools/updates/development</ulink></para> + </listitem> + <listitem> + <para> Nightly Builds: <ulink url="http://download.jboss.org/jbosstools/updates/nightly/trunk/" + >http://download.jboss.org/jbosstools/updates/nightly/trunk/</ulink></para> + </listitem> + </itemizedlist> + </para> +<itemizedlist> + <note> + <title>Note:</title> + <para>During the JBT installation/updating process using some of Jboss + update sites <emphasis>No repository found containing...</emphasis> error + can appear.It is a Eclipse P2 bug.To work around it try:1.Restart your Eclipse. 2. + Add the update site again. 3. + Do the update again.</para> + </note> + <para>To install/update Jboss Tools from one of the update sites you should follow the steps:</para> + <listitem><para>First, download the correct version of Eclipse + for your platform which is compatible with the version of JBoss + Tools you plan to install.For example if you want to install + 3.1.0.GA Eclipse 3.5.2 Galileo JEE Bundle is required.</para></listitem> + <listitem><para>If you do not already have Java 5 or 6 installed and in your path, + download and install it.</para></listitem> + <listitem><para>When Eclipse is started, go to <itemizedlist> + <listitem><para>Help->Software Updates... ->Available Software->Manage Sites...->Add...<emphasis>(Eclipse 3.4)</emphasis></para></listitem> + <listitem><para>Help->Install New Software->Add..<emphasis>(Eclipse 3.5)</emphasis></para></listitem> + </itemizedlist> + </para></listitem> + <listitem><para>After clicking <emphasis>Add</emphasis> button <property>Add Site</property> View should appear. + In the <property>Location</property> field you should paste one of the update sites described + <link linkend="sites">above</link>.On some platforms, + you can also drag and drop the link from your browser directly into Eclipse.In <property>Name</property> you can write any name you like. + In the end press the <property>Ok</property> button.</para> + <figure> + <title>Add Update Site</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4a.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem id="from_point"><para>In the <property>Install</property> View select features to install, then click <emphasis>Next</emphasis>.</para> + <figure> + <title>Jboss Tools installation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4b.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem> + <para>And the system checks whether all necessary requirements and + dependencies are installed on your Eclipse.</para> + <figure> + <title>Requirements and + dependencies check</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_10.png"/> + </imageobject> + </mediaobject> + </figure> + <para>If some of them are missing an error message will appear and + the installation process will be terminated. + </para> + <note> + <title>Note:</title> + <para>Sometimes when a user changes the list of plugins for download and clicks + <emphasis>Next</emphasis>, after required dependences check, + the list of missing dependencies of the previous attempt is showed. + In this case the completely close of the <emphasis>Install New Software</emphasis> dialog can help.</para> + </note> + <para>If Jboss Tools are already installed on your Eclipse and you are doing updating but not + installation the following messages will appear in your <emphasis>Details</emphasis> section. + Ignore them and press <emphasis>Next.</emphasis></para> + <figure> + <title>Possible messages</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4c.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>When you click Finish the prosses of Installation/Updating starts up. </para></listitem> + <listitem><para>Install. Restart when prompted.</para> + <figure> + <title>Message dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4d.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>After fetching all the features and plugins for installation, + you may be prompted that your selection contains unsigned jars. + This is normal,simply accept the warning and continue. </para> + <figure> + <title>Warning Message</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4e.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> +</itemizedlist> + + <note> + <title>Note:</title> + <para>While installing JBoss Tools on GNU/Linux (64-bit) through the eclipse installation manager you may run into some problems which can interrupt your installation process. + Please, read the + <ulink url="http://www.jboss.org/community/wiki/ManualinstallationofJBossTo... installation of JBoss Tools 3.1.x on Eclipse 3.5 on GNU/Linux (64-bit)</ulink> + wiki article which provides you with the necessary steps to do it correct.</para> + </note> + </section> + <section> + <title>Installation From Zip file</title> + <para>You can download Jboss tools in a zip file from one of the pages below:</para> + <itemizedlist id="zip_sites"> + <listitem> + <para>Stable Releases: <ulink url="http://www.jboss.org/tools/download/stable.html" + >http://www.jboss.org/tools/download/stable.html</ulink></para> + </listitem> + <listitem> + <para> Development Updates: <ulink url="http://www.jboss.org/tools/download/dev.html" + >http://www.jboss.org/tools/download/dev.html</ulink></para> + </listitem> + <listitem> + <para> Nightly Builds: <ulink url="http://download.jboss.org/jbosstools/updates/nightly/" + >http://download.jboss.org/jbosstools/updates/nightly/</ulink></para> + </listitem> + </itemizedlist> + <para>When you downloaded Jboss Tools Zip please <emphasis>DO NOT UNZIP IT</emphasis> and follow the steps described below:</para> + <itemizedlist> + <listitem><para>When Eclipse is started, go to <property>Help -> Install New Software... -> Add... -> Archive...</property></para></listitem> + <listitem><para>Browse for the update site zip.In the <emphasis>Name</emphasis> field you can write any name you like. + In the end press <property>Ok</property> button.</para> + <figure> + <title>Installation from a zip file</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_4f.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + <listitem><para>All the other steps are the same as it was described in the <link linkend="from_point"> + Installation From Update Site section</link>. </para> + </listitem> + </itemizedlist> + + </section> + + </section> + </section> + + <section id="Welcome"> + <title>Welcome to JBoss Developer Studio</title> + <para>In this section we'll show you how to work with the welcome page of the <property>JBoss + Developer Studio</property>.</para> + <para>The welcome page is the first page you see when you first launch <property>JBoss Developer + Studio</property>. </para> + + <figure> + <title>Welcome to JBoss Developer Studio</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>With the help of its page you will be able:</para> + <itemizedlist> + <listitem> + <para>to get quick access to Getting Started Documentation (guides, tutorials and + viewlets)</para> + </listitem> + </itemizedlist> + + <figure> + <title>Getting Started Documentation</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_6.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to create new Seam projects, jBPM Process, JSF or Struts projects using JBDS + wizards</para> + </listitem> + </itemizedlist> + + <figure> + <title>Create New...</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to get short description of perspectives that JBDS offers for more productive + development</para> + </listitem> + </itemizedlist> + + <figure> + <title>Perspectives</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_8.png"/> + </imageobject> + </mediaobject> + </figure> + + <itemizedlist> + <listitem> + <para>to visit JBoss Developer Studio web resources.</para> + </listitem> + </itemizedlist> + + <figure> + <title>Web Resources</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/getting_started/getting_started_9.png" scale="90"/> + </imageobject> + </mediaobject> + </figure> + + <para>Start work with <property>JBoss Developer Studio</property> by clicking on <emphasis> + <property>Workbench</property> + </emphasis> button or simply close the Welcome page.</para> + + </section> + + <section id="Upgrading"> + <?dbhtml filename="Upgrading.html"?> + <title>Upgrading</title> + <para>As opposed to upgrading your JBDS from 2.0 to 2.1 using the update site, + to upgrade your JBDS from 2.1 to 3.0 you have to uninstall your 2.1 version and install the new one + because of some platform change.</para> +<!-- + <para>Now it&apos;s possible to upgrade from JBDS 2.0 to 2.1 using the update site + which is available at <ulink url="is available at + http://devstudio.jboss.com/updates/2.1">http://devstudio.jboss.co...;. + This is described more fully in the + <ulink url="http://www.jboss.com/products/devstudio/update/">JBDS Update Guide</ulink>.</para> + <note> + <title>Note:</title> + <para>You <emphasis><property>CAN NOT</property></emphasis> upgrade from 2.1 to 3.0 using update site because of some platform change. + Full installation is required.</para> + </note> +--> + </section> + + <section id="Uninstalling"> + <?dbhtml filename="Uninstalling.html"?> + <title>Uninstalling</title> + <itemizedlist> + <listitem> + <para>Make sure <property>JBoss Developer Studio</property> is not running</para> + </listitem> + <listitem> + <para>Uninstall your current version of <property>JBoss Developer Studio</property> by running + Uninstaller</para> + </listitem> + </itemizedlist> + </section> + + <section id="Support"> + <?dbhtml filename="Support.html"?> + <title>Support</title> + <para>If you have comments or questions, you can discuss them at our <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Developer Studio Forum</ulink>.</para> + <para>When writing to the forum for questions, please include the following information:</para> + <orderedlist> + <listitem> + <para>JBoss Developer Studio version</para> + </listitem> + <listitem> + <para>Exact error message</para> + </listitem> + <listitem> + <para>Steps to reproduce the issue</para> + </listitem> + </orderedlist> + + <para><property>JBDS</property> subscribers can get necessary support on our <ulink url="https://network.jboss.com/jbossnetwork/login.html">Support Portal</ulink>.</para> + </section> + + + <section id="OtherRelevantResourcesOnTheTopic33"> + <?dbhtml filename="OtherRelevantResourcesOnTheTopic33.html"?> + <title>Other relevant resources on the topic</title> + <para>JBDS on RedHat: <ulink url="http://www.redhat.com/developer_studio">JBoss Developer + Studio</ulink></para> + <para>Forum: <ulink url="http://www.jboss.com/index.html?module=bb&amp;op=viewforum&... + Forum</ulink></para> + <para> + Wiki: <ulink url="http://www.jboss.org/community/wiki/JBossTools"> JBossToolsWiki </ulink> + </para> + <para>Subscription: <ulink url="https://www.redhat.com/apps/store/developers/jboss_developer_st... + Subscription</ulink></para> + + <para>The latest documentation builds are available <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">her... + + <para> + <ulink url="http://www.jboss.org/community/wiki/Matrixofsupportedplatformsr... of supported platforms, runtimes and technologies in JBossTools/JBDS</ulink></para> + </section> + +</chapter> \ No newline at end of file