Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Getting Started

Red Hat Fuse 7.0

Get started quickly with Red Hat Fuse!

Fuse Documentation Team Fuse Support Team http://access.redhat.com/support

Abstract

Get started with Fuse on Spring Boot, Fuse on Apache Karaf, Fuse on JBoss Enterprise Application Platform, and Fuse on JBoss Web Server

Chapter 1. Getting Started Dashboard
Copy link

The following dashboard shows alternative paths for getting started with Fuse standalone, depending on which container type you prefer:

get started with spring boot

get started with fuse on karaf download devstudio download fuse on karaf

get started with fuse on eap download devstudio download jboss eap download fuse on eap

1.2. Overview of the Fuse containers
Copy link

To help you choose the right container for your project, the following sections give a brief overview of each container type.

1.2.1. JBoss EAP
Copy link

JBoss Enterprise Application Platform (EAP), based on Jakarta EE (previously, Java EE) technology from the Eclipse Foundation, was originally created to address the use cases for developing enterprise applications. Characterized by well-defined patterns for implementing services and standardized Java APIs (for accessing services such as persistence, messaging, security, and so on), in recent years this technology has evolved to be more lightweight, with the introduction of CDI for dependency injection and simplified annotations for enterprise Java beans.

Distinctive features of this container technology are:

  • Particularly suited to running in standalone mode.
  • Many standard services (for example, persistence, messaging, security, and so on) pre-configured and provided out of the box.
  • Application WARs typically small and lightweight (since many dependencies are pre-installed in the container).
  • Standardized, backward-compatible Java APIs.

1.2.2. Apache Karaf
Copy link

Apache Karaf is based on the OSGi standard from the OSGi Alliance. OSGi originated in the telecommunications industry, where it was used to develop gateway servers that could be upgraded on the fly, without needing to shut down the server (a feature known as hot code swapping). Subsequently, OSGi container technology has found a variety of other uses and is popular for modularised applications (for example, the Eclipse IDE).

Distinctive features of this container technology are:

  • Particularly suited to running in standalone mode.
  • Strong support for modularisation (OSGi bundles), with sophisticated class-loading support.
  • Multiple versions of a dependency can be deployed side by side in a container (but this requires some care in practice).
  • Hot code swapping, enabling you to upgrade or replace a module without shutting down the container. This is a unique feature, but requires significant effort to make it work properly.

1.2.3. Spring Boot
Copy link

Spring Boot is a recent evolution of the well-known Spring container. A distinctive quality of the Spring Boot container is that container functionality is divided up into small chunks, which can be deployed independently. This enables you to deploy a container with a small footprint, specialized for a particular kind of service, and this happens to be exactly what you need to fit the paradigm of a microservices architecture.

Distinctive features of this container technology are:

  • Particularly suited to running on a scalable cloud platform (Kubernetes and OpenShift).
  • Small footprint (ideal for microservices architecture).
  • Optimized for convention over configuration.
  • No application server required. You can run a Spring Boot application Jar directly in a JVM.

Chapter 2. Getting Started with Spring Boot
Copy link

2.1. Overview of the circuit breaker booster
Copy link

The Netflix/Hystrix circuit breaker component enables distributed applications to cope with interruptions to network connectivity and temporary unavailability of backend services. The basic idea of the circuit breaker pattern is that the loss of a dependent service is detected automatically and an alternative behavior can be programmed, in case the backend service is temporarily unavailable.

The Fuse circuit breaker booster consists of two related services:

  • A name service, which returns a name to greet, and
  • A greetings service, which invokes the name service to get a name and then returns the string, Hello, NAME.

In this demonstration, the Hystrix circuit breaker is inserted between the greetings service and the name service. If the name service becomes unavailable, the greetings service can fall back to an alternative behavior and respond to the client immediately, instead of blocking while it waits for the name service to restart.

2.2. Prerequisites
Copy link

To build and run the booster demonstration, install the following prerequisites:

2.3. Generate the booster project
Copy link

