[Building Sakai] cleaning up the Sakai web services

[Steve Swinsburg]

Hi Noah,

The plan was to mark anything I don't receive information about as deprecated, and update them to add some logging about them being deprecated (maybe even include this logging in 2.7 to give adequate notice). 

Then, at some point in the 2.8 cycle, move them into an 'archived' or 'deprecated' directory. Services that are being used would be migrated and documented and implementors would have quite some time to update their applications to look at the new location (from now until 2.8.0).

So it would be two upgrades away (2.8.0).

cheers,
Steve








On 07/03/2010, at 3:50 AM, Noah Botimer wrote:

> Hi Steve,
> 
> I think it's great that you're looking to take inventory and give a single, consistent place for people to look.
> 
> However; I have to urge that nothing be moved/removed in one shot. These are part of an external contract that people write their tools and scripts against. Copying methods and marking the originals as deprecated with a full cycle to port would be fine. Making the very next upgrade contingent on porting stuff for cleanliness is probably too far, causing unnecessary admin/development stress. If I can port things a la carte over a whole generation, I'm much happier.
> 
> An important point here is that there are no internal consumers of these services where we need to make exclusive changes for a fix, enhancement, or refactoring. And we can't find/test the consumers. I suppose I might say "it ain't broke; improve it but don't break it".
> 
> SakaiSigning is definitely used for verification of LinkTool launches. See linktool.txt in the top level of the module source.
> 
> Your interest and energy here are much appreciated.
> 
> Thanks,
> -Noah
> 
> On Mar 6, 2010, at 8:46 AM, Steve Swinsburg <steve.swinsburg at gmail.com> wrote:
> 
>> Hi all,
>> 
>> I am looking to cleanup and consolidate the current suite of web services, but have a few queries about some of the JWS files that are in there.
>> 
>> The main web service sets are:
>> 
>> SakaiLogin - remote login/logout functionality
>> SakaiScript - the main set of administrative functions
>> Portfolio - portfolio functions
>> 
>> However, there are a number of others which are undocumented and sometimes duplicate existing functionality in the main ones above.  In particular, I would like some information about the following:
>> 
>> SakaiPortalLogin.jws
>> SakaiSession.jws
>> SakaiSigning.jws - I believe this is used by the LinkTool, but in what capacity? I can't find any working reference to it in the code.
>> SakaiSite.jws
>> WSContent.jws
>> WSSession.jws
>> 
>> Are these being used? It seems reasonable that the functionality from these could be rolled into either SakaiLogin or SakaiScript, which will make maintenance and testing easier, and might bring some useful functionality to the general population, or remove them entirely, if they are not being maintained/used.
>> 
>> So if you have any information about the state of the above web service sets, or are dependent on these locally, can you please let me know.
>> 
>> See also: http://jira.sakaiproject.org/browse/SAK-18136
>> 
>> thanks,
>> Steve
>> _______________________________________________
>> sakai-dev mailing list
>> sakai-dev at collab.sakaiproject.org
>> http://collab.sakaiproject.org/mailman/listinfo/sakai-dev
>> 
>> TO UNSUBSCRIBE: send email to sakai-dev-unsubscribe at collab.sakaiproject.org with a subject of "unsubscribe"
>> 
>>