Red Hat JBoss Developer Studio 7.1 Installation Guide

Red Hat Documentation Team

Red Hat JBoss Developer Studio 7.1

Installation Guide

Red Hat JBoss Developer Studio 7.1 Installation Guide

Information for users installing JBoss Developer Studio

Red Hat Do cumentatio n Team

Co pyright © 20 13, 20 14 Red Hat, Inc.

This do cument is licensed by Red Hat under the

Creative Co mmo ns Attributio n-ShareAlike 3.0

Unpo rted License

. If yo u distribute this do cument, o r a mo dified versio n o f it, yo u must pro vide

attributio n to Red Hat, Inc. and pro vide a link to the o riginal. If the do cument is mo dified, all Red

Hat trademarks must be remo ved.

Red Hat, as the licenso r o f this do cument, waives the right to enfo rce, and agrees no t to assert,

Sectio n 4 d o f CC-BY-SA to the fullest extent permitted by applicable law.

Red Hat, Red Hat Enterprise Linux, the Shado wman lo go , JBo ss, MetaMatrix, Fedo ra, the Infinity

Lo go , and RHCE are trademarks o f Red Hat, Inc., registered in the United States and o ther

co untries.

Linux ® is the registered trademark o f Linus To rvalds in the United States and o ther co untries.

Java ® is a registered trademark o f Oracle and/o r its affiliates.

XFS ® is a trademark o f Silico n Graphics Internatio nal Co rp. o r its subsidiaries in the United

States and/o r o ther co untries.

MySQL ® is a registered trademark o f MySQL AB in the United States, the Euro pean Unio n and

o ther co untries.

No de.js ® is an o fficial trademark o f Jo yent. Red Hat So ftware Co llectio ns is no t fo rmally

related to o r endo rsed by the o fficial Jo yent No de.js o pen so urce o r co mmercial pro ject.

The OpenStack ® Wo rd Mark and OpenStack Lo go are either registered trademarks/service

marks o r trademarks/service marks o f the OpenStack Fo undatio n, in the United States and o ther

co untries and are used with the OpenStack Fo undatio n's permissio n. We are no t 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

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

Table of Contents

⁠2. G etting Help and G iving Feed b ack

⁠Chapt er 1 . Int roduct ion t o Red Hat JBoss Developer St udio

⁠1.1. Ab o ut Red Hat JBo ss Develo p er Stud io ⁠1.2. Use Cases o f JBo ss Develo p er Stud io

⁠Chapt er 2 . Syst em Requirement s

⁠2.1. System Req uirements O verview

⁠2.2. Sup p o rted O p erating Systems and Architectures ⁠2.3. Co mp uter Memo ry

⁠2.4. Co mp atib le Java Develo p er Kits

⁠Chapt er 3. Inst all JBoss Developer St udio

⁠3.1. Install O p tio ns

⁠3.2. Install JBo ss Develo p er Stud io ⁠3.3. Install JBo ss Develo p er Stud io BYO E

⁠Chapt er 4 . Set Preferences on First Launch aft er Inst alling

⁠4.1. Preferences O p tio ns

⁠4.2. Select a Wo rksp ace Lo catio n ⁠4.3. Set Usag e Rep o rting

⁠4.4. Define Servers fo r Ap p licatio n Servers Fo und b y Runtime Detectio n ⁠4.5. Set the Persp ective to JBo ss

⁠Chapt er 5. Upgrade from Previous Versions of JBoss Developer St udio

⁠5.1. Up g rad e Metho d s

⁠5.2. Up g rad e fro m JBo ss Develo p er Stud io 6 .x and Earlier ⁠5.3. Up g rad e fro m JBo ss Develo p er Stud io 7.0

⁠Chapt er 6 . Uninst all JBoss Developer St udio

⁠6 .1. Uninstall Metho d s

⁠6 .2. Uninstall JBo ss Develo p er Stud io ⁠6 .3. Uninstall JBo ss Develo p er Stud io BYO E