To generate the circuit breaker booster project, perform the following steps:

  1. Navigate to https://developers.redhat.com/launch.

  2. Click START.

    The launcher wizard prompts you to log in to your Red Hat account.

  3. The launcher wizard prompts you to log in to your Red Hat account. Click the Log in or register button to log in.
  4. On the Launcher page, click the Deploy an Example Application button.
  5. On the Create Example Application page, type the name, fuse-circuit-breaker, in the Create Example Application as field.
  6. Click Select an Example.

  7. In the Example dialog, select the Circuit Breaker option. A Select a Runtime dropdown menu appears.

    1. From the Select a Runtime dropdown, select Fuse.
    2. From the version dropdown menu, select 7.0.1 (Red Hat Fuse) (do not select the 2.21.2 (Community) version).
    3. Click Save.
  8. On the Create Example Application page, click Download.
  9. When you see the Your Application is Ready dialog, click Download.zip. Your browser downloads the generated booster project (packaged as a ZIP file).
  10. Your browser now commences downloading the generated booster project (packaged as a ZIP file).
  11. After downloading the ZIP file, use an archive utility to extract the generated project to a convenient location on your local filesystem.

2.4. Build and run the booster
Copy link

To build and run the booster project, perform the following steps:

  1. Open a shell prompt and build the project from the command line, using Maven: 

    cd fuse-circuit-breaker
mvn clean package
    Copy to Clipboard Toggle word wrap

  2. Open a new shell prompt and start the name service, as follows: 

    cd name-service
mvn spring-boot:run -DskipTests -Dserver.port=8081
    Copy to Clipboard Toggle word wrap

    As Spring Boot starts up, you should see some output like the following: 

    ...
2019-06-25 10:01:40.763  INFO 13064 --- [           main] o.a.camel.spring.SpringCamelContext      : Route: route1 started and consuming from: servlet:/name?httpMethodRestrict=GET
2019-06-25 10:01:40.764  INFO 13064 --- [           main] o.a.camel.spring.SpringCamelContext      : Total 1 routes, of which 1 are started
2019-06-25 10:01:40.765  INFO 13064 --- [           main] o.a.camel.spring.SpringCamelContext      : Apache Camel 2.21.0.fuse-000112-redhat-3 (CamelContext: camel-1) started in 0.436 seconds
2019-06-25 10:01:40.767  INFO 13064 --- [           main] o.a.c.c.s.CamelHttpTransportServlet      : Initialized CamelHttpTransportServlet[name=CamelServlet, contextPath=]
2019-06-25 10:01:40.840  INFO 13064 --- [           main] b.c.e.u.UndertowEmbeddedServletContainer : Undertow started on port(s) 8081 (http)
2019-06-25 10:01:40.846  INFO 13064 --- [           main] com.redhat.fuse.boosters.cb.Application  : Started Application in 6.431 seconds (JVM running for 10.073)
    Copy to Clipboard Toggle word wrap

  3. Open a new shell prompt and start the greetings service, as follows: 

    cd greetings-service
mvn spring-boot:run -DskipTests
    Copy to Clipboard Toggle word wrap

    As Spring Boot starts up, you should see some output like the following: 

    ...
2019-06-25 10:03:25.061  INFO 13171 --- [           main] o.a.c.c.s.CamelHttpTransportServlet      : Initialized CamelHttpTransportServlet[name=CamelServlet, contextPath=]
2019-06-25 10:03:25.136  INFO 13171 --- [           main] b.c.e.u.UndertowEmbeddedServletContainer : Undertow started on port(s) 8080 (http)
2019-06-25 10:03:25.143  INFO 13171 --- [           main] com.redhat.fuse.boosters.cb.Application  : Started Application in 6.636 seconds (JVM running for 10.59)
    Copy to Clipboard Toggle word wrap

  4. The greetings service exposes a REST endpoint at the URL, http://localhost:8080/camel/greetings. You can invoke the REST endpoint either from a Web browser or from a shell prompt, using the curl command, as follows: 

    $ curl http://localhost:8080/camel/greetings

{"greetings":"Hello, Jacopo"}
    Copy to Clipboard Toggle word wrap
  5. To demonstrate the circuit breaker functionality provided by Camel Hystrix, kill the backend name service by typing Ctrl-C in the window of the shell prompt where the name service is running.

  6. Now that the name service is unavailable, the circuit breaker kicks in to prevent the greetings service from hanging when it is invoked. Invoke the greetings REST endpoint using the curl command, as follows: 

    $ curl http://localhost:8080/camel/greetings

{"greetings":"Hello, default fallback"}
    Copy to Clipboard Toggle word wrap

    The log in the window where the greetings service is running shows the following sequence of messages: 

    2019-06-25 10:05:05.710  INFO 13171 --- [-CamelHystrix-2] route2                                   :  Try to call name Service
