Confluence JSON webservice

This plugin is to utilize the existing webservice plugins which are XMLRPC plugin and SOAP plugin, including Confluence Remote API plugin

Details

As per summary, this plugin can be used to expose the functionalities of the existing SOAP and XMLRPC plugins, including the default plugin which is bundled by Confluence (Confluence Remote API plugin).

You can switch this plugin to be able to expose either XMLRPC or SOAP. If you switch to XMLRPC, Confluence JSON webservice will expose the existing XMLRPC plugin, and also if you switch to SOAP, then this plugin can expose the existing SOAP plugin.

For more example on how to use the plugin, you can refer to the Documentation link of this plugin.

In order to use the plugin, what you need to do is to request a servlet of this plugin. This servlet is processing what service and what method that you want to consume. The URL that is used to consume JSON services, has a pattern. The following is the pattern of the URL address that you need so that you can consume the service:

http://<confluencePath>/plugins/servlet/<serviceKey>/<methodName>?parameters=<methodsParameter>&callback=<callback>

No	Variable	Description
1	<confluencePath>	The path to access your Confluence. By default, your Confluence should be accessible via http://localhost:8080.
2	<serviceKey>	Key of the service that you want to access. Each installed rpc plugins (SOAP and XMLRPC) in your Confluence have a key. You need to supply this key so that this plugin can process further. For example, XMLRPC service of Confluence Remote API plugin has a key confluence-xmlrpc. You can see all of the installed RPC plugins in your Confluence which you can expose via configuration page of this plugin: http://<ConfluencePath>/admin/JsonConfigurationPage.action
3	<methodsParameter>	The method and its parameters which you want to call. All the available methods are depending on the installed XMLRPC and SOAP plugins in your Confluence. You can see the available methods in certain service via configuration page of this plugin as well. Please note that the sequence of parameters of the methods that you want to call is very important.
4	<callback>	Callback of the JSON string. This wraps the JSON object before the result is returned to client. This callback is used for security reason. By default the callback's value is Confluence. If you don't want to include callback in the JSON script that will be returned. You can specify the value of this parameter to be noLabel.

In this page, I will demonstrate a few ways on how to use this plugin. Most of the services that I use in this example are bundled in Confluence distribution. The services are Confluence Remote API and Confluence Blogging RPC Plugin.

Example:{*}Calling method getPage from Confluence Remote API using browser:*In the above example, the service is accessed via the following URL:

http://localhost:8080/plugins/servlet/jsonService/confluence-xmlrpc/getPage?parameters=BiqCJuhH2a;262148

Overview

Name	Confluence JSON webservice
Vendor	CustomWare (Website)
Authors	Arie Murdianto
Homepage	n/a
Issue Management	http://greenhouse.customware.net/jira/browse/JSON
Continuous Integration	n/a
Categories	Other
Most Recent Version	1.2
Availability	confluence v2.9 to v3.0.2
State	Stable
Support	By: CustomWare
License	Freeware / Open Source (BSD)
Price	Free
Release Docs
Java API Docs	https://maven.atlassian.com/contrib/net/customware/webservice/json/confluence-json-webservice/1.2/confluence-json-webservice-1.2-javadoc.jar
Download Source	https://studio.plugins.atlassian.com/source/browse/JSON/
Download JAR	11168

Bugs & Feature Requests

Bug reports and feature requests are available in JIRA.

This plugin does not have any macros.

Examples

Example 1:{*}Calling method getPage from Confluence Remote API using browser:*In the above example, the service is accessed via the following URL:

http://localhost:8080/plugins/servlet/jsonService/confluence-xmlrpc/getPage?parameters=BiqCJuhH2a;262148
Example 2:
Using JQuery to retrieve the content of JSON Webservice

<html>
<head>
  <script src="jquery.js"></script>
  <script>
  $(document).ready(function(){	  
    $.getJSON('http://localhost:8080/plugins/servlet/jsonService/confluence-xmlrpc/getPage?parameters=BiqCJuhH2a;262148&callback=?', function ( data ) { 
	    alert('test'+data.title);
	    });
    });
  </script>
</head>
<body>
</body>
</html>

Example 3:
Calling method getMostPopularLabels from Confluence Remote API using Apache HttpClient + JSON-lib.

import net.sf.json.JSONArray;
import net.sf.json.JSONObject;
import net.sf.json.util.JSONDynaBean;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.*;
import org.apache.commons.httpclient.params.HttpMethodParams;
import java.io.*;
import java.util.List;

public class FetchJSONService {
	  public static void main(String[] args) {
	    HttpClient client = new HttpClient();
	    GetMethod methodLogin = new GetMethod("http://localhost:8080/plugins/servlet/jsonService/confluence-soap/login?parameters=admin;arie&callback=noLabel");
	    methodLogin.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,new DefaultHttpMethodRetryHandler(3, false));
	    try {
	      client.executeMethod(methodLogin);
		  String token = methodLogin.getResponseBodyAsString();
		  token = token.substring(1, token.length()-1);
		  GetMethod method = new GetMethod("http://localhost:8080/plugins/servlet/jsonService/confluence-soap/getMostPopularLabels?parameters="+token+";10&callback=noLabel");
		  method.getParams().setParameter(HttpMethodParams.RETRY_HANDLER,new DefaultHttpMethodRetryHandler(3, false));  
		  int statusCode = client.executeMethod(method);
	      String responseBody = method.getResponseBodyAsString();
	      System.out.println("the retrieved token: "+ token);
		  System.out.println(responseBody);
	      JSONArray jsonArray = JSONArray.fromString(responseBody);
	      List<JSONDynaBean> listOfLabel = JSONArray.toList(jsonArray);
	      for(JSONDynaBean item:listOfLabel)
	      {
	    	  System.out.println("Available label: "+item.get("name"));
	      }
	    } catch (Exception e) {
	      e.printStackTrace();
	    }
	  }
}

The above code will give you the available labels in your Confluence instance as illustrated below:

Example 4:
Calling method storePage from Confluence Remote API using browser
In this example, I will be using browser to add a page to a Confluence instance, which has the following attribute:

title: Arie Murdianto

content: {pagetree}
URL address to access:

http://<ConfluencePath>/plugins/servlet/jsonService/confluence-soap/storePage?parameters=23rF60CNz1;{'parentId':0,'permissions':0,'title':'Arie%20Murdianto','url':'http://kimprit:8080/display/TT/Arie+Murdianto','space':'TT','content':'{pagetree}'}&callback=noLabel

The above URL produces the following:

Example 5
Calling method getUserInfo from Confluence Blogging RPC Plugin
In this example, I am using browser to get user info via browser. The method has the following parameters:

http://localhost:8080/plugins/servlet/jsonService/blogger-xmlrpc/getUserInfo?parameters=confluence;admin;arie

The above url produces the following:

Title

Note: By downloading the product below, you agree to CustomWare's product license agreement.

In order to install you can download the plugin here and then install it via plugin manager. Alternatively, you can use repository client plugin to install Confluence JSON webservice plugin.

Get Satisfaction support network

Loading...

Get Satisfaction support network

Confluence FlotChart Plugin

Plugins

Confluence Page History Slider

Confluence JSON webservice

Details

Overview

Bugs & Feature Requests

Title

Labels

Discussions