Java Doc for GroupManager.java in » Portal » jetspeed-2.1.3 » org » apache » jetspeed » security » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Portal » jetspeed 2.1.3 » org.apache.jetspeed.security

Source Cross Reference

Class Diagram

Java Document (Java Doc)

org.apache.jetspeed.security .GroupManager

All known Subclasses:   org.apache.jetspeed.security.impl .GroupManagerImpl,
GroupManager
public interface GroupManager (Code)

Describes the service interface for managing groups.

Group hierarchy elements are being returned as a Group collection. The backing implementation must appropriately map the group hierarchy to a preferences sub-tree.

The convention {principal}.{subprincipal} has been chosen to name groups hierachies. Implementation follow the conventions enforced by the Preferences API.

author:
   David Le Strat

Method Summary
void addGroup(String groupFullPathName)

Add a new group.

Group principal names are expressed as {principal}.{subprincipal} where "." is the separator expressing the hierarchical nature of a group.

Group principal path names are stored leveraging the Preferences api.
void addUserToGroup(String username, String groupFullPathName)

Add a user to a group.
Group getGroup(String groupFullPathName)

Get a group Group for a given group full path name.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupChildName).
Iterator getGroups(String filter)
     Get all groups available from all group handlers
Parameters:
  filter - The filter used to retrieve matching groups.
Collection getGroupsForUser(String username)

A collection of Group for all the groups associated to a specific user.
Parameters:
  username - The user name.
Collection getGroupsInRole(String roleFullPathName)

A collection of Group for all the groups in a specific role.

Parameters:
  roleFullPathName - The role full path (e.g.theRoleName.theRoleChildName)..
boolean groupExists(String groupFullPathName)

Whether or not a group exists.
boolean isUserInGroup(String username, String groupFullPathName)

Whether or not a user is in a group.

Parameters:
  username - The user name.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupChildName).
void removeGroup(String groupFullPathName)

Remove a group.

Group principal names are expressed as {principal}.{subprincipal} where "." is the separator expressing the hierarchical nature of a group.

Group principal path names are stored leveraging the Preferences api.
void removeUserFromGroup(String username, String groupFullPathName)

Remove a user from a group.
void setGroupEnabled(String groupFullPathName, boolean enabled)
     Enable or disable a group.

Method Detail
addGroup
void addGroup(String groupFullPathName) throws SecurityException(Code)

Add a new group.

Group principal names are expressed as {principal}.{subprincipal} where "." is the separator expressing the hierarchical nature of a group.

Group principal path names are stored leveraging the Preferences api. Groups will be stored under /group/theGroupName/theGroupNameChild when given the full path name theGroupName.theGroupNameChild.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupNameChild).
throws:
  Throws - a security exception.

addUserToGroup
void addUserToGroup(String username, String groupFullPathName) throws SecurityException(Code)

Add a user to a group.

Parameters:
  username - The user name.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupChildName).
throws:
  Throws - a security exception.

getGroup
Group getGroup(String groupFullPathName) throws SecurityException(Code)

Get a group Group for a given group full path name.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupChildName). The Preferencesnode.
throws:
  Throws - security exception if the group does not exist.

getGroups
Iterator getGroups(String filter) throws SecurityException(Code)
Get all groups available from all group handlers
Parameters:
  filter - The filter used to retrieve matching groups. all groups available as Principal

getGroupsForUser
Collection getGroupsForUser(String username) throws SecurityException(Code)

A collection of Group for all the groups associated to a specific user.
Parameters:
  username - The user name. A collection of Group.
throws:
  Throws - security exception if the user does not exist.

getGroupsInRole
Collection getGroupsInRole(String roleFullPathName) throws SecurityException(Code)

A collection of Group for all the groups in a specific role.

Parameters:
  roleFullPathName - The role full path (e.g.theRoleName.theRoleChildName).. A Collection of Group.
throws:
  Throws - a security exception if the role does not exist.

groupExists
boolean groupExists(String groupFullPathName)(Code)

Whether or not a group exists.

Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupNameChild) Whether or not a group exists.

isUserInGroup
boolean isUserInGroup(String username, String groupFullPathName) throws SecurityException(Code)

Whether or not a user is in a group.

Parameters:
  username - The user name.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupChildName). Whether or not a user is in a group.
throws:
  Throws - security exception if the user or group does not exist.

removeGroup
void removeGroup(String groupFullPathName) throws SecurityException(Code)

Remove a group.

Group principal names are expressed as {principal}.{subprincipal} where "." is the separator expressing the hierarchical nature of a group.

Group principal path names are stored leveraging the Preferences api. Groups will be stored under /group/theGroupName/theGroupNameChild when given the full path name theGroupName.theGroupNameChild.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupNameChild)
throws:
  Throws - a security exception.

removeUserFromGroup
void removeUserFromGroup(String username, String groupFullPathName) throws SecurityException(Code)

Remove a user from a group.

Parameters:
  username - The user name.
Parameters:
  groupFullPathName - The group name full path (e.g.theGroupName.theGroupChildName).
throws:
  Throws - a security exception.

setGroupEnabled
void setGroupEnabled(String groupFullPathName, boolean enabled) throws SecurityException(Code)
Enable or disable a group.
Parameters:
  groupFullPathName - The group name full path theGroupName.theGroupChildName).
Parameters:
  enabled - enabled flag for the group

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.