Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 333527 - [API] WebUtilities should have a method to find the Web projects that contain a Module
Summary: [API] WebUtilities should have a method to find the Web projects that contain...
Status: RESOLVED FIXED
Alias: None
Product: WTP Java EE Tools
Classification: WebTools
Component: jst.j2ee (show other bugs)
Version: 3.2   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: 3.2.3   Edit
Assignee: Carl Anderson CLA
QA Contact: Chuck Bridgham CLA
URL:
Whiteboard: PMC_approved
Keywords:
Depends on: 333518
Blocks:
  Show dependency tree
 
Reported: 2011-01-04 22:11 EST by Carl Anderson CLA
Modified: 2011-01-11 10:56 EST (History)
1 user (show)

See Also:
david_williams: pmc_approved+
ccc: pmc_approved? (raghunathan.srinivasan)
ccc: pmc_approved? (naci.dai)
ccc: pmc_approved? (deboer)
ccc: pmc_approved? (neil.hauge)
ccc: pmc_approved? (kaloyan)
cbridgha: review+

Attachments
The same patch as was committed to WTP 3.3 M5 (2.14 KB, patch)
2011-01-04 22:12 EST, Carl Anderson CLA 		no flags Details | Diff
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Carl Anderson CLA 2011-01-04 22:11:14 EST 
This bug is to track the inclusion of this method into WTP 3.2.3

+++ This bug was initially created as a clone of Bug #333518 +++

For EAR projects, EARUtilities.getReferencingEARProjects() finds all of the EAR projects that contain a certain module.  It would be extremely useful to have a similar method on WebUtilities to help us find what Web projects contain a module.

(Note that this method would be helpful for both Web Fragment projects and EJB projects utilized in packaging EJBs in WARs.)
Comment 1 Carl Anderson CLA 2011-01-04 22:12:58 EST 
Created attachment 186065 [details]
The same patch as was committed to WTP 3.3 M5
Comment 2 Carl Anderson CLA 2011-01-04 22:18:25 EST 
This API is extremely useful for programming of both Web Fragments and the packaging of EJBs in WARs.  It will definitely be part of WTP 3.3, but it would be useful if developers already started coding to it (to avoid repetition of this code within adopters as well as the need to convert such code over to this method call).
Comment 3 Chuck Bridgham CLA 2011-01-10 10:35:23 EST 
approve
Comment 4 Carl Anderson CLA 2011-01-10 14:55:28 EST 
PMC Review requested due to API change

    * Explain why you believe this is a stop-ship defect. Or, if it is a "hotbug" (requested by an adopter) please document it as such. 

An adopter (IBM) would like this API backported to WTP 3.2.x.  This API is quite useful in regards to packaging Web Fragments and EJBs in a WAR.

    * Is there a work-around? If so, why do you believe the work-around is insufficient?

The workaround would be for the adopter to provide such a utility method.  However, that method would then need to be deprecated/removed as soon as the adopter gets onto WTP 3.3.  Therefore, I see this as a much preferable solution.

    * How has the fix been tested? Is there a test case attached to the bugzilla record? Has a JUnit Test been added?

This fix has been tested by hand (both using plain WTP as well as adopter code).

    * Give a brief technical overview. Who has reviewed this fix? 

Chuck Bridgham has reviewed this fix.
This provides the same API functionality as EARUtilities.getReferencingEARProjects()

    * What is the risk associated with this fix? 

This is extremely low risk.  The only possible risk would be if an adopter extends this class and adds a method with the exact same signature, then accesses that method via reflection.
Comment 5 David Williams CLA 2011-01-10 15:11:35 EST 
sounds fine by me. Thanks for your care.
Comment 6 Carl Anderson CLA 2011-01-11 10:56:04 EST 
Committed to R3_2_maintenance for WPT 3.2.3