diff options
Diffstat (limited to 'doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml')
| -rw-r--r-- | doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml | 263 |
1 files changed, 263 insertions, 0 deletions
diff --git a/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml b/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml new file mode 100644 index 0000000000..8bd63ade7a --- /dev/null +++ b/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml @@ -0,0 +1,263 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- + + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. + +--> + +<section id="Java-Broker-Configuring-And-Managing-REST-API"> +<title>REST API</title> + <section id="Java-Broker-Configuring-And-Managing-REST-API-Overview"> + <title>REST API Overview</title> + <para>This section provides an overview of REST management API.</para> + <para>If web management is enabled (see <xref linkend="Java-Broker-Configuring-And-Managing-Config-Files-Web-Management"/>) + the REST API can be used to monitor and manage the broker instance.</para> + <para>The Qpid broker REST services 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 the configured object and POST to update the configured objects.</para> + <para>The table below lists the available REST services with brief description how they can be used.</para> + + <table> + <title>Rest services</title> + <tgroup cols="6"> + <thead> + <row> + <entry>Rest service URL</entry> + <entry>Description</entry> + <entry>GET</entry> + <entry>PUT</entry> + <entry>POST</entry> + <entry>DELETE</entry> + </row> + </thead> + <tbody> + <row> + <entry><para>/rest/broker</para></entry> + <entry><para>Rest service to manage broker instance</para></entry> + <entry><para>Retrieves the details of broker configuration</para></entry> + <entry><para>Not implemented yet</para></entry> + <entry><para>Not implemented yet</para></entry> + <entry><para>Not implemented yet</para></entry> + </row> + <row> + <entry><para>/rest/authenticationprovider</para> + <para>/rest/authenticationprovider/<authentication provider name></para> + </entry> + <entry>Rest service to manage authentication providers on the broker</entry> + <entry>Retrieves the details about authentication providers</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry><para>/rest/user</para> + <para>/rest/user/<authentication provider name>/<user name></para> + </entry> + <entry>Rest service to manage user account</entry> + <entry>Retrieves the details about user account</entry> + <entry>Creates user account</entry> + <entry>Updates user password</entry> + <entry>Deletes user account</entry> + </row> + <row> + <entry><para>/rest/groupprovider</para> + <para>/rest/groupprovider/<group provider name></para> + </entry> + <entry>Rest service to manage group providers</entry> + <entry>Retrieves the details about group provider(s)</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry><para>/rest/group</para> + <para>/rest/group/<group provider name>/<group name></para> + </entry> + <entry>Rest service to manage user group</entry> + <entry>Retrieves the details about user group</entry> + <entry>Creates group</entry> + <entry>Not implemented yet</entry> + <entry>Deletes group</entry> + </row> + <row> + <entry><para>/rest/groupmember</para> + <para>/rest/groupmember/<group provider name >/<group name>/<user name></para> + </entry> + <entry>Rest service to manage group member(s)</entry> + <entry>Retrieves the details about group member(s)</entry> + <entry>Add user to group</entry> + <entry>Not implemented yet</entry> + <entry>Deletes user from group</entry> + </row> + <row> + <entry> + <para>/rest/port</para> + <para>/rest/port/<port name></para> + </entry> + <entry>Rest service to manage broker ports(s)</entry> + <entry>Retrieves the details about the broker port(s)</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/port</para> + <para>/rest/port/<port name></para> + </entry> + <entry>Rest service to manage broker ports(s)</entry> + <entry>Retrieves the details about the broker port(s)</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/queue</para> + <para>/rest/queue/<virtual host name>/>queue name></para> + </entry> + <entry>Rest service to manage queue(s)</entry> + <entry>Retrieves the details about the queue(s)</entry> + <entry>Creates queue</entry> + <entry>Not implemented yet</entry> + <entry>Deletes queue</entry> + </row> + <row> + <entry> + <para>/rest/exchange</para> + <para>/rest/exchange/<virtual host name>/<exchange name></para> + </entry> + <entry>Rest service to manage exchange(s)</entry> + <entry>Retrieves the details about the exchange(s)</entry> + <entry>Creates exchange</entry> + <entry>Not implemented yet</entry> + <entry>Deletes exchange</entry> + </row> + <row> + <entry> + <para>/rest/binding</para> + <para>/rest/binding/<virtual host name>/<exchange name>/<queue name>/<binding name></para> + </entry> + <entry>Rest service to manage binding(s)</entry> + <entry>Retrieves the details about the binding(s)</entry> + <entry>Binds a queue to an exchange</entry> + <entry>Not implemented yet</entry> + <entry>Deletes binding</entry> + </row> + <row> + <entry> + <para>/rest/connection</para> + <para>/rest/connection/<virtual host name>/<connection name></para> + </entry> + <entry>Rest service to manage connection(s)</entry> + <entry>Retrieves the details about the connection(s)</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/session</para> + <para>/rest/session/<virtual host name>/<connection name>/<session name></para> + </entry> + <entry>Rest service to manage session(s)</entry> + <entry>Retrieves the details about the session(s)</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/message/*</para> + </entry> + <entry>Rest service to manage messages(s)</entry> + <entry>Retrieves the details about the messages(s)</entry> + <entry>Not implemented yet</entry> + <entry>Copies, moves messages</entry> + <entry>Deletes messages</entry> + </row> + <row> + <entry> + <para>/rest/message-content/*</para> + </entry> + <entry>Rest service to retrieve message content</entry> + <entry>Retrieves the message content</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/logrecords</para> + </entry> + <entry>Rest service to retrieve broker logs</entry> + <entry>Retrieves the broker logs</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/sasl</para> + </entry> + <entry>Sasl authentication</entry> + <entry>Retrieves user current authentication status and broker supported SASL mechanisms</entry> + <entry>Authenticates user using supported SASL mechanisms</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + <row> + <entry> + <para>/rest/logout</para> + </entry> + <entry>Log outs</entry> + <entry>Log outs user</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + <entry>Not implemented yet</entry> + </row> + </tbody> + </tgroup> + </table> + <para>Rest URL 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.</para> + <para>For example, for binding URL http://localhost:8080/rest/binding/<vhost>/<exchange>/<queue>/<binding> + replacing of <emphasis><exchange></emphasis> 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 <emphasis><binding></emphasis> and <emphasis><queue></emphasis> 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. + </para> + <example> + <title>Examples of queue creation using curl:</title> + <programlisting><![CDATA[ +#create a durable queue +curl -X PUT -d '{"durable":true}' http://localhost:8080/rest/queue/<vhostname>/<queuename> +#create a durable priority queue +curl -X PUT -d '{"durable":true,"type":"priority"}' http://localhost:8080/rest/queue/<vhostname>/<queuename> + ]]></programlisting> + </example><example> + <title>Example of binding a queue to an exchange using curl</title> + <programlisting><![CDATA[ +curl -X PUT -d '{}' http://localhost:8080/rest/binding/<vhostname>/<exchangename>/<queue-name>/<binding-name> + ]]></programlisting> + </example> + <para>Qpid broker web management console calls rest interfaces internally to manage the broker.</para> + </section> +</section> |