- All Implemented Interfaces:
public class XMLGroupDatabase extends java.lang.Object implements GroupDatabase
GroupDatabase implementation for loading, persisting and storing wiki groups, using an XML file for persistence. Group entries are simple
<group>elements under the root. Each group member is representated by a
<member>element. For example:
<group name="TV" created="Jun 20, 2006 2:50:54 PM" lastModified="Jan 21, 2006 2:50:54 PM">
<member principal="Archie Bunker" />
<member principal="BullwinkleMoose" />
<member principal="Fred Friendly" />
<group name="Literature" created="Jun 22, 2006 2:50:54 PM" lastModified="Jan 23, 2006 2:50:54 PM">
<member principal="Charles Dickens" />
<member principal="Homer" />
Fields Modifier and Type Field Description
PROP_DATABASEThe jspwiki.properties property specifying the file system location of the group database.
Constructors Constructor Description
All Methods Instance Methods Concrete 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.
public 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.
public 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).
public void initialize(Engine engine, java.util.Properties props) throws NoRequiredPropertyException, WikiSecurityExceptionInitializes the group database based on values from a Properties object. The properties object must contain a file path to the XML database file whose key is
- Specified by:
engine- the wiki engine
props- the properties used to initialize the group database
NoRequiredPropertyException- if the user database cannot be located, parsed, or opened
WikiSecurityException- if the database could not be initialized successfully
public 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.