All Methods Instance Methods Abstract Methods Modifier and Type Method Description
delete(Group group)Looks up and deletes a
Groupfrom the group database.
groups()Returns all wiki groups that are stored in the GroupDatabase as an array of Group objects.
initialize(Engine engine, java.util.Properties props)Initializes the group database based on values from a Properties object.
save(Group group, java.security.Principal modifier)Saves a Group to the group database.
void delete(Group group) throws WikiSecurityExceptionLooks up and deletes a
Groupfrom the group database. If the group database does not contain the supplied Group. this method throws a
NoSuchPrincipalException. The method commits the results of the delete to persistent storage.
void initialize(Engine engine, java.util.Properties props) throws NoRequiredPropertyException, WikiSecurityExceptionInitializes the group database based on values from a Properties object.
void save(Group group, java.security.Principal modifier) throws WikiSecurityExceptionSaves a Group to the group database. Note that this method must fail, and throw an
IllegalArgumentException, if the proposed group is the same name as one of the built-in Roles: e.g., Admin, Authenticated, etc. The database is responsible for setting create/modify timestamps, upon a successful save, to the Group. The method commits the results of the delete to persistent storage.
group- the Group to save
modifier- the user who saved the Group
WikiSecurityException- if the Group could not be saved successfully
Group groups() throws WikiSecurityExceptionReturns all wiki groups that are stored in the GroupDatabase as an array of Group objects. If the database does not contain any groups, this method will return a zero-length array. This method causes back-end storage to load the entire set of group; thus, it should be called infrequently (e.g., at initialization time). Note that this method should use the protected constructor
Group(String, String)rather than the various "parse" methods (
GroupManager.parseGroup(String, String, boolean)) to construct the group. This is so as not to flood GroupManager's event queue with spurious events.
- the wiki groups
WikiSecurityException- if the groups cannot be returned by the back-end