SPI - Service Provider Interface
Note: These pages are being reviewed.
This document describes the basic SPI/API requirements requested by the needs of the bugtracking infrastructure and other dependent subsystems of the IDE.
For a Bugtracking plugin implementation it is essential to support the following functionality:
provide functionality to manage Repository lifecycle
Provide Issues from a Repository by:
provide Issues from a Repository based on a simple text criteria - match text with id or summary
provide functionality to manage Query lifecycle:
provide a Query editor component capable to to create, edit and rename Queries and to notify the IDE about the state of changes in the editor
provide list of saved Queries associated with a Repository and notify about eventual changes in the saved queries list
execute the Query against the remote server and retrieve Issues matching the query criteria
provide functionality to access and manipulate Issues:
provide an Issue Editor component capable to create and edit Issues and to notify about the state of changes in the editor
provide basic issue information - id, summary, priority, finished state, relationship to other issues (parent/child), etc …
Persist Issue and Query state between IDE sessions. Notify and provide information about an Issues current local state. (Not mandatory.)
the bugtracking infrastructure will provide the following functionality for other subsystems to support:
provide a list of existing Queries for each Repository and a list of Issues for each Query (e.g for the needs of Team Support)
provide "quick" Issue search by a simple text criteria - (e.g for the needs of VCS Commit hooks, and patch integration)
provide Issue operations:
add comment, close and submit an issue (VCS Commit hooks)
create a new issue preset with summary and description (create Issue from Action Items or Hudson)
attach files to an Issue (export and attach patch to an issue from VCS)
parse text for issue references in the IDE (comments in source code editors, or in commit messages in VCS or in code comments)
open Issues by ID
The content in this page was kindly donated by Oracle Corp. to the Apache Software Foundation.
This page was exported from http://wiki.netbeans.org/BugtrackingAPISPIUseCases , that was last modified by NetBeans user Tstupka on 2013-11-12T14:11:14Z.
This document was automatically converted to the AsciiDoc format on 2020-03-12, and needs to be reviewed.