Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 324851

Summary:	[api] URIResolverExtension Interface is Internal
Product:	[WebTools] WTP Common Tools	Reporter:	David Carver <d_a_carver>
Component:	wst.common	Assignee:	Keith Chong <keith.chong.ca>
Status:	NEW ---	QA Contact:	Carl Anderson <ccc>
Severity:	normal
Priority:	P3	CC:	thatnitind, valentinbaciu
Version:	3.2
Target Milestone:	4.0
Hardware:	PC
OS:	Linux
Whiteboard:

Description David Carver

2010-09-09 09:52:47 EDT

This is an API request and something I think was just over looked.  The current org.eclipse.wst.common.uriresolver.resolverExtensions is an API extension point for adding Custom Resolvers to help resolve grammars and xml files, however, the implementing interface that adopters are to implement is currently resides in an Internal package.   The URIResolverExtension should be made API.

Yes this will break many current Adopters, but it should be done to follow eclipse API guidelines.

Comment 1 Carl Anderson

2010-09-14 13:44:46 EDT

This would be best done in a new release, with the internal version being deprecated.  Targetting to WTP 3.3 M6 since that is the API cutoff, and assigning to Keith Chong for the initial investigation.

Comment 2 Keith Chong

2010-09-14 14:05:56 EDT

The current extension is in the internal provisional package.

Comment 3 Nitin Dahyabhai

2010-09-14 14:40:10 EDT

Which means the *only* way to use the framework at all is to make use of internals.

Comment 4 David Carver

2010-09-14 15:25:13 EDT

Correct, and I'd rather have true API instead of provisional, and it's been Provisional for years.  I think it is time to graduate it our get rid of it.

Comment 5 Valentin Baciu

2010-10-05 15:50:40 EDT

See also bug 88014.

Comment 6 Valentin Baciu

2010-10-15 10:30:44 EDT

Bug 172412 is also interesting in that it discusses URI classes. The URI resolver plug-in has its own URI class and various URI utilities.

Comment 7 Valentin Baciu

2010-10-19 14:32:05 EDT

I've been looking through the code recently and I've jotted down some potential improvements that could/should be done while cleaning this plug-in up for API:

- URI resolver extension schema could spell out the allowed values for the stage attribute using restrictions
- projectNature, value is a string, should perhaps be made an IDREF pointing to the nature ID.
- there some strangeness in org.eclipse.wst.common.uriresolver.internal.ExtensibleURIResolver.computeFile(String) in using getFileForLocation()

I'm sure there's more to be done to clean-up this code. Hope this helps.

Comment 8 Keith Chong

2011-03-17 13:33:01 EDT

Have to defer this out.   It is possible that supporting EFS may require these provisional APIs to change.....or there may be new APIs added.