2019-06-25 10:05:05.721  INFO 13171 --- [-CamelHystrix-2] o.a.c.httpclient.HttpMethodDirector      : I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
2019-06-25 10:05:05.721  INFO 13171 --- [-CamelHystrix-2] o.a.c.httpclient.HttpMethodDirector      : Retrying request
2019-06-25 10:05:05.722  INFO 13171 --- [-CamelHystrix-2] o.a.c.httpclient.HttpMethodDirector      : I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
2019-06-25 10:05:05.722  INFO 13171 --- [-CamelHystrix-2] o.a.c.httpclient.HttpMethodDirector      : Retrying request
2019-06-25 10:05:05.722  INFO 13171 --- [-CamelHystrix-2] o.a.c.httpclient.HttpMethodDirector      : I/O exception (java.net.ConnectException) caught when processing request: Connection refused (Connection refused)
2019-06-25 10:05:05.722  INFO 13171 --- [-CamelHystrix-2] o.a.c.httpclient.HttpMethodDirector      : Retrying request
2019-06-25 10:05:05.729  INFO 13171 --- [-CamelHystrix-2] route2                                   :  We are falling back!!!!
    Copy to Clipboard Toggle word wrap
  7. For more information about this example, visit the Circuit Breaker Mission page at http://localhost:8080/ (while the greetings-service is running). This page provides a link to the Hystrix dashboard, which monitors the state of the circuit breaker.

Chapter 3. Getting Started with Apache Karaf
Copy link

3.1. Log in to the Customer Portal
Copy link

Before you can download the required packages, you need an account on Red Hat’s Customer Portal which has a Red Hat Fuse subscription. Using this account, log in to the portal at https://access.redhat.com/login.

3.2. Download the required packages
Copy link

Click each of the Download buttons to get the required packages from the Customer Portal:

get started with fuse on karaf download devstudio download fuse on karaf

3.3. Install and configure Fuse on Apache Karaf
Copy link

To install and configure Fuse on Apache Karaf, perform the following steps:

  1. Unpack the downloaded .zip archive file for Fuse on Apache Karaf to a convenient location on your file system, FUSE_INSTALL.

  2. Add an administrator user to the Fuse runtime.

    1. Open the FUSE_INSTALL/etc/users.properties file in a text editor.
    2. Delete the # character at the start of the line that starts with #admin = admin.
    3. Delete the # character at the start of the line that starts with #g\:admingroup.

    4. Customize the username, USERNAME, and password, PASSWORD, of the user entry, so that you have a user entry and an admin group entry like the following (on consecutive lines): 

      USERNAME = PASSWORD,_g_:admingroup
_g_\:admingroup = group,admin,manager,viewer,systembundles,ssh
      Copy to Clipboard Toggle word wrap
    5. Save the etc/users.properties file.

3.4. Set up your development environment
Copy link

To set up your development environment, perform the following steps:

  1. Run the Developer Studio installer, as follows: 

    java -jar DOWNLOAD_LOCATION/devstudio-11.3.0.GA-installer-standalone.jar
    Copy to Clipboard Toggle word wrap

  2. During installation:

    1. Accept the terms and conditions.
    2. Choose your preferred installation path.
    3. Select the Java 8 JVM.
    4. At the Select Platforms and Servers step, configure the Fuse on Karaf runtime by clicking Add and browsing to the location of the FUSE_INSTALL directory (see Section 3.3, “Install and configure Fuse on Apache Karaf”).
    5. At the Select Additional Features to Install step, select JBoss Fuse Tooling.
  3. Developer Studio starts up. When the Searching for runtimes dialog appears, click OK to create the Fuse on Karaf runtime.

  4. (Optional) In order to use Apache Maven from the command line, you need to install and configure Maven as described in Appendix A, Preparing to use Maven.

    Note

    If you are using Developer Studio exclusively, it is not strictly necessary to install Maven, because Developer Studio has Maven pre-installed and configured for you. But if you plan to invoke Maven from the command line, it is necessary to perform this step.

3.5. Build your first application
Copy link

