diff options
| author | Keith Wall <kwall@apache.org> | 2014-10-06 06:56:59 +0000 |
|---|---|---|
| committer | Keith Wall <kwall@apache.org> | 2014-10-06 06:56:59 +0000 |
| commit | 1cff5b63b5503feaa555c9f31ddc057fe9a18fdd (patch) | |
| tree | 2af0b085d86b1c258b8946ffc3332d9b037117c8 /qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml | |
| parent | 5d1236947bf2fb8117e8976149fbffa385022c0d (diff) | |
| download | qpid-python-1cff5b63b5503feaa555c9f31ddc057fe9a18fdd.tar.gz | |
QPID-6108: [Java Broker Documentation] Updates for changes made during 0.30
* Remove references to virtualhost.xml
* Rework concepts section
* Rework management section to separate means of management from management of the entities themselves
* Remove references message stores
* Update JVM defect to Java 7
* ACL updates
* Add Flow to Disk
Still further changes required flagged by TODO.
git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1629579 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml')
| -rw-r--r-- | qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml | 296 |
1 files changed, 0 insertions, 296 deletions
diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml b/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml deleted file mode 100644 index 7ec2428414..0000000000 --- a/qpid/doc/book/src/java-broker/Java-Broker-Configuring-And-Managing-REST-API.xml +++ /dev/null @@ -1,296 +0,0 @@ -<?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> - <para> - The brokers <link linkend="Java-Broker-Configuring-And-Managing-Web-Console">Web Management Console</link> 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. - </para> - - <para>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.</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>Updates broker attributes</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>Creates or updates authentication providers</entry> - <entry>Not implemented yet</entry> - <entry>Deletes authentication providers</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, updates user password</entry> - <entry>Not implemented yet</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>Creates group provider</entry> - <entry>Not implemented yet</entry> - <entry>Deletes groups providers</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>Creates or updates port</entry> - <entry>Not implemented yet</entry> - <entry>Deletes ports</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/<virtual host name>/<queue name></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/<virtual host name>/<queue name></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> - <row> - <entry> - <para>/rest/accesscontrolprovider</para> - </entry> - <entry>Rest service to manage access control providers</entry> - <entry>Retrieves the details about access control providers</entry> - <entry>Creates access control provider</entry> - <entry>Not implemented yet</entry> - <entry>Deletes access control provider(s)</entry> - </row> - <row> - <entry> - <para>/rest/keystore</para> - </entry> - <entry>Rest service to manage KeyStores</entry> - <entry>Retrieves the details about KeyStore</entry> - <entry>Creates or updates KeyStore</entry> - <entry>Not implemented yet</entry> - <entry>Deletes KeyStore(s)</entry> - </row> - <row> - <entry> - <para>/rest/truststore</para> - </entry> - <entry>Rest service to manage TrustStore</entry> - <entry>Retrieves the details about TrustStore</entry> - <entry>Creates or updates TrustStore</entry> - <entry>Not implemented yet</entry> - <entry>Deletes TrustStore(s)</entry> - </row> - <row> - <entry> - <para>/rest/plugin</para> - </entry> - <entry>Rest service to manage plugins</entry> - <entry>Retrieves the details about plugins</entry> - <entry>Updates plugin attributes</entry> - <entry>Not implemented yet</entry> - <entry>Not implemented yet</entry> - </row> - </tbody> - </tgroup> - </table> - <para>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.</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 (authenticating as user admin):</title> - <programlisting><![CDATA[ -#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> - ]]></programlisting> - </example><example> - <title>Example of binding a queue to an exchange using curl</title> - <programlisting><![CDATA[ -curl --user admin -X PUT -d '{}' http://localhost:8080/rest/binding/<vhostname>/<exchangename>/<queue-name>/<binding-name> - ]]></programlisting> - </example> - <para> - 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 <xref linkend="Java-Broker-Configuring-And-Managing-HTTP-Management-Plugin-Configuration"/> - </para> -</section> |