### Run Examples with Server

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/examples.adoc

Use the `-Pexamples` profile to run multiple examples. This will start a server under `./target/server0` for each example.

```sh
mvn -Pexamples clean install
```

--------------------------------

### Run Examples Without Server

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/examples.adoc

Use the `-PnoServer` profile to prevent the example from starting the server automatically. This allows for manual server management.

```sh
mvn -PnoServer clean install
```

--------------------------------

### Get Help for Broker Creation Options

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-server.adoc

Execute this command to view all available options for creating a broker instance. This is useful for customizing the instance setup.

```bash
$ ./artemis help create
```

--------------------------------

### Basic Test Setup with ActiveMQTestBase

Source: https://github.com/apache/artemis/blob/main/docs/hacking-guide/_tests.adoc

Example of a simple test case extending ActiveMQTestBase. This class provides utilities for configuring, starting, managing, and stopping brokers.

```java
public class MyTest {
    private static final org.slf4j.Logger log = org.slf4j.LoggerFactory.getLogger(MyTest.class);

    @Test
    public void test() {
        log.debug("Log only what you need please!");
    }
}

```

--------------------------------

### Run Example Without Server

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/examples.adoc

Use this command to run an example without starting the Artemis server. The script to configure the server will be generated under ./target.

```bash
mvn verify -PnoServer
```

--------------------------------

### Push Changes to Examples Repository

Source: https://github.com/apache/artemis/blob/main/RELEASING.adoc

Push the main and development branches, along with the release tag, to the examples repository.

```bash
git push origin main development <release-version>
```

--------------------------------

### KubernetesLoginModule Configuration Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/security.adoc

Example configuration for the KubernetesLoginModule, demonstrating optional parameters like role mapping and debugging.

```java
org.apache.activemq.artemis.spi.core.security.jaas.KubernetesLoginModule required
    ;
```

--------------------------------

### Queue Example: Send and Receive Message

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/examples.adoc

This example demonstrates sending a message to a queue and then receiving it. It includes server startup and shutdown logs.

```text
Sent message: This is a text message
Received message: This is a text message
```

--------------------------------

### Complete Maven POM example with Artemis Plugin

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/maven-plugin.adoc

This is a comprehensive example of a Maven POM file that includes the Artemis plugin and its configurations, demonstrating a full project setup.

```xml
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>

   <parent>
      <groupId>org.apache.artemis.examples.broker</groupId>
      <artifactId>jms-examples</artifactId>
      <version>1.1.0</version>
   </parent>

   <artifactId>queue</artifactId>
   <packaging>jar</packaging>
   <name>ActiveMQ Artemis JMS Queue Example</name>

   <properties>
      <activemq.basedir>${project.basedir}/../../../..</activemq.basedir>
   </properties>

   <dependencies>
      <dependency>
         <groupId>org.apache.artemis</groupId>
         <artifactId>artemis-jms-client</artifactId>
         <version>${project.version}</version>
      </dependency>
   </dependencies>

   <build>
      <plugins>
         <plugin>
            <groupId>org.apache.artemis</groupId>
            <artifactId>artemis-maven-plugin</artifactId>
            <executions>
               <execution>
                  <id>create</id>
                  <goals>
                     <goal>create</goal>
                  </goals>

```

--------------------------------

### Bootstrap Configuration Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-server.adoc

An example of the bootstrap.xml file, which configures the embedded web server, security, and the main broker configuration file.

```xml
<broker xmlns="http://activemq.apache.org/schema">

   <jaas-security domain="activemq"/>

   <server configuration="file:/path/to/broker.xml"/>

   <web path="web" rootRedirectLocation="console">
      <binding name="artemis" uri="http://localhost:8161">
         <app name="console" url="console" war="console.war"/>
      </binding>
   </web>
</broker>
```

--------------------------------

### Example Build Output (Queue Example)

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/examples.adoc

This is a common output observed when running an Apache Artemis example using Maven. It details the build process, including compilation, testing, and server startup.

