Skip to content

O
Openfire
Commit e5eebf4c authored by Roman Soldatow's avatar Roman Soldatow Committed by daryl herzmann
Browse files
Options

REST API update to 1.3.1 (#1068) 

Fixed: That created rooms were not propagated to other nodes OF-1535
Fixed: Missing documentation for "new" json mapping
parent 5aba3a97
Show whitespace changes
Inline Side-by-side
Showing with 87 additions and 4 deletions
src/plugins/restAPI/changelog.html
View file @ e5eebf4c
......@@ -44,6 +44,12 @@
REST API Plugin Changelog
</h1>
<p><b>1.3.1</b> -- April 20th, 2018</p>
<ul>
<li>Fixed: That created rooms were not propagated to other nodes <a href="https://issues.igniterealtime.org/browse/OF-1535">OF-1535</a></li>
<li>Fixed: Missing documentation for "new" json mapping</li>
</ul>
<p><b>1.3.0</b> -- March 7th, 2018</p>
<ul>
<li>Added: Security Audit endpoint to get the security logs</li>
......
src/plugins/restAPI/plugin.xml
View file @ e5eebf4c
......@@ -5,8 +5,8 @@
<name>REST API</name>
<description>Allows administration over a RESTful API.</description>
<author>Roman Soldatow</author>
<version>1.3.0</version>
<date>03/07/2018</date>
<version>1.3.1</version>
<date>04/20/2018</date>
<minServerVersion>4.1.0</minServerVersion>
<adminconsole>
<tab id="tab-server">
......
src/plugins/restAPI/pom.xml
View file @ e5eebf4c
......@@ -8,7 +8,7 @@
</parent>
<groupId>org.igniterealtime.openfire.plugins</groupId>
<artifactId>restAPI</artifactId>
<version>1.3.0</version>
<version>1.3.1</version>
<name>Rest API Plugin</name>
<description>Allows administration over a RESTful API.</description>
......
src/plugins/restAPI/readme.html
View file @ e5eebf4c
......@@ -9,7 +9,7 @@
</head>
<body class="stackedit">
<div class="stackedit__left" style="height: 100%; overflow-x: scroll;">
<div class="stackedit__left">
<div class="stackedit__toc">
<ul>
......@@ -334,6 +334,29 @@ The secret key can be defined in Openfire Admin console under Server &gt; Server
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<p><strong>REST API Version 1.3.0 and later - Payload Example 2 (available parameters):</strong></p>
<pre class=" language-json"><code class="prism language-json"><span class="token punctuation">{</span>
<span class="token string">"users"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token punctuation">{</span>
<span class="token string">"username"</span><span class="token punctuation">:</span> <span class="token string">"admin"</span><span class="token punctuation">,</span>
<span class="token string">"name"</span><span class="token punctuation">:</span> <span class="token string">"Administrator"</span><span class="token punctuation">,</span>
<span class="token string">"email"</span><span class="token punctuation">:</span> <span class="token string">"admin@example.com"</span><span class="token punctuation">,</span>
<span class="token string">"password"</span><span class="token punctuation">:</span> <span class="token string">"p4ssword"</span><span class="token punctuation">,</span>
<span class="token string">"properties"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token punctuation">{</span>
<span class="token string">"key"</span><span class="token punctuation">:</span> <span class="token string">"console.order"</span><span class="token punctuation">,</span>
<span class="token string">"value"</span><span class="token punctuation">:</span> <span class="token string">"session-summary=0"</span>
<span class="token punctuation">}</span>
<span class="token punctuation">]</span>
<span class="token punctuation">}</span><span class="token punctuation">,</span>
<span class="token punctuation">{</span>
<span class="token string">"username"</span><span class="token punctuation">:</span> <span class="token string">"test"</span><span class="token punctuation">,</span>
<span class="token string">"name"</span><span class="token punctuation">:</span> <span class="token string">"Test"</span><span class="token punctuation">,</span>
<span class="token string">"password"</span><span class="token punctuation">:</span> <span class="token string">"p4ssword"</span>
<span class="token punctuation">}</span>
<span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<h2 id="delete-a-user">Delete a user</h2>
<p>Endpoint to delete a user</p>
<blockquote>
......@@ -451,6 +474,19 @@ The secret key can be defined in Openfire Admin console under Server &gt; Server
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<p><strong>REST API Version 1.3.0 and later - Payload Example 2 (available parameters):</strong></p>
<pre class=" language-json"><code class="prism language-json"><span class="token punctuation">{</span>
<span class="token string">"username"</span><span class="token punctuation">:</span> <span class="token string">"testuser"</span><span class="token punctuation">,</span>
<span class="token string">"name"</span><span class="token punctuation">:</span> <span class="token string">"Test User edit"</span><span class="token punctuation">,</span>
<span class="token string">"email"</span><span class="token punctuation">:</span> <span class="token string">"test@edit.de"</span><span class="token punctuation">,</span>
<span class="token string">"properties"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token punctuation">{</span>
<span class="token string">"key"</span><span class="token punctuation">:</span> <span class="token string">"keyname"</span><span class="token punctuation">,</span>
<span class="token string">"value"</span><span class="token punctuation">:</span> <span class="token string">"value"</span>
<span class="token punctuation">}</span>
<span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<h2 id="retrieve-all-user-groups">Retrieve all user groups</h2>
<p>Endpoint to get group names of a specific user</p>
<blockquote>
......@@ -1200,6 +1236,45 @@ Payload Example 1 (required parameters):</p>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
</code></pre>
<p><strong>REST API Version 1.3.0 and later - Payload Example 2 (available parameters):</strong></p>
<pre class=" language-json"><code class="prism language-json"><span class="token punctuation">{</span>
<span class="token string">"roomName"</span><span class="token punctuation">:</span> <span class="token string">"global-1"</span><span class="token punctuation">,</span>
<span class="token string">"naturalName"</span><span class="token punctuation">:</span> <span class="token string">"global-1_test_hello"</span><span class="token punctuation">,</span>
<span class="token string">"description"</span><span class="token punctuation">:</span> <span class="token string">"Global chat room"</span><span class="token punctuation">,</span>
<span class="token string">"subject"</span><span class="token punctuation">:</span> <span class="token string">"Global chat room subject"</span><span class="token punctuation">,</span>
<span class="token string">"creationDate"</span><span class="token punctuation">:</span> <span class="token string">"2012-10-18T16:55:12.803+02:00"</span><span class="token punctuation">,</span>
<span class="token string">"modificationDate"</span><span class="token punctuation">:</span> <span class="token string">"2014-07-10T09:49:12.411+02:00"</span><span class="token punctuation">,</span>
<span class="token string">"maxUsers"</span><span class="token punctuation">:</span> <span class="token string">"0"</span><span class="token punctuation">,</span>
<span class="token string">"persistent"</span><span class="token punctuation">:</span> <span class="token string">"true"</span><span class="token punctuation">,</span>
<span class="token string">"publicRoom"</span><span class="token punctuation">:</span> <span class="token string">"true"</span><span class="token punctuation">,</span>
<span class="token string">"registrationEnabled"</span><span class="token punctuation">:</span> <span class="token string">"false"</span><span class="token punctuation">,</span>
<span class="token string">"canAnyoneDiscoverJID"</span><span class="token punctuation">:</span> <span class="token string">"true"</span><span class="token punctuation">,</span>
<span class="token string">"canOccupantsChangeSubject"</span><span class="token punctuation">:</span> <span class="token string">"false"</span><span class="token punctuation">,</span>
<span class="token string">"canOccupantsInvite"</span><span class="token punctuation">:</span> <span class="token string">"false"</span><span class="token punctuation">,</span>
<span class="token string">"canChangeNickname"</span><span class="token punctuation">:</span> <span class="token string">"false"</span><span class="token punctuation">,</span>
<span class="token string">"logEnabled"</span><span class="token punctuation">:</span> <span class="token string">"true"</span><span class="token punctuation">,</span>
<span class="token string">"loginRestrictedToNickname"</span><span class="token punctuation">:</span> <span class="token string">"true"</span><span class="token punctuation">,</span>
<span class="token string">"membersOnly"</span><span class="token punctuation">:</span> <span class="token string">"false"</span><span class="token punctuation">,</span>
<span class="token string">"moderated"</span><span class="token punctuation">:</span> <span class="token string">"false"</span><span class="token punctuation">,</span>
<span class="token string">"broadcastPresenceRoles"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token string">"moderator"</span><span class="token punctuation">,</span>
<span class="token string">"participant"</span><span class="token punctuation">,</span>
<span class="token string">"visitor"</span>
<span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token string">"owners"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token string">"owner@localhost"</span>
<span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token string">"admins"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token string">"admin@localhost"</span>
<span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token string">"members"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token string">"member@localhost"</span>
<span class="token punctuation">]</span><span class="token punctuation">,</span>
<span class="token string">"outcasts"</span><span class="token punctuation">:</span> <span class="token punctuation">[</span>
<span class="token string">"outcast@localhost"</span>
<span class="token punctuation">]</span>
<span class="token punctuation">}</span>
</code></pre>
<h2 id="delete-a-chat-room">Delete a chat room</h2>
<p>Endpoint to delete a chat room.</p>
<blockquote>
......
src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/controller/MUCRoomController.java
View file @ e5eebf4c
......@@ -16,6 +16,7 @@ import org.jivesoftware.openfire.muc.ForbiddenException;
import org.jivesoftware.openfire.muc.MUCRole;
import org.jivesoftware.openfire.muc.MUCRoom;
import org.jivesoftware.openfire.muc.NotAllowedException;
import org.jivesoftware.openfire.muc.cluster.RoomAvailableEvent;
import org.jivesoftware.openfire.muc.cluster.RoomUpdatedEvent;
import org.jivesoftware.openfire.muc.spi.LocalMUCRoom;
import org.jivesoftware.openfire.plugin.rest.entity.MUCChannelType;
......@@ -274,6 +275,7 @@ public class MUCRoomController {
// Fire RoomUpdateEvent if cluster is started
if (ClusterManager.isClusteringStarted()) {
CacheFactory.doClusterTask(new RoomAvailableEvent((LocalMUCRoom) room));
CacheFactory.doClusterTask(new RoomUpdatedEvent((LocalMUCRoom) room));
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment

Technounit-GROUP 2023