Java Developer Kit s

⁠A.1. Determine Default Java Develo p er Kit o f the System ⁠A.2. Install a Java Develo p er Kit

Supplement ary Inst allat ion Procedures

⁠B.1. Build the Universal Installer fro m So urce ⁠B.2. Install JBo ss Develo p er Stud io b y Scrip t

Revision Hist ory

2 2 2 3 4 4 6 6 6 9 9 9 10 10 1 1 11 11 16 2 2 22 22 23 24 26 2 7 27 27 27 2 9 29 29 30 33 33 34 36 36 37 39 T able of Cont ent s

Preface

1. Document Convent ions

This manual uses several conventions to highlight certain words and phrases and draw attention to specific pieces of information.

1.1. 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.

Pro p o rt io n al Bo ld

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 Syst em → Pref eren ces → Mo u se from the main menu bar to launch Mo u se Pref eren ces. 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 g ed it file, choose Ap p licat io n s →

Accesso ries → Ch aract er Map from the main menu bar. Next, choose Search → Fin d … from the Ch aract er 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

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 Ed it → Past e from the g ed it 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.

1.2. 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) {

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 Yo u Need Help ?

If you experience difficulty with a procedure described in this documentation, visit the Red Hat Customer Portal at http://access.redhat.com. 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).

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

https://www.redhat.com/mailman/listinfo. Click on the name of any mailing list to subscribe to that list or to access the list archives.

G ive u s Feed b ack

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 Do cu men t at io n f o r JBo ss T o o ls an d Develo p er St u d io ( T O O LSDO C) . The following link will take you to a pre-filled bug report for this product: https://issues.jboss.org.

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.

Chapter 1. Introduction to Red Hat JBoss Developer Studio

1.1. About Red Hat JBoss Developer St udio

Red Hat JBoss Developer 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 (IDE).

JBoss Developer 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 IDE. Furthermore, JBoss Developer Studio can assist your application development with its unique features in the following ways:

Develop 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, CDI 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

Deploy applications to JBoss runtime servers and the cloud using JBoss Server Tools and OpenShift Tools

JBoss Developer 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 Developer Studio can also be installed through Eclipse Marketplace. For distinction, this latter JBoss Developer Studio installation is called JBoss Developer Studio BYOE (Bring Your Own Eclipse).

Report a bug

1.2. Use Cases of JBoss Developer St udio

JBoss Developer Studio assists JEE developers by integrating JBoss technology and APIs in a single development environment. Here are a few ways that JBoss Developer Studio makes the work of a developer easier:

Web ap p licat io n s

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 Developer Studio also offers project file templates in a range of popular programming languages, including HTML, XHTML, and JSF.

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 Developer Studio supports the Java EE specification and provides tools for JAX-RS, Hibernate, and CDI 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 ap p licat io n s o p t imiz ed f o r mo b ile d evices

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. Hyb rid mo b ile ap p licat io n s

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 Discovery 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 Cordova-enabled 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 SDK 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.

Ap p licat io n s f o r clo u d d ep lo ymen t

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,

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.

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 Developer 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 Developer Studio.

A variety of operating systems and Java developer kit combinations are supported.

Report a bug

2.2. Support ed Operat ing Syst ems and Archit ect ures

JBoss Developer Studio 7.1 is supported on the operating systems listed in the table below. T ab le 2.1. Su p p o rt ed O p erat in g Syst ems

O p erat in g Syst em Ch ip Arch it ect u re

Red Hat Enterprise Linux 6 x86, x86_64 Microsoft Windows XP, Windows 7 and Windows 8 x86, x86_64 OS X Lion (10.7) ⁠ , OS X Mountain Lion (10.8) and OS X Mavericks

(10.9) ⁠

x86_64

Fedora 18 and Fedora 19 x86, x86_64

Ubuntu 12.04.2 LTS and Ubuntu 13.04 x86, x86_64

As JBoss Developer Studio 7.1 is based on Eclipse Kepler (4.3), the system requirements of Eclipse Kepler also apply to JBoss Developer 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

http://www.eclipse.org/eclipse/development/readme_eclipse_4.3.html 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 Developer 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 Developer 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 Developer Studio, you must set BrowserSim [a]

[b ]

[a] O S X Lio n (10 .7) is sup p o rted b y JBo ss Develo p er Stud io 7.1.0 o nly.

[b ] O S X Mavericks (10 .9 ) is sup p o rted b y JBo ss Develo p er Stud io 7.1.1 o nly.

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.

Report a bug

2.3. Comput er Memory

To install and run JBoss Developer 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.

Report a bug

2.4 . 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 Developer Studio is supported on the operating system and Java developer kit combinations listed in the table below.

T ab le 2.2. Su p p o rt ed Co mb in at io n s o f O p erat in g Syst ems an d Java Develo p er Kit s

O p erat in g Syst em Java Develo p er Kit

Red Hat Enterprise Linux 6 OpenJDK 1.6, OpenJDK 1.7, Oracle JDK 1.6 and Oracle JDK 1.7

Microsoft Windows XP Oracle JDK 1.6

Microsoft Window 7 and Windows 8 Oracle JDK 1.6 and Oracle JDK 1.7 OS X Lion (10.7) ⁠ , OS X Mountain Lion (10.8)

and OS X Mavericks (10.9) ⁠

Apple JDK 1.6 and Oracle JDK 1.7 (64-bit only) Fedora 18 and Fedora 19 OpenJDK 1.6 and OpenJDK 1.7

Ubuntu 12.04.2 LTS and Ubuntu 13.04 OpenJDK 1.6 and OpenJDK 1.7

Before installing JBoss Developer 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 Report a bug

[a]

[b ]

[a] O S X Lio n (10 .7) is sup p o rted b y JBo ss Develo p er Stud io 7.1.0 o nly.

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 Developer 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 Developer Studio and JBoss EAP.

Alternatively, if you already have Eclipse on your system you may prefer to install JBoss Developer Studio BYOE. This option installs JBoss Developer Studio in Eclipse.

The primary installation method for JBoss Developer Studio and JBoss Developer 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 Developer Studio by Script”.

Report a bug

3.2. Inst all JBoss Developer St udio

A universal installer . jar file is provided for installing JBoss Developer Studio and it is available from the Customer Portal. A second version of the universal installer for installing both JBoss Developer 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 Developer Studio. For instructions for building the universal installer see Section B.1, “ Build the Universal Installer from Source”.

Pro ced u re 3.1. In st all wit h t h e Un iversal In st aller

1. Log into the Customer Portal at https://access.redhat.com. 2. From the menu bar click Do wn lo ad s.

3. Under Red Hat JBo ss Mid d leware, click Do wn lo ad So f t ware.

Fig u re 3.1. Do wn lo ad Red Hat JBo ss Mid d leware So f t ware o n t h e Cu st o mer Po rt al

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 7. 1. 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 7. 1. 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 7. 1. 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.

Fig u re 3.2. In st allat io n St ep 3: Select T arg et Fo ld er

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 Developer 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.

Fig u re 3.3. In st allat io n St ep 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 Developer Studio and generates a complete server definition within the IDE 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 Developer 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.

Fig u re 3.4 . Ad d Lo cat io n Win d o w f o r Ru n t ime Det ect io n

13. Review the details in the Su mmary In f o rmat io n 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.

Fig u re 3.5. In st allat io n St ep 7: In st allat io n Pro g ress in Fin ish ed St at e

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.

16. To automatically start JBoss Developer 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 9 216 at a minimum. If the variables have smaller values, the values must be increased to 9 216 . If the variables are not specified, the following lines must be added to the file:

* soft nofile 9216 * hard nofile 9216

Report a bug

3.3. 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 Developer 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 Developer Studio BYOE installation process.

Pro ced u re 3.2. In st all f ro m Eclip se Market p lace 1. Start Eclipse Kepler.

2. Click Help →Eclip se Market p lace.

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 JBo ss Develo p er St u d io ( Kep ler) and click Instal l .

Fig u re 3.6 . In st all JBo ss Develo p er St u d io BYO E via Eclip se Market p lace

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.

Fig u re 3.7. Co n f irm Select ed Feat u res Win d o w

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.

Fig u re 3.8. Review Licen ses Win d o w

7. During 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.

Fig u re 3.9 . Warn in g Pro mp t f o r In st allin g Un sig n ed Co n t en t

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.

Pro ced u re 3.3. In st all f ro m Up d at e . 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 https://access.redhat.com on the Customer Portal or https://devstudio.jboss.com/updates/7.0/ on the Red Hat JBoss Developer update website.

1. Start Eclipse Kepler.

2. Click Help →In st all New So f t ware.

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 /.

Fig u re 3.10. Wo rk f ro m an O n lin e Web sit e

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.

Fig u re 3.11. Wo rk f ro m a Lo cal Co p y o f t h e Up d at e . 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.

Fig u re 3.12. Availab le So f t ware Win d o w List in g JBo ss Develo p er St u d io 7.x -Brin g Yo u r O wn Eclip se

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.

Fig u re 3.13. Review Licen ses Win d o w

7. During 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.

Fig u re 3.14 . Warn in g Pro mp t f o r In st allin g Un sig n ed Co n t en t

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.

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 IDE start after installing:

Select a workspace for your projects

Choose whether to enable JBoss Developer Studio to collect usage information for compiling product-wide statistics

Decide whether to define servers for application servers that runtime detection found on IDE start Activate the JBoss perspective to provide easy access to common views, menus and toolbars for working with JBoss technologies

Report a bug

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.

Fig u re 4 .1. Select a Wo rksp ace Win d o w To set the workspace location, follow these steps:

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

Win d o w→Pref eren ces. 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.

Report a bug

4 .3. 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 Developer Studio.

Fig u re 4 .2. Pro mp t f o r An o n ymo u s Usag e St at ist ics

The information collected enables Red Hat to understand how and where JBoss Developer Studio is being used. Specifically, information about operating systems and system display resolution assists in continually improving JBoss Developer Studio.

The following information is collected: Version of JBoss Developer Studio

Installed components of JBoss Developer Studio JBoss Central enabled

Origin of Eclipse product Version of Eclipse

Operating system

Operating system version

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 Developer Studio has been started Date of first usage reported

Date of last usage reported Date of current usage reported

If enabled, the usage reporting plug-in uses Google Analytics to track data as though you visited a page under https://devstudio.jboss.com/usage.

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 Win d o w→Pref eren ces. 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.

Report a bug

4 .4 . 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. Depending 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 .

Fig u re 4 .3. No New Ap p licat io n Servers Fo u n d b y Ru n t ime Det ect io n

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.

Fig u re 4 .4 . O n e New Ap p licat io n Server Fo u n d b y Ru n t ime Det ect io n

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 Pref eren ces under JBo ss T o o l s→JBo ss R unti me D etecti o n.

Report a bug

4 .5. Set t he Perspect ive t o JBoss

JBoss Developer 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 Developer Studio BYOE, this perspective is not automatically displayed. To show the JBoss perspective, click Win d o w→O p en

Persp ect ive→O t h er, select JBo ss and click O K.

To set the JBoss perspective as the default perspective, click Win d o w→Pref eren ces. Expand G eneral and select P erspecti ves. From the Avai l abl e perspecti ves list, select JBo ss and click Make D efaul t. Click Appl y and click O K to close the P references window.

Fig u re 4 .5. Make JBo ss t h e Def au lt Persp ect ive in t h e Pref eren ces Win d o w

Chapter 5. Upgrade from Previous Versions of JBoss Developer

Studio

5.1. Upgrade Met hods

The method for upgrading JBoss Developer Studio depends on the version of JBoss Developer 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.

Report a bug

5.2. 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 Developer 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 Developer Studio, download and run the JBoss Developer Studio 7.1 universal installer available from https://access.redhat.com on the Red Hat Customer Portal.

For JBoss Developer Studio BYOE, upgrade to Eclipse Kepler (4.3) and install

JBoss Developer 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

https://devstudio.jboss.com/updates/7.0/ on the Red Hat JBoss Developer 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.

Report a bug

5.3. Upgrade from JBoss Developer St udio 7.0

It is possible to upgrade an existing JBoss Developer Studio 7.0 installation to

JBoss Developer Studio 7.1 because they are based on the same version of Eclipse, namely Kepler (4.3).

You may be automatically notified by the IDE when the JBoss Developer Studio 7.1 upgrade is available, depending on your IDE settings for automatic updates. Alternatively, the upgrade method stated here is applicable to JBoss Developer Studio and JBoss Developer Studio BYOE.

To manually initiate the upgrade to JBoss Developer Studio 7.1, in the IDE click Help →Ch eck f o r Up d at es. 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 7.1.0 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.

During 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 IDE 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 Win d o w→Pref eren ces, 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 https://devstudio.jboss.com/updates/7.0/ 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 Developer Studio, you must upgrade the plug-ins independently after first upgrading JBoss Developer 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.

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.

Report a bug

6.2. Uninst all JBoss Developer St udio

Pro ced u re 6 .1. Un in st all wit h t h e Un in st aller 1. Ensure JBoss Developer 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 Un in st aller window.

Fig u re 6 .1. Un in st aller in Fin ish ed St at e

6.3. Uninst all JBoss Developer St udio BYOE

JBoss Developer Studio BYOE can be uninstalled with the procedure below regardless of whether it was installed via Eclipse Marketplace or the update . zi p file.

Pro ced u re 6 .2. Un in st all via Eclip se Market p lace 1. Start Eclipse Kepler.

2. Click Help →Eclip se Market p lace.

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 JBo ss Develo p er St u d io ( Kep ler) and click Uni nstal l .

Fig u re 6 .2. Un in st all JBo ss Develo p er St u d io via Eclip se Market p lace

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.

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.

Fig u re 6 .3. Co n f irm Select ed Feat u res Win d o w

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.

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

Report a bug

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.

Pro ced u re A.1. Det ermin e Def au lt Java Develo p er Kit o f t h e Syst em

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.

Examp le A.1. Samp le O u t p u t f ro m Id en t if yin g t h e Def au lt Java Develo p er Kit o f t h e Syst em

Output for OpenJDK Java developer kit 1.7.0: $ javac -version

javac 1.7.0_09 $ java -version

OpenJDK Runtime Environment (fedora-2.3.5.fc17-x86_64) OpenJDK 64-Bit Server VM (build 23.2-b09, mixed mode) Output for Oracle JDK 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 20.13-b02, mixed mode) Output for OpenJDK JRE 1.7.0 (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-2.3.5.fc17-x86_64) OpenJDK Server VM (build 23.2-b09, mixed mode)

Report a bug

A.2. Inst all a Java Developer Kit

The procedures given here guide you through how to install a new Java developer kit, either OpenJDK or Oracle.

Important

Each Java developer kit has its own system requirements and these must be checked before starting the installation process.

Pro ced u re A.2. In st all a O p en JDK Java d evelo p er 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-1.7.0-openjdk-devel

B. For Ubuntu, on the command line enter

sudo apt-get install openjdk-7-jdk Pro ced u re A.3. In st all a O racle JDK

1. To download a JDK, go to

http://www.oracle.com/technetwork/java/javase/downloads/index.html 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 JDK 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. Double-click the . exe and follow the installer instructions. b. Once complete, the . exe file can be deleted to save disk space.

Report a bug

Supplementary Installation Procedures

B.1. Build t he Universal Inst aller from Source

A source code . zi p file is provided for building the JBoss Developer Studio universal installer and it is available from the Red Hat Customer Portal. The procedure below guides you through obtaining the source code and the build process.

Important

Maven must be installed to build the universal installer from the source code. To obtain Maven see http://maven.apache.org/.

Pro ced u re B.1. Bu ild t h e Un iversal In st aller f ro m So u rce 1. Log into the Customer Portal at https://access.redhat.com. 2. From the menu bar click Do wn lo ad s.