```sh
[INFO] --------------< org.apache.artemis.examples.broker:queue >--------------
[INFO] Building Apache Artemis JMS Queue Example 2.50.0
[INFO]   from pom.xml
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- clean:3.5.0:clean (default-clean) @ queue ---
[INFO] Deleting /home/user/artemis-examples/examples/features/standard/queue/target
[INFO]
[INFO] --- enforcer:3.5.0:enforce (enforce-maven-version) @ queue ---
[INFO] Rule 0: org.apache.maven.enforcer.rules.version.RequireMavenVersion passed
[INFO]
[INFO] --- enforcer:3.5.0:enforce (enforce-java-version) @ queue ---
[INFO] Rule 0: org.apache.maven.enforcer.rules.version.RequireJavaVersion passed
[INFO]
[INFO] --- remote-resources:3.3.0:process (process-resource-bundles) @ queue ---
[INFO] Preparing remote bundle org.apache.apache.resources:apache-jar-resource-bundle:1.7
[INFO] Copying 3 resources from 1 bundle.
[INFO]
[INFO] --- resources:3.3.1:resources (default-resources) @ queue ---
[INFO] Copying 1 resource from src/main/resources to target/classes
[INFO] Copying 3 resources from target/maven-shared-archive-resources to target/classes
[INFO]
[INFO] --- compiler:3.14.0:compile (default-compile) @ queue ---
[INFO] Recompiling the module because of changed source code.
[INFO] Compiling 1 source file with javac [debug release 17] to target/classes
[INFO]
[INFO] --- resources:3.3.1:testResources (default-testResources) @ queue ---
[INFO] skip non existing resourceDirectory /home/user/artemis-examples/examples/features/standard/queue/src/test/resources
[INFO] Copying 3 resources from target/maven-shared-archive-resources to target/test-classes
[INFO]
[INFO] --- compiler:3.14.0:testCompile (default-testCompile) @ queue ---
[INFO] No sources to compile
[INFO]
[INFO] --- surefire:3.5.3:test (default-test) @ queue ---
[INFO]
[INFO] --- jar:3.4.2:jar (default-jar) @ queue ---
[INFO] Building jar: /home/user/artemis-examples/examples/features/standard/queue/target/queue-2.50.0.jar
[INFO]
[INFO] --- artemis:2.50.0:create (create) @ queue ---
[INFO]
[INFO] --- artemis:2.50.0:cli (start) @ queue ---
[INFO] awaiting server to start
server-out:     _        _               _
server-out:    / \  ____| |_  ___ __  __(_) _____ 
server-out:   / _ \|  _ \ __|/ _ \  \/  | |/  __/
server-out:  / ___ \ | \/ |_/  __/ |\/| | |\___ \
server-out: /_/   \_\|   \__\____|_|  |_|_|/___ /
server-out: Apache Artemis 2.50.0
server-out:
server-out:
[INFO] awaiting server to start
server-out:2025-12-23 11:07:42,914 INFO  [org.apache.activemq.artemis.integration.bootstrap] AMQ101000: Starting Apache Artemis Server version 2.50.0
server-out:2025-12-23 11:07:42,943 INFO  [org.apache.activemq.artemis.core.server] AMQ221000: Primary message broker is starting with configuration Broker Configuration (clustered=false,journalDirectory=./data/journal,bindingsDirectory=./data/bindings,largeMessagesDirectory=./data/large-messages,pagingDirectory=./data/paging)
server-out:2025-12-23 11:07:42,961 INFO  [org.apache.activemq.artemis.core.server] AMQ221012: Using AIO Journal

```

--------------------------------

### Example of Add Artemis Release Script

Source: https://github.com/apache/artemis/blob/main/RELEASING.adoc

An example demonstrating how to use the 'add-artemis-release.sh' script with specific version numbers for a release.

```bash
./scripts/release/add-artemis-release.sh ../artemis 2.31.2 2.32.0
```

--------------------------------

### Client Application Log4J2 Properties Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/logging.adoc

Example Log4J2 configuration for a client application. This setup logs at INFO level to the console and a daily rolling file, with a 5-second monitor interval for configuration updates.

