Menu Search

5.2. HTTP Management

5.2.1. Introduction

The brokers HTTP Management Plugin provides the Web Management Console to enable fully configuring the Broker, via an underlying REST management interface.

It is included into the brokers Initial Configuration by default, and is responsible for servicing the HTTP ports configured on the broker.

5.2.2. Web Management Console

The Web Management Console can be accessed from a web browser using the URL: http(s)://<hostname>:<port>/management where:

  • hostname is the broker hostname

  • port is the HTTP(S) port number

For authenticated and authorized user the page like below should be displayed on navigation to the management URL:

5.2.3. HTTP Management Plugin Configuration

The HTTP Management Plugin itself can be configured through the Web Management Console and underlying REST management interface. By double-clicking on the Http Management Plugin name in the object tree a tab for the plugin is displayed with its current settings, which can be changed by clicking on the "Edit" button. The following attributes can be set on the HTTP Management Plugin:

  • Basic Authentication for HTTP. It is set to false (disabled) by default.

  • Basic Authentication for HTTPS. It is set to true (enabled) by default.

  • SASL Authentication for HTTP. It is set to true (enabled) by default.

  • SASL Authentication for HTTPS. It is set to true (enabled) by default.

  • Session timeout is the timeout in seconds to close the HTTP session. It is set to 10 minutes by default.

NOTE: Changes to the Session Timeout attribute only take effect at broker restart.

5.2.4. REST API

The brokers Web Management Console makes calls to an underlying REST API to manage the broker. This section provides a brief overview of the REST interface, which can be used directly to monitor and manage the Broker instance although it is still evolving toward being fully considered a seperately supported interface.

The brokers REST interface support traditional REST model which uses the GET method requests to retrieve the information about broker configured objects, DELETE method requests to delete the configured object, PUT to create or update the configured object and POST to perform the configured objects updates not available with the PUT requests.

The table below lists the available REST services with brief description how they can be used.

Table 5.2. Rest services

REST Service URLDescriptionGETPUTPOSTDELETE

/rest/broker

Rest service to manage broker instance

Retrieves the details of broker configuration

Updates broker attributes

Not implemented yet

Not implemented yet

/rest/authenticationprovider

/rest/authenticationprovider/<authentication provider name>

Rest service to manage authentication providers on the brokerRetrieves the details about authentication providersCreates or updates authentication providersNot implemented yetDeletes authentication providers

/rest/user

/rest/user/<authentication provider name>/<user name>

Rest service to manage user accountRetrieves the details about user accountCreates user account, updates user passwordNot implemented yetDeletes user account

/rest/groupprovider

/rest/groupprovider/<group provider name>

Rest service to manage group providersRetrieves the details about group provider(s)Creates group providerNot implemented yetDeletes groups providers

/rest/group

/rest/group/<group provider name>/<group name>

Rest service to manage user groupRetrieves the details about user groupCreates groupNot implemented yetDeletes group

/rest/groupmember

/rest/groupmember/<group provider name >/<group name>/<user name>

Rest service to manage group member(s)Retrieves the details about group member(s)Add user to groupNot implemented yetDeletes user from group

/rest/port

/rest/port/<port name>

Rest service to manage broker ports(s)Retrieves the details about the broker port(s)Creates or updates portNot implemented yetDeletes ports

/rest/queue

/rest/queue/<virtual host name>/<queue name>

Rest service to manage queue(s)Retrieves the details about the queue(s)Creates queueNot implemented yetDeletes queue

/rest/exchange

/rest/exchange/<virtual host name>/<exchange name>

Rest service to manage exchange(s)Retrieves the details about the exchange(s)Creates exchangeNot implemented yetDeletes exchange

/rest/binding

/rest/binding/<virtual host name>/<exchange name>/<queue name>/<binding name>

Rest service to manage binding(s)Retrieves the details about the binding(s)Binds a queue to an exchangeNot implemented yetDeletes binding

/rest/connection

/rest/connection/<virtual host name>/<connection name>

Rest service to manage connection(s)Retrieves the details about the connection(s)Not implemented yetNot implemented yetNot implemented yet

/rest/session

/rest/session/<virtual host name>/<connection name>/<session name>

Rest service to manage session(s)Retrieves the details about the session(s)Not implemented yetNot implemented yetNot implemented yet

/rest/message/<virtual host name>/<queue name>

Rest service to manage messages(s)Retrieves the details about the messages(s)Not implemented yetCopies, moves messagesDeletes messages

/rest/message-content/<virtual host name>/<queue name>

Rest service to retrieve message contentRetrieves the message contentNot implemented yetNot implemented yetNot implemented yet

/rest/logrecords

Rest service to retrieve broker logsRetrieves the broker logsNot implemented yetNot implemented yetNot implemented yet

/rest/sasl

Sasl authenticationRetrieves user current authentication status and broker supported SASL mechanismsAuthenticates user using supported SASL mechanismsNot implemented yetNot implemented yet

/rest/logout

Log outsLog outs userNot implemented yetNot implemented yetNot implemented yet

/rest/accesscontrolprovider

Rest service to manage access control providersRetrieves the details about access control providersCreates access control providerNot implemented yetDeletes access control provider(s)

/rest/keystore

Rest service to manage KeyStoresRetrieves the details about KeyStoreCreates or updates KeyStoreNot implemented yetDeletes KeyStore(s)

/rest/truststore

Rest service to manage TrustStoreRetrieves the details about TrustStoreCreates or updates TrustStoreNot implemented yetDeletes TrustStore(s)

/rest/plugin

Rest service to manage pluginsRetrieves the details about pluginsUpdates plugin attributesNot implemented yetNot implemented yet

The REST URLs are hierarchical. It is permitted to replace rest URL elements with an "asterisks" in GET requests to denote all object of a particular type. Additionally, trailing object type in the URL hierarchy can be omitted. In this case GET request will return all of the object underneath of the current object.

For example, for binding URL http://localhost:8080/rest/binding/<vhost>/<exchange>/<queue>/<binding> replacing of <exchange> with "asterisks" (http://localhost:8080/rest/binding/<vhost>/*/<queue>/<binding>) will result in the GET response containing the list of bindings for all of the exchanges in the virtual host having the given name and given queue. If <binding> and <queue> are omitted in binding REST URL (http://localhost:8080/rest/binding/<vhostname>/<exchangename>) the GET request will result in returning all bindings for all queues for the given exchange in the virtual host.

Example 5.2. Examples of queue creation using curl (authenticating as user admin):

#create a durable queue
curl --user admin -X PUT  -d '{"durable":true}' http://localhost:8080/rest/queue/<vhostname>/<queuename>
#create a durable priority queue
curl --user admin -X PUT  -d '{"durable":true,"type":"priority"}' http://localhost:8080/rest/queue/<vhostname>/<queuename>
            

Example 5.3. Example of binding a queue to an exchange using curl

curl --user admin -X PUT  -d '{}' http://localhost:8080/rest/binding/<vhostname>/<exchangename>/<queue-name>/<binding-name>
            

NOTE: These curl examples utilise unsecure HTTP transport. To use the examples it is first necessary enable Basic authentication for HTTP within the HTTP Management Configuration (it is off by default). For details see Section 5.2.3, “HTTP Management Plugin Configuration”