To build your first application with Fuse on JBoss EAP, perform the following steps:

  1. In Developer Studio, create a new project, as follows:

    1. Select File→New→Fuse Integration Project.
    2. Enter fuse-camel-cbr in the Project Name field. Click Next.
    3. Select the Red Hat Fuse 7.0 Runtime server as the Target Runtime.
    4. After selecting the target runtime, the Camel Version is automatically selected for you and the field is grayed out. Click Next.
    5. In the Advanced Project Setup pane, select Use a predefined template.
    6. Select the Red Hat Fuse→Beginner→Content Based Router template.
    7. Make sure that the selected project type is Blueprint DSL.
    8. Click Finish.
    9. If prompted to open the associated Fuse Integration perspective, click Yes.

    10. Wait for a couple of minutes, while Developer Studio downloads required artifacts and builds the project in the background.

      Note

      If this is the first time you are building a Fuse project in Developer Studio, it might take several minutes for the wizard to finish generating the project, as it downloads dependencies from remote Maven repositories.

  2. Deploy the project to the server, as follows:

    1. In the Servers view (bottom left corner of the Fuse Integration perspective), if the server is not already started, select the Red Hat Fuse 7.0 Runtime server and click the green arrow to start it.

    2. Wait until you see a message like the following in the Console view: 

      Karaf started in 5s. Bundle stats: 229 active, 229 total
      Copy to Clipboard Toggle word wrap
    3. After the server has started, switch back to the Servers view, right-click on the server and select Add and Remove from the context menu.
    4. In the Add and Remove dialog, select the fuse-camel-cbr project and click the Add > button.
    5. Click Finish.

    6. You can check whether the project’s OSGi bundle has started up by going to the Terminal view and entering bundle:list | tail. You should see some output like the following: 

      ...
228 │ Active │  80 │ 1.0.0.201505202023          │ org.osgi:org.osgi.service.j
232 │ Active │  80 │ 1.0.0.SNAPSHOT              │ Fuse CBR Quickstart
      Copy to Clipboard Toggle word wrap
      Note

      If you see the dialog, Warning: The authenticity of host 'localhost' can’t be established., click Yes to connect to the server and access the Karaf console.

3.5.1. Verify the project
Copy link

As soon as the Camel route starts up, it will create a directory, work/cbr/input, in your Fuse installation (not in the fuse-camel-cbr project).

Now you can test your Camel route and see it in action.

Copy the files you find in the project’s fuse-camel-cbr/src/main/data directory (under the Eclipse workspace directory) to the newly created work/cbr/input directory. You can do this in your system file browser (outside of Eclipse).

Wait a few moments and you will find the same files organized by country under the work/cbr/output directory:

  1. order1.xml in work/cbr/output/others
  2. order2.xml and order4.xml in work/cbr/output/uk
  3. order3.xml and order5.xml in work/cbr/output/us

Enter log:display in the Karaf console (Terminal view) to see the application output in the log, for example: 