```properties
# Log4J 2 configuration

# Monitor config file every X seconds for updates
monitorInterval = 5

rootLogger.level = INFO
rootLogger.appenderRef.console.ref = console
rootLogger.appenderRef.log_file.ref = log_file

logger.activemq.name=org.apache.activemq
logger.activemq.level=INFO

# Console appender
appender.console.type=Console
appender.console.name=console
appender.console.layout.type=PatternLayout
appender.console.layout.pattern=%d %-5level [%logger] %msg%n

```

--------------------------------

### Start Broker as a Service

Source: https://github.com/apache/artemis/blob/main/docs/migration-guide/_configuration.adoc

Use this script to start the broker in the background as a service, analogous to the 'start' command in ActiveMQ.

```sh
bin/artemis-service start
```

--------------------------------

### Start Apache Artemis Broker

Source: https://github.com/apache/artemis/blob/main/artemis-distribution/src/main/resources/README.html

Run this command from the 'bin' directory of a created broker to start the Apache Artemis broker with its default configuration.

```bash
./artemis run
```

--------------------------------

### Install with Dev Profile and Checkstyle

Source: https://github.com/apache/artemis/blob/main/docs/hacking-guide/_maintainers.adoc

Developers are encouraged to use the `dev` profile to activate CheckStyle during the build.

```bash
$ mvn -Pdev install
```

--------------------------------

### Execute 'listConnections' with Filter via GET

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/management.adoc

This example shows how to execute the 'listConnections' operation with a specific filter (protocol equals OPENWIRE) using the URL syntax. The results are parsed with jq.

```console
$ curl -s -H "Origin: http://localhost" -u myUser:myPass "http://localhost:8161/console/jolokia/exec/org.apache.activemq.artemis:broker="0.0.0.0"/listConnections/\{\"field\":\"protocol\",\"operation\":\"EQUALS\",\"value\":\"OPENWIRE\"\}/-1/-1" | jq '.value | fromjson'

```

--------------------------------

### JGroups Configuration File Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/clusters.adoc

An example of a JGroups configuration file used to initialize JGroups channels for broadcasting. Ensure this file is accessible in the Java resource path.

```xml
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="urn:org:jgroups"
        xsi:schemaLocation="urn:org:jgroups http://www.jgroups.org/schema/jgroups.xsd">
  <TCP bind_addr="${jgroups.bind_addr:site_local}"
       bind_port="${jgroups.bind_port:7800}"
```

--------------------------------

### LegacyLDAPSecuritySettingPlugin Configuration Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/security.adoc

Provides a concrete example of configuring the LegacyLDAPSecuritySettingPlugin for security information retrieval from an LDAP server.

```xml
<security-setting-plugin class-name="org.apache.activemq.artemis.core.server.impl.LegacyLDAPSecuritySettingPlugin">
   <setting name="initialContextFactory" value="com.sun.jndi.ldap.LdapCtxFactory"/>
   <setting name="connectionURL" value="ldap://localhost:1024"/>
   <setting name="connectionUsername" value="uid=admin,ou=system"/>
   <setting name="connectionPassword" value="secret"/>
   <setting name="connectionProtocol" value="s"/>
   <setting name="authentication" value="simple"/>
</security-setting-plugin>
```

--------------------------------

### Start Broker in Foreground

Source: https://github.com/apache/artemis/blob/main/docs/migration-guide/_configuration.adoc

Execute this command to start the broker in the foreground, similar to the 'console' command in ActiveMQ. This is useful for monitoring logs directly.

```sh
bin/artemis run
```

--------------------------------

### Update Artemis Examples Repository Versions

Source: https://github.com/apache/artemis/blob/main/RELEASING.adoc

Clone the examples repository, checkout the development branch, and run the update script with the release and new snapshot versions.

```bash
git clone https://gitbox.apache.org/repos/asf/artemis-examples.git
cd artemis-examples
git checkout development
./scripts/release/update-branch-versions.sh <release-version> <new-main-snapshot-version>
```

```bash
git clone https://gitbox.apache.org/repos/asf/artemis-examples.git
cd artemis-examples
git checkout development
./scripts/release/update-branch-versions.sh 2.32.0 2.33.0-SNAPSHOT
```

--------------------------------

### Install Artemis as a Windows Service

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-server.adoc

Command to install the Apache Artemis broker as a Windows service. Refer to the artemis-service.exe for available commands.

```bash
./artemis-service.exe install
```

--------------------------------

### Start Apache Artemis Broker with Custom Configuration

Source: https://github.com/apache/artemis/blob/main/artemis-distribution/src/main/resources/README.html

To start the Apache Artemis broker using a specific configuration file, use the '--config' option followed by the scheme and location of the configuration file.

```bash
./artemis run --config scheme:location
```

```bash
./artemis run --config xml:/home/artemis/bootstrap.xml
```

--------------------------------

### Install Full Release to Local Maven Repo

Source: https://github.com/apache/artemis/blob/main/docs/hacking-guide/_building.adoc

Installs the full release artifact, including documentation and JavaDocs, into your local Maven repository.

```bash
$ mvn -Prelease install
```

--------------------------------

### Maven Plugin Execution: Start Server

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/maven-plugin.adoc

Configures the 'start' execution goal for the Maven plugin. It spawns the server process and ignores the 'noServer' property. Includes arguments for running the server.

```xml
<execution>
   <id>start</id>
   <goals>
      <goal>cli</goal>
   </goals>
   <configuration>
      <spawn>true</spawn>
      <ignore>${noServer}</ignore>
      <testURI>tcp://localhost:61616</testURI>
      <args>
         <param>run</param>
      </args>
   </configuration>
</execution>
```

--------------------------------

### Example AMQP Acceptor Configuration with Idle Timeout

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/amqp.adoc

A complete example of an AMQP acceptor configuration including idle timeout, buffer sizes, protocols, and other options.

```xml
<acceptor name="amqp">tcp://0.0.0.0:5672?amqpIdleTimeout=0;tcpSendBufferSize=1048576;tcpReceiveBufferSize=1048576;protocols=AMQP;useEpoll=true;amqpCredits=1000;amqpLowCredits=300;directDeliver=false;batchDelay=10</acceptor>
```

--------------------------------

### Artemis Karaf Configuration Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/karaf.adoc

Example configuration properties for the Apache Artemis OSGi component in Karaf. These settings are typically placed in ${KARAF_BASE}/etc/org.apache.activemq.artemis.cfg.

```properties
config=file:etc/artemis.xml
name=local
domain=karaf
rolePrincipalClass=org.apache.karaf.jaas.boot.principal.RolePrincipal
```

--------------------------------

### Install Artemis Broker Feature

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/karaf.adoc

Install the 'artemis' feature to set up and run the full Apache Artemis broker with its default configuration within the Karaf environment.

```sh
feature:install artemis
```

--------------------------------

### Configuring Connection TTL in URI

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/connection-ttl.adoc

Example of setting the connection TTL parameter directly in the broker URI.

```none
tcp://localhost:61616?connectionTTL=60000
```

--------------------------------

### View Available Commands

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-cli.adoc

After installing auto-completion, press TAB after './artemis' to list all available commands.

```bash
$ ./artemis
activation    check         consumer      disconnect    mask          producer      run           transfer      version
address       completion    create        help          perf          pwd           shell         upgrade
browser       connect       data          kill          perf-journal  queue         stop          user
```

--------------------------------

### Get Help for Create Command Options

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-cli.adoc

View the available options and parameters for the 'create' command, which is used to initialize a new broker instance. This helps in configuring the new instance correctly.

```console
Usage: artemis create [--aio] [--allow-anonymous] [--autocreate] [--autodelete]
                      [--backup] [--blocking] [--clustered]
                      [--disable-persistence] [--failover-on-shutdown]
                      [--force] [--jdbc] [--linux] [--mapped] [--nio]
                      [--no-amqp-acceptor] [--no-autocreate] [--no-autotune]
                      [--no-fsync] [--no-hornetq-acceptor] [--no-mqtt-acceptor]
                      [--no-stomp-acceptor] [--no-web] [--paging]
                      [--relax-jolokia] [--replicated] [--require-login]
                      [--shared-store] [--silent] [--slave]
                      [--support-advisory]
                      [--suppress-internal-management-objects]
                      [--use-client-auth] [--verbose] [--windows]
                      [--addresses=<addresses>]
                      [--cluster-password=<clusterPassword>]
                      [--cluster-user=<clusterUser>] [--data=<data>]
                      [--default-port=<defaultPort>] [--encoding=<encoding>]
                      [--etc=<etc>] [--global-max-messages=<globalMaxMessages>]
```

--------------------------------

### Generate Server Configuration Script

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/examples.adoc

This is an example of a generated script to configure the Artemis server. It shows the exact commands required for server setup.

```sh
#!/bin/sh
#
# Generated by the Queue example
#

# Create server0
/opt/artemis/bin/artemis create /var/lib/artemis/server0 --user admin --password admin --allow-any-ip

# Start server0
/opt/artemis/bin/artemis run /var/lib/artemis/server0

```

--------------------------------

### Create a Broker Instance

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/upgrading.adoc

Use this command to create a new broker instance, referencing the broker home directory. It's recommended to choose a folder different from where the broker was downloaded.

```shell
./bin/artemis create /path/to/myBrokerInstance
```

--------------------------------

### Configure Chain Cluster with max-hops=2

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/clusters.adoc

For a chain cluster, `max-hops` is set to `2` to allow knowledge propagation across the chain. This example shows a unidirectional connection setup.

```xml
<cluster-connection name="my-chain-cluster">
    <connector-ref>netty-connector</connector-ref>
    <max-hops>2</max-hops>
</cluster-connection>
```

--------------------------------

### JMS Client Code with JNDI Lookup

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-jms.adoc

Example of a JMS client using JNDI to look up a connection factory and a queue, then sending and receiving a text message. Ensure the connection is started for message delivery.

```java
InitialContext ic = new InitialContext();

//Now we'll look up the connection factory from which we can create
//connections to myhost:5445:

ConnectionFactory cf = (ConnectionFactory)ic.lookup("ConnectionFactory");

//And look up the Queue:

Queue orderQueue = (Queue)ic.lookup("queues/OrderQueue");

//Next we create a JMS connection using the connection factory:

Connection connection = cf.createConnection();

//And we create a non-transacted JMS Session, with AUTO_ACKNOWLe.g. //acknowledge mode:

Session session = connection.createSession(false, Session.AUTO_ACKNOWLEDGE);

//We create a MessageProducer that will send orders to the queue:

MessageProducer producer = session.createProducer(orderQueue);

//And we create a MessageConsumer which will consume orders from the
//queue:

MessageConsumer consumer = session.createConsumer(orderQueue);

//We make sure we start the connection, or delivery won't occur on it:

connection.start();

//We create a simple TextMessage and send it:

TextMessage message = session.createTextMessage("This is an order");
producer.send(message);

//And we consume the message:

TextMessage receivedMessage = (TextMessage)consumer.receive();
System.out.println("Got order: " + receivedMessage.getText());
```

--------------------------------

### Configure Broker with System Properties

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/configuration-index.adoc

Replace broker.xml configuration properties using system properties prefixed with 'brokerconfig.'. This example sets the global max size.

```bash
java -Dbrokerconfig.globalMaxSize=1000000
```

--------------------------------

### Configure Address with Two Queues for FQQN Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/address-model.adoc

Sets up an address 'a1' with two queues, 'q1' and 'q2', for demonstrating Fully Qualified Queue Name usage.

```xml
<addresses>
   <address name="a1">
      <multicast>
         <queue name="q1" />
         <queue name="q2" />
      </multicast>
   </address>
</addresses>
```

--------------------------------

### Install libaio on Debian/Ubuntu

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/libaio.adoc

Use this command to install the libaio dependency on Debian and Ubuntu systems.

```bash
sudo apt-get install libtool gcc-g++ gcc libaio libaio- cmake
```

--------------------------------

### Start Broker with Custom Security Manager via System Properties

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/security.adoc

Configure a custom security manager at boot time by specifying its class name and properties using system properties.

```sh
./artemis run \
  -Dsecurityconfig.manager.className=org.apache.activemq.artemis.spi.core.security.ActiveMQBasicSecurityManager \
  -Dsecurityconfig.manager.properties.bootstrapUser=admin \
  -Dsecurityconfig.manager.properties.bootstrapPassword=admin \
  -Dsecurityconfig.manager.properties.bootstrapRole=amq
```

--------------------------------

### Start ActiveMQ Artemis Broker

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-server.adoc

Execute the 'run' command with the artemis script to start the broker instance.

```console
/var/lib/mybroker/bin/artemis run
```

--------------------------------

### Create a Broker Instance

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-server.adoc

Use this command to create a new broker instance. Ensure you are in the desired parent directory for the instance before execution.

```bash
$ cd /var/lib
$ ${ARTEMIS_HOME}/bin/artemis create mybroker
```

--------------------------------

### Instantiate ActiveMQServerImpl Directly

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/embedding-artemis.adoc

This demonstrates instantiating and starting the ActiveMQServerImpl directly with a provided configuration object, offering another way to embed the broker programmatically.

```java
ActiveMQServer server = new ActiveMQServerImpl(config);
server.start();
```

--------------------------------

### Install libaio on Fedora/CentOS/RHEL

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/libaio.adoc

Use this command to install the libaio dependency on Fedora, CentOS, Rocky Linux, and RHEL systems.

```bash
sudo yum install libtool gcc-c++ gcc libaio libaio-devel cmake
```

--------------------------------

### Example of Automated PR Merge Script Usage

Source: https://github.com/apache/artemis/blob/main/docs/hacking-guide/_maintainers.adoc

An example demonstrating how to use the merge-pr.sh script with a specific PR number and message.

```bash
$ pwd
/checkouts/artemis

$ ./scripts/merge-PR.sh 175 ARTEMIS-229 address on Security Interface
```

--------------------------------

### Display All Available Commands

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-cli.adoc

Use this command to list all available commands and their basic usage. For more detailed help on a specific command, append its name.

```console
$ ./artemis help
Usage: artemis [COMMAND]
Apache Artemis Command Line
Commands:
  help        use 'help <command>' for more information
  pwd         Information on current folder and instance.
  shell       JLine3 shell helping using the CLI
  producer    Send message(s) to a broker.
  transfer    Move messages from one destination towards another destination.
  consumer    Consume messages from a queue.
  browser     Browse messages on a queue.
  mask        Mask a password and print it out.
  version     Print version information.
  perf        use 'help perf' for sub commands list
  check       use 'help check' for sub commands list
  queue       use 'help queue' for sub commands list
  address     use 'help address' for sub commands list
  connect     Connect to the broker validating credentials for commands.
  disconnect  Clear previously typed user credentials.
  data        use 'help data' for sub commands list
  create      Create a new broker instance.
  upgrade     Update a broker instance to the current artemis.home, keeping all
                the data and broker.xml. Warning: backup your instance before
                using this command and compare the files.
  completion  Generates the auto complete script file to be used in bash or
                zsh. Usage: source <(./artemis completion)
```

--------------------------------

### Start Artemis Shell with Static Connection

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-cli.adoc

Initiates the Artemis shell with pre-configured user, password, and broker URL. Subsequent commands will use these static parameters.

```bash
$ ./artemis shell --user <username> --password <password> --url tcp://<hostname>:<port>
```

--------------------------------

### Example Artemis Commit Report Generation

Source: https://github.com/apache/artemis/blob/main/RELEASING.adoc

An example command demonstrating how to generate the commit report for version 2.31.0, following version 2.30.0.

```bash
git clone https://gitbox.apache.org/repos/asf/artemis-website.git
cd artemis-website
./scripts/release/create-artemis-git-report.sh ../artemis 2.30.0 2.31.0
```

--------------------------------

### Run Broker with Custom Configuration

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/using-server.adoc

Specify a custom bootstrap configuration file when running the broker.

```bash
./artemis run -- xml:path/to/bootstrap.xml
```

--------------------------------

### Configure Federation in broker.xml

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/federation.adoc

Example configuration for setting up address and queue federation between brokers. Ensure the federation name is globally unique. This configuration connects 'eu-north-1' to 'eu-east-1' and 'eu-west-1', applying specific queue and address policies.

```xml
<federations>
    <federation name="eu-north-1-federation">
        <upstream name="eu-west-1" user="westuser" password="32a10275cf4ab4e9">
           <static-connectors>
              <connector-ref>connector1</connector-ref>
           </static-connectors>
           <policy ref="policySetA"/>
        </upstream>
        <upstream name="eu-east-1" user="eastuser" password="32a10275cf4ab4e9">
           <discovery-group-ref discovery-group-name="ue-west-dg"/>
           <policy ref="policySetA"/>
        </upstream>

        <policy-set name="policySetA">
           <policy ref="address-federation" />
           <policy ref="queue-federation" />
        </policy-set>

        <queue-policy name="queue-federation" >
           <exclude queue-match="federated_queue" address-match="#" />
        </queue-policy>

        <address-policy name="address-federation" >
           <include address-match="federated_address" />
        </address-policy>
    </federation>
</federations>
```

--------------------------------

### Basic AMQP Federation Configuration

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/amqp-federation-configuration-glossary.adoc

This example shows a basic AMQP connection with local and remote address and queue policies defined for federation.

```xml
<broker-connections>
  <amqp-connection uri="tcp://HOST:PORT" name="federation-example">
    <federation>
       <local-address-policy name="example-local-address-policy">
         <include address-match="local-address.#" />
         <exclude address-match="local-address.excluded" />
       </local-address-policy>
       <local-queue-policy name="example-local-queue-policy">
         <include address-match="address" queue-match="local-queue" />
       </local-queue-policy>
       <remote-address-policy name="example-remote-address-policy">
         <include address-match="remote-address" />
       </remote-address-policy>
       <remote-queue-policy name="example-remote-queue-policy">
         <include address-match="#" queue-match="remote-queue" />
         <exclude address-match="excluded.#" queue-match="remote-queue-excluded" />
       </remote-queue-policy>
    </federation>
  </amqp-connection>
</broker-connections>
```

--------------------------------

### List Available Artemis Features

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/karaf.adoc

List all installed and available features in Karaf, filtering for those related to Artemis. This helps in identifying the correct feature to install.

```sh
karaf@root()> feature:list | grep artemis
```

--------------------------------

### Example Address Setting Configuration

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/address-settings.adoc

This XML snippet demonstrates how to configure address settings within broker.xml. It specifies various parameters for message handling, dead-lettering, expiry, and queue management for addresses matching 'order.foo'.

```xml
<address-settings>
   <address-setting match="order.foo">
      <dead-letter-address>DLA</dead-letter-address>
      <auto-create-dead-letter-resources>false</auto-create-dead-letter-resources>
      <dead-letter-queue-prefix></dead-letter-queue-prefix>
      <dead-letter-queue-suffix></dead-letter-queue-suffix>
      <expiry-address>ExpiryQueue</expiry-address>
      <auto-create-expiry-resources>false</auto-create-expiry-resources>
      <expiry-queue-prefix></expiry-queue-prefix>
      <expiry-queue-suffix></expiry-queue-suffix>
      <no-expiry>false</no-expiry>
      <expiry-delay>-1</expiry-delay>
      <min-expiry-delay>-1</min-expiry-delay>
      <max-expiry-delay>-1</max-expiry-delay>
      <redelivery-delay>5000</redelivery-delay>
      <redelivery-delay-multiplier>1.0</redelivery-delay-multiplier>
      <redelivery-collision-avoidance-factor>0.0</redelivery-collision-avoidance-factor>
      <max-redelivery-delay>10000</max-redelivery-delay>
      <max-delivery-attempts>3</max-delivery-attempts>
      <max-size-bytes>-1</max-size-bytes>
      <max-size-messages>-1</max-size-messages>
      <max-size-bytes-reject-threshold>-1</max-size-bytes-reject-threshold>
      <page-size-bytes>10MB</page-size-bytes>
      <address-full-policy>PAGE</address-full-policy>
      <disk-full-policy>BLOCK</disk-full-policy>
      <message-counter-history-day-limit></message-counter-history-day-limit>
      <last-value-queue>false</last-value-queue> <!-- deprecated! see default-last-value-queue -->
      <default-last-value-queue>false</default-last-value-queue>
      <default-non-destructive>false</default-non-destructive>
      <default-exclusive-queue>false</default-exclusive-queue>
      <default-consumers-before-dispatch>0</default-consumers-before-dispatch>
      <default-delay-before-dispatch>-1</default-delay-before-dispatch>
      <redistribution-delay>-1</redistribution-delay>
      <send-to-dla-on-no-route>false</send-to-dla-on-no-route>
      <slow-consumer-threshold>-1</slow-consumer-threshold>
      <slow-consumer-threshold-measurement-unit>MESSAGES_PER_SECOND</slow-consumer-threshold-measurement-unit>
      <slow-consumer-policy>NOTIFY</slow-consumer-policy>
      <slow-consumer-check-period>5</slow-consumer-check-period>
      <auto-create-queues>true</auto-create-queues>
      <auto-delete-queues>true</auto-delete-queues>
      <auto-delete-created-queues>false</auto-delete-created-queues>
      <auto-delete-queues-delay>0</auto-delete-queues-delay>
      <auto-delete-queues-message-count>0</auto-delete-queues-message-count>
      <auto-delete-queues-skip-usage-check>false</auto-delete-queues-skip-usage-check>
      <config-delete-queues>OFF</config-delete-queues>
      <config-delete-diverts>OFF</config-delete-diverts>
      <auto-create-addresses>true</auto-create-addresses>
      <auto-delete-addresses>true</auto-delete-addresses>
      <auto-delete-addresses-delay>0</auto-delete-addresses-delay>
      <auto-delete-addresses-skip-usage-check>false</auto-delete-addresses-skip-usage-check>
      <config-delete-addresses>OFF</config-delete-addresses>
      <management-browse-page-size>200</management-browse-page-size>
      <management-message-attribute-size-limit>256</management-message-attribute-size-limit>
      <default-purge-on-no-consumers>false</default-purge-on-no-consumers>
      <default-max-consumers>-1</default-max-consumers>
      <default-queue-routing-type>MULTICAST</default-queue-routing-type>
   </address-setting>
</address-settings>
```

--------------------------------

### Create Subscription Queue using FQQN

Source: https://github.com/apache/artemis/blob/main/docs/migration-guide/_virtual-topics.adoc

Example of creating a subscription queue using the Fully Qualified Queue Name (FQQN) format in Apache Artemis for a virtual topic.

```java
    ...    
    Queue subscriptionQueue = session.createQueue("VirtualTopic.Orders::Consumer.A.VirtualTopic.Orders");
    session.createConsumer(subscriptionQueue);
```

--------------------------------

### Create Server with Network Ping Enabled

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/network-isolation.adoc

Use the `create` command with the `--ping` argument to generate a default broker configuration that includes network checks.

```bash
$ ./artemis create /myDir/myServer --ping 10.0.0.1
```

--------------------------------

### Example Commit Message

Source: https://github.com/apache/artemis/blob/main/docs/hacking-guide/_code.adoc

An example of a correctly formatted commit message adhering to the 50/72 rule, including a JIRA key, summary line, and detailed description.

```text
ARTEMIS-123 Add new commit msg format to README

Adds a description of the new commit message format as well as examples
of well formatted commit messages to the README.md.  This is required
to enable developers to quickly identify what the commit is intended to
do and why the commit was added.
```

--------------------------------

### Run the Artemis Upgrade Tool

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/upgrading.adoc

Execute the upgrade helper tool from the new broker download's bin directory. This command automates the refresh of configuration files and scripts for an existing broker instance.

```shell
cd $NEW_ARTEMIS_DOWNLOAD/bin/
./artemis upgrade PATH_TO_UPGRADING_INSTANCE
```

--------------------------------

### Jolokia Read Response Example

Source: https://github.com/apache/artemis/blob/main/docs/user-manual/management.adoc

This is an example of the JSON response received from a Jolokia read operation, showing the request details, the returned value, timestamp, and status code.

```json
{
  "request": {
    "mbean": "org.apache.activemq.artemis:broker=\"0.0.0.0\"",
    "attribute": "Version",
    "type": "read"
  },
  "value": "true",
  "timestamp": 1663086398,
  "status": 200
}

```