Bug 149940 - [api] make naming of classes consistent accross connectors
Summary: [api] make naming of classes consistent accross connectors
Status: RESOLVED FIXED
Alias: None
Product: z_Archived
Classification: Eclipse Foundation
Component: Mylyn (show other bugs)
Version: unspecified   Edit
Hardware: All All
: P3 enhancement (vote)
Target Milestone: 2.0 M3   Edit
Assignee: Steffen Pingel CLA
QA Contact:
URL:
Whiteboard:
Keywords: plan
Depends on:
Blocks:
 
Reported: 2006-07-06 22:15 EDT by Steffen Pingel CLA
Modified: 2007-05-09 02:15 EDT (History)
2 users (show)

See Also:


Attachments
mylar/context/zip (1.47 KB, application/octet-stream)
2007-02-22 20:49 EST, Steffen Pingel CLA
no flags Details
mylar/context/zip (8.97 KB, application/octet-stream)
2007-05-08 20:35 EDT, Steffen Pingel CLA
no flags Details

Note You need to log in before you can comment on or make changes to this bug.
Description Steffen Pingel CLA 2006-07-06 22:15:29 EDT
As already discussed in bug 147816 comment #8, #9, #12, #13 and #18 naming of classes should be consistens across connectors.
Comment 1 Steffen Pingel CLA 2006-07-06 22:19:59 EDT
Trac currently uses the following naming schema:

  Trac Connector
  - 1..n Task Repository
  -> Trac Client Manager
    - 1..n Trac Client (TracXmlRpcClient, Trac09Client)
Comment 2 Steffen Pingel CLA 2006-07-30 12:04:18 EDT
When the renaming is done all *Trac09* classes should be renamed to *TracWeb* to avoid confusion with the access method and version of the repository.
Comment 3 Mik Kersten CLA 2006-12-07 15:20:42 EST
We focused on fixing naming for the Tasks framework.  Connectors are still largely in internal packages and naming will need to be fixed post 1.0.
Comment 4 Steffen Pingel CLA 2007-02-22 20:49:30 EST
Renamed Trac classes as per comment 2.
Comment 5 Steffen Pingel CLA 2007-02-22 20:49:32 EST
Created attachment 59622 [details]
mylar/context/zip
Comment 6 Mik Kersten CLA 2007-02-22 20:55:23 EST
Great.  I'll try to go through the other connectors before 2.0M2 ships, so that we set a good example for connector implementors.
Comment 7 Steffen Pingel CLA 2007-05-07 01:45:08 EDT
I am considering renaming of JiraServer to JiraClient for consistency with TracClient and BugzillaClient. Opinions?
Comment 8 Robert Elves CLA 2007-05-07 14:04:41 EDT
 (In reply to comment #7)
> I am considering renaming of JiraServer to JiraClient for consistency with
> TracClient and BugzillaClient. Opinions?
I agree.
Comment 9 Mik Kersten CLA 2007-05-07 15:24:06 EDT
Yes, I think that's a good idea because it names the class for what it is (a client to the JIRA server) and not what it abstracts (the JIRA server).  If the class were a data type it would be fine to name it for what it abstracts, but it's a connectivity mechanism.  I also thing that JiraServerFacade is a good name.  It sounds more complicated so I prefer JiraClient.  Also, JiraClient parallels the naming that we inherit from HttpClient.

Steffen: if you make this rename could you add a note to the Integrator Reference on this naming convention?
Comment 10 Steffen Pingel CLA 2007-05-07 15:33:40 EDT
Alright. I did not understand your comment regarding JiraServerFacade though. That class is essentially a facade to JiraServerManager (which would be renamed to JiraClientManager). 
Comment 11 Mik Kersten CLA 2007-05-08 12:35:05 EDT
 (In reply to comment #10)
> Alright. I did not understand your comment regarding JiraServerFacade though.
> That class is essentially a facade to JiraServerManager (which would be renamed
> to JiraClientManager).

Yes, the rename to JiraClientManager sounds right.  I was referring to the fact that "FooServerFacade" was an alternative naming convention to "FooClient", but I think that we've all settled on the latter.
Comment 12 Steffen Pingel CLA 2007-05-08 20:34:49 EDT
Renaming done. Anything left to do here?
Comment 13 Steffen Pingel CLA 2007-05-08 20:35:20 EDT
Created attachment 66390 [details]
mylar/context/zip
Comment 14 Mik Kersten CLA 2007-05-09 02:15:26 EDT
This should do it.  
Comment 15 Mik Kersten CLA 2007-05-09 02:15:57 EDT
Done.