Chapter 2. Installation

This chapter guides you through the steps to install AMQ Core Protocol JMS in your environment.

2.1. Using the Red Hat Maven repository

The client uses Apache Maven as its build tool. You can configure your Maven environment to download the library from the Red Hat Maven repository.

Procedure

  1. Add the Red Hat repository to your Maven settings or POM file. For example configuration files, see Section B.1, “Using the online repository”.

    <repository>
      <id>red-hat-ga</id>
      <url>https://maven.repository.redhat.com/ga</url>
    </repository>
  2. Add the library dependency to your POM file.

    <dependency>
      <groupId>org.apache.activemq</groupId>
      <artifactId>artemis-jms-client</artifactId>
      <version>2.7.0.redhat-00056</version>
    </dependency>

The client is now available in your Maven project.

2.2. Installing a local Maven repository

As an alternative to the online repository, AMQ Core Protocol JMS can be installed to your local filesystem as a file-based Maven repository. Note that AMQ Core Protocol JMS is delivered as part of the AMQ Broker component.

Procedure

  1. Use your subscription to download the AMQ Broker Maven Repository zip file.
  2. Extract the file contents into a directory of your choosing.

    On Linux or UNIX, use the unzip command to extract the file contents.

    unzip amq-broker-<version>-maven-repository.zip

    On Windows, right-click on the zip file and select Extract All.

  3. Configure Maven to use the repository in the maven-repository directory inside the extracted install directory. For more information, see Section B.2, “Using a local repository”.

2.3. Installing the zip file

AMQ Core Protocol JMS is delivered as part of the AMQ Broker component. The AMQ Broker zip file contains the examples and a distribution of the client libraries for those not using Maven. If you are using Maven and do not require the examples, you do not need to install the zip file.

Procedure

  1. Use your subscription to download the AMQ Broker zip file.
  2. Extract the file contents into a directory of your choosing.

    On Linux or UNIX, use the unzip command to extract the file contents.

    unzip amq-broker-<version>-bin.zip

    On Windows, right-click on the zip file and select Extract All.

    When you extract the contents of the zip file, a directory named amq-broker-<version> is created. This is the top-level directory of the installation and is referred to as <install-dir> throughout this document.

  3. (Optional) If you are not using Maven, add the jar files in the <install-dir>/lib directory to your Java classpath.