Difference between revisions of "ECF/Shared Code Plugin"

From Eclipsepedia

< ECF
Jump to: navigation, search
(References)
 
(31 intermediate revisions by 4 users not shown)
Line 6: Line 6:
  
 
==Project Motivation==
 
==Project Motivation==
The Shared Code Plug-in (SCP) is an Eclipse plug-in exclusively allocated to share source code between Eclipse users, providing a mechanism to take charge of search, retrieval and sharing. The SCP idea is to provide developers with an easy-to-use interface to search for source code and share source code among developers, which can
+
The Shared Code Project is a small set of Eclipse plugins to support dynamic source code search and sharing among a team of Eclipse users. The SCP idea is to provide developers with an easy-to-use interface to search for source code and share source code among developers, which can be leveraged in the applications. Developers can make yours source code on Eclipse Workspace available to a lot of people, adding special metadata into these source code, making way for others developers find easy source code, in ways never possible before. SCP is based in a peer-to-peer communications and file sharing, therefore, the intention is to use the Eclipse Communication Framework (ECF) as base, because ECF provides an open source framework supporting the creation of communications-based applications on the Eclipse platform, using a peer-to-peer network.
be leveraged in the applications. Developers can make yours source code on Eclipse Workspace available to a lot of people, adding special metadata into these source code, making way for others developers find easy source code, in ways never possible before. SCP is based in a peer-to-peer communications and file sharing, therefore, the intention is to use the Eclipse Communication Framework (ECF) as base, because ECF provides an open source framework supporting the creation of communications-based applications on the Eclipse platform, using a peer-to-peer network.
+
 
SCP focuses on the development of tool of collaborative.
 
SCP focuses on the development of tool of collaborative.
  
  
 
==Goals==
 
==Goals==
* Developer types criteria and select metadata to the search.
+
# Enable easy-to-user searching of source code across multiple Eclipse workspaces
* Metadata Terms maybe embedded in source code so Developers may cite a particular entry with the specific form(maybe Eclipse’s makers or annotations). Metadata Terms are available to the search, and used for Developers gives information about yours source code. Metadata Terms are based on Dublin Core:
+
# Support metadata-based searches using Eclipse markers. See [[Candidate Metadata|here]] for candidate metadata types and screenshots.
** Data create
+
# Support the delivery and view/presentation of matching source code in response to remote search requests
** Last update
+
# Support search restriction based upon source license type, as well as individual and group-level search restrictions
** Language
+
 