3. Under Red Hat JBo ss Mid d leware, click Do wn lo ad So f t ware.

Fig u re B.1. Do wn lo ad Red Hat JBo ss Mid d leware So f t ware o n t h e Cu st o mer Po rt al

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 7. 1. x.

5. From the table, click D o wnl o ad for the R ed Hat JBo ss D evel o per Stud i o 7. 1. x So urce C o d e download file. This downloads the sources . zi p file.

6. On the command line, navigate to path/to /. zi p and enter unzip jbdevstudio-product-sources-version.zip

where version is substituted to match the name of the downloaded file. The archive is extracted to a d evstud i o directory.

7. To build the universal installer, on the command line navigate to d evstud i o /pro d uct and enter

mvn clean install

Building takes some time to complete, after which the universal installer . jar file is located in the i nstal l er/targ et/ directory.

Report a bug

B.2. Inst all JBoss Developer St udio by Script

A scripted method is available for use when installing JBoss Developer Studio using the universal installer. The scripted installation method removes the need to step through the universal installer GUI for every installation, enabling simplified repeat installations or installations in bulk. The

procedure below details how you can install JBoss Developer Studio stepping through the universal installer GUI once and then use a generated script for subsequent installations.

Note

To install JBoss Developer Studio using scripts, you must first download the universal installer . jar file. You can download the . jar file from https://access.redhat.com on the Red Hat Customer Portal.

