Java Doc for SecurityMappingHandler.java in  » Portal » jetspeed-2.1.3 » org » apache » jetspeed » security » spi » 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
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net 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.spi 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.apache.jetspeed.security.spi.SecurityMappingHandler

All known Subclasses:   org.apache.jetspeed.security.spi.impl.DefaultSecurityMappingHandler,  org.apache.jetspeed.security.spi.impl.LdapSecurityMappingHandler,
SecurityMappingHandler
public interface SecurityMappingHandler (Code)

This interface encapsulates the mapping between principals.

This provides a central placeholder for changing the implementation of the mapping association between principals.


author:
   David Le Strat




Method Summary
 HierarchyResolvergetGroupHierarchyResolver()
    

Gets the HierarchyResolver to be used for resolving group hierarchy.

 SetgetGroupPrincipals(String username)
    

Gets the group principals for the given user according to the relevant hierarchy resolution rules.


Parameters:
  username - The user name.
 SetgetGroupPrincipalsInRole(String roleFullPathName)
    

Gets the group principals for the given role according to the relevant hierarchy resolution rules.


Parameters:
  roleFullPathName - The role full path name.
 HierarchyResolvergetRoleHierarchyResolver()
    

Gets the HierarchyResolver to be used for resolving role hierarchy.

 SetgetRolePrincipals(String username)
    

Gets the role principals for the given user according to the relevant hierarchy resolution rules.


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

Gets the role principals for the given group according to the relevant hierarchy resolution rules.


Parameters:
  groupFullPathName - The group full path name.
 SetgetUserPrincipalsInGroup(String groupFullPathName)
    

Gets the user principals for the given group according to the relevant hierarchy resolution rules.


Parameters:
  groupFullPathName - The group full path name.
 SetgetUserPrincipalsInRole(String roleFullPathName)
    

Gets the user principals for the given role according to the relevant hierarchy resolution rules.


Parameters:
  roleFullPathName - The role full path name.
 voidremoveRolePrincipalInGroup(String groupFullPathName, String roleFullPathName)
    

Removes the role principal on a given user.


Parameters:
  groupFullPathName - The group to remove the role principal from.
Parameters:
  roleFullPathName - The full path of the role principal to remove.
throws:
  SecurityException - Throws a SecurityException.
 voidremoveUserPrincipalInGroup(String username, String groupFullPathName)
    

Removes the user principal from the given group.


Parameters:
  username - The user to remove from the group principal.
Parameters:
  groupFullPathName - The full path of the group principal.
throws:
  SecurityException - Throws a SecurityException.
 voidremoveUserPrincipalInRole(String username, String roleFullPathName)
    

Removes the role principal on a given user.

If a mapping only record does not have any mapping, this method will remove the record as well.


Parameters:
  username - The user to remove the role principal from.
Parameters:
  roleFullPathName - The full path of the role principal to remove.
throws:
  SecurityException - Throws a SecurityException.
 voidsetGroupHierarchyResolver(HierarchyResolver groupHierarchyResolver)
    

Sets the HierarchyResolver used for resolving group hierarchy.

 voidsetRoleHierarchyResolver(HierarchyResolver roleHierarchyResolver)
    

Sets the HierarchyResolver to be used for resolving role hierachy.

 voidsetRolePrincipalInGroup(String groupFullPathName, String roleFullPathName)
    

Sets the role principal on a given user.


Parameters:
  groupFullPathName - The group to add the role principal to.
Parameters:
  roleFullPathName - The full path of the role principal to add.
throws:
  SecurityException - Throws a SecurityException.
 voidsetUserPrincipalInGroup(String username, String groupFullPathName)
    

Sets the user principal in the given group.

Existence of the group or the user must be checked prior to invoking this method. If a principal does not exist in the security mapping store, it will be created for the purpose of security mapping only.


Parameters:
  username - The user to add to the group principal.
Parameters:
  groupFullPathName - The full path of the group principal.
throws:
  SecurityException - Throws a SecurityException.
 voidsetUserPrincipalInRole(String username, String roleFullPathName)
    

Sets the role principal on a given user. Existence of the role or the user must be checked prior to invoking this method. If a principal does not exist in the security mapping store, it will be created for the purpose of security mapping only.


Parameters:
  username - The user to add the role principal to.
Parameters:
  roleFullPathName - The full path of the role principal to add.