** Title
+
See [[Goals Achieve|here]] more details of how these goals will be achieved.
** Creator
+
** Subject and Keywords
+
** Description
+
** Resource Identifier
+
** Source
+
** Coverage
+
** Rights Management
+
* The search executed by developers, will be sending to the peers (others developers with the SCP). Each peer will take out the criteria search and find source code in the Eclipse workspace that meets their needs. SCP will find Metadata terms, class name, imports, code block, comment block, method return and others criterions.
+
* Developers want the ability to regulate access to their workspace, and to govern how the SCP will respond to searches. Social aspects for usage of these source code collaboration will have raised demand for security policies and restrictions. For example, maybe some workspace contents are associated with a 'public domain' group (which has public access only), while other source in the workspace is associated with other groups (for example EPL licensed code, commercial open source, commercial closed source, etc - http://www.opensource.org/licenses). Within each group could be appropriate sharing and search policies. SCP will have a set of roles and policies that can be applied to collaborative settings. These roles and policies can be customized.
+
* The peers that received the request, will send to the requester a list of response, this list contain peer name, source code file name, method name(if possible), date, last update, number of results and a possible page rank.
+
* The requester selects a bundle of choice, and the SCP download the files.
+
* SCP copies the files to shared area in the requester, and make them available from a view.
+
  
 
==Schedule==
 
==Schedule==
Project's shechudule is in [[SCP Schedule]], you can be well aware of tasks and status about the project.
+
Project's schedule is in [[SCP Schedule]], you can be well aware of tasks and status about the project.
  
==Technical Issues==
 
===Communication Channel===
 
SCP make a broadcasting search requests from peer A(requestor) to peers N. When peer N1 matches on the search term, it sends the match to Peer A, not all the peers in the group. The messaging model imply in a request/response model. We decided have two channels: one to broadcast requests to peers N, and another to receive responses - only to requesters. A simple solution was get ID of the sender, using method getFromContainerID() in IChannelMessageEvent, and send the response using sendMessage(ID receiver, byte [] message), which sends to a particular receiver container. Any peer that wants to respond can simply initiate a direct connection with the requester. [[Media:CommunicationChannel.png|Figure]] shows the scenario.
 
  
==Screenshots==
+
==Architecture==
 +
All the relevant characteristics of SCP Architecture can be figured out in [[ScpArchitecture]].
  
 +
 +
==Screenshots==
 
Screenshots were produced from the SCP and placed where it can be easily seen - [[Screenshots SCP]].
 
Screenshots were produced from the SCP and placed where it can be easily seen - [[Screenshots SCP]].
  
==Architecture==
 
  
All the relevant characteristics of SCP Architecture can be figured out in [[ScpArchitecture]].
+
==Technical Issues==
 +
===[[Multipoint Request/Reply Implementation]]===
  
==Futere Work==
 
===Server Cache Mechanism===
 
  
===Peer Cache Mechanism===
+
==Plug'in Usage==
==Resources==
+
* This simple [[story]] describes the user value provided by SCP. The story will describe how a developer would have a useful search for source code. <br>
 +
 
 +
===How to run a Demo===
 +
 
 +
Once the Shared Code is on workspace, you can run it two different ways. One way is to compile the project, package it up as a JAR file, copy it to the plugins subdirectory, and restart Eclipse. You will see the menu and toolbar button in your workbench.
 +
 
 +
The other method to run Shared Code is more convenient. Using the Run-time Workbench, you start a temporary Eclipse installation that automatically runs it.
 +
 
 +
To run and test Shared Code on the run-time workbench, see [[HOWTO: Shared Code Plugin]], it is a step-by-step description of how to install and run the SCP.
 +
 
 +
===How to build===
 +
Shared Code plug-in depends on other plug-ins, only internal Eclipse plug-in:
 +
 
 +
* org.eclipse.ui,
 +
* org.eclipse.core.runtime,
 +
* org.eclipse.search,
 +
* org.eclipse.core.resources,
 +
* org.eclipse.jdt.core,
 +
* org.eclipse.ecf.datashare,
 +
* org.eclipse.ui.ide
 +
 
 +
PDE takes care of all of these things. PDE has a section Dependency Analysis -> Find plug-ins and fragments that reference this plug-in, that takes care of all dependences of Shared Code plug-in.
 +
 
 +
To package and export the Shared Code plug-in, the Deployable Plug-ins and Fragments export wizard is used, only select  org.eclipse.ecf.example.sharecode. The zip file generated then simply needs to be unzipped into the installation directory of any Eclipse-based product and the Shared Code plug-in becomes part of Eclipse.
 +
 
 +
'''Obs: See [[HOWTO:_Shared_Code_Plugin#Step_0| here]] the Prerequisites to run Shared Code plug-in, and get the plugin Shared Code from anonymous CVS on soc.eclipse.org and path = /cvsroot/org.eclipse.soc/ org.eclipse.ecf.example.sharecode.'''
 +
 
 +
==Future Work==
 +
===[[Peer Cache Mechanism]]===
 +
 
 +
 
 +
==Resources and Talks==
 +
This session is a nice place to talk abou '''ideas''' and '''clues''' with other people about SCP - [[Talk:Shared_Code_Plugin|Talks]].
 +
 
 
===References===
 
===References===
 +
* Notes on the Eclipse Plug-in Architecture by Azad Bolour (Bolour Computing) July 2003
 +
* On the Job: The Eclipse Jobs API by Michael Valenta (IBM) September 2004
 +
* Preferences in the Eclipse Workbench UI by Tod Creasey (IBM) August 2002
 +
* Enterprise Integration Patterns : Designing, Building, and Deploying Messaging Solutions by Gregor Hohpe, Bobby Woolf
 +
 +
{{ECF}}
  
===Notes===
+
[[Category:Eclipse Communication Framework]]
 +
[[Category:ECF]]
 +
[[Category:Source Code Sharing]]
 +
[[Category:SOC]]

Latest revision as of 09:23, 22 December 2010

Sharecodelogo.gif

Project Lead: Marcelo Mayworm

Mentor(s): Scott Lewis, Ken Gilmer

Contents

[edit] Project Motivation

The Shared Code Project is a small set of Eclipse plugins to support dynamic source code search and sharing among a team of Eclipse users. The SCP idea is to provide developers with an easy-to-use interface to search for source code and share source code among developers, which can be leveraged in the applications. Developers can make yours source code on Eclipse Workspace available to a lot of people, adding special metadata into these source code, making way for others developers find easy source code, in ways never possible before. SCP is based in a peer-to-peer communications and file sharing, therefore, the intention is to use the Eclipse Communication Framework (ECF) as base, because ECF provides an open source framework supporting the creation of communications-based applications on the Eclipse platform, using a peer-to-peer network. SCP focuses on the development of tool of collaborative.


[edit] Goals

  1. Enable easy-to-user searching of source code across multiple Eclipse workspaces
  2. Support metadata-based searches using Eclipse markers. See here for candidate metadata types and screenshots.
  3. Support the delivery and view/presentation of matching source code in response to remote search requests
  4. Support search restriction based upon source license type, as well as individual and group-level search restrictions

See here more details of how these goals will be achieved.

[edit] Schedule

Project's schedule is in SCP Schedule, you can be well aware of tasks and status about the project.


[edit] Architecture

All the relevant characteristics of SCP Architecture can be figured out in ScpArchitecture.


[edit] Screenshots

Screenshots were produced from the SCP and placed where it can be easily seen - Screenshots SCP.


[edit] Technical Issues

[edit] Multipoint Request/Reply Implementation

[edit] Plug'in Usage

  • This simple story describes the user value provided by SCP. The story will describe how a developer would have a useful search for source code.

[edit] How to run a Demo

Once the Shared Code is on workspace, you can run it two different ways. One way is to compile the project, package it up as a JAR file, copy it to the plugins subdirectory, and restart Eclipse. You will see the menu and toolbar button in your workbench.

The other method to run Shared Code is more convenient. Using the Run-time Workbench, you start a temporary Eclipse installation that automatically runs it.

To run and test Shared Code on the run-time workbench, see HOWTO: Shared Code Plugin, it is a step-by-step description of how to install and run the SCP.

[edit] How to build

Shared Code plug-in depends on other plug-ins, only internal Eclipse plug-in:

  • org.eclipse.ui,
  • org.eclipse.core.runtime,
  • org.eclipse.search,
  • org.eclipse.core.resources,
  • org.eclipse.jdt.core,
  • org.eclipse.ecf.datashare,
  • org.eclipse.ui.ide

PDE takes care of all of these things. PDE has a section Dependency Analysis -> Find plug-ins and fragments that reference this plug-in, that takes care of all dependences of Shared Code plug-in.

To package and export the Shared Code plug-in, the Deployable Plug-ins and Fragments export wizard is used, only select org.eclipse.ecf.example.sharecode. The zip file generated then simply needs to be unzipped into the installation directory of any Eclipse-based product and the Shared Code plug-in becomes part of Eclipse.

Obs: See here the Prerequisites to run Shared Code plug-in, and get the plugin Shared Code from anonymous CVS on soc.eclipse.org and path = /cvsroot/org.eclipse.soc/ org.eclipse.ecf.example.sharecode.

[edit] Future Work

[edit] Peer Cache Mechanism

[edit] Resources and Talks

This session is a nice place to talk abou ideas and clues with other people about SCP - Talks.

[edit] References

  • Notes on the Eclipse Plug-in Architecture by Azad Bolour (Bolour Computing) July 2003
  • On the Job: The Eclipse Jobs API by Michael Valenta (IBM) September 2004
  • Preferences in the Eclipse Workbench UI by Tod Creasey (IBM) August 2002
  • Enterprise Integration Patterns : Designing, Building, and Deploying Messaging Solutions by Gregor Hohpe, Bobby Woolf
Eclipse Communication Framework
API
API DocumentationJavadocProvidersECF/Bot Framework
Components
ServersShared EditingShared Code Plug-in
Development
Development GuidelinesIntegrators Guide