...
15:46:14.859 INFO [Camel (cbr-example-context) thread #3 - file://work/cbr/input] Receiving order order2.xml
15:46:14.888 INFO [Camel (cbr-example-context) thread #3 - file://work/cbr/input] Sending order order2.xml to the UK
15:46:14.891 INFO [Camel (cbr-example-context) thread #3 - file://work/cbr/input] Done processing order2.xml
15:46:14.895 INFO [Camel (cbr-example-context) thread #3 - file://work/cbr/input] Receiving order order3.xml
Copy to Clipboard Toggle word wrap

3.5.2. Undeploy the project
Copy link

Undeploy the project, as follows:

  1. In the Servers view, select the Red Hat Fuse 7.0 Runtime server.
  2. Right-click on the server and select Add and Remove from the context menu.
  3. In the Add and Remove dialog, select your fuse-camel-cbr project and click the < Remove button.
  4. Click Finish.

4.1. Log in to the Customer Portal
Copy link

Before you can download the required packages, you need an account on Red Hat’s Customer Portal which has a Red Hat Fuse subscription. Using this account, log in to the portal at https://access.redhat.com/login.

4.2. Download the required packages
Copy link

Click each of the Download buttons to get the required packages from the Customer Portal:

get started with fuse on eap download devstudio download jboss eap download fuse on eap

4.3. Install and configure Fuse on JBoss EAP
Copy link

To install and configure Fuse on JBoss EAP, perform the following steps:

  1. Run the JBoss EAP installer from a shell prompt, as follows: 

    java -jar DOWNLOAD_LOCATION/jboss-eap-7.1.0-installer.jar
    Copy to Clipboard Toggle word wrap

  2. During installation:

    1. Accept the terms and conditions.
    2. Choose your preferred installation path, EAP_INSTALL, for the JBoss EAP runtime.
    3. Create an administrative user and make a careful note of these administrative user credentials for later.
    4. You can accept the default settings on the remaining screens.
  3. Open a shell prompt and change directory to EAP_INSTALL.

  4. From the EAP_INSTALL directory, run the Fuse on EAP installer, as follows: 

    java -jar DOWNLOAD_LOCATION/jboss-fuse-eap-installer-7.0.0.000041-fuse-000001-redhat-1.jar
    Copy to Clipboard Toggle word wrap

4.4. Set up your development environment
Copy link

To set up your development environment, perform the following steps:

  1. Run the Developer Studio installer, as follows: 

    java -jar DOWNLOAD_LOCATION/devstudio-11.3.0.GA-installer-standalone.jar
    Copy to Clipboard Toggle word wrap

  2. During installation:

    1. Accept the terms and conditions.
    2. Choose your preferred installation path.
    3. Select the Java 8 JVM.
    4. At the Select Platforms and Servers step, configure the JBoss EAP runtime by clicking Add and browsing to the location of the EAP_INSTALL directory (see Section 4.3, “Install and configure Fuse on JBoss EAP”).
    5. At the Select Additional Features to Install step, select JBoss Fuse Tooling.
  3. Developer Studio starts up. When the Searching for runtimes dialog appears, click OK to create the JBoss EAP runtime.

  4. (Optional) In order to use Apache Maven from the command line, you need to install and configure Maven as described in Appendix A, Preparing to use Maven.

    Note

    If you are using Developer Studio exclusively, it is not strictly necessary to install Maven, because Developer Studio has Maven pre-installed and configured for you. But if you plan to invoke Maven from the command line, it is necessary to perform this step.

4.5. Build your first application
Copy link

To build your first application with Fuse on JBoss EAP, perform the following steps:

  1. In Developer Studio, create a new project, as follows:

    1. Select File→New→Fuse Integration Project.
    2. Enter eap-camel in the Project Name field. Click Next.
    3. Select the Red Hat JBoss EAP 7.1 Runtime server as the Target Runtime.
    4. After selecting the target runtime, the Camel Version is automatically selected for you and the field is grayed out. Click Next.
    5. In the Advanced Project Setup pane, select Use a predefined template.
    6. Select the Fuse on EAP→Medium→Spring on EAP template.
    7. Click Finish.
    8. If prompted to open the associated Fuse Integration perspective, click Yes.
    9. Wait for a couple of minutes, while Developer Studio downloads required artifacts and builds the project in the background.

  2. Deploy the project to the server, as follows:

    1. In the Servers view (bottom left corner of the Fuse Integration perspective), if the server is not already started, select the Red Hat JBoss EAP 7.1 Runtime server and click the green arrow to start it.

    2. Wait until you see a message like the following in the Console view: 

      12:02:25,467 INFO  [org.jboss.as] (Controller Boot Thread) JBAS015874: JBoss EAP 6.4.0.GA (AS 7.5.0.Final-redhat-21) started in 9494ms - Started 480 of 518 services (69 services are lazy, passive or on-demand)
      Copy to Clipboard Toggle word wrap
    3. After the server has started, switch back to the Servers view, right-click on the server and select Add and Remove from the context menu.
    4. In the Add and Remove dialog, select the eap-camel project and click the Add > button.
    5. Click Finish.

  3. Verify that the project is working, as follows:

    1. Browse to the following URL to access the service running in the eap-camel project: http://localhost:8080/camel-test-spring?name=Kermit
    2. The browser window should show the response Hello Kermit.

  4. Undeploy the project, as follows:

    1. In the Servers view, select the Red Hat JBoss EAP 7.1 Runtime server.
    2. Right-click on the server and select Add and Remove from the context menu.
    3. In the Add and Remove dialog, select your eap-camel project and click the < Remove button.
    4. Click Finish.

Appendix A. Preparing to use Maven
Copy link

A.1. Overview
Copy link

This section gives a brief overview of how to prepare Maven for building Red Hat JBoss Fuse projects and introduces the concept of Maven coordinates, which are used to locate Maven artifacts.

A.2. Prerequisites
Copy link

In order to build a project using Maven, you must have the following prerequisites:

  • Maven installation — Maven is a free, open source build tool from Apache. You can download the latest version from the Maven download page.

  • Network connection — whilst performing a build, Maven dynamically searches external repositories and downloads the required artifacts on the fly. By default, Maven looks for repositories that are accessed over the Internet. You can change this behavior so that Maven will prefer searching repositories that are on a local network.

    Note

    Maven can run in an offline mode. In offline mode Maven only looks for artifacts in its local repository.

A.3. Adding the Red Hat Maven repositories
Copy link

In order to access artifacts from the Red Hat Maven repositories, you need to add them to Maven’s settings.xml file. Maven looks for your settings.xml file in the .m2 directory of the user’s home directory. If there is not a user specified settings.xml file, Maven will use the system-level settings.xml file at M2_HOME/conf/settings.xml.

To add the Red Hat repositories to Maven’s list of repositories, you can either create a new .m2/settings.xml file or modify the system-level settings. In the settings.xml file, add repository elements for the Red Hat repositories as shown in Adding the Red Hat JBoss Fuse Repositories to Maven.

Adding the Red Hat JBoss Fuse Repositories to Maven

<?xml version="1.0"?>
<settings>

  <profiles>
    <profile>
      <id>extra-repos</id>
      <activation>
        <activeByDefault>true</activeByDefault>
      </activation>
      <repositories>
       <repository>
            <id>redhat-ga-repository</id>
            <url>https://maven.repository.redhat.com/ga</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
        <repository>
            <id>redhat-ea-repository</id>
            <url>https://maven.repository.redhat.com/earlyaccess/all</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
        <repository>
          <id>jboss-public</id>
          <name>JBoss Public Repository Group</name>
          <url>https://repository.jboss.org/nexus/content/groups/public/</url>
        </repository>
      </repositories>
      <pluginRepositories>
        <pluginRepository>
            <id>redhat-ga-repository</id>
            <url>https://maven.repository.redhat.com/ga</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
        <pluginRepository>
            <id>redhat-ea-repository</id>
            <url>https://maven.repository.redhat.com/earlyaccess/all</url>
            <releases>
                <enabled>true</enabled>
            </releases>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </pluginRepository>
        <pluginRepository>
          <id>jboss-public</id>
          <name>JBoss Public Repository Group</name>
          <url>https://repository.jboss.org/nexus/content/groups/public</url>
        </pluginRepository>
      </pluginRepositories>
    </profile>
  </profiles>

  <activeProfiles>
    <activeProfile>extra-repos</activeProfile>
  </activeProfiles>

</settings>
Copy to Clipboard Toggle word wrap

A.4. Artifacts
Copy link

The basic building block in the Maven build system is an artifact. The output of an artifact, after performing a Maven build, is typically an archive, such as a JAR or a WAR.

A.5. Maven coordinates
Copy link

A key aspect of Maven functionality is the ability to locate artifacts and manage the dependencies between them. Maven defines the location of an artifact using the system of Maven coordinates, which uniquely define the location of a particular artifact. A basic coordinate tuple has the form, {groupId, artifactId, version}. Sometimes Maven augments the basic set of coordinates with the additional coordinates, packaging and classifier. A tuple can be written with the basic coordinates, or with the additional packaging coordinate, or with the addition of both the packaging and classifier coordinates, as follows: 

groupdId:artifactId:version
groupdId:artifactId:packaging:version
groupdId:artifactId:packaging:classifier:version
Copy to Clipboard Toggle word wrap

Each coordinate can be explained as follows:

groupdId
Defines a scope for the name of the artifact. You would typically use all or part of a package name as a group ID — for example, org.fusesource.example.
artifactId
Defines the artifact name (relative to the group ID).
version
Specifies the artifact’s version. A version number can have up to four parts: n.n.n.n, where the last part of the version number can contain non-numeric characters (for example, the last part of 1.0-SNAPSHOT is the alphanumeric substring, 0-SNAPSHOT).
packaging
Defines the packaged entity that is produced when you build the project. For OSGi projects, the packaging is bundle. The default value is jar.
classifier
Enables you to distinguish between artifacts that were built from the same POM, but have different content.

The group ID, artifact ID, packaging, and version are defined by the corresponding elements in an artifact’s POM file. For example: 

<project ... >
  ...
  <groupId>org.fusesource.example</groupId>
  <artifactId>bundle-demo</artifactId>
  <packaging>bundle</packaging>
  <version>1.0-SNAPSHOT</version>
  ...
</project>
Copy to Clipboard Toggle word wrap

For example, to define a dependency on the preceding artifact, you could add the following dependency element to a POM: 

<project ... >
  ...
  <dependencies>
    <dependency>
      <groupId>org.fusesource.example</groupId>
      <artifactId>bundle-demo</artifactId>
      <version>1.0-SNAPSHOT</version>
    </dependency>
  </dependencies>
  ...
</project>
Copy to Clipboard Toggle word wrap
Note

It is not necessary to specify the bundle package type in the preceding dependency, because a bundle is just a particular kind of JAR file and jar is the default Maven package type. If you do need to specify the packaging type explicitly in a dependency, however, you can use the type element.

Legal Notice
Copy link

Copyright © 2019 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat