info.magnolia.cms.security
Interface Group

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

MgnlGroup

public interface Group
extends java.io.Serializable

Author:

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

Method Summary

void	addGroup(java.lang.String groupName) add subgroup to this group
void	addRole(java.lang.String roleName) add role to this group
java.util.Collection<java.lang.String>	getAllGroups() get all groups assigned to this group, collected recursively from subgroups
java.util.Collection<java.lang.String>	getGroups() get groups that are directly assigned to group
java.lang.String	getName() get name of this node
java.lang.String	getProperty(java.lang.String propertyName) Gets an arbitrary property from this group.
java.util.Collection<java.lang.String>	getRoles() get roles that are directly assigned to group
boolean	hasRole(java.lang.String roleName) returns true if role exist in this group
void	removeGroup(java.lang.String groupName) remove subgroup from this group
void	removeRole(java.lang.String roleName) remove role from this group
void	setProperty(java.lang.String propertyName, java.lang.String value) Sets an arbitrary property for this group.

Method Detail

getName

java.lang.String getName()

get name of this node

Returns:

group name

addRole

void addRole(java.lang.String roleName)
             throws java.lang.UnsupportedOperationException,
                    AccessDeniedException

add role to this group

Parameters:

roleName -

Throws:

java.lang.UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException - if loggen in repository user does not sufficient rights

addGroup

void addGroup(java.lang.String groupName)
              throws java.lang.UnsupportedOperationException,
                     AccessDeniedException

add subgroup to this group

Parameters:

groupName -

Throws:

java.lang.UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException - if loggen in repository user does not sufficient rights

removeRole

void removeRole(java.lang.String roleName)
                throws java.lang.UnsupportedOperationException,
                       AccessDeniedException

remove role from this group

Parameters:

roleName -

Throws:

java.lang.UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException - if loggen in repository user does not sufficient rights

removeGroup

void removeGroup(java.lang.String groupName)
                 throws java.lang.UnsupportedOperationException,
                        AccessDeniedException

remove subgroup from this group

Parameters:

groupName -

Throws:

java.lang.UnsupportedOperationException - if the implementation does not support writing

AccessDeniedException - if loggen in repository user does not sufficient rights

hasRole

boolean hasRole(java.lang.String roleName)
                throws java.lang.UnsupportedOperationException,
                       AccessDeniedException

returns true if role exist in this group

Parameters:

roleName -

Throws:

java.lang.UnsupportedOperationException - if the implementation does not exist

AccessDeniedException - if loggen in repository user does not sufficient rights

getProperty

java.lang.String getProperty(java.lang.String propertyName)

Gets an arbitrary property from this group.

setProperty

void setProperty(java.lang.String propertyName,
                 java.lang.String value)

Sets an arbitrary property for this group.

getGroups

java.util.Collection<java.lang.String> getGroups()

get groups that are directly assigned to group

getAllGroups

java.util.Collection<java.lang.String> getAllGroups()

get all groups assigned to this group, collected recursively from subgroups

getRoles

java.util.Collection<java.lang.String> getRoles()

get roles that are directly assigned to group