|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface UserService
The UserService provides a way to create and manage users in SDD. The intention for this service is to provide programmatic administration of users. Users can be created and updated given the user accessing this service has the approriate policy to manage users. Users can be created in SDD as well as created to authenticate against an external authentication provider. Note that once a user is created, that user must manually consent via the SDD user interface before they can successfully call other methods on the API.
Method Summary | |
---|---|
boolean |
canManage()
Tests if the current user can manage user accounts on this SDD instance by verifying they have the User Manager policy. |
void |
changePassword(char[] currentPassword,
char[] newPassword)
Change the current user's password. |
RemoteUser |
create(UserBean userBean)
Create the user described by the given UserBean. |
boolean |
exists(java.lang.String userId)
Tests if the user with the specified userId exists |
RemoteUser |
get(java.lang.String userId)
Get the user with the specified userId. |
java.util.List |
getAll()
Gets a list of all users defined in SDD including active, inactive, and retired users. |
java.util.Date |
getPasswordExpirationDate()
Get the date that the current user's password will expire. |
java.util.List |
getUsersWithPolicy(Policy policy)
Gets a list of all users with the given policy |
RemoteUser |
update(UserBean userBean)
Apply the changes that have been made on the given User on the server side. |
Method Detail |
---|
boolean canManage() throws RemoteException, InvalidSessionException
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedRemoteUser get(java.lang.String userId) throws InsufficientPrivilegesException, RemoteException, InvalidSessionException
userId
- of the user
InsufficientPrivilegesException
- if the current user does not have the Policy
to manage users
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedjava.util.List getAll() throws InsufficientPrivilegesException, RemoteException, InvalidSessionException
RemoteUser
objects
InsufficientPrivilegesException
- if the current user does not have the Policy
to manage users
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedRemoteUser update(UserBean userBean) throws ObjectModifiedException, PropertyValidationException, InvalidUserException, InsufficientPrivilegesException, RemoteException, InvalidSessionException
userBean
-
ObjectModifiedException
- if the UserBean was constructed with a RemoteUser and the
user has been modified since it was retrieved
PropertyValidationException
- if any properties set on the user fail validation
InvalidUserException
- if the user doesn't exist or user is retired
InsufficientPrivilegesException
- if the current user does not have the Policy
to manage users
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedboolean exists(java.lang.String userId) throws InsufficientPrivilegesException, RemoteException, InvalidSessionException
userId
- of the user
InsufficientPrivilegesException
- if the current user does not have the Policy
to manage users
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedRemoteUser create(UserBean userBean) throws PropertyValidationException, InvalidUserException, InvalidSessionException, InsufficientPrivilegesException, RemoteException
userBean
-
PropertyValidationException
- if any properties set on the user fail validation
InvalidUserException
- if the user already exists
InsufficientPrivilegesException
- if the current user does not have the Policy
to manage users
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedjava.util.Date getPasswordExpirationDate() throws RemoteException, InvalidSessionException
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidatedvoid changePassword(char[] currentPassword, char[] newPassword) throws InvalidPasswordException, RemoteException, InvalidSessionException
currentPassword
- current password of the current usernewPassword
- new password for the current user
RemoteException
- if a server or transport error occurs
InvalidSessionException
- if the current session is expired or has been invalidated
InvalidPasswordException
- if the current password is expired or is not validjava.util.List getUsersWithPolicy(Policy policy) throws PropertyValidationException, InsufficientPrivilegesException, RemoteException, InvalidSessionException
policy
- the policy to check for
PropertyValidationException
InsufficientPrivilegesException
RemoteException
InvalidSessionException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |