Recently Updated Xmlrpc Plugin

Name Recently Updated Xmlrpc Plugin
Vendor Atlassian Software Systems (Website)
Authors Laura Kolker, Brendan Patterson
Homepage http://confluence.atlassian.com/display/CONFEXT/Recently+Updated+Xmlrpc+Plugin
Issue Management n/a
Continuous Integration n/a
Categories Remote Access
Most Recent Version 1.0
Availability Confluence v2.3 to v2.10
State Prerelease
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Recently+Updated+Xmlrpc+Plugin
Java API Docs n/a
Download Source https://svn.atlassian.com/svn/public/contrib/confluence/recently-updated-xmlrpc-plugin
Download JAR recently-updated-xmlrpc-plugin-1.0.jar

Description/Features

Exposes Recently Updated Pages method to as an XMLRPC Service. This provides functionality similar to the dashboard's Recently Updated list.
A simple client object is included.

Installation

Download the JAR, place it in your Confluence WEB-INF/lib, and restart your Confluence.
Or, install it via the Confluence Repository Client.

Dependencies

Don't forget to install dependencies!

To run the Xmlrpc Plugin as an Xmlrpc Service, there are no dependencies.

To use the bundled Client to communicate with the Xmlrpc Service, the following additional libraries will need to be available to your classpath:

Usage

You can use the provided Xmlrpc Client to access the Xmlrpc Service.
The client is com.atlassian.confluence.xmlrpc.recentlyupdated.RecentlyUpdatedXmlrpcClient
and is dependent on Brendan Patterson's Confluence Remote Java Wrapper library (and several other libraries, see note above).

Or, you can access the Remote Service with your own client code.

The Results Object

Using either the client or the service API will return, a Vector of Hashtable objects.
The Hashtables represent pages, and should provide values for the following keys:

key value
title The page name
url url to that page
id Confluence page id
excerpt page excerpt

Client API

	
/**
 * gets a default number of recently updated pages 
 * from a Confluence server
 * @param confSettings
 * @return Vector of RecentlyUpdatedPage objects
 */
public Vector getPages(ConfluenceServerSettings confSettings) 

/**
 * gets a given number of recently updated pages from a 
 * Confluence server
 * @param confSettings settings reflecting login and server for this request
 * @param maxResults maximum number of results 
 * @return Vector of RecentlyUpdatedPage objects representing recently
 * added and updated pages from the confluence server represented by confSettings
 */
 public Vector getPages(ConfluenceServerSettings confSettings, int maxResults) 

Remote API

/**
 * gets a vector of recently updated pages. 
 * @param token login token
 * @param maxResults the maximum number of results to be returned
 * @return Vector of Hashtables; each Hashtable represents a recently updated page.
 * <br/>Available keys include:
 * <ul><li>title</li><li>url</li><li>id</li><li>excerpt</li></ul>
 * @throws RemoteException
 */
public Vector getPages(String token, int maxResults) throws RemoteException;

Example Use of the Client API

	private Vector<RecentlyUpdatedPage> getRecentlyUpdatedPages(String server) {
		Vector<RecentlyUpdatedPage> pages = new Vector<RecentlyUpdatedPage>();

		//set up confluence login settings
		ConfluenceServerSettings confSettings = new ConfluenceServerSettings();
		confSettings.url = server;
		confSettings.login = null;
		
		//use xmlrpc client to get confluence pages
		RecentlyUpdatedXmlrpcClient client = new RecentlyUpdatedXmlrpcClient();
		Vector recentPages = client.getPages(confSettings);

		//transform hash of confluence pages to RecentlyUpdatedPage format
		for (Iterator iter = recentPages.iterator(); iter.hasNext();) {
			Hashtable pagehash = (Hashtable) iter.next();
			String label = (String) pagehash.get("title");
			String url = (String) pagehash.get("url");
			String link = "http://" + server + url;
			RecentlyUpdatedPage page = new RecentlyUpdatedPage(label, link);
			pages.add(page);
		}

		return pages;
	}

Version History

Plugin Versions

Version Date State License Price
Show description 1.0 (#1) 13 Feb 2007 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Features

  • Exposes Recently Updated Pages method as Xmlrpc interface
  • Provides Xmlrpc Client to interact with Xmlrpc interface

Limitations

Contributors

Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.