Framework API, Example Plugin and User Guide

A description of the framework API is provided along with a user guide which not only illustrates how to use the framework application, but also how to develop plugins. An example plugin is provided, along with an accompanying description.

API

All Interfaces relating to the P2P Application Framework (all plugins must implement one of these)

• PluginInterface
• ServerPluginInterface

• ClientFramework
• ServerFramework
• ResourceTemplate
• User
• UserObject
• MediaType
• ResourceObject

Example Plugin

This very simple plugin demonstrates how the framework can be used and how new plugins can be rapidly developed. Essentially it allows users to transfer a file (Test.txt) between each other. To install and run the compiled code, download the zip file, uncompress it and copy the ExamplePlugin folder into the Plugins directory within your ClientFramework. Upon next running the ClientFramework the ExamplePlugin will be loaded automatically.

ExamplePlugin compilied code - zip file containing a ready-to-run version of the plugin
ExamplePlugin source code - java file containing the commented source code for the plugin

User Guide

A brief user guide for the framework is provided here. Individiual plugins also have their own user guides, written by the plugin authors.

1. P2P Application Framework Front-end
2. Framework Preferences
3. User Search
4. Resource Search
5. Activating a plugin
6. Building a new plugin
7. Setting up the JXTA aspect of the framework