com.docdoku.core.services

Interface IUserManagerLocal

public interface IUserManagerLocal

Author:

Florent Garin

Method Summary

Modifier and Type	Method and Description
void	activateUser(String pWorkspaceId, String login)
void	activateUserGroup(String pWorkspaceId, String groupId)
void	activateUserGroups(String pWorkspaceId, String[] pGroupIds)
void	activateUsers(String pWorkspaceId, String[] pLogins)
void	addUserInGroup(UserGroupKey pGroupKey, String pLogin)
void	addUserInWorkspace(String pWorkspaceId, String pLogin)
Account	checkAdmin(String pWorkspaceId)
Account	checkAdmin(Workspace pWorkspace)
User	checkWorkspaceReadAccess(String pWorkspaceId)
User	checkWorkspaceWriteAccess(String pWorkspaceId)
PasswordRecoveryRequest	createPasswordRecoveryRequest(Account account)
UserGroup	createUserGroup(String pId, String workspaceId)
UserGroup	createUserGroup(String pId, Workspace pWorkspace)
Workspace[]	getAdministratedWorkspaces()
User[]	getReachableUsers()
UserGroup	getUserGroup(UserGroupKey pKey)
UserGroup[]	getUserGroups(String pWorkspaceId)
UserGroup[]	getUserGroupsForUser(UserKey userKey)
User[]	getUsers(String pWorkspaceId)
WorkspaceUserGroupMembership[]	getWorkspaceSpecificUserGroupMemberships(String workspaceId)
WorkspaceUserMembership	getWorkspaceSpecificUserMemberships(String workspaceId)
Workspace[]	getWorkspacesWhereCallerIsActive()
WorkspaceUserGroupMembership[]	getWorkspaceUserGroupMemberships(String pWorkspaceId)
WorkspaceUserMembership[]	getWorkspaceUserMemberships(String pWorkspaceId)
void	grantGroupAccess(String pWorkspaceId, String[] pGroupIds, boolean pReadOnly)
WorkspaceUserGroupMembership	grantGroupAccess(String pWorkspaceId, String groupId, boolean pReadOnly)
void	grantUserAccess(String pWorkspaceId, String[] pLogins, boolean pReadOnly)
WorkspaceUserMembership	grantUserAccess(String pWorkspaceId, String login, boolean pReadOnly)
boolean	hasCommonWorkspace(String user1, String user2)
boolean	hasWorkspaceWriteAccess(User user, String pWorkspaceId)
void	passivateUser(String pWorkspaceId, String login)
void	passivateUserGroup(String pWorkspaceId, String groupId)
void	passivateUserGroups(String pWorkspaceId, String[] pGroupIds)
void	passivateUsers(String pWorkspaceId, String[] pLogins)
void	recoverPassword(String pPasswdRRUuid, String pPassword)
Workspace	removeUser(String pWorkspaceId, String login)
UserGroup	removeUserFromGroup(UserGroupKey pGroupKey, String logins)
void	removeUserFromGroup(UserGroupKey pGroupKey, String[] pLogins)
void	removeUserGroups(String pWorkspaceId, String[] pIds)
void	removeUsers(String pWorkspaceId, String[] pLogins)
User	whoAmI(String pWorkspaceId)

Method Detail

recoverPassword

void recoverPassword(String pPasswdRRUuid,
                     String pPassword)
              throws PasswordRecoveryRequestNotFoundException

Throws:

PasswordRecoveryRequestNotFoundException

createPasswordRecoveryRequest

PasswordRecoveryRequest createPasswordRecoveryRequest(Account account)

getAdministratedWorkspaces

Workspace[] getAdministratedWorkspaces()
                                throws AccountNotFoundException

Throws:

AccountNotFoundException

getWorkspacesWhereCallerIsActive

Workspace[] getWorkspacesWhereCallerIsActive()

whoAmI

User whoAmI(String pWorkspaceId)
     throws WorkspaceNotFoundException,
            UserNotFoundException,
            UserNotActiveException,
            WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

UserNotFoundException

UserNotActiveException

WorkspaceNotEnabledException

addUserInWorkspace

void addUserInWorkspace(String pWorkspaceId,
                        String pLogin)
                 throws AccessRightException,
                        AccountNotFoundException,
                        WorkspaceNotFoundException,
                        UserAlreadyExistsException,
                        FolderAlreadyExistsException,
                        CreationException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

UserAlreadyExistsException

FolderAlreadyExistsException

CreationException

removeUser

Workspace removeUser(String pWorkspaceId,
                     String login)
              throws UserNotFoundException,
                     AccessRightException,
                     AccountNotFoundException,
                     WorkspaceNotFoundException,
                     FolderNotFoundException,
                     EntityConstraintException,
                     UserNotActiveException,
                     DocumentRevisionNotFoundException

Throws:

UserNotFoundException

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

FolderNotFoundException

