|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface GroupManager
Specifies how to add, remove, and persist groups to an external group management entity.
Field Summary | |
---|---|
static String |
PROP_GROUPMANAGER
Property name for the manager class in jspwiki.properties. |
Method Summary | |
---|---|
void |
add(Group group)
Adds a Group to the group cache. |
void |
addWikiEventListener(WikiEventListener listener)
Registers a WikiEventListener with this GroupManager. |
void |
commit()
Commits the groups to persistent storage. |
boolean |
exists(Group group)
Returns true if a Group is known to the GroupManager
(contained in the group cache), false otherwise. |
void |
initialize(WikiEngine engine,
Properties props)
Initializes the authorizer. |
void |
reload()
Reloads the group cache from persistent storage. |
void |
remove(Group group)
Removes a Group from the group cache. |
void |
removeWikiEventListener(WikiEventListener listener)
Un-registers a WikiEventListener with this GroupManager. |
Methods inherited from interface com.ecyrd.jspwiki.auth.Authorizer |
---|
findRole, getRoles, isUserInRole |
Field Detail |
---|
static final String PROP_GROUPMANAGER
Method Detail |
---|
void initialize(WikiEngine engine, Properties props)
Authorizer
initialize
in interface Authorizer
engine
- the current wiki engineprops
- the wiki engine initialization propertiesvoid add(Group group)
IllegalArgumentException
, if the proposed group
is the same name as one of the built-in Roles: e.g., Admin,
Authenticated, etc. When a Group is added successfully, the GroupManager
implementation should send a WikiSecurityEvent of type
WikiSecurityEvent.GROUP_ADD
to all of its registered
WikiEventListeners. It should also register itself as a WikiEventListener for the Group
itself, so that additions to the group can be detected and
forwarded on to the GroupManager's own listeners.
group
- the Group to addvoid addWikiEventListener(WikiEventListener listener)
listener
- the event listenervoid remove(Group group)
WikiSecurityEvent.GROUP_REMOVE
to all of
its registered WikiEventListeners.
group
- the group to removeboolean exists(Group group)
true
if a Group is known to the GroupManager
(contained in the group cache), false
otherwise.
void commit() throws WikiException
WikiException
void reload()
WikiSecurityEvent.GROUP_CLEAR_GROUPS
to
all of its registered WikiEventListeners.
void removeWikiEventListener(WikiEventListener listener)
listener
- the event listener
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |