⁠2.3. Start Developing Prerequisite Tasks

There are two prerequisite tasks that must be completed before commencing the tutorials. The JBoss Web Framework Kit projects in the Start Developing tutorials are Maven-based and require the JBoss EAP and JBoss Web Framework Kit Maven repositories. Once downloaded and the contents extracted, you must configure Maven to use these repositories. Further, these tutorials deploy the project applications to JBoss EAP servers and so you must set up JBoss EAP servers for use within JBoss Developer Studio. These prerequisite tasks are detailed here.
Report a bug

⁠2.3.1. Configure Maven

The JBoss Web Framework Kit projects in the Start Developing tutorials are Maven-based and require the JBoss EAP and JBoss Web Framework Kit Maven repositories. Maven is distributed with JBoss Developer Studio so it is not necessary to install Maven. But, once downloaded and the contents extracted, you must configure Maven to use these specific repositories by editing your Maven configuration file, settings.xml. You can edit settings.xml from within JBoss Developer Studio as detailed in the procedure below.

Important

The procedure details how to configure Maven for using the JBoss Web Framework Kit Maven repository. Once complete, you must repeat this procedure to configure Maven to also use the JBoss EAP Maven repository, replacing the file paths and names accordingly.
⁠

Procedure 2.1. Configure Maven

  1. Click Window→Preferences, expand JBoss Tools and select JBoss Maven Integration.
  2. Click Configure Maven Repositories.
    ⁠
    Description

    Figure 2.1. JBoss Maven Integration Pane in the Preferences Window

  3. Click Add Repository.
  4. Click Recognize JBoss Maven Enterprise Repositories.
  5. Navigate to path/to/jboss-wfk-maven-repository and click OK. JBoss Maven Tools recursively scans the path searching for the Maven repository.
  6. Modify the information in the ID and Name fields as desired, ensure the Active by default check box is selected and click OK.
    ⁠
    Description

    Figure 2.2. Add Maven Repository Wizard

  7. Click Finish and at the prompt asking if you are sure you want to update the Maven configuration file click Yes. If the specified configuration file does not exist, JBoss Maven Tools creates it.
  8. Click Apply and click OK to close the Preferences window.

Note

Maven settings, such as the configuration file, are specified in Preferences under Maven→User Settings. These settings can be customized.
Report a bug

⁠2.3.2. Set Up a Server Using Runtime Detection

These tutorials deploy the project applications to JBoss EAP servers from within JBoss Developer Studio. To accomplish this, you must first inform the IDE about the servers you want to use. JBoss Server Tools provides a runtime detection feature and, as demonstrated in the procedure below, this locates and sets up servers so that they can be used from within the IDE.
⁠

Procedure 2.2. Set Up a Server Using Runtime Detection

  1. Click Window→Preferences, expand JBoss Tools and select JBoss Runtime Detection.
    ⁠
    Description

    Figure 2.3. JBoss Runtime Detection Pane

  2. Click Add.
  3. Navigate to path/to/jboss-eap and click OK. JBoss Server Tools recursively scans the path searching for installed servers and displays a list of those it finds.
  4. Ensure the jboss-eap-version check box is selected, where version denotes the JBoss EAP version, and click OK.
    ⁠
    Description

    Figure 2.4. JBoss EAP 6.x Server Selected

  5. Click Apply and click OK to close the Preferences window. The server is listed in the Servers view in stopped mode.
Report a bug