Link

Deploy BuildVu with GlassFish

Table of contents

  1. Compatibility Warning
  2. Building the web app
  3. Deploying the web app
  4. Usage

Compatibility Warning

As of January 2021, the latest GlassFish version is not compatible with Java 10 or higher. If you are using Java 10 or higher, you will need to configure the server to use a Java 9 SDK.

To do so, navigate to /glassfish/config/ and change the following:

Windows:

asenv.bat - Add "set AS_JAVA=PATH\TO\JDK.jdk"
For example: "set AS_JAVA=C:\Program Files\Java\jdk1.8.0_172.jdk"

Mac:

asenv.conf - Add "AS_JAVA=/PATH/TO/JDK.jdk"
For example: "AS_JAVA=/Library/Java/JavaVirtualMachines/jdk1.8.0_172.jdk"

Building the web app

  1. Download and install the latest version of GlassFish. You can use either the Web Profile or the Full Platform. (Versions tested: 4.X, 5.0)
  2. Build a copy of our BuildVu Microservice Example project. Instructions can be found on the GitHub page.

Deploying the web app

  1. Start GlassFish and navigate to the admin console in your browser.
    • For example, the command glassfish5/glassfish/bin/asadmin start-domain will start the server on port 8080, with the admin console on port 4848 - check the README.txt supplied with GlassFish for detailed instructions.
  2. On the home page, click on ‘Applications’ from the menubar on the left, then click ‘Deploy’.
    1
  3. You should now be on the Deploy page as show below.
    1 You should enter the following values.
    The remaining options can be left as their default values or configured however you wish.
    • Upload the .war file you built earlier or Provide GlassFish with the path to it.
    • Set Type to ‘Web Application’.
    • Set a Context Root. If left empty, the default context root (usually the name of the .war file) will be used. For example, if your server is located at localhost:8080 and you’ve set the web app’s context root to buildvu-microservice, you can find it at localhost:8080/buildvu-microservice.
    • Set a Virtual Server - Make sure you have a server selected, or the web app will fail to deploy.
  4. Click OK and you’re done!

You can check if the web app has successfully deployed by navigating to its URL in your browser - you should see a blank white page with BuildVu Microservice Example written in the centre.

Usage

You can interact with the BuildVu Microservice Example using the REST API (See the GitHub page for details).

For specific languages, see our tutorials.

Still need help? Send us your questions.