Pro ced u re B.2. In st all JBo ss Develo p er St u d io via Scrip t 1. To run the universal installer GUI, on the command line enter

java -jar jbdevstudio-*.jar

This generates a Instal l C o nfi g R eco rd . xml file in the directory where JBoss Developer Studio is installed.

2. To perform repeat installations without stepping through the universal installer GUI, on the command line enter

java -jar jbdevstudio-*.jar InstallConfigRecord.xml This creates an identically configured JBoss Developer Studio installation.

Note

The generated Instal l C o nfi g R eco rd . xml file is machine-specific, using the Java developer kit and installation paths of your system. To use the

Instal l C o nfi g R eco rd . xml file for systems with different operating systems, Java developer kits or paths, you must manually modify the file.

Revision History

Revisio n 7.1.1- 2 Wed No v 05 2014 Mich elle Mu rray TOOLSDOC-540: Fixed typos

Revisio n 7.1.1- 1 T h u Mar 13 2014 Mich elle Mu rray TOOLSDOC-457: Supported operating systems updated

Revisio n 7.1.0- 7 T u e Dec 10 2013 Mich elle Mu rray Published for 7.1.0.GA

Revisio n 7.1.0- 6 Fri No v 08 2013 Mich elle Mu rray Published for 7.1.0.Beta

Revisio n 7.1.0- 5 Wed No v 06 2013 Mich elle Mu rray TOOLSDOC-416: Screen captures updated for UI changes

Revisio n 7.1.0- 4 T u e No v 05 2013 Mich elle Mu rray

TOOLSDOC-392, TOOLSDOC-414: Scripted installations information added, screen captures updated

Revisio n 7.1.0- 3 T h u O ct 24 2013 Mich elle Mu rray TOOLSDOC-413: JIRA links added for bug reporting

Revisio n 7.1.0- 2 T h u O ct 10 2013 Mich elle Mu rray TOOLSDOC-393: Universal installer with JBoss EAP information added

Revisio n 7.1.0- 1 Wed O ct 09 2013 Mich elle Mu rray First draft