EntityConstraintException

UserNotActiveException

DocumentRevisionNotFoundException

getUserGroup

UserGroup getUserGroup(UserGroupKey pKey)
                throws WorkspaceNotFoundException,
                       UserGroupNotFoundException,
                       UserNotFoundException,
                       UserNotActiveException,
                       AccountNotFoundException,
                       WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

UserGroupNotFoundException

UserNotFoundException

UserNotActiveException

AccountNotFoundException

WorkspaceNotEnabledException

getUserGroups

UserGroup[] getUserGroups(String pWorkspaceId)
                   throws WorkspaceNotFoundException,
                          UserNotFoundException,
                          UserNotActiveException,
                          AccountNotFoundException,
                          WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

UserNotFoundException

UserNotActiveException

AccountNotFoundException

WorkspaceNotEnabledException

removeUserFromGroup

UserGroup removeUserFromGroup(UserGroupKey pGroupKey,
                              String logins)
                       throws AccessRightException,
                              UserGroupNotFoundException,
                              AccountNotFoundException,
                              WorkspaceNotFoundException

Throws:

AccessRightException

UserGroupNotFoundException

AccountNotFoundException

WorkspaceNotFoundException

createUserGroup

UserGroup createUserGroup(String pId,
                          Workspace pWorkspace)
                   throws UserGroupAlreadyExistsException,
                          AccessRightException,
                          AccountNotFoundException,
                          CreationException

Throws:

UserGroupAlreadyExistsException

AccessRightException

AccountNotFoundException

CreationException

passivateUserGroup

void passivateUserGroup(String pWorkspaceId,
                        String groupId)
                 throws AccessRightException,
                        AccountNotFoundException,
                        WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

removeUsers

void removeUsers(String pWorkspaceId,
                 String[] pLogins)
          throws UserNotFoundException,
                 AccessRightException,
                 AccountNotFoundException,
                 WorkspaceNotFoundException,
                 FolderNotFoundException,
                 EntityConstraintException,
                 UserNotActiveException,
                 DocumentRevisionNotFoundException

Throws:

UserNotFoundException

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

FolderNotFoundException

EntityConstraintException

UserNotActiveException

DocumentRevisionNotFoundException

passivateUser

void passivateUser(String pWorkspaceId,
                   String login)
            throws AccessRightException,
                   AccountNotFoundException,
                   WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

removeUserGroups

void removeUserGroups(String pWorkspaceId,
                      String[] pIds)
               throws UserGroupNotFoundException,
                      AccessRightException,
                      AccountNotFoundException,
                      WorkspaceNotFoundException,
                      EntityConstraintException

Throws:

UserGroupNotFoundException

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

EntityConstraintException

addUserInGroup

void addUserInGroup(UserGroupKey pGroupKey,
                    String pLogin)
             throws AccessRightException,
                    UserGroupNotFoundException,
                    AccountNotFoundException,
                    WorkspaceNotFoundException,
                    UserAlreadyExistsException,
                    FolderAlreadyExistsException,
                    CreationException

Throws:

AccessRightException

UserGroupNotFoundException

AccountNotFoundException

WorkspaceNotFoundException

UserAlreadyExistsException

FolderAlreadyExistsException

CreationException

removeUserFromGroup

void removeUserFromGroup(UserGroupKey pGroupKey,
                         String[] pLogins)
                  throws AccessRightException,
                         UserGroupNotFoundException,
                         AccountNotFoundException,
                         WorkspaceNotFoundException

Throws:

AccessRightException

UserGroupNotFoundException

AccountNotFoundException

WorkspaceNotFoundException

hasWorkspaceWriteAccess

boolean hasWorkspaceWriteAccess(User user,
                                String pWorkspaceId)
                         throws WorkspaceNotFoundException,
                                WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

WorkspaceNotEnabledException

hasCommonWorkspace

boolean hasCommonWorkspace(String user1,
                           String user2)

grantUserAccess

void grantUserAccess(String pWorkspaceId,
                     String[] pLogins,
                     boolean pReadOnly)
              throws AccessRightException,
                     AccountNotFoundException,
                     WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

grantUserAccess

WorkspaceUserMembership grantUserAccess(String pWorkspaceId,
                                        String login,
                                        boolean pReadOnly)
                                 throws AccessRightException,
                                        AccountNotFoundException,
                                        WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

grantGroupAccess

WorkspaceUserGroupMembership grantGroupAccess(String pWorkspaceId,
                                              String groupId,
                                              boolean pReadOnly)
                                       throws AccessRightException,
                                              AccountNotFoundException,
                                              WorkspaceNotFoundException,
                                              UserGroupNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

UserGroupNotFoundException

grantGroupAccess

void grantGroupAccess(String pWorkspaceId,
                      String[] pGroupIds,
                      boolean pReadOnly)
               throws AccessRightException,
                      AccountNotFoundException,
                      WorkspaceNotFoundException,
                      UserGroupNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

