org.apache.jetspeed.security.spi.impl.ldap
Interface LdapUserPrincipalDao

All Superinterfaces:

LdapPrincipalDao, LdapReadOnlyPrincipalDao

All Known Implementing Classes:

LdapUserPrincipalDaoImpl

public interface LdapUserPrincipalDao
extends LdapPrincipalDao

The ldap user principal DAO.

Author:

Mike Long , David Le Strat

Method Summary

void	addGroup(java.lang.String userPrincipalUid, java.lang.String groupPrincipalUid) Add a user to a group.
void	addRole(java.lang.String userPrincipalUid, java.lang.String rolePrincipalUid) Add a user to a group.
void	addRoleToGroup(java.lang.String groupPrincipalUid, java.lang.String rolePrincipalUid) Add a role to a group.
java.lang.String[]	getGroupUidsForUser(java.lang.String userPrincipalUid) Return an array of the group principal UIDS that belong to a specific user.
java.lang.String[]	getRolesForGroup(java.lang.String groupPrincipalUid) Return an array of the role principal UIDS that belong to a specific group.
java.lang.String[]	getRoleUidsForUser(java.lang.String userPrincipalUid) Return an array of the role principal UIDS that belong to a specific user.
java.lang.String[]	getUserUidsForGroup(java.lang.String groupPrincipalUid) Return an array of the user principal uids that belong to a group.
java.lang.String[]	getUserUidsForRole(java.lang.String rolePrincipalUid) Return an array of the user principal uids that belong to a role.
void	removeGroup(java.lang.String userPrincipalUid, java.lang.String groupPrincipalUid) Remove a user from a group.
void	removeRole(java.lang.String userPrincipalUid, java.lang.String rolePrincipalUid) Remove a user from a group.
void	removeRoleFromGroup(java.lang.String groupPrincipalUid, java.lang.String rolePrincipalUid) Remove a role from a group.

Methods inherited from interface org.apache.jetspeed.security.spi.impl.ldap.LdapPrincipalDao

convertUidToLdapAcceptableName, create, delete, find

Methods inherited from interface org.apache.jetspeed.security.spi.impl.ldap.LdapReadOnlyPrincipalDao

lookupByUid

Method Detail

addGroup

void addGroup(java.lang.String userPrincipalUid,
              java.lang.String groupPrincipalUid)
              throws SecurityException

Add a user to a group.

Parameters:

userPrincipalUid - The user principal.

groupPrincipalUid - The group principal.

Throws:

SecurityException - A SecurityException.

removeGroup

void removeGroup(java.lang.String userPrincipalUid,
                 java.lang.String groupPrincipalUid)
                 throws SecurityException

Remove a user from a group.

Parameters:

userPrincipalUid - The user principal.

groupPrincipalUid - The group principal.

Throws:

SecurityException - A SecurityException.

addRole

void addRole(java.lang.String userPrincipalUid,
             java.lang.String rolePrincipalUid)
             throws SecurityException

Add a user to a group.

Parameters:

userPrincipalUid - The user principal.

rolePrincipalUid - The role principal.

Throws:

SecurityException - A SecurityException.

removeRole

void removeRole(java.lang.String userPrincipalUid,
                java.lang.String rolePrincipalUid)
                throws SecurityException

Remove a user from a group.

Parameters:

userPrincipalUid - The user principal.

rolePrincipalUid - The role principal.

Throws:

SecurityException - A SecurityException.

getGroupUidsForUser

java.lang.String[] getGroupUidsForUser(java.lang.String userPrincipalUid)
                                       throws SecurityException

Return an array of the group principal UIDS that belong to a specific user.

Parameters:

userPrincipalUid - The user principal uid.

Returns:

The array of group uids asociated with this user

Throws:

SecurityException - A SecurityException.

getRoleUidsForUser

java.lang.String[] getRoleUidsForUser(java.lang.String userPrincipalUid)
                                      throws SecurityException

Return an array of the role principal UIDS that belong to a specific user.

Parameters:

userPrincipalUid - The user principal uid.

Returns:

The array of group uids asociated with this user

Throws:

SecurityException - A SecurityException.

getUserUidsForGroup

java.lang.String[] getUserUidsForGroup(java.lang.String groupPrincipalUid)
                                       throws SecurityException

Return an array of the user principal uids that belong to a group.

Parameters:

groupPrincipalUid - The group uid.

Returns:

The array of user uids asociated with this group

Throws:

SecurityException - A SecurityException.

getUserUidsForRole

java.lang.String[] getUserUidsForRole(java.lang.String rolePrincipalUid)
                                      throws SecurityException

Return an array of the user principal uids that belong to a role.

Parameters:

rolePrincipalUid - The role uid.

Returns:

The array of user uids asociated with this group

Throws:

SecurityException - A SecurityException.

getRolesForGroup

java.lang.String[] getRolesForGroup(java.lang.String groupPrincipalUid)
                                    throws SecurityException

Return an array of the role principal UIDS that belong to a specific group.

Parameters:

groupPrincipalUid - The group principal uid.

Returns:

The array of role uids asociated with this user

Throws:

SecurityException - A SecurityException.

addRoleToGroup

void addRoleToGroup(java.lang.String groupPrincipalUid,
                    java.lang.String rolePrincipalUid)
                    throws SecurityException

Add a role to a group.

Parameters:

groupPrincipalUid - The group principal.

rolePrincipalUid - The role principal.

Throws:

SecurityException - A SecurityException.

removeRoleFromGroup

void removeRoleFromGroup(java.lang.String groupPrincipalUid,
                         java.lang.String rolePrincipalUid)
                         throws SecurityException

Remove a role from a group.

Parameters:

groupPrincipalUid - The group principal.

rolePrincipalUid - The role principal.

Throws:

SecurityException - A SecurityException.