Red Hat JBoss Developer Studio 7.1 Installation Guide

Transcription

1 Red Hat JBoss Developer Studio 7.1 Installation Guide Information for users installing JBoss Developer Studio Red Hat Documentation Team

2

3 Red Hat JBoss Developer Studio 7.1 Installation Guide Information for users installing JBoss Developer Studio Red Hat Documentation Team

4 Legal Notice Copyright 2013, 2014 Red Hat, Inc. This do cument is licensed by Red Hat under the Creative Co mmo ns Attributio n- ShareAlike 3.0 Unported License. If you distribute this document, or a modified version of it, you must provide attribution to Red Hat, Inc. and provide a link to the original. If the document is modified, all Red Hat trademarks must be remo ved. Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law. Red Hat, Red Hat Enterprise Linux, the Shadowman logo, JBoss, MetaMatrix, Fedora, the Infinity Logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other co untries. Linux is the registered trademark of Linus Torvalds in the United States and other countries. Java is a registered trademark o f Oracle and/o r its affiliates. XFS is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/o r o ther co untries. MySQL is a registered trademark of MySQL AB in the United States, the European Union and o ther co untries. Node.js is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project. The OpenStack Wo rd Mark and OpenStack Lo go are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endo rsed o r spo nso red by the OpenStack Fo undatio n, o r the OpenStack co mmunity. All o ther trademarks are the pro perty o f their respective o wners. Abstract This document details how to install and set up JBoss Developer Studio.

5 T able of Cont ent s Table of Contents. Preface Do cument Co nventio ns Typ o g rap hic Co nventio ns Pull-q uo te Co nventio ns No tes and Warning s 4 2. G etting Help and G iving Feed b ack 4. Chapt..... er Int... roduct ion... t. o.. Red.... Hat... JBoss Developer St.. udio Ab o ut Red Hat JBo ss Develo p er Stud io Use Cases o f JBo ss Develo p er Stud io 6. Chapt..... er Syst.... em... Requirement s System Req uirements O verview Sup p o rted O p erating Systems and Architectures Co mp uter Memo ry Co mp atib le Java Develo p er Kits 10. Chapt..... er Inst.... all.. JBoss Developer St.. udio Install O p tio ns Install JBo ss Develo p er Stud io Install JBo ss Develo p er Stud io BYO E 16. Chapt..... er Set.... Preferences on.. First..... Launch aft.. er... Inst... alling Preferences O p tio ns Select a Wo rksp ace Lo catio n Set Usag e Rep o rting Define Servers fo r Ap p licatio n Servers Fo und b y Runtime Detectio n Set the Persp ective to JBo ss 26. Chapt..... er Upgrade from..... Previous Versions of.. JBoss Developer St.. udio Up g rad e Metho d s Up g rad e fro m JBo ss Develo p er Stud io 6.x and Earlier Up g rad e fro m JBo ss Develo p er Stud io Chapt..... er Uninst all... JBoss Developer St.. udio Uninstall Metho d s Uninstall JBo ss Develo p er Stud io Uninstall JBo ss Develo p er Stud io BYO E 30. Java.... Developer Kit... s A.1. Determine Default Java Develo p er Kit o f the System 33 A.2. Install a Java Develo p er Kit 34. Supplement ary... Inst.... allat.... ion... Procedures B.1. Build the Universal Installer fro m So urce 36 B.2. Install JBo ss Develo p er Stud io b y Scrip t 37. Revision Hist... ory

6 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Preface 1. Document Convent ions This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information T ypographic Convent ions Four typographic conventions are used to call attention to specific words and phrases. These conventions, and the circumstances they apply to, are as follows. Mo no -spaced Bo l d Used to highlight system input, including shell commands, file names and paths. Also used to highlight keys and key combinations. For example: To see the contents of the file my_next_bestsel l i ng _no vel in your current working directory, enter the cat my_next_bestsel l i ng _no vel command at the shell prompt and press Enter to execute the command. The above includes a file name, a shell command and a key, all presented in mono-spaced bold and all distinguishable thanks to context. Key combinations can be distinguished from an individual key by the plus sign that connects each part of a key combination. For example: Press Enter to execute the command. Press C trl +Al t+f2 to switch to a virtual terminal. The first example highlights a particular key to press. The second example highlights a key combination: a set of three keys pressed simultaneously. If source code is discussed, class names, methods, functions, variable names and returned values mentioned within a paragraph will be presented as above, in mo no -spaced bo l d. For example: File-related classes include fi l esystem for file systems, fi l e for files, and d i r for directories. Each class has its own associated set of permissions. Proportional Bold This denotes words or phrases encountered on a system, including application names; dialog-box text; labeled buttons; check-box and radio-button labels; menu titles and submenu titles. For example: Choose System Preferences Mouse from the main menu bar to launch Mouse Preferences. In the Butto ns tab, select the Left-hand ed mo use check box and click C l o se to switch the primary mouse button from the left to the right (making the mouse suitable for use in the left hand). To insert a special character into a gedit file, choose Applications Accessories Character Map from the main menu bar. Next, choose Search Find from the Character Map menu bar, type the name of the character in the Search field and click Next. The character you sought will be highlighted in the 2