UserGroupNotFoundException

activateUsers

void activateUsers(String pWorkspaceId,
                   String[] pLogins)
            throws AccessRightException,
                   AccountNotFoundException,
                   WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

passivateUsers

void passivateUsers(String pWorkspaceId,
                    String[] pLogins)
             throws AccessRightException,
                    AccountNotFoundException,
                    WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

activateUserGroups

void activateUserGroups(String pWorkspaceId,
                        String[] pGroupIds)
                 throws AccessRightException,
                        AccountNotFoundException,
                        WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

activateUser

void activateUser(String pWorkspaceId,
                  String login)
           throws AccessRightException,
                  AccountNotFoundException,
                  WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

activateUserGroup

void activateUserGroup(String pWorkspaceId,
                       String groupId)
                throws AccessRightException,
                       AccountNotFoundException,
                       WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

passivateUserGroups

void passivateUserGroups(String pWorkspaceId,
                         String[] pGroupIds)
                  throws AccessRightException,
                         AccountNotFoundException,
                         WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

getWorkspaceSpecificUserMemberships

WorkspaceUserMembership getWorkspaceSpecificUserMemberships(String workspaceId)
                                                     throws AccountNotFoundException,
                                                            UserNotFoundException,
                                                            UserNotActiveException,
                                                            WorkspaceNotFoundException,
                                                            WorkspaceNotEnabledException

Throws:

AccountNotFoundException

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

getWorkspaceUserMemberships

WorkspaceUserMembership[] getWorkspaceUserMemberships(String pWorkspaceId)
                                               throws WorkspaceNotFoundException,
                                                      UserNotFoundException,
                                                      UserNotActiveException,
                                                      AccountNotFoundException,
                                                      WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

UserNotFoundException

UserNotActiveException

AccountNotFoundException

WorkspaceNotEnabledException

getWorkspaceSpecificUserGroupMemberships

WorkspaceUserGroupMembership[] getWorkspaceSpecificUserGroupMemberships(String workspaceId)
                                                                 throws UserNotFoundException,
                                                                        UserNotActiveException,
                                                                        WorkspaceNotFoundException,
                                                                        UserGroupNotFoundException,
                                                                        WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

UserGroupNotFoundException

WorkspaceNotEnabledException

getWorkspaceUserGroupMemberships

WorkspaceUserGroupMembership[] getWorkspaceUserGroupMemberships(String pWorkspaceId)
                                                         throws WorkspaceNotFoundException,
                                                                UserNotFoundException,
                                                                UserNotActiveException,
                                                                AccountNotFoundException,
                                                                WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

UserNotFoundException

UserNotActiveException

AccountNotFoundException

WorkspaceNotEnabledException

checkAdmin

Account checkAdmin(String pWorkspaceId)
            throws AccessRightException,
                   AccountNotFoundException,
                   WorkspaceNotFoundException

Throws:

AccessRightException

AccountNotFoundException

WorkspaceNotFoundException

checkAdmin

Account checkAdmin(Workspace pWorkspace)
            throws AccessRightException,
                   AccountNotFoundException

Throws:

AccessRightException

AccountNotFoundException

checkWorkspaceReadAccess

User checkWorkspaceReadAccess(String pWorkspaceId)
                       throws UserNotFoundException,
                              UserNotActiveException,
                              WorkspaceNotFoundException,
                              WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

checkWorkspaceWriteAccess

User checkWorkspaceWriteAccess(String pWorkspaceId)
                        throws UserNotFoundException,
                               WorkspaceNotFoundException,
                               AccessRightException,
                               WorkspaceNotEnabledException

Throws:

UserNotFoundException

WorkspaceNotFoundException

AccessRightException

WorkspaceNotEnabledException

getUserGroupsForUser

UserGroup[] getUserGroupsForUser(UserKey userKey)
                          throws UserNotFoundException

Throws:

UserNotFoundException

getReachableUsers

User[] getReachableUsers()
                  throws AccountNotFoundException

Throws:

AccountNotFoundException

getUsers

User[] getUsers(String pWorkspaceId)
         throws WorkspaceNotFoundException,
                AccessRightException,
                AccountNotFoundException,
                UserNotFoundException,
                UserNotActiveException,
                WorkspaceNotEnabledException

Throws:

WorkspaceNotFoundException

AccessRightException

AccountNotFoundException

UserNotFoundException

UserNotActiveException

WorkspaceNotEnabledException

createUserGroup

UserGroup createUserGroup(String pId,
                          String workspaceId)
                   throws UserGroupAlreadyExistsException,
                          AccessRightException,
                          AccountNotFoundException,
                          CreationException,
                          WorkspaceNotFoundException

Throws:

UserGroupAlreadyExistsException

AccessRightException

AccountNotFoundException

CreationException

WorkspaceNotFoundException