|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
This interface encapsulates the mapping between principals.
This provides a central placeholder for changing the implementation of the mapping association between principals.
Method Summary | |
HierarchyResolver |
getGroupHierarchyResolver()
Gets the HierarchyResolver to be used for resolving group hierarchy. |
Set |
getGroupPrincipals(String username)
Gets the group principals for the given user according to the relevant hierarchy resolution rules. |
Set |
getGroupPrincipalsInRole(String roleFullPathName)
Gets the group principals for the given role according to the relevant hierarchy resolution rules. |
HierarchyResolver |
getRoleHierarchyResolver()
Gets the HierarchyResolver to be used for resolving role hierarchy. |
Set |
getRolePrincipals(String username)
Gets the role principals for the given user according to the relevant hierarchy resolution rules. |
Set |
getRolePrincipalsInGroup(String groupFullPathName)
Gets the role principals for the given group according to the relevant hierarchy resolution rules. |
Set |
getUserPrincipalsInGroup(String groupFullPathName)
Gets the user principals for the given group according to the relevant hierarchy resolution rules. |
Set |
getUserPrincipalsInRole(String roleFullPathName)
Gets the user principals for the given role according to the relevant hierarchy resolution rules. |
void |
removeRolePrincipal(String username,
String roleFullPathName)
Removes the role principal on a given user. |
void |
removeRolePrincipalInGroup(String groupFullPathName,
String roleFullPathName)
Removes the role principal on a given user. |
void |
removeUserPrincipalInGroup(String username,
String groupFullPathName)
Removes the user principal from the given group. |
void |
setGroupHierarchyResolver(HierarchyResolver groupHierarchyResolver)
Sets the HierarchyResolver used for resolving group hierarchy. |
void |
setRoleHierarchyResolver(HierarchyResolver roleHierarchyResolver)
Sets the HierarchyResolver to be used for resolving role hierachy. |
void |
setRolePrincipal(String username,
String roleFullPathName)
Sets the role principal on a given user. |
void |
setRolePrincipalInGroup(String groupFullPathName,
String roleFullPathName)
Sets the role principal on a given user. |
void |
setUserPrincipalInGroup(String username,
String groupFullPathName)
Sets the user principal in the given group. |
Method Detail |
public HierarchyResolver getRoleHierarchyResolver()
Gets the HierarchyResolver
to be used for resolving role hierarchy.
HierarchyResolver
.public void setRoleHierarchyResolver(HierarchyResolver roleHierarchyResolver)
Sets the HierarchyResolver
to be used for resolving role hierachy.
roleHierarchyResolver
- The role HierarchyResolver
.public HierarchyResolver getGroupHierarchyResolver()
Gets the HierarchyResolver
to be used for resolving group hierarchy.
HierarchyResolver
.public void setGroupHierarchyResolver(HierarchyResolver groupHierarchyResolver)
Sets the HierarchyResolver
used for resolving group hierarchy.
groupHierarchyResolver
- The group HierarchyResolver
.public Set getRolePrincipals(String username)
Gets the role principals for the given user according to the relevant hierarchy resolution rules.
username
- The user name.
Principal
public void setRolePrincipal(String username, String roleFullPathName) throws org.apache.jetspeed.security.SecurityException
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.
username
- The user to add the role principal to.roleFullPathName
- The full path of the role principal to add.
org.apache.jetspeed.security.SecurityException
- Throws a SecurityException
. An exeption needs to be
thrown if the user does not exist.public void removeRolePrincipal(String username, String roleFullPathName) throws org.apache.jetspeed.security.SecurityException
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.
username
- The user to remove the role principal from.roleFullPathName
- The full path of the role principal to remove.
org.apache.jetspeed.security.SecurityException
- Throws a SecurityException
. An exeption needs to be
thrown if the user does not exist.public Set getRolePrincipalsInGroup(String groupFullPathName)
Gets the role principals for the given group according to the relevant hierarchy resolution rules.
groupFullPathName
- The group full path name.
Principal
public void setRolePrincipalInGroup(String groupFullPathName, String roleFullPathName) throws org.apache.jetspeed.security.SecurityException
Sets the role principal on a given user.
groupFullPathName
- The group to add the role principal to.roleFullPathName
- The full path of the role principal to add.
org.apache.jetspeed.security.SecurityException
- Throws a SecurityException
. An exeption needs to be
thrown if the group does not exist.public void removeRolePrincipalInGroup(String groupFullPathName, String roleFullPathName) throws org.apache.jetspeed.security.SecurityException
Removes the role principal on a given user.
groupFullPathName
- The group to remove the role principal from.roleFullPathName
- The full path of the role principal to remove.
org.apache.jetspeed.security.SecurityException
- Throws a SecurityException
. An exeption needs to be
thrown if the group does not exist.public Set getGroupPrincipals(String username)
Gets the group principals for the given user according to the relevant hierarchy resolution rules.
username
- The user name.
GroupPrincipal
public Set getGroupPrincipalsInRole(String roleFullPathName)
Gets the group principals for the given role according to the relevant hierarchy resolution rules.
roleFullPathName
- The role full path name.
Principal
public Set getUserPrincipalsInRole(String roleFullPathName)
Gets the user principals for the given role according to the relevant hierarchy resolution rules.
roleFullPathName
- The role full path name.
Principal
public Set getUserPrincipalsInGroup(String groupFullPathName)
Gets the user principals for the given group according to the relevant hierarchy resolution rules.
groupFullPathName
- The group full path name.
Principal
public void setUserPrincipalInGroup(String username, String groupFullPathName) throws org.apache.jetspeed.security.SecurityException
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.
username
- The user to add to the group principal.groupFullPathName
- The full path of the group principal.
org.apache.jetspeed.security.SecurityException
- Throws a SecurityException
. An exeption needs to be
thrown if the user does not exist.public void removeUserPrincipalInGroup(String username, String groupFullPathName) throws org.apache.jetspeed.security.SecurityException
Removes the user principal from the given group.
username
- The user to remove from the group principal.groupFullPathName
- The full path of the group principal.
org.apache.jetspeed.security.SecurityException
- Throws a SecurityException
. An exeption needs to be
thrown if the user does not exist.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |