LibraryToggle FramesPrintFeedback

Using the Embedded Console

Overview

For a standalone broker the default configuration is for the Web console to be loaded along with the broker. The default address for the standalone broker's console is localhost:8181/activemqweb .

When a broker is deployed into a fabric, the default configuration profile does not include the Web console. To enable the console, the default configuration profile must be modified to include the feature that implements the Web console. Once it is installed the broker's Web console uses the same default address as a standalone broker.

The default port and security configuration can easily be modified.

Adding the Web console to a broker in a fabric

The default configuration profile for a fabric broker does not include the Fuse MQ Enterprise Web console. To add the Web console to a broker's configuration profile using a broker's console:

  1. Connect to a fabric broker.

  2. Create a new configuration profile based on the default mq profile using the fabric:profile-create command as shown in Example 9.

    Example 9. Creating a New Profile

    FuseMQ:karaf@root fabric:profile-create --parents mq mq-console

    The --parents mq argument specifies that the mq configuration profile is the parent of the new profile. The new profile inherits all of the configuration in the mq profile, so initially it is identical to the default.

    You can change mq-console to any name that fits your naming scheme.

    For more information on fabric:profile-create see fabric:profile-create in Console Reference.

  3. Edit the new profile to include the Web console feature using the fabric:profile-edit command as shown in Example 10.

    Example 10. Editing a Profile to Include the Web Console

    FuseMQ:karaf@root fabric:profile-edit -f mq-web-console mq-console

    The -f mq-web-console adds the mq-web-console feature, which implements the Fuse MQ Enterprise Web console, to the default broker configuration profile.

    For more information on fabric:profile-edit see fabric:profile-edit in Console Reference.

  4. Add the new profile to broker you want to monitor with the Web console using the fabric:container-change-profile command as shown in Example 11.

    Example 11. Adding the Web Console Profile to a Broker

    FuseMQ:karaf@root fabric:container-add-profile broker1 mq-console

    This command deploys the configuration profile with the Web console to the broker. The broker's fabric agent will immediately download the required bundles for the Web console and install them.

    For more information on fabric:container-add-profile see fabric:container-add-profile, in Console Reference.

[Tip]Tip

You can also use Fuse Management Console to modify the broker's configuration profile to include the Web console. See the Fuse Management Console Documentation.

Accessing the console

The Fuse MQ Enterprise Web console's address is http://hostName:portNum/activemqweb .

For example, to access the default broker administration console on your local machine, you would point your Web browser at http://localhost:8181/activemqweb .

Changing the port

The port number at which the Web console is accessed is controlled by the broker's Pax Web server. To change the port, you need to edit the org.osgi.service.http.port property in the org.ops4j.pax.web configuration file.

Example 12 shows the console commands used to change the port number of a standalone broker's Web console to 8536.

Example 12. Changing the Web Console's Port

FuseMQ:karaf@root> config:edit org.ops4j.pax.web
FuseMQ:karaf@root> config:proplist
   service.pid = org.ops4j.pax.web
   javax.servlet.context.tempdir = /Applications/FuseMQEnterprise-7.0.0/fuse-mq-7.0.0.fuse-beta-042/data/pax-web-jsp
   org.osgi.service.http.port = 8181
   org.ops4j.pax.web.config.file = /Applications/FuseMQEnterprise-7.0.0/fuse-mq-7.0.0.fuse-beta-042/etc/jetty.xml
   org.apache.karaf.features.configKey = org.ops4j.pax.web
FuseMQ:karaf@root> config:propset org.osgi.service.http.port 8536
FuseMQ:karaf@root> config:update

Example 13 shows the console command used to make the same to the Web console of a fabric broker.

Example 13. Changing the Web Console's Port in a Fabric

FuseMQ:karaf@root> profile-edit -p org.ops4j.pax.web/org.osgi.service.http.port=8536 mq-console

Securing the console

The security for the Web console is provided by the Web container in which it is deployed. For the embedded instance of the Web console, you need to configure the embedded Jetty container's security by editing conf/jetty.xml.

See Securing the Web Console for details.

Comments powered by Disqus