Java Doc for RoleManager.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 .RoleManager

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

Describes the service interface for managing roles.

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

The convention {principal}.{subprincipal} has been chosen to name roles hierachies in order to support declarative security. Implementation follow the conventions enforced by the preferences API.

author:
   David Le Strat

Method Summary
void addRole(String roleFullPathName)

Add a new role.

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

Role principal path names are stored leveraging the Preferences api.
void addRoleToGroup(String roleFullPathName, String groupFullPathName)

Add a role to a group.

Parameters:
  roleFullPathName - The role name full path(e.g.
void addRoleToUser(String username, String roleFullPathName)

Add a role to a user.

Parameters:
  username - The user name.
Parameters:
  roleFullPathName - The role name full path(e.g.
Role getRole(String roleFullPathName)

Get a role Role for a given role full path name.
Parameters:
  roleFullPathName - The role name full path(e.g.
Iterator getRoles(String filter)
     Get all roles available from all role handlers
Parameters:
  filter - The filter used to retrieve matching roles.
Collection getRolesForUser(String username)

A collection of Role for all the roles associated to a specific user.

Parameters:
  username - The user name.
Collection getRolesInGroup(String groupFullPathName)

A collection of Role for all the roles associated to a specific group.

Parameters:
  groupFullPathName - The group full path(e.g.
boolean isGroupInRole(String groupFullPathName, String roleFullPathName)

Whether or not a role is in a group.

Parameters:
  groupFullPathName - The group name full path(e.g.
boolean isUserInRole(String username, String roleFullPathName)

Whether or not a user is in a role.

Parameters:
  username - The user name.
Parameters:
  roleFullPathName - The role name full path(e.g.
void removeRole(String roleFullPathName)

Remove a given role and all the children of that role.

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

Role principal path names are stored leveraging the Preferences api.
void removeRoleFromGroup(String roleFullPathName, String groupFullPathName)

Remove a role from a group.

Parameters:
  roleFullPathName - The role name full path (e.g.
void removeRoleFromUser(String username, String roleFullPathName)

Remove a user from a role.

Parameters:
  username - The user name.
Parameters:
  roleFullPathName - The role name full path relative to the/role node (e.g.
boolean roleExists(String roleFullPathName)

Whether or not a role exists.

Parameters:
  roleFullPathName - The role name full path(e.g.
void setRoleEnabled(String roleFullPathName, boolean enabled)
     Enable or disable a role.
Parameters:
  roleFullPathName - The role name full path (e.g.

Method Detail
addRole
void addRole(String roleFullPathName) throws SecurityException(Code)

Add a new role.

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

Role principal path names are stored leveraging the Preferences api. Roles will be stored under /role/theGroupName/theGroupNameChild when given the full path name theRoleName.theRoleNameChild.
Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleNameChild).
throws:
  Throws - a security exception if the role already exists.

addRoleToGroup
void addRoleToGroup(String roleFullPathName, String groupFullPathName) throws SecurityException(Code)

Add a role to a group.

Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleChildName).
Parameters:
  groupFullPathName - The group name full path(e.g. theGroupName.theGroupChildName).
throws:
  Throws - a security exception.

addRoleToUser
void addRoleToUser(String username, String roleFullPathName) throws SecurityException(Code)

Add a role to a user.

Parameters:
  username - The user name.
Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleChildName).
throws:
  Throws - a security exception if the role or the user do not exist.

getRole
Role getRole(String roleFullPathName) throws SecurityException(Code)

Get a role Role for a given role full path name.
Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleNameChild). The Preferences node.
throws:
  Throws - a security exception if the role does not exist.

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

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

A collection of Role for all the roles associated to a specific user.

Parameters:
  username - The user name. A Collection of Role.
throws:
  Throws - a security exception if the user does not exist.

getRolesInGroup
Collection getRolesInGroup(String groupFullPathName) throws SecurityException(Code)

A collection of Role for all the roles associated to a specific group.

Parameters:
  groupFullPathName - The group full path(e.g. theGroupName.theGroupChildName). A Collection of Role.
throws:
  Throws - a security exception if the group does not exist.

isGroupInRole
boolean isGroupInRole(String groupFullPathName, String roleFullPathName) throws SecurityException(Code)

Whether or not a role is in a group.

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

isUserInRole
boolean isUserInRole(String username, String roleFullPathName) throws SecurityException(Code)

Whether or not a user is in a role.

Parameters:
  username - The user name.
Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleChildName). Whether or not a user is in a role.
throws:
  Throws - a security exception if the role or the user does not exist.

removeRole
void removeRole(String roleFullPathName) throws SecurityException(Code)

Remove a given role and all the children of that role.

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

Role principal path names are stored leveraging the Preferences api. Roles will be stored under /role/theGroupName/theGroupNameChild when given the full path name theRoleName.theRoleNameChild.
Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleNameChild).
throws:
  Throws - a security exception.

removeRoleFromGroup
void removeRoleFromGroup(String roleFullPathName, String groupFullPathName) throws SecurityException(Code)

Remove a role from a group.

Parameters:
  roleFullPathName - The role name full path (e.g. theRoleName.theRoleChildName).
Parameters:
  groupFullPathName - The group name full path(e.g. theGroupName.theGroupChildName).
throws:
  Throws - a security exception.

removeRoleFromUser
void removeRoleFromUser(String username, String roleFullPathName) throws SecurityException(Code)

Remove a user from a role.

Parameters:
  username - The user name.
Parameters:
  roleFullPathName - The role name full path relative to the/role node (e.g. /theRoleName/theRoleChildName).
throws:
  Throws - a security exception.

roleExists
boolean roleExists(String roleFullPathName)(Code)

Whether or not a role exists.

Parameters:
  roleFullPathName - The role name full path(e.g. theRoleName.theRoleNameChild). Whether or not a role exists.

setRoleEnabled
void setRoleEnabled(String roleFullPathName, boolean enabled) throws SecurityException(Code)
Enable or disable a role.
Parameters:
  roleFullPathName - The role name full path (e.g. theRoleName.theRoleChildName).
Parameters:
  enabled - enabled flag for the role

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.