Update the REST API plugin to version 1.1.1

src/plugins/restAPI/changelog.html

@@ -44,6 +44,11 @@
 REST API Plugin Changelog
 </h1>
 
+<p><b>1.1.1</b> -- June 29th, 2015</p>
+<ul>
+     <li>Added: new endpoint to close user sessions</li>
+</ul>
+
 <p><b>1.1.0</b> -- June 3rd, 2015</p>
 <ul>
      <li>Added: new endpoints for sessions (Get overview over all or specific user sessions)</li>

src/plugins/restAPI/plugin.xml

@@ -5,8 +5,8 @@
     <name>REST API</name>
     <description>Allows administration over a RESTful API.</description>
     <author>Roman Soldatow</author>
-    <version>1.1.0</version>
-    <date>06/03/2015</date>
+    <version>1.1.1</version>
+    <date>29/03/2015</date>
     <minServerVersion>3.9.0</minServerVersion>
     
     <adminconsole>		

src/plugins/restAPI/readme.html

@@ -1246,6 +1246,7 @@ body.pdf{font-family:"DejaVu Sans"}body.pdf code,body.pdf pre{font-family:"DejaV
 <li><a href="#rosteritem">RosterItem</a></li>
 <li><a href="#chatroom">Chatroom</a></li>
 <li><a href="#system-property">System Property</a></li>
+<li><a href="#session">Session</a></li>
 </ul>
 </li>
 </ul>
@@ -1427,6 +1428,18 @@ body.pdf{font-family:"DejaVu Sans"}body.pdf code,body.pdf pre{font-family:"DejaV
 </li>
 </ul>
 </li>
+<li><a href="#session-related-rest-endpoints">Session related REST Endpoints</a><ul>
+<li><a href="#retrieve-all-user-session">Retrieve all user session</a><ul>
+<li><a href="#examples-31">Examples</a></li>
+</ul>
+</li>
+<li><a href="#retrieve-the-user-sessions">Retrieve the user sessions</a><ul>
+<li><a href="#possible-parameters-27">Possible parameters</a></li>
+<li><a href="#examples-32">Examples</a></li>
+</ul>
+</li>
+</ul>
+</li>
 <li><a href="#deprecated-user-service-plugin-readme">(Deprecated) User Service Plugin Readme</a><ul>
 <li><a href="#overview">Overview</a></li>
 <li><a href="#installation-1">Installation</a></li>
@@ -1449,12 +1462,24 @@ body.pdf{font-family:"DejaVu Sans"}body.pdf code,body.pdf pre{font-family:"DejaV
 <li>Get overview over all or specific group and to create, update or delete a group</li>
 <li>Get overview over all user roster entries and to add, update or delete a roster entry</li>
 <li>Add user to a group and remove a user from a group</li>
-<li>Lockout or unlock the user (enable / disable)</li>
+<li>Lockout, unlock or kick the user (enable / disable)</li>
 <li>Get overview over all or specific system properties and to create, update or delete system property</li>
 <li>Get overview over all or specific chat room and to create, update or delete a chat room</li>
 <li>Get overview over all or specific user sessions</li>
 </ul>
 
+
+
+<h2 id="available-rest-api-clients">Available REST API clients</h2>
+
+<p>REST API clients are implementations of the REST API in a specific programming language.</p>
+
+<ul>
+<li>JAVA: <a href="https://github.com/Redor/REST-API-Client">https://github.com/Redor/REST-API-Client</a> (fully implemented)</li>
+<li>PHP: <a href="https://github.com/gidkom/php-openfire-restapi">https://github.com/gidkom/php-openfire-restapi</a> party implemented)</li>
+<li>GO Lang <a href="https://github.com/Urethramancer/fireman">https://github.com/Urethramancer/fireman</a> (party implemented)</li>
+</ul>
+
 <h2 id="installation">Installation</h2>
 
 <p>Copy restAPI.jar into the plugins directory of your Openfire server. The plugin will then be automatically deployed. To upgrade to a new version, copy the new restAPI.jar file over the existing file.</p>
@@ -1842,6 +1867,8 @@ If you want to create a resource with JSON data format, please add “<strong>Co
 </tbody></table>
 
 
+
+
 <h1 id="user-related-rest-endpoints">User related REST Endpoints</h1>
 
 
@@ -3713,6 +3740,8 @@ DELETE /chatrooms/{roomName}/{roles}/{name}</p>
 
 <h1 id="session-related-rest-endpoints">Session related REST Endpoints</h1>
 
+
+
 <h2 id="retrieve-all-user-session">Retrieve all user session</h2>
 
 <p>Endpoint to get all user sessions</p>
@@ -3724,6 +3753,8 @@ DELETE /chatrooms/{roomName}/{roles}/{name}</p>
 <p><strong>Payload:</strong> none <br>
 <strong>Return value:</strong> Sessions</p>
 
+
+
 <h3 id="examples-31">Examples</h3>
 
 <blockquote>
@@ -3732,7 +3763,7 @@ DELETE /chatrooms/{roomName}/{roles}/{name}</p>
   <p><strong>GET</strong> <a href="http://example.org:9090/plugins/restapi/v1/sessions">http://example.org:9090/plugins/restapi/v1/sessions</a></p>
 </blockquote>
 
-<h2 id="retrieve-the-user-sessions">Retrieve the user sessions</h2>
+<h2 id="retrieve-the-user-sessions-1">Retrieve the user sessions</h2>
 
 <p>Endpoint to get sessions from a user</p>
 
@@ -3743,7 +3774,9 @@ DELETE /chatrooms/{roomName}/{roles}/{name}</p>
 <p><strong>Payload:</strong> none <br>
 <strong>Return value:</strong> Sessions</p>
 
-<h3 id="possible-parameters-27">Possible parameters</h3>
+
+
+<h3 id="possible-parameters-28">Possible parameters</h3>
 
 <table>
 <thead>
@@ -3763,12 +3796,57 @@ DELETE /chatrooms/{roomName}/{roles}/{name}</p>
 </tbody></table>
 
 
+
+
 <h3 id="examples-32">Examples</h3>
 
 <p><strong>Header:</strong> Authorization: Basic YWRtaW46MTIzNDU=</p>
 
 <p><strong>GET</strong> <a href="http://example.org:9090/plugins/restapi/v1/sessions/testuser">http://example.org:9090/plugins/restapi/v1/sessions/testuser</a></p>
 
+
+
+<h2 id="close-all-user-sessions">Close all user sessions</h2>
+
+<p>Endpoint to close/kick sessions from a user</p>
+
+<blockquote>
+  <p><strong>DELETE</strong> /sessions/{username}</p>
+</blockquote>
+
+<p><strong>Payload:</strong> none <br>
+<strong>Return value:</strong> HTTP status 200 (OK)</p>
+
+
+
+<h3 id="possible-parameters-27">Possible parameters</h3>
+
+<table>
+<thead>
+<tr>
+  <th>Parameter</th>
+  <th>Parameter Type</th>
+  <th>Description</th>
+  <th>Default value</th>
+</tr>
+</thead>
+<tbody><tr>
+  <td>username</td>
+  <td>@Path</td>
+  <td>The username of the user</td>
+  <td></td>
+</tr>
+</tbody></table>
+
+
+
+
+<h3 id="examples-33">Examples</h3>
+
+<p><strong>Header:</strong> Authorization: Basic YWRtaW46MTIzNDU=</p>
+
+<p><strong>DELETE</strong> <a href="http://example.org:9090/plugins/restapi/v1/sessions/testuser">http://example.org:9090/plugins/restapi/v1/sessions/testuser</a></p>
+
 <h1 id="deprecated-user-service-plugin-readme">(Deprecated) User Service Plugin Readme</h1>
 
 
@@ -4191,6 +4269,54 @@ If the strings are encoded incorrectly, double byte characters will look garbele
 
 
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/controller/SessionController.java

@@ -17,6 +17,7 @@ import org.jivesoftware.openfire.session.Session;
 import org.jivesoftware.openfire.user.UserNotFoundException;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.xmpp.packet.StreamError;
 
 /**
  * The Class SessionController.
@@ -61,6 +62,20 @@ public class SessionController {
 		SessionEntities sessionEntities = convertToSessionEntities(clientSessions);
 		return sessionEntities;
 	}
+	
+	/**
+	 * Removes the user sessions.
+	 *
+	 * @param username the username
+	 * @throws ServiceException the service exception
+	 */
+	public void removeUserSessions(String username) throws ServiceException {
+	    final StreamError error = new StreamError(StreamError.Condition.not_authorized);
+	    for (ClientSession session : SessionManager.getInstance().getSessions(username)) {
+		    session.deliverRawText(error.toXML());
+		    session.close();
+	    }
+	}
 
 	/**
 	 * Convert to session entities.

src/plugins/restAPI/src/java/org/jivesoftware/openfire/plugin/rest/service/SessionService.java

 package org.jivesoftware.openfire.plugin.rest.service;
 
 import javax.annotation.PostConstruct;
+import javax.ws.rs.DELETE;
 import javax.ws.rs.GET;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
 
 import org.jivesoftware.openfire.plugin.rest.controller.SessionController;
 import org.jivesoftware.openfire.plugin.rest.entity.SessionEntities;
@@ -34,4 +36,11 @@ public class SessionService {
 		return sessionController.getUserSessions(username);
 	}
 	
+	@DELETE
+	@Path("/{username}")
+	public Response kickSession(@PathParam("username") String username) throws ServiceException {
+		sessionController.removeUserSessions(username);
+		return Response.status(Response.Status.OK).build();
+	}
+	
 }