info.magnolia.cms.security
Interface Group

All Superinterfaces:

Serializable

All Known Implementing Classes:

MgnlGroup

public interface Group
extends Serializable

A user group. Groups are assigned to users and can have sub groups.

Author:

Sameer Charles $Id:Group.java 9391 2007-05-11 15:48:02Z scharles $

Method Summary

void	addGroup(String groupName) Add a subgroup to this group.
void	addRole(String roleName)
Collection<String>	getAllGroups() Get all groups assigned to this group, collected recursively from subgroups.
Collection<String>	getGroups() Get groups that are directly assigned to group.
String	getName()
String	getProperty(String propertyName) Gets an arbitrary property from this group.
Collection<String>	getRoles() Get roles that are directly assigned to group.
boolean	hasRole(String roleName)
void	removeGroup(String groupName)
void	removeRole(String roleName)
void	setProperty(String propertyName, String value) Sets an arbitrary property for this group.

Method Detail

getName

String getName()

addRole

void addRole(String roleName)
             throws UnsupportedOperationException,
                    AccessDeniedException

Throws:

UnsupportedOperationException

AccessDeniedException

addGroup

void addGroup(String groupName)
              throws UnsupportedOperationException,
                     AccessDeniedException

Add a subgroup to this group.

Parameters:

groupName -

Throws:

UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException - if loggen in repository user does not sufficient rights

removeRole

void removeRole(String roleName)
                throws UnsupportedOperationException,
                       AccessDeniedException

Throws:

UnsupportedOperationException

AccessDeniedException

removeGroup

void removeGroup(String groupName)
                 throws UnsupportedOperationException,
                        AccessDeniedException

Throws:

UnsupportedOperationException

AccessDeniedException

hasRole

boolean hasRole(String roleName)
                throws UnsupportedOperationException,
                       AccessDeniedException

Throws:

UnsupportedOperationException

AccessDeniedException

getProperty

String getProperty(String propertyName)

Gets an arbitrary property from this group.

setProperty

void setProperty(String propertyName,
                 String value)

Sets an arbitrary property for this group.

getGroups

Collection<String> getGroups()

Get groups that are directly assigned to group.

getAllGroups

Collection<String> getAllGroups()

Get all groups assigned to this group, collected recursively from subgroups.

getRoles

Collection<String> getRoles()

Get roles that are directly assigned to group.