Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaEE Guides


In order to build your app on a SmartDeviceLink (SDL) Core, the SDL software development kit (SDK) must be installed in your app. The following steps will guide you through adding the SDL SDK to your workspace and configuring the environment.


The SDL SDK is currently supported on Java 7 (1.7) and above.

Install SDL SDK

Each SDL JavaEE library release is published to Github. By building and importing the library JAR file to the project, developers can compile with the latest SDL JavaEE release. In this guide we exclusively use IntelliJ to compile and build the project.

Building The JavaEE Library JAR

To build the library JAR from the source code, first clone the SDL Java Suite repository then, simply call:

gradle build

from within the JavaEE directory and a JAR should be generated in the build/libs folder.

Creating a New SDL Project

  • Download Glassfish 5.0.0 Full Platform
  • Start a new IntelliJ Project (Menu -> New -> Project)
  • Select Java Enterprise as project type.
  • Ensure Java EE 8 is the version used.
  • Set Application Server to the directory of Glassfish 5.0.0 download.
  • Check the following: (they should all be using the libraries from Glassfish)
    • Glassfish 5.0.0 - EJB
    • Glassfish 5.0.0 - WebSocket
    • Glassfish 5.0.0 - Web Application
  • Give the project a name.
  • Once the project is created, add the SDL Java JAR library
    (Right-click project -> Open Module Settings -> Libraries -> +)
  • Go to artifacts. A problem may appear concerning the exploded war not having the library.
    Add SDL Java to the war exploded artifact (IntelliJ has an auto fix for it).
    Apply and OK.
  • In the artifacts -> choose ejb exploded -> in the "output layout" tab, click on the + -> Extracted directory -> add the SDL Java JAR library
  • In the artifacts -> choose war exploded -> in the "output layout" tab, click on the + -> Extracted directory -> add the SDL Java JAR library
  • You can now start creating your SDL enabled application. If you already have source code to start with, you can copy it into the new project along with any jars and assets.

Glassfish 5.0.0 only works on JDK 8 and lower.

To Find more information on installation, read our README.

View on GitHub.com
Next Section