FishEye 2.1 : Developing Fisheye Plugins
This page last changed on Mar 03, 2009 by edawson.
IntroductionThis page contains the basic information to guide plugin developers in coding and building a plugin for FishEye. There is also Crucible documentation on this topic, if you wish to also access Crucible with your plugin. FishEye uses the standard Atlassian Plugins framework, so many of the tasks involved in developing a plugin for FishEye are the same as for other Atlassian products. The differences are:
Building a FishEye PluginThe simplest way to build a FishEye plugin is via Maven. Atlassian provides an Archetype for Fisheye/Crucible plugins. You can create a Maven 2 project containing a sample Servlet Plugin Module with the following command: mvn org.apache.maven.plugins:maven-archetype-plugin:1.0-alpha-7:create \ -DarchetypeGroupId=com.atlassian.maven.archetypes \ -DarchetypeArtifactId=crucible-plugin-archetype \ -DarchetypeVersion=1-SNAPSHOT \ -DremoteRepositories=https://maven.atlassian.com/repository/public/ \ -DgroupId=com.foo -DartifactId=foo-crucible-plugin FishEye Plugin Module TypesFishEye supports several different kinds of plugin modules, listed below. FishEye Web ItemsWeb UI plugin modules allow you to add links, tabs and sections of links to the Fisheye user interface. See FishEye Web Items for more details. Servlet Plugin ModulesCreate a servlet which is deployed to the same web application context as Fisheye/Crucible. See Servlet Plugin Modules for more details. Spring Component Plugin ModulesCreate a plugin that makes use of Spring components. See Spring Component Plugin Modules for more details. The FishEye APIYour plugin will need to use The FishEye Remote API to retrieve data from FishEye and to perform operations on it, such as retrieving a changeset. Debugging your pluginYou can start FishEye in debug mode with the environment variable setting: export FISHEYE_OPTS="-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=5005" This allows you to connect your IDE to the debugger listening on port 5005. Source Code LinksSee the following pages for code from example plugins: Further Information |
![]() |
Document generated by Confluence on Nov 11, 2009 21:21 |