This project has retired. For details please refer to its Attic page.

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(String userPrincipalUid, String groupPrincipalUid) Add a user to a group.
void	addRole(String userPrincipalUid, String rolePrincipalUid) Add a user to a group.
void	addRoleToGroup(String groupPrincipalUid, String rolePrincipalUid) Add a role to a group.
String[]	getGroupUidsForUser(String userPrincipalUid) Return an array of the group principal UIDS that belong to a specific user.
String[]	getRolesForGroup(String groupPrincipalUid) Return an array of the role principal UIDS that belong to a specific group.
String[]	getRoleUidsForUser(String userPrincipalUid) Return an array of the role principal UIDS that belong to a specific user.
String[]	getUserUidsForGroup(String groupPrincipalUid) Return an array of the user principal uids that belong to a group.
String[]	getUserUidsForRole(String rolePrincipalUid) Return an array of the user principal uids that belong to a role.
void	removeGroup(String userPrincipalUid, String groupPrincipalUid) Remove a user from a group.
void	removeRole(String userPrincipalUid, String rolePrincipalUid) Remove a user from a group.
void	removeRoleFromGroup(String groupPrincipalUid, 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(String userPrincipalUid,
              String groupPrincipalUid)
              throws org.apache.jetspeed.security.SecurityException

Add a user to a group.

Parameters:

userPrincipalUid - The user principal.

groupPrincipalUid - The group principal.

Throws:

org.apache.jetspeed.security.SecurityException - A SecurityException.

removeGroup

void removeGroup(String userPrincipalUid,
                 String groupPrincipalUid)
                 throws org.apache.jetspeed.security.SecurityException

Remove a user from a group.

Parameters:

userPrincipalUid - The user principal.

groupPrincipalUid - The group principal.

Throws:

org.apache.jetspeed.security.SecurityException - A SecurityException.

addRole

void addRole(String userPrincipalUid,
             String rolePrincipalUid)
             throws org.apache.jetspeed.security.SecurityException

Add a user to a group.

Parameters:

userPrincipalUid - The user principal.

rolePrincipalUid - The role principal.

Throws:

org.apache.jetspeed.security.SecurityException - A SecurityException.

removeRole

void removeRole(String userPrincipalUid,
                String rolePrincipalUid)
                throws org.apache.jetspeed.security.SecurityException

Remove a user from a group.

Parameters:

userPrincipalUid - The user principal.

rolePrincipalUid - The role principal.

Throws:

org.apache.jetspeed.security.SecurityException - A SecurityException.

getGroupUidsForUser

String[] getGroupUidsForUser(String userPrincipalUid)
                             throws org.apache.jetspeed.security.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:

org.apache.jetspeed.security.SecurityException - A SecurityException.

getRoleUidsForUser

String[] getRoleUidsForUser(String userPrincipalUid)
                            throws org.apache.jetspeed.security.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:

org.apache.jetspeed.security.SecurityException - A SecurityException.

getUserUidsForGroup

String[] getUserUidsForGroup(String groupPrincipalUid)
                             throws org.apache.jetspeed.security.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:

org.apache.jetspeed.security.SecurityException - A SecurityException.

getUserUidsForRole

String[] getUserUidsForRole(String rolePrincipalUid)
                            throws org.apache.jetspeed.security.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:

org.apache.jetspeed.security.SecurityException - A SecurityException.

getRolesForGroup

String[] getRolesForGroup(String groupPrincipalUid)
                          throws org.apache.jetspeed.security.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:

org.apache.jetspeed.security.SecurityException - A SecurityException.

addRoleToGroup

void addRoleToGroup(String groupPrincipalUid,
                    String rolePrincipalUid)
                    throws org.apache.jetspeed.security.SecurityException

Add a role to a group.

Parameters:

groupPrincipalUid - The group principal.

rolePrincipalUid - The role principal.

Throws:

org.apache.jetspeed.security.SecurityException - A SecurityException.

removeRoleFromGroup

void removeRoleFromGroup(String groupPrincipalUid,
                         String rolePrincipalUid)
                         throws org.apache.jetspeed.security.SecurityException

Remove a role from a group.

Parameters:

groupPrincipalUid - The group principal.

rolePrincipalUid - The role principal.

Throws:

org.apache.jetspeed.security.SecurityException - A SecurityException.