7 Preface C haracter T abl e. Double-click this highlighted character to place it in the T ext to co py field and then click the C o py button. Now switch back to your document and choose Edit Paste from the gedit menu bar. The above text includes application names; system-wide menu names and items; application-specific menu names; and buttons and text found within a GUI interface, all presented in proportional bold and all distinguishable by context. Mono-spaced Bold Italic or Proportional Bold Italic Whether mono-spaced bold or proportional bold, the addition of italics indicates replaceable or variable text. Italics denotes text you do not input literally or displayed text that changes depending on circumstance. For example: To connect to a remote machine using ssh, type ssh username@ domain.name at a shell prompt. If the remote machine is exampl e. co m and your username on that machine is john, type ssh jo hn@ exampl e. co m. The mo unt -o remo unt file-system command remounts the named file system. For example, to remount the /ho me file system, the command is mo unt -o remo unt /ho me. To see the version of a currently installed package, use the rpm -q package command. It will return a result as follows: package-version-release. Note the words in bold italics above: username, domain.name, file-system, package, version and release. Each word is a placeholder, either for text you enter when issuing a command or for text displayed by the system. Aside from standard usage for presenting the title of a work, italics denotes the first use of a new and important term. For example: Publican is a DocBook publishing system Pull-quot e Convent ions Terminal output and source code listings are set off visually from the surrounding text. Output sent to a terminal is set in mo no -spaced ro man and presented thus: books Desktop documentation drafts mss photos stuff svn books_tests Desktop1 downloads images notes scripts svgs Source-code listings are also set in mo no -spaced ro man but add syntax highlighting as follows: static int kvm_vm_ioctl_deassign_device(struct kvm *kvm, struct kvm_assigned_pci_dev *assigned_dev) { int r = 0; struct kvm_assigned_dev_kernel *match; mutex_lock(& kvm->lock); match = kvm_find_assigned_dev(& kvm->arch.assigned_dev_head, assigned_dev->assigned_dev_id); if (!match) { printk(kern_info "%s: device hasn't been assigned 3

8 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide before, " } "so cannot be deassigned\n", func ); r = -EINVAL; goto out; kvm_deassign_device(kvm, match); kvm_free_assigned_device(kvm, match); out: mutex_unlock(& kvm->lock); return r; } 1.3. Not es and Warnings Finally, we use three visual styles to draw attention to information that might otherwise be overlooked. Note Notes are tips, shortcuts or alternative approaches to the task at hand. Ignoring a note should have no negative consequences, but you might miss out on a trick that makes your life easier. Important Important boxes detail things that are easily missed: configuration changes that only apply to the current session, or services that need restarting before an update will apply. Ignoring a box labeled Important will not cause data loss but may cause irritation and frustration. Warning Warnings should not be ignored. Ignoring warnings will most likely cause data loss. 2. Get t ing Help and Giving Feedback Do You Need Help? If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at Through the customer portal, you can: search or browse through a knowledgebase of technical support articles about Red Hat products. submit a support case to Red Hat Global Support Services (GSS). access other product documentation. 4

9 Preface Red Hat also hosts a large number of electronic mailing lists for discussion of Red Hat software and technology. You can find a list of publicly available mailing lists at Click on the name of any mailing list to subscribe to that list or to access the list archives. G ive us Feedback If you find a typographical error or have a suggestion for improving this documentation, we would love to hear from you. Submit a report in JIRA against the project Documentation for JBoss Tools and Developer Studio (TO O LSDO C). The following link will take you to a pre-filled bug report for this product: Fill out the following template in JIRA's D escri pti o n field. Be as specific as possible when describing the issue; this will help ensure that we can fix it quickly. Document URL: Section Number and Name: Describe the issue: Suggestions for improvement: Additional information: Be sure to give us your name so that you can receive full credit for reporting the issue. 5

10 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Chapter 1. Introduction to Red Hat JBoss Developer Studio 1.1. About Red Hat JBoss Developer St udio Red Hat JBoss D eveloper Studio is a set of Eclipse-based development tools. It contains plug-ins that integrate with Eclipse to extend the existing functionality of the integrated development environment (ID E). JBoss D eveloper Studio is designed to increase your productivity when developing applications. You can focus on building, testing and deploying your applications because JBoss application development tools are integrated in one ID E. Furthermore, JBoss D eveloper Studio can assist your application development with its unique features in the following ways: D evelop new applications using the wizards and project examples of JBoss Central Add powerful functionality to applications with minimal effort using Forge Tools Build web interfaces with ease using the visual editing and drag-and-drop utilities of Visual Web Tools and Mobile Web Tools Experience browsers automatically refreshing in response to modified application resources with LiveReload Tools Incorporate JSF, Seam, JAX-RS, Hibernate, CD I and other popular APIs into applications with simplicity using the tool-driven interface Preview and test mobile web applications on a variety of simulation mobile devices using BrowserSim Create, build and test Cordova-based hybrid mobile applications for ios and Android platforms using Hybrid Mobile Tools and CordovaSim D eploy applications to JBoss runtime servers and the cloud using JBoss Server Tools and OpenShift Tools JBoss D eveloper Studio comes built around Eclipse and packaged with all of the necessary dependencies and third-party plug-ins for simplified installing. For developers already running Eclipse, JBoss D eveloper Studio can also be installed through Eclipse Marketplace. For distinction, this latter JBoss D eveloper Studio installation is called JBoss D eveloper Studio BYOE (Bring Your Own Eclipse) Use Cases of JBoss Developer St udio JBoss D eveloper Studio assists JEE developers by integrating JBoss technology and APIs in a single development environment. Here are a few ways that JBoss D eveloper Studio makes the work of a developer easier: Web applications JBoss Central provides wizards that generate skeleton and sample projects, enabling you to focus on developing the functionality of your applications. The wizards create web applications based on different APIs and technologies, showing the usage and advantages of each. JBoss D eveloper Studio also offers project file templates in a range of popular programming languages, including HTML, XHTML, and JSF. 6

11 Chapt er 1. Int roduct ion t o Red Hat JBoss Developer St udio Palettes in JBoss Developer Studio give access to the core elements of the JSF, Richfaces and Seam APIs, for use in developing the user interfaces of your applications. Elements of these APIs can be dragged and dropped directly into your project so that you can create richer user interfaces quickly. Visual Web Tools offers graphical and source viewing of files and defaults to dedicated editors for different file types. JBoss D eveloper Studio supports the Java EE specification and provides tools for JAX-RS, Hibernate, and CD I APIs so you can develop the server-side components of your applications effortlessly. LiveReload Tools automatically refreshes browsers of local or deployed applications as you modify project resources to save you from needing to manually refresh. You can even experience automatic refreshing when viewing applications in browsers on external and mobile devices, with application web addresses easy to navigate to with QR codes. Web applications optimiz ed for mobile devices Mobile Web Tools provides support for HTML5 and jquery Mobile to enable you to create web applications optimized across desktop and mobile clients. The HTML5 Project wizard in JBoss Central generates a sample application using HTML5 and jquery Mobile technologies and, together with HTML5 and jquery Mobile project file templates, helps you to get up and running with these APIs and technologies quickly. HTML5 and jquery Mobile widgets can be dragged from the jquery Mobile palette into your project files and, in conjunction with the widget wizards, enable you to effortlessly develop customized user interfaces for your mobile web applications. BrowserSim allows you to view your web applications on a variety of simulated mobile devices so that you can ensure they will be correctly formatted. LiveReload also extends to BrowserSim allowing you to experience automatic browser refreshing as you develop your mobile web applications. The integration of Firebug Lite and Weinre capabilities with BrowserSim assists you to inspect the page source of web pages with familiar tools. Hybrid mobile applications Hybrid Mobile Tools provides support for developing and building Cordova-based hybrid mobile applications for ios and Android platforms. The Hybrid Mobile application wizard assists you to quickly generate new projects, while the Cordova Configuration Editor and Cordova Plug-in D iscovery wizard help you to efficiently modify the capabilities of your projects. Hybrid Mobile Tools provides actions that simplify your workflow, for example calling your system installed Android and ios SDKs from within the IDE to emulate or run your hybrid mobile applications. With wizards to export workspace projects to Cordovaenabled native projects or ready-to-sign applications, you can quickly be ready to share your hybrid mobile projects and applications. CordovaSim enables you to view and test your hybrid mobile applications on Android and ios simulated mobile devices so that you can ensure they look and work as expected. You can interact with your mobile applications through BrowserSim and use the device input panel to provide sample data to your applications for device functions like cameras and accelerometers. An advantage of CordovaSim is that it does not require native SDKs to be installed on your system, unlike native SD K emulators. Additionally, by teaming the device control panel with BrowserSim, you get all of the great functionality of BrowserSim, such as skins and LiveReload, while simulating your hybrid mobile applications. Applications for cloud deployment OpenShift Tools deploys your applications directly to the cloud on the Red Hat OpenShift platform. You can create and manage your OpenShift account and manage the deployment of applications in your OpenShift domains from within the IDE. In addition to using the OpenShift Application wizard to create new applications for deployment to OpenShift, 7

12 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide OpenShift Tools can import applications already deployed on OpenShift so that you can further develop them and manage their deployment from the comfort of the IDE. 8

13 Chapt er 2. Syst em Requirement s Chapter 2. System Requirements 2.1. Syst em Requirement s Overview The aim of this section is familiarize you with the system requirements necessary for JBoss D eveloper Studio to function optimally: A variety of operating system and architecture combinations are generally supported but some tools have additional requirements. A minimum amount of RAM and hard disk space are required to install and run JBoss D eveloper Studio. A variety of operating systems and Java developer kit combinations are supported Support ed Operat ing Syst ems and Archit ect ures JBoss D eveloper Studio 7.1 is supported on the operating systems listed in the table below. Table 2.1. Supported O perating Systems O perating System Red Hat Enterprise Linux 6 Microsoft Windows XP, Windows 7 and Windows 8 Chip Architecture x86, x86_64 x86, x86_64 OS X Lion (10.7) [a], OS X Mountain Lion (10.8) and OS X Mavericks x86_64 (10.9) [b ] Fedora 18 and Fedora 19 Ubuntu LTS and Ubuntu [a] O S X Lio n (10.7) is sup p o rted b y JBo ss Develo p er Stud io o nly. [b ] O S X Mavericks (10.9 ) is sup p o rted b y JBo ss Develo p er Stud io o nly. x86, x86_64 x86, x86_64 As JBoss D eveloper Studio 7.1 is based on Eclipse Kepler (4.3), the system requirements of Eclipse Kepler also apply to JBoss D eveloper Studio 7.1. For example, GTK is required as the windowing system on Linux distributions, Win32 on Microsoft Windows operating systems and Cocoa on OS X operating systems. For more information about Eclipse Kepler system requirements see on the Eclipse website. The Visual Page Editor and BrowserSim tools have additional Java developer kit requirements and restrictions: The visual component of the Visual Page Editor, which depends on XULRunner, does not operate in the 64-bit version of JBoss D eveloper Studio on OS X and Microsoft Windows operating systems. To work around this restriction on 64-bit OS X and Microsoft Windows operating systems, you must install a 32-bit version of JBoss D eveloper Studio with a 32-bit Java developer kit. BrowserSim, which depends on WebKit, requires Apple Safari to be installed on Microsoft Windows operating systems. Only a 32-bit version of Apple Safari is available for Microsoft Windows operating systems. To work around this restriction for 64-bit Microsoft Windows operating systems running 64-bit versions of JBoss D eveloper Studio, you must set BrowserSim 9

14 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide to use a 32-bit JVM by editing the BrowserSim preferences from within the IDE. Note that 32-bit JVM choice is limited to Oracle 32-bit JRE 1.6, JDK 1.6, or JDK 1.7 on Microsoft Windows operating systems because Oracle 32-bit JRE 1.7 is incompatible with Apple Safari Comput er Memory To install and run JBoss D eveloper Studio 7.1, the following memory requirements are recommended: 4 GB RAM 1.5 GB of hard disk space The minimum memory requirements are 2 GB RAM and 750 MB of hard disk space Compat ible Java Developer Kit s JBoss Developer Studio 7.1 requires a Java developer kit of version 1.6 or later. This release of JBoss D eveloper Studio is supported on the operating system and Java developer kit combinations listed in the table below. Table 2.2. Supported Combinations of O perating Systems and Java Developer Kits O perating System Red Hat Enterprise Linux 6 Java Developer Kit Microsoft Windows XP Oracle JD K 1.6 OpenJD K 1.6, OpenJD K 1.7, Oracle JD K 1.6 and Oracle JD K 1.7 Microsoft Window 7 and Windows 8 Oracle JDK 1.6 and Oracle JDK 1.7 OS X Lion (10.7) [a], OS X Mountain Lion (10.8) and OS X Mavericks (10.9) [b ] Apple JDK 1.6 and Oracle JDK 1.7 (64-bit only) Fedora 18 and Fedora 19 OpenJD K 1.6 and OpenJD K 1.7 Ubuntu LTS and Ubuntu OpenJD K 1.6 and OpenJD K 1.7 [a] O S X Lio n (10.7) is sup p o rted b y JBo ss Develo p er Stud io o nly. [b ] O S X Mavericks (10.9 ) is sup p o rted b y JBo ss Develo p er Stud io o nly. Before installing JBoss D eveloper Studio you must identify which Java developer kit you have installed. If it is not listed above, you must install a compatible one before proceeding. Important You must use a 32-bit Java developer kit to install a 32-bit version of JBoss Developer Studio and a 64-bit Java developer kit to install a 64-bit version of JBoss Developer Studio. See Also: Appendix A, Java Developer Kits 10

15 Chapt er 3. Inst all JBoss Developer St udio Chapter 3. Install JBoss Developer Studio 3.1. Inst all Opt ions JBoss Developer Studio can be installed in a number of different ways. You can install JBoss D eveloper Studio, packaged with Eclipse and dependent third-party plug-ins, with a universal installer for all operating systems. A second version of the universal installer is available that additionally contains Red Hat JBoss Enterprise Application Platform and installs both JBoss D eveloper Studio and JBoss EAP. Alternatively, if you already have Eclipse on your system you may prefer to install JBoss D eveloper Studio BYOE. This option installs JBoss D eveloper Studio in Eclipse. The primary installation method for JBoss D eveloper Studio and JBoss D eveloper Studio BYOE is via the interactive user interfaces of the universal installer and Eclipse, respectively. For information about the secondary scripted installation method see Section B.2, Install JBoss D eveloper Studio by Script Inst all JBoss Developer St udio A universal installer. jar file is provided for installing JBoss D eveloper Studio and it is available from the Customer Portal. A second version of the universal installer for installing both JBoss D eveloper Studio and JBoss EAP is also available from the Customer Portal. The procedure below guides you though obtaining the universal installers and the installation process. Alternatively, the source code is available as a. zi p file at the same location. You can use this source code to build the universal installer yourself and then use that to install JBoss D eveloper Studio. For instructions for building the universal installer see Section B.1, Build the Universal Installer from Source. Procedure 3.1. Install with the Universal Installer 1. Log into the Customer Portal at 2. From the menu bar click Downloads. 3. Under Red Hat JBoss Middleware, click Download Software. 11

16 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Figure 3.1. Download Red Hat JBoss Middleware Software on the Customer Portal 4. Under So ftware D o wnl o ad s, select the following options: From the P ro d uct list, select JBo ss D evel o per Stud i o. From the Versi o n list, select x. 5. From the table, click D o wnl o ad for one of the following: For the JBoss Developer Studio universal installer, click D o wnl o ad for the R ed Hat JBo ss D evel o per Stud i o x Stand Al o ne Uni versal Bi nary download file. For the JBoss Developer Studio and JBoss EAP universal installer, click D o wnl o ad for the R ed Hat JBo ss D evel o per Stud i o x Uni versal Bi nary wi th JBo ss EAP download file. This downloads a universal installer. jar file. 6. On the command line, navigate to path/to /. jar and enter java -jar jbdevstudio-product-universal-version.jar or java -jar jbdevstudio-product-eap-universal-version.jar as appropriate for the downloaded universal installer, where version is substituted to match the name of the. jar file. Note Alternatively, to start the installer you may be able to double-click the. jar file. 7. When the Instal l er window opens, click Next. 8. After reading and agreeing to the terms of the End User License Agreement, click I accept the terms o f thi s l i cense ag reement and click Next. 9. In the Sel ect the i nstal l ati o n path field, type the path where you want JBoss Developer Studio to be installed or click Bro wse to navigate to the location. When the Sel ect the i nstal l ati o n path field shows the correct path, click Next. When you are prompted about the specified location being created or overwritten, review the message and, if satisfied, click O K or Y es as appropriate. 12

17 Chapt er 3. Inst all JBoss Developer St udio Figure 3.2. Installation Step 3: Select Target Folder 10. In the Sel ect Java VM step, D efaul t Java VM is automatically selected. Ensure that the disabled text field contains the path of the Java developer kit you want to use. This is based on the default Java developer kit of your system. To change the specified Java developer kit, click Speci fi c Java VM and type the path of the Java developer kit in the text field or use the Bro wse button to locate the Java developer kit. When the text field shows the correct Java developer kit path, click Next. Important You must specify a Java developer kit with a 32-bit JRE to install a 32-bit version of JBoss Developer Studio and a 64-bit JRE to install a 64-bit version of JBoss Developer Studio. To change the bit version of the Java developer kit to be used for installing JBoss D eveloper Studio, complete the appropriate step for your operating system: On OS X operating systems, from the Instal l ati o n type list click the appropriate bit version. On Linux distributions and Microsoft Windows operating systems, in the text field type the path to the appropriate bit version of the Java developer kit. 13

18 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Figure 3.3. Installation Step 4 : Select Java VM 11. If installing from the universal installer that includes JBoss EAP, you are asked if you want to install JBoss EAP. This option installs JBoss EAP in a subdirectory under JBoss D eveloper Studio and generates a complete server definition within the ID E with which to manage the runtime server and deployed applications. Click Y es or No as appropriate. 12. To make use of automatic runtime detection for finding already installed application servers, click Ad d. In the Lo cati o n field, type the path from which recursive scanning for application servers is to commence or click Bro wse to navigate to the location: To detect a specific application server, select the install directory for that application server. To detect multiple application servers, select a directory higher up the directory tree. Alternatively, this can be achieved by adding multiple locations for scanning. To scan the specified path for new application servers each time JBoss D eveloper Studio starts, select the Scan every start check box. Click O K to close the Ad d Lo cati o n window and click Next. 14

19 Chapt er 3. Inst all JBoss Developer St udio Figure 3.4. Add Location Window for Runtime Detection 13. Review the details in the Summary Information window and, if they are correct, click Next. Installation commences. 14. When the P ack i nstal l ati o n pro g ress bar shows Fi ni shed, click Next. The installation process is now complete. Figure 3.5. Installation Step 7: Installation Progress in Finished State 15. To create shortcuts for starting JBoss Developer Studio, select the C reate sho rtcuts i n the Start-Menu and C reate ad d i ti o nal sho rtcut o n the d eskto p check boxes and click Next. 15

20 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide 16. To automatically start JBoss D eveloper Studio when the Instal l er window closes, select the R un JBo ss D evel o per Stud i o after i nstal l ati o n check box. Click D o ne to close the Instal l er window. Important Linux distributions have a maximum number of files that a process can have open at one time. If this maximum number of files is set too low, JBoss Developer Studio will not start. You must open the /etc/securi ty/l i mi ts. co nf file and ensure that the so ft no fi l e and hard no fi l e variables have values of at a minimum. If the variables have smaller values, the values must be increased to If the variables are not specified, the following lines must be added to the file: * soft nofile 9216 * hard nofile Inst all JBoss Developer St udio BYOE You can obtain JBoss Developer Studio BYOE from Eclipse Marketplace or use the update. zi p file available from the Red Hat Customer Portal or Red Hat JBoss D eveloper Studio Update website. The latter option provisions for online and offline installation modes; Eclipse can install directly from the online. zi p file or you can download the. zi p file first and then Eclipse can install from this local copy. Select one of the procedures below, which will guide you through the JBoss D eveloper Studio BYOE installation process. Procedure 3.2. Install from Eclipse Marketplace 1. Start Eclipse Kepler. 2. Click Help Eclipse Marketplace. 3. In the Fi nd field of the Search tab, enter R ed Hat JBo ss D evel o per Stud i o. 4. Locate Red Hat JBoss Developer Studio (Kepler) and click Instal l. 16

21 Chapt er 3. Inst all JBoss Developer St udio Figure 3.6. Install JBoss Developer Studio BYO E via Eclipse Marketplace 5. Ensure the R ed Hat JBo ss D evel o per Stud i o (Kepl er) check box is selected and click C o nfi rm. 17

22 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Figure 3.7. Confirm Selected Features Window 6. After reading and agreeing to the licenses, click I accept the terms o f the l i cense ag reements and click Fi ni sh. Figure 3.8. Review Licenses Window 7. D uring the installation process you may receive warnings about installing unsigned content. If this is the case, review the details of the content and if satisfied click O K to continue with the installation. 18

23 Chapt er 3. Inst all JBoss Developer St udio Figure 3.9. Warning Prompt for Installing Unsigned Content 8. Once installing is complete, you are prompted to restart Eclipse. Click Y es to restart now and No if you need to save any unsaved changes to open projects. Note that IDE changes do not take effect until Eclipse is restarted. Procedure 3.3. Install from Update. zi p File Note To install JBoss Developer Studio BYOE in offline mode, you must first download the update. zi p file. You can download the update. zi p file from on the Customer Portal or on the Red Hat JBoss D eveloper update website. 1. Start Eclipse Kepler. 2. Click Help Install New Software. 3. Complete the appropriate step for your chosen install mode: A. For online mode, in the Wo rk wi th field enter https: //d evstud i o. jbo ss. co m/upd ates/7. 0 /. Figure Work from an O nline Website B. For offline mode, in the Wo rk wi th field enter the path of the update. zi p file. Alternatively, click Ad d and click Archi ve to locate the file. 19

24 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Figure Work from a Local Copy of the Update. zi p File 4. From the table of components, select JBo ss D evel o per Stud i o 7. x - Bri ng Y o ur O wn Ecl i pse and click Next. Figure Available Software Window Listing JBoss Developer Studio 7.x - Bring Your O wn Eclipse 5. Review the details of the component to be installed and click Next. 20

25 Chapt er 3. Inst all JBoss Developer St udio 6. After reading and agreeing to the licenses, click I accept the terms o f the l i cense ag reements and click Fi ni sh. Figure Review Licenses Window 7. D uring the installation process you may receive warnings about installing unsigned content. If this is the case, review the details of the content and if satisfied click O K to continue with the installation. Figure Warning Prompt for Installing Unsigned Content 8. Once installing is complete, you are prompted to restart Eclipse. Click Y es to restart now and No if you need to save any unsaved changes to open projects. Note that IDE changes do not take effect until Eclipse is restarted. 21

26 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Chapter 4. Set Preferences on First Launch after Installing 4.1. Preferences Opt ions The aim of this section is to guide you in setting preferences for the JBoss Developer Studio features encountered on the first ID E start after installing: Select a workspace for your projects Choose whether to enable JBoss D eveloper Studio to collect usage information for compiling product-wide statistics D ecide whether to define servers for application servers that runtime detection found on ID E start Activate the JBoss perspective to provide easy access to common views, menus and toolbars for working with JBoss technologies 4.2. Select a Workspace Locat ion When the IDE starts, you are asked to choose the workspace folder for the session. The workspace is where your projects are stored. Figure 4.1. Select a Workspace Window To set the workspace location, follow these steps: 22

27 Chapt er 4. Set Preferences on First Launch aft er Inst alling 1. In the Wo rkspace field, type the path for a new or existing workspace or use Bro wse to navigate to the workspace location. 2. If you do not want to be asked to choose a workspace folder each time the IDE starts, select the Use thi s as the d efaul t and d o no t ask ag ai n check box. 3. Click O K. The workspace location prompting behavior can be altered at any time by clicking Window Preferences. Expand G eneral Startup and Shutd o wn and select Wo rkspaces. Select or clear the P ro mpt fo r wo rkspace o n startup check box to alter the behavior as appropriate Set Usage Report ing JBoss Developer Studio has usage reporting. At the first start of the IDE after installing, you are asked if you allow the collection of anonymous usage statistics by JBoss D eveloper Studio. Figure 4.2. Prompt for Anonymous Usage Statistics The information collected enables Red Hat to understand how and where JBoss D eveloper Studio is being used. Specifically, information about operating systems and system display resolution assists in continually improving JBoss D eveloper Studio. The following information is collected: Version of JBoss D eveloper Studio Installed components of JBoss D eveloper Studio JBoss Central enabled Origin of Eclipse product Version of Eclipse Operating system Operating system version 23

28 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide Linux distribution and version, if appropriate Screen colors Screen resolution Version of Java Internet connection type Location (continent, country, city) and language User type (new or returning) Number of times JBoss D eveloper Studio has been started Date of first usage reported Date of last usage reported D ate of current usage reported If enabled, the usage reporting plug-in uses Google Analytics to track data as though you visited a page under To agree to this anonymous information being collected, click Y es when prompted. The usage reporting behavior can be changed at any time by clicking Window Preferences. Expand JBo ss T o o l s and select Usag e R epo rti ng. Select or clear the P l ease al l o w R ed Hat Inc. to recei ve ano nymo us usag e stati sti cs fo r thi s JBo ss D evel o per Stud i o i nstal l ati o n check box to alter the behavior as appropriate Define Servers for Applicat ion Servers Found by Runt ime Det ect ion If you set up runtime detection during the installation process, at the first start of the IDE you are prompted with the results of the runtime detection scan. D epending on whether any application servers are found, follow the appropriate step: If no new application servers are found or if new application servers are found but you do not want to create any server runtime environments for them, click C ancel. 24

29 Chapt er 4. Set Preferences on First Launch aft er Inst alling Figure 4.3. No New Application Servers Found by Runtime Detection If new application servers are found and you want to generate server runtime environments for them, select the check boxes of the appropriate application servers and click O K. Figure 4.4. O ne New Application Server Found by Runtime Detection Note If you did not set up runtime detection during the installation process or you installed JBoss Developer Studio BYOE, you can set up runtime detection in Preferences under JBo ss T o o l s JBo ss R unti me D etecti o n. 25

30 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide 4.5. Set t he Perspect ive t o JBoss JBoss D eveloper Studio has the JBoss perspective. This perspective displays views, toolbars and menu items most often used by developers using JBoss. When you start JBoss Developer Studio, this perspective is set as the default and it is automatically displayed. When you start Eclipse after installing JBoss D eveloper Studio BYOE, this perspective is not automatically displayed. To show the JBoss perspective, click Window O pen Perspective O ther, select JBoss and click O K. To set the JBoss perspective as the default perspective, click Window Preferences. Expand G eneral and select P erspecti ves. From the Avai l abl e perspecti ves list, select JBoss and click Make D efaul t. Click Appl y and click O K to close the P references window. Figure 4.5. Make JBoss the Default Perspective in the Preferences Window 26

31 Chapt er 5. Upgrade from Previous Versions of JBoss Developer St udio Chapter 5. Upgrade from Previous Versions of JBoss Developer Studio 5.1. Upgrade Met hods The method for upgrading JBoss D eveloper Studio depends on the version of JBoss D eveloper Studio from which you are upgrading. Warning Before upgrading, you are advised to back up your workspace. In addition to your project files, your workspace contains meta-data about customized setting and preferences for the IDE. To back up your workspace, either copy the workspace directory to a backup location or save it as a compressed file Upgrade from JBoss Developer St udio 6.x and Earlier It is not possible to upgrade an existing JBoss Developer Studio 6.x or earlier installation to JBoss D eveloper Studio 7.1 because they are based on different versions of Eclipse. For example, JBoss Developer Studio 6.0 is based on Eclipse Juno (4.2) but JBoss Developer Studio 7.1 is based on Eclipse Kepler (4.3). To use JBoss Developer Studio 7.1, you must do one of the following: For JBoss D eveloper Studio, download and run the JBoss D eveloper Studio 7.1 universal installer available from on the Red Hat Customer Portal. For JBoss D eveloper Studio BYOE, upgrade to Eclipse Kepler (4.3) and install JBoss D eveloper Studio 7.1 BYOE from one of the following options: Eclipse Marketplace, the update. zi p file available from the Red Hat Customer Portal or from on the Red Hat JBoss D eveloper Studio Update website. Note You can use different versions of JBoss Developer Studio or JBoss Developer Studio BYOE alongside each other by installing them in different directories or installing them onto different Eclipse installations, respectively Upgrade from JBoss Developer St udio 7.0 It is possible to upgrade an existing JBoss D eveloper Studio 7.0 installation to JBoss Developer Studio 7.1 because they are based on the same version of Eclipse, namely Kepler (4.3). 27

32 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide You may be automatically notified by the IDE when the JBoss Developer Studio 7.1 upgrade is available, depending on your ID E settings for automatic updates. Alternatively, the upgrade method stated here is applicable to JBoss D eveloper Studio and JBoss D eveloper Studio BYOE. To manually initiate the upgrade to JBoss Developer Studio 7.1, in the IDE click Help Check for Updates. The C o ntacti ng So ftware Si tes window opens and searches for updates to apply. If any updates are found they are listed in the Avai l abl e Upd ates window. Ensure the check box for JBoss Developer Studio is selected and click Next. After reading and agreeing to the licenses, click I accept the terms o f the l i cense ag reements and click Fi ni sh. D uring the installation process you may receive warnings about installing unsigned content. If this is the case, review the details of the content and if satisfied click O K to continue with the installation. Once installing is complete, you are prompted to restart the IDE. Click Y es to restart now and No if you need to save any unsaved changes to open projects. Note that IDE changes do not take effect until the ID E is restarted. Note If you are expecting updates but none are found, check that the IDE is aware of the URL where JBoss Developer Studio updates are located. Click Window Preferences, expand Instal l /Upd ate and click Avai l abl e So ftware Si tes. In the table of Avai l abl e So ftware Si tes the URL must be listed. If it is not listed, click Ad d and in the Lo cati o n field type the URL. Click O K to close the Ad d Si te window and click O K to close the P references window. Important If you have installed additional plug-ins from JBoss Central and updated versions of these plug-ins are available with this release of JBoss D eveloper Studio, you must upgrade the plug-ins independently after first upgrading JBoss D eveloper Studio. To install the updated version of an already installed plug-in, from the JBoss Central So ftware/upd ate tab select to install the plug-in as if it is new and follow the installation wizard instructions. 28

33 Chapt er 6. Uninst all JBoss Developer St udio Chapter 6. Uninstall JBoss Developer Studio 6.1. Uninst all Met hods There are two uninstall methods for JBoss Developer Studio. The method you use depends on whether you are using JBoss Developer Studio or JBoss Developer Studio BYOE Uninst all JBoss Developer St udio Procedure 6.1. Uninstall with the Uninstaller 1. Ensure JBoss D eveloper Studio is not running. 2. On the command line, navigate to path/to /JBo ss D evel o per Stud i o /Uni nstal l er. 3. On the command line, enter java -jar uninstaller.jar Note Alternatively, to start the uninstaller you may be able to double-click the uni nstal l er. jar file. 4. To remove the entire JBoss Developer Studio installation directory, select the Fo rce the d el eti o n check box. If this is not selected, JBoss Developer Studio is uninstalled but some files are left behind in the installation directory. 5. Click Uni nstal l. 6. Once the progress bar shows Fi ni shed, click Q ui t to close the Uninstaller window. Figure 6.1. Uninstaller in Finished State 29

34 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide 6.3. Uninst all JBoss Developer St udio BYOE JBoss D eveloper Studio BYOE can be uninstalled with the procedure below regardless of whether it was installed via Eclipse Marketplace or the update. zi p file. Procedure 6.2. Uninstall via Eclipse Marketplace 1. Start Eclipse Kepler. 2. Click Help Eclipse Marketplace. 3. In the Fi nd field of the Search tab, enter R ed Hat JBo ss D evel o per Stud i o. 4. Locate Red Hat JBoss Developer Studio (Kepler) and click Uni nstal l. 30

35 Chapt er 6. Uninst all JBoss Developer St udio Figure 6.2. Uninstall JBoss Developer Studio via Eclipse Marketplace 5. Ensure the R ed Hat JBo ss D evel o per Stud i o (Kepl er) check box is selected and click C o nfi rm. 31

36 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide 6. Ensure the R ed Hat JBo ss D evel o per Stud i o (Kepl er) check box is selected and click Fi ni sh. Figure 6.3. Confirm Selected Features Window 7. Once installing is complete, you are prompted to restart Eclipse. Click Y es to restart immediately and No if you need to save any unsaved changes to open projects. Note that IDE changes do not take effect until Eclipse is restarted. 32

37 Java Developer Kit s Java Developer Kits It is important to use a Java developer kit that is supported by this release of JBoss Developer Studio. The aim of this section is to assist you to do the following: Determine the Java developer kit used by your system Install a supported Java developer kit A.1. Det ermine Default Java Developer Kit of t he Syst em To determine if your system has a Java developer kit set up for use and the version, follow the procedure below which is suitable for all operating systems. Procedure A.1. Determine Default Java Developer Kit of the System 1. On the command line, enter javac -versi o n. The output shows the version of the Java compiler being used as the default of the system and indicates that the system has a Java developer kit set up for use. Important If a message to the effect of javac no t fo und is returned, the system does not have a Java compiler set up for use. This indicates that either the system does not have a Java developer kit installed or that the installed Java developer kit is not set up for use. 2. On the command line, enter java -versi o n. The output preceding R unti me Envi ro nment identifies which Java distribution is being used as the default Java runtime environment (JRE) and the output after java versi o n identifies the version number of the JRE. Important If the version numbers of the Java compiler and JRE are different, the system is using a Java compiler and JRE from different Java distributions as the default. This should be rectified so that the Java compiler and JRE are from the same Java developer kit. Sample output for various Java developer kits is displayed below. Example A.1. Sample O utput from Identifying the Default Java Developer Kit of the Syst em Output for OpenJD K Java developer kit 1.7.0: $ javac -version javac 1.7.0_09 $ java -version java version "1.7.0_09-icedtea" 33

38 Red Hat JBoss Developer St udio 7.1 Inst allat ion G uide OpenJDK Runtime Environment (fedora fc17-x86_64) OpenJDK 64-Bit Server VM (build 23.2-b09, mixed mode) Output for Oracle JD K 1.6.0: $ javac -version javac 1.6.0_38 $ java -version java version "1.6.0_38" Java(TM) SE Runtime Environment (build 1.6.0_38-b05) Java HotSpot(TM) 64-Bit Server VM (build b02, mixed mode) Output for OpenJD K JRE (no Java compiler): $ javac -version bash: /usr/bin/javac: No such file or directory $ java -version java version "1.7.0_09-icedtea" OpenJDK Runtime Environment (fedora fc17-x86_64) OpenJDK Server VM (build 23.2-b09, mixed mode) A.2. Inst all a Java Developer Kit The procedures given here guide you through how to install a new Java developer kit, either OpenJD K or Oracle. Important Each Java developer kit has its own system requirements and these must be checked before starting the installation process. Procedure A.2. Install a O penjdk Java developer kit Complete the appropriate step for your operating system: A. For Red Hat Enterprise Linux and Fedora, on the command line enter sudo yum install java openjdk-devel B. For Ubuntu, on the command line enter sudo apt-get install openjdk-7-jdk Procedure A.3. Install a O racle JDK 34

39 Java Developer Kit s 1. To download a JDK, go to on the Oracle website. Identify the Java SE version you want and follow the instructions to download the appropriate file for your operating system and architecture. Note For Linux distributions, both a. rpm and a. tar. g z file will be available for download. Installing with an RPM binary (. rpm) file requires root access but the archive binary (tar. g z) file can be installed by all users. 2. To install the JD K from the downloaded file, complete the appropriate steps for your operating system: A. For Linux distributions and the. tar. g z file: a. Move the. tar. g z file to the directory where you want to install the JDK. For example, Java distributions are typically stored in /usr/java/. b. On the command line, navigate to the location of the. tar. g z file and enter tar zxvf jdk-<version>-linux-<architecture>.tar.gz replacing <version> and <architecture> as appropriate. c. Once complete, the. tar. g z file can be deleted to save disk space. B. For Linux distributions and the. rpm file: a. On the command line, navigate to the location of the. rpm file and enter sudo rpm -ivh jdk-<version>-linux-<architecture>.rpm replacing <version> and <architecture> as appropriate. b. Once complete, the. rpm file can be deleted to save disk space. C. For OS X operating systems: a. Double-click the. d mg file. b. In the open Finder window, double-click the package icon and follow the installer instructions. c. Once complete, the. d mg file can be deleted to save disk space. D. For Microsoft Windows operating systems: a. D ouble-click the. exe and follow the installer instructions. b. Once complete, the. exe file can be deleted to save disk space. 35