org.apache.jetspeed.security.spi.impl
Class DefaultSecurityMappingHandler

java.lang.Object
  extended by org.apache.jetspeed.security.spi.impl.DefaultSecurityMappingHandler
All Implemented Interfaces:
SecurityMappingHandler

public class DefaultSecurityMappingHandler
extends java.lang.Object
implements SecurityMappingHandler

Author:
David Le Strat
See Also:
SecurityMappingHandler

Constructor Summary
DefaultSecurityMappingHandler(SecurityAccess commonQueries)
           Constructor providing access to the common queries.
DefaultSecurityMappingHandler(SecurityAccess commonQueries, HierarchyResolver roleHierarchyResolver, HierarchyResolver groupHierarchyResolver)
           Constructor providing access to the common queries and hierarchy resolvers.
 
Method Summary
 HierarchyResolver getGroupHierarchyResolver()
           Gets the HierarchyResolver to be used for resolving group hierarchy.
 java.util.Set getGroupPrincipals(java.lang.String username)
           Gets the group principals for the given user according to the relevant hierarchy resolution rules.
 java.util.Set getGroupPrincipalsInRole(java.lang.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.
 java.util.Set getRolePrincipals(java.lang.String username)
           Gets the role principals for the given user according to the relevant hierarchy resolution rules.
 java.util.Set getRolePrincipalsInGroup(java.lang.String groupFullPathName)
           Gets the role principals for the given group according to the relevant hierarchy resolution rules.
 java.util.Set getUserPrincipalsInGroup(java.lang.String groupFullPathName)
           Gets the user principals for the given group according to the relevant hierarchy resolution rules.
 java.util.Set getUserPrincipalsInRole(java.lang.String roleFullPathName)
           Gets the user principals for the given role according to the relevant hierarchy resolution rules.
 void removeRolePrincipalInGroup(java.lang.String groupFullPathName, java.lang.String roleFullPathName)
           Removes the role principal on a given user.
 void removeUserPrincipalInGroup(java.lang.String username, java.lang.String groupFullPathName)
           Removes the user principal from the given group.
 void removeUserPrincipalInRole(java.lang.String username, java.lang.String roleFullPathName)
           Removes the role principal on a given user.
 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 setRolePrincipalInGroup(java.lang.String groupFullPathName, java.lang.String roleFullPathName)
           Sets the role principal on a given user.
 void setUserPrincipalInGroup(java.lang.String username, java.lang.String groupFullPathName)
           Sets the user principal in the given group.
 void setUserPrincipalInRole(java.lang.String username, java.lang.String roleFullPathName)
           Sets the role principal on a given user.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultSecurityMappingHandler

public DefaultSecurityMappingHandler(SecurityAccess commonQueries)

Constructor providing access to the common queries.


DefaultSecurityMappingHandler

public DefaultSecurityMappingHandler(SecurityAccess commonQueries,
                                     HierarchyResolver roleHierarchyResolver,
                                     HierarchyResolver groupHierarchyResolver)

Constructor providing access to the common queries and hierarchy resolvers.

Method Detail

getRoleHierarchyResolver

public HierarchyResolver getRoleHierarchyResolver()
Description copied from interface: SecurityMappingHandler

Gets the HierarchyResolver to be used for resolving role hierarchy.

Specified by:
getRoleHierarchyResolver in interface SecurityMappingHandler
Returns:
Returns the roleHierarchyResolver.

setRoleHierarchyResolver

public void setRoleHierarchyResolver(HierarchyResolver roleHierarchyResolver)
Description copied from interface: SecurityMappingHandler

Sets the HierarchyResolver to be used for resolving role hierachy.

Specified by:
setRoleHierarchyResolver in interface SecurityMappingHandler
Parameters:
roleHierarchyResolver - The role HierarchyResolver.
See Also:
SecurityMappingHandler.setRoleHierarchyResolver(org.apache.jetspeed.security.HierarchyResolver)

getGroupHierarchyResolver

public HierarchyResolver getGroupHierarchyResolver()
Description copied from interface: SecurityMappingHandler

Gets the HierarchyResolver to be used for resolving group hierarchy.

Specified by:
getGroupHierarchyResolver in interface SecurityMappingHandler
Returns:
Returns the groupHierarchyResolver.

setGroupHierarchyResolver

public void setGroupHierarchyResolver(HierarchyResolver groupHierarchyResolver)
Description copied from interface: SecurityMappingHandler

Sets the HierarchyResolver used for resolving group hierarchy.

Specified by:
setGroupHierarchyResolver in interface SecurityMappingHandler
Parameters:
groupHierarchyResolver - The group HierarchyResolver.
See Also:
SecurityMappingHandler.setGroupHierarchyResolver(org.apache.jetspeed.security.HierarchyResolver)

getRolePrincipals

public java.util.Set getRolePrincipals(java.lang.String username)
Description copied from interface: SecurityMappingHandler

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

Specified by:
getRolePrincipals in interface SecurityMappingHandler
Parameters:
username - The user name.
Returns:
A set of Principal

See Also:
SecurityMappingHandler.getRolePrincipals(java.lang.String)

setUserPrincipalInRole

public void setUserPrincipalInRole(java.lang.String username,
                                   java.lang.String roleFullPathName)
                            throws SecurityException
Description copied from interface: SecurityMappingHandler

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.

Specified by:
setUserPrincipalInRole in interface SecurityMappingHandler
Parameters:
username - The user to add the role principal to.
roleFullPathName - The full path of the role principal to add.
Throws:
SecurityException - Throws a SecurityException. An exeption needs to be thrown if the user does not exist.
See Also:
SecurityMappingHandler.setUserPrincipalInRole(java.lang.String, java.lang.String)

removeUserPrincipalInRole

public void removeUserPrincipalInRole(java.lang.String username,
                                      java.lang.String roleFullPathName)
                               throws SecurityException
Description copied from interface: SecurityMappingHandler

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.

Specified by:
removeUserPrincipalInRole in interface SecurityMappingHandler
Parameters:
username - The user to remove the role principal from.
roleFullPathName - The full path of the role principal to remove.
Throws:
SecurityException - Throws a SecurityException. An exeption needs to be thrown if the user does not exist.
See Also:
SecurityMappingHandler.removeUserPrincipalInRole(java.lang.String, java.lang.String)

getRolePrincipalsInGroup

public java.util.Set getRolePrincipalsInGroup(java.lang.String groupFullPathName)
Description copied from interface: SecurityMappingHandler

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

Specified by:
getRolePrincipalsInGroup in interface SecurityMappingHandler
Parameters:
groupFullPathName - The group full path name.
Returns:
A set of Principal

See Also:
SecurityMappingHandler.getRolePrincipalsInGroup(java.lang.String)

setRolePrincipalInGroup

public void setRolePrincipalInGroup(java.lang.String groupFullPathName,
                                    java.lang.String roleFullPathName)
                             throws SecurityException
Description copied from interface: SecurityMappingHandler

Sets the role principal on a given user.

Specified by:
setRolePrincipalInGroup in interface SecurityMappingHandler
Parameters:
groupFullPathName - The group to add the role principal to.
roleFullPathName - The full path of the role principal to add.
Throws:
SecurityException - Throws a SecurityException. An exeption needs to be thrown if the group does not exist.
See Also:
SecurityMappingHandler.setRolePrincipalInGroup(java.lang.String, java.lang.String)

removeRolePrincipalInGroup

public void removeRolePrincipalInGroup(java.lang.String groupFullPathName,
                                       java.lang.String roleFullPathName)
                                throws SecurityException
Description copied from interface: SecurityMappingHandler

Removes the role principal on a given user.

Specified by:
removeRolePrincipalInGroup in interface SecurityMappingHandler
Parameters:
groupFullPathName - The group to remove the role principal from.
roleFullPathName - The full path of the role principal to remove.
Throws:
SecurityException - Throws a SecurityException. An exeption needs to be thrown if the group does not exist.
See Also:
SecurityMappingHandler.removeRolePrincipalInGroup(java.lang.String, java.lang.String)

getGroupPrincipals

public java.util.Set getGroupPrincipals(java.lang.String username)
Description copied from interface: SecurityMappingHandler

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

Specified by:
getGroupPrincipals in interface SecurityMappingHandler
Parameters:
username - The user name.
Returns:
A set of GroupPrincipal

See Also:
SecurityMappingHandler.getGroupPrincipals(java.lang.String)

getGroupPrincipalsInRole

public java.util.Set getGroupPrincipalsInRole(java.lang.String roleFullPathName)
Description copied from interface: SecurityMappingHandler

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

Specified by:
getGroupPrincipalsInRole in interface SecurityMappingHandler
Parameters:
roleFullPathName - The role full path name.
Returns:
A set of Principal

See Also:
SecurityMappingHandler.getGroupPrincipalsInRole(java.lang.String)

getUserPrincipalsInRole

public java.util.Set getUserPrincipalsInRole(java.lang.String roleFullPathName)
Description copied from interface: SecurityMappingHandler

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

Specified by:
getUserPrincipalsInRole in interface SecurityMappingHandler
Parameters:
roleFullPathName - The role full path name.
Returns:
A set of Principal

See Also:
SecurityMappingHandler.getUserPrincipalsInRole(java.lang.String)

getUserPrincipalsInGroup

public java.util.Set getUserPrincipalsInGroup(java.lang.String groupFullPathName)
Description copied from interface: SecurityMappingHandler

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

Specified by:
getUserPrincipalsInGroup in interface SecurityMappingHandler
Parameters:
groupFullPathName - The group full path name.
Returns:
A set of Principal

See Also:
SecurityMappingHandler.getUserPrincipalsInGroup(java.lang.String)

setUserPrincipalInGroup

public void setUserPrincipalInGroup(java.lang.String username,
                                    java.lang.String groupFullPathName)
                             throws SecurityException
Description copied from interface: SecurityMappingHandler

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.

Specified by:
setUserPrincipalInGroup in interface SecurityMappingHandler
Parameters:
username - The user to add to the group principal.
groupFullPathName - The full path of the group principal.
Throws:
SecurityException - Throws a SecurityException. An exeption needs to be thrown if the user does not exist.
See Also:
SecurityMappingHandler.setUserPrincipalInGroup(java.lang.String, java.lang.String)

removeUserPrincipalInGroup

public void removeUserPrincipalInGroup(java.lang.String username,
                                       java.lang.String groupFullPathName)
                                throws SecurityException
Description copied from interface: SecurityMappingHandler

Removes the user principal from the given group.

Specified by:
removeUserPrincipalInGroup in interface SecurityMappingHandler
Parameters:
username - The user to remove from the group principal.
groupFullPathName - The full path of the group principal.
Throws:
SecurityException - Throws a SecurityException. An exeption needs to be thrown if the user does not exist.
See Also:
SecurityMappingHandler.removeUserPrincipalInGroup(java.lang.String, java.lang.String)


Copyright © 1999-2009 Apache Software Foundation. All Rights Reserved.