The group property to enable Site Info to see groups should be moved out of site-manage and into kernel-api

Description

In order for a group to show up in the Manage Groups part of Site Info, it must have the property:

group_prop_wsetup_created=true

This is defined in:
site-manage-util/util/src/java/org/sakaiproject/site/util/SiteConstants.java: public static final String GROUP_PROP_WSETUP_CREATED = "group_prop_wsetup_created";

Therefore, other tools that want to create groups with this property must either take a chance that the property won't change and hard code it themselves, or use the constant from the site manage utils, creating a hard dependency.

Ideally, this property would be moved to the kernel.

Attachments

1

Activity

Show:

Steve Swinsburg April 11, 2012 at 11:43 PM

Yeah its just to abstract the property name out so it is kept centrally. It isn't going to change though since that would mean a conversion is required, so lets just remove the merge flags and be done with it.

Agreed re documenting the various properties.

Matthew Jones April 11, 2012 at 11:37 PM

Yea, it just seems like a question of where this even belongs. I mean for something like this does it save that much time to say

properties.getProperty(((Group) g).GROUP_PROP_WSETUP_CREATED)

verses
properties.getProperty("group_prop_wsetup_created")

Perhaps the first one would auto complete IF you knew which class that variable was located in. But why even define them as variables at all? A constant string seems just as good if it's documented somewhere.

site/user/page/tool properties are even worse than sakai.properties because they're often created and nobody knows how they exist or what they do. Show me the document that describes how site templates are created or the property for embedding arbitrary html in a site. Sakai doesn't know about these properties, they're often not in confluence. The same work that happened with should really happen here. The number of questions I've gotten about these lately feels like it's finally the time. I would still love it if this happened during tool registration.

Not to pick on this issue in particular though.

Steve Swinsburg April 11, 2012 at 10:27 PM

It probably doesn't NEED to happen but it just means that tools that need to use it will have to recreate the property within themselves, i.e. SIGNUP-51. Thats probably ok if the property isn't going to change.

Matthew Jones March 5, 2012 at 2:40 PM

This is an api change, does this NEED to happen in 1.3.x (2.9). The api for 1.3 should really be considered frozen at this point unless it's a blocker.

Hudson CI Server March 1, 2012 at 11:58 AM

Integrated in kernel-trunk #464 (See http://builds.sakaiproject.org:8080/job/kernel-trunk/464/)
move GROUP_PROP_WSETUP_CREATED definition into kernel (Revision 105359)

Result = SUCCESS

Fixed

Details

Priority

Affects versions

Fix versions

Components

Assignee

Reporter

Labels

Created February 22, 2012 at 8:07 AM
Updated March 23, 2022 at 3:02 PM
Resolved March 1, 2012 at 11:43 AM