Developing RESTful Services with REST/JAX-RS: Lab Setup Instructions (Windows OS: Java 11, Eclipse, Tomcat 9)

Below are the standard requirements for this course. If you have any questions or issues, please contact us.

Important Note: Student lab files are required on each computer used for the course. The links for these are not in this lab setup, and you should receive them separately.

Other notes:

• It’s a good idea to keep downloaded software install files on the machines during the class in case of problems that require a re-install.
• Cloning a setup is generally not a problem. If it is, we’ll mention it in the software section (for example, much of the IBM/RAD-WAS software can be problematic in this regard).

Hardware and classroom setup.

Each student and the instructor shall have a workstation that fulfills the listed requirements.

• Required: Intel-compatible processor (with reasonably recent hardware).
• Memory: 8GB min recommended
• Disk Space: Free disk space for software installs (generally minimum 2GB)
• Operating System: Windows OS (Any modern version - e.g. Windows 10. - labs have not been tested on Windows 8 variants)
• Required: Zip utility. A good free one is 7-zip
• Required: Adobe Acrobat Reader
• Required: One of Firefox browser (https://www.mozilla.org/en-US/firefox/new/) or Chrome browser (https://www.google.com/chrome/). Edge browser is not sufficient.
• Recommended: Internet access
• Recommended: Class machines networked together - allows students to access a shared network directory.

Install 7-zip 

We’ve found that there are sometimes problems using the built in Windows archive/zip utility. This generally has to do with long path lengths that it can’t handle. Use 7-zip to extract the labs and any software zips which we’ve found very reliable.

• Can try direct download link for 64-bit install: https://www.7-zip.org/a/7z2301-x64.exe
• If that doesn’t work, go to home page https://www.7-zip.org
• Near the top of the page, find the download link for your bitness (probably 64 bit), and download the installer.
• Execute the installer, and take all the defaults.
• You can now extract zip files by right clicking on them, and selecting 7-Zip | Extract ...

Lab Files: Each student and instructor must have lab files installed (links to these files are generally sent separately via e-mail).

• Extract the lab files to a location conveniently accessible to the student (e.g. C:\ )
• Recommend using utility like 7-zip, not Windows built-in extractor.
• If using folder other than C:\, make sure that students know where they are.

Other instructor requirements for the classroom

• Projector or large screen TV capable of 1280x800 or higher resolution. Instructor must be able to use this to project slides.
• Whiteboard (preferred) or flip charts with markers.

Install Java Development Kit – JDK 11 (11.0.24)

• Note that any JDK 11 version should work fine. Other close (later) Java versions (e.g. Java 12 or 13) should be fine also, but have not been tested.

• Download:
• From https://www.oracle.com/java/technologies/javase/jdk11-archive-downloads.html download the installer file for the Windows x64 Installer
  • File name is something like: jdk-11.0.24_windows-x64_bin

• Run the installer and take all defaults.

• Create or modify environment variables. This will add an environment variable JAVA_HOME, and modify your path to include the jdk bin folder. For windows set the following.
  • JAVA_HOME:
    • Navigate to the System Properties widget > click the Advanced tab > click the Environment Variables button
    • In the bottom half of the dialog, click New to add a new System variable
    • Variable name: JAVA_HOME (this is case-sensitive)
    • Variable value: C:\Program Files\Java\jdk-11.0.24 (or adjust to the actual path for your JDK version and where you installed the JDK – please double-check this path – probably best to copy and paste it)
    • Click OK
  • Path:
    • Find this existing entry in the bottom half of the Environment Variables button, and click Edit
    • Click in the Variable value field and move your cursor all the way to the left (pressing Home on your keyboard should do this quickly for you)
    • Check whether the value below is already present, or add it at the beginning if necessary (make sure you get all of this, including the trailing semicolon, with no spaces):
      
      %JAVA_HOME%\bin;
       
  • Click OK repeatedly (likely in 3 different dialogs) until all the dialogs close.

• Open a terminal prompt, type the below, and press Enter

  javac -version

• You should get a message that tells you the version. If the command is not found, you did something wrong.
• Close the terminal prompt. You’re done installing Java

Install Eclipse 2020-06 (or later) for Enterprise Java Developers (Windows OS - 64 bit only)

• Later or earlier editions should work fine. NOTE: You need at lease the 2018-12 edition for full Java 11 support, so don’t use an earlier one if using Java 11.
• Download:
  • Try a direct link first:
  • https://www.eclipse.org/downloads/download.php?file=/technology/epp/downloads/release/2020-06/R/eclipse-jee-2020-06-R-win32-x86_64.zip
  • If you have problems with a direct link, follow the instructions below
    • Go to https://www.eclipse.org/downloads/packages/release/2020-06/r
    • Look for the heading “Eclipse IDE 2020-06 R Packages” and the download areas below it. This is below the top banner on the page. Do NOT use the Installer Download in the banner.
    • Find the section for “Eclipse IDE for Enterprise Java Developers”
    • Click the link next to Windows 64 bit
    • For Windows (64 bit only) the file will have a name like eclipse-jee-2020-06-R-win32-x86_64.zip
• Extract:
  • Unzip the file - Can extract to C:\, or other location convenient to student (as long as they know it, and can access it)
• Test
  • Execute the program (double click on the eclipse.exe executable, or a shortcut for it)
  • Accept the default workspace, and let it load
  • Quit Eclipse
     
• That’s it. You’re done installing Eclipse

Install WildFly 24.0.1

• Download: You can try this direct link first: https://download.jboss.org/wildfly/24.0.1.Final/wildfly-24.0.1.Final.zip
• If the direct link doesn’t work, go to http://wildfly.org/downloads go to the 24.0.1.Final section
  • In that section, find the zip file link for the “Jakarta EE 8 Full & Web Distribution”
    • NOTE: Do not use the top link in that section - the WildFly Preview EE 9.1 Distribution link. That's a preview version for Jakarta 9.
  • The filename will be wildfly-24.0.1.Final.zip
  • Save the file where you can access it easily


• Extract: Extract the zip file where students can access and run it easily.
  • Windows OS: Common location is C:\
  • Mac OS: Common location is user home directory.
     
• Create a JBOSS_HOME Environment variable that points to the WildFly install folder (according to your OS needs)
  • Windows OS: Right click My Computer and choose Properties, Click the Advanced tab, Click the Environment Variables butto
  • *nix / Mac OS: Generally done in user’s shell config file (e.g. ~/.bashrc)

• If not already present, create a JAVA_HOME environment variable that points to the Java installation on your system

• That’s all that needs to be done to install WildFly.