info.magnolia.cms.security
Interface Group

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
MgnlGroup

public interface Group
extends java.io.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(java.lang.String groupName)
          Add a subgroup to this group.
 void addRole(java.lang.String roleName)
           
 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()
           
 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)
           
 void removeGroup(java.lang.String groupName)
           
 void removeRole(java.lang.String roleName)
           
 void setProperty(java.lang.String propertyName, java.lang.String value)
          Sets an arbitrary property for this group.
 

Method Detail

getName

java.lang.String getName()

addRole

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

addGroup

void addGroup(java.lang.String groupName)
              throws java.lang.UnsupportedOperationException,
                     AccessDeniedException
Add a 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
Throws:
java.lang.UnsupportedOperationException
AccessDeniedException

removeGroup

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

hasRole

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

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.



Copyright © 2003-2011 Magnolia International Ltd.. All Rights Reserved.