throws:
  SecurityException - Throws a SecurityException.



Method Detail
getGroupHierarchyResolver
HierarchyResolver getGroupHierarchyResolver()(Code)

Gets the HierarchyResolver to be used for resolving group hierarchy.

The role HierarchyResolver.



getGroupPrincipals
Set getGroupPrincipals(String username)(Code)

Gets the group principals for the given user according to the relevant hierarchy resolution rules.


Parameters:
  username - The user name. A set of GroupPrincipal




getGroupPrincipalsInRole
Set getGroupPrincipalsInRole(String roleFullPathName)(Code)

Gets the group principals for the given role according to the relevant hierarchy resolution rules.


Parameters:
  roleFullPathName - The role full path name. A set of Principal




getRoleHierarchyResolver
HierarchyResolver getRoleHierarchyResolver()(Code)

Gets the HierarchyResolver to be used for resolving role hierarchy.

The role HierarchyResolver.



getRolePrincipals
Set getRolePrincipals(String username)(Code)

Gets the role principals for the given user according to the relevant hierarchy resolution rules.


Parameters:
  username - The user name. A set of Principal




getRolePrincipalsInGroup
Set getRolePrincipalsInGroup(String groupFullPathName)(Code)

Gets the role principals for the given group according to the relevant hierarchy resolution rules.


Parameters:
  groupFullPathName - The group full path name. A set of Principal




getUserPrincipalsInGroup
Set getUserPrincipalsInGroup(String groupFullPathName)(Code)

Gets the user principals for the given group according to the relevant hierarchy resolution rules.


Parameters:
  groupFullPathName - The group full path name. A set of Principal




getUserPrincipalsInRole
Set getUserPrincipalsInRole(String roleFullPathName)(Code)

Gets the user principals for the given role according to the relevant hierarchy resolution rules.


Parameters:
  roleFullPathName - The role full path name. A set of Principal




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

Removes the role principal on a given user.


Parameters:
  groupFullPathName - The group to remove the role principal from.
Parameters:
  roleFullPathName - The full path of the role principal to remove.
throws:
  SecurityException - Throws a SecurityException. An exeption needs to bethrown if the group does not exist.



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

Removes the user principal from the given group.


Parameters:
  username - The user to remove from the group principal.
Parameters:
  groupFullPathName - The full path of the group principal.
throws:
  SecurityException - Throws a SecurityException. An exeption needs to bethrown if the user does not exist.



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

Removes the role principal on a given user.

If a mapping only record does not have any mapping, this method will remove the record as well.


Parameters:
  username - The user to remove the role principal from.
Parameters:
  roleFullPathName - The full path of the role principal to remove.
throws:
  SecurityException - Throws a SecurityException. An exeption needs to bethrown if the user does not exist.



setGroupHierarchyResolver
void setGroupHierarchyResolver(HierarchyResolver groupHierarchyResolver)(Code)

Sets the HierarchyResolver used for resolving group hierarchy.


Parameters:
  groupHierarchyResolver - The group HierarchyResolver.



setRoleHierarchyResolver
void setRoleHierarchyResolver(HierarchyResolver roleHierarchyResolver)(Code)

Sets the HierarchyResolver to be used for resolving role hierachy.


Parameters:
  roleHierarchyResolver - The role HierarchyResolver.



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

Sets the role principal on a given user.


Parameters:
  groupFullPathName - The group to add the role principal to.
Parameters:
  roleFullPathName - The full path of the role principal to add.
throws:
  SecurityException - Throws a SecurityException. An exeption needs to bethrown if the group does not exist.



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

Sets the user principal in the given group.

Existence of the group or the user must be checked prior to invoking this method. If a principal does not exist in the security mapping store, it will be created for the purpose of security mapping only.


Parameters:
  username - The user to add to the group principal.
Parameters:
  groupFullPathName - The full path of the group principal.
throws:
  SecurityException - Throws a SecurityException. An exeption needs to bethrown if the user does not exist.



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

Sets the role principal on a given user. Existence of the role or the user must be checked prior to invoking this method. If a principal does not exist in the security mapping store, it will be created for the purpose of security mapping only.


Parameters:
  username - The user to add the role principal to.
Parameters:
  roleFullPathName - The full path of the role principal to add.
throws:
  SecurityException - Throws a SecurityException. An exeption needs to bethrown if the user does not exist.



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.