|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface UserService
The UserService provides functionality for operating on CARNOT users.
This includes:
| Field Summary | |
|---|---|
static String |
ARCHIVE
Constant used as sessionId on sessions opened on archive audit trails. |
static String |
DISABLED_FOR_USER
Constant used as sessionId on sessions opened with user disabled for tracking. |
| Method Summary | |
|---|---|
org.eclipse.stardust.engine.api.runtime.Deputy |
addDeputy(UserInfo user,
UserInfo deputyUser,
DeputyOptions options)
Adds a new deputy user for a given user. |
void |
closeSession(String sessionId)
Tracks the ending of a user session. |
User |
createUser(String account,
String firstName,
String lastName,
String description,
String password,
String eMail,
Date validFrom,
Date validTo)
Creates a new user with default realm ID. |
User |
createUser(String realm,
String account,
String firstName,
String lastName,
String description,
String password,
String eMail,
Date validFrom,
Date validTo)
Creates a new user. |
UserGroup |
createUserGroup(String id,
String name,
String description,
Date validFrom,
Date validTo)
Creates a new user group. |
UserRealm |
createUserRealm(String id,
String name,
String description)
Creates a new user realm. |
void |
dropUserRealm(String id)
Drops the user realm associated with the given ID. |
void |
generatePasswordResetToken(String realm,
String account)
Generates a token which is required to perform resetPassword(String, java.util.Map, String) |
List<org.eclipse.stardust.engine.api.runtime.Deputy> |
getDeputies(UserInfo user)
Returns a list of all deputy users for the given user. |
User |
getUser()
Retrieves information on the current user. |
User |
getUser(long userOID)
Retrieves the specified user. |
User |
getUser(String account)
Retrieves the user associated with the given account. |
User |
getUser(String realm,
String account)
Retrieves the user associated with the given account. |
UserGroup |
getUserGroup(long oid)
Retrieves the specified user group. |
UserGroup |
getUserGroup(String id)
Retrieves the user group associated with the given ID. |
List |
getUserRealms()
Retrives all existing user realms. |
List<org.eclipse.stardust.engine.api.runtime.Deputy> |
getUsersBeingDeputyFor(UserInfo deputyUser)
Returns a list of all users for which the given user is an deputy user. |
User |
invalidate(String account)
Deprecated. Please use invalidateUser(String) instead. |
User |
invalidateUser(String account)
Invalidates the user with the specified account. |
User |
invalidateUser(String realm,
String account)
Invalidates the user with the specified account. |
UserGroup |
invalidateUserGroup(long oid)
Invalidates the specified user group. |
UserGroup |
invalidateUserGroup(String id)
Invalidates the user group associated with the given ID. |
boolean |
isInternalAuthentication()
Checks if internal authentication is used. |
boolean |
isInternalAuthentified()
Deprecated. Superseded by isInternalAuthentication(). |
boolean |
isInternalAuthorization()
Checks if internal authorization is used. |
org.eclipse.stardust.engine.api.runtime.Deputy |
modifyDeputy(UserInfo user,
UserInfo deputyUser,
DeputyOptions options)
Modifies an existing deputy user for a given user. |
User |
modifyLoginUser(String oldPassword,
String firstName,
String lastName,
String newPassword,
String eMail)
Modifies the current user. |
User |
modifyUser(User user)
Modifies the specified user. |
User |
modifyUser(User user,
boolean generatePassword)
Modifies the specified user. |
UserGroup |
modifyUserGroup(UserGroup userGroup)
Modifies the specified user group. |
void |
removeDeputy(UserInfo user,
UserInfo deputyUser)
Removes an existing deputy user for a given user. |
void |
resetPassword(String account,
Map properties,
String token)
Resets the password of specified user by generated password according to configured password rules. |
String |
startSession(String clientId)
Tracks the starting of a new user session. |
| Field Detail |
|---|
static final String ARCHIVE
static final String DISABLED_FOR_USER
| Method Detail |
|---|
@ExecutionPermission String startSession(String clientId)
clientId - the client starting the session.
@ExecutionPermission void closeSession(String sessionId)
sessionId - the id of the ending session.@ExecutionPermission boolean isInternalAuthentified()
isInternalAuthentication().
@ExecutionPermission boolean isInternalAuthentication()
@ExecutionPermission boolean isInternalAuthorization()
@ExecutionPermission User getUser()
@ExecutionPermission
User modifyLoginUser(String oldPassword,
String firstName,
String lastName,
String newPassword,
String eMail)
throws org.eclipse.stardust.common.error.ConcurrencyException,
IllegalOperationException,
org.eclipse.stardust.common.security.InvalidPasswordException
oldPassword - the current password.firstName - first name of the user.lastName - last name of the user.newPassword - the new password.eMail - email address of the user.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the current user.
IllegalOperationException - if the authentication is not internal.
org.eclipse.stardust.common.security.InvalidPasswordException - if the new password does not match the given rules.
@ExecutionPermission(id=modifyUserData)
User modifyUser(User user)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException,
org.eclipse.stardust.common.security.InvalidPasswordException,
org.eclipse.stardust.common.error.AccessForbiddenException
user - the user to be modified.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified one.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user or a given grant is not found.
IllegalOperationException - if the authentication is not internal.
org.eclipse.stardust.common.security.InvalidPasswordException - if the new password does not match the given rules.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not allowed for operation.
@ExecutionPermission(id=resetUserPassword,
defaults=ALL)
void generatePasswordResetToken(String realm,
String account)
resetPassword(String, java.util.Map, String)
realm - the realm ID of the user to retrieve.account - the user account to generate the token for
@ExecutionPermission(id=resetUserPassword,
defaults=ALL)
void resetPassword(String account,
Map properties,
String token)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
account - the user account to be modified.properties - Map providing further login properties.token - the token generated by generatePasswordResetToken(String, String)
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified one.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user or a given grant is not found.
IllegalOperationException - if the authentication is not internal.
@ExecutionPermission(id=modifyUserData)
User modifyUser(User user,
boolean generatePassword)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException,
org.eclipse.stardust.common.security.InvalidPasswordException,
org.eclipse.stardust.common.error.AccessForbiddenException
user - the user to be modified.generatePassword - if set to true a password will be generated and send by mail to the user.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified one.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user or a given grant is not found.
IllegalOperationException - if the authentication is not internal.
org.eclipse.stardust.common.security.InvalidPasswordException - if the new password does not match the given rules.
org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not allowed for operation.
@ExecutionPermission(id=modifyUserData)
User createUser(String account,
String firstName,
String lastName,
String description,
String password,
String eMail,
Date validFrom,
Date validTo)
throws UserExistsException,
IllegalOperationException,
org.eclipse.stardust.common.security.InvalidPasswordException
account - the account name.firstName - first name of the user.lastName - last name of the user.description - short description.password - the user password.eMail - email address of the user.validFrom - validity start time or null if unlimited.validTo - validity end time or null if unlimited.
UserExistsException - if another user with the specified account already exists.
IllegalOperationException - if the authentication is not internal.
org.eclipse.stardust.common.security.InvalidPasswordException
@ExecutionPermission(id=modifyUserData)
User createUser(String realm,
String account,
String firstName,
String lastName,
String description,
String password,
String eMail,
Date validFrom,
Date validTo)
throws UserExistsException,
IllegalOperationException,
org.eclipse.stardust.common.security.InvalidPasswordException
realm - the user's realm ID.account - the account name.firstName - first name of the user.lastName - last name of the user.description - short description.password - the user password.eMail - email address of the user.validFrom - validity start time or null if unlimited.validTo - validity end time or null if unlimited.
UserExistsException - if another user with the specified account already exists.
IllegalOperationException - if the authentication is not internal.
org.eclipse.stardust.common.security.InvalidPasswordException
@ExecutionPermission(id=readUserData,
defaults=ALL)
User getUser(String account)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
account - the account name of the user to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account.
IllegalOperationException
@ExecutionPermission(id=readUserData,
defaults=ALL)
User getUser(String realm,
String account)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
realm - the realm ID of the user to retrieve.account - the account name of the user to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account.
@ExecutionPermission(id=readUserData,
defaults=ALL)
User getUser(long userOID)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
userOID - the OID of the user to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified oid.
@ExecutionPermission(id=modifyUserData)
User invalidate(String account)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
invalidateUser(String) instead.
org.eclipse.stardust.common.error.ObjectNotFoundException
IllegalOperationException
@ExecutionPermission(id=modifyUserData)
User invalidateUser(String account)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
account - the account name of the user to invalidate.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account.
IllegalOperationException - if the authentication is not internal.
@ExecutionPermission(id=modifyUserData)
User invalidateUser(String realm,
String account)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
realm - the realm ID of the user to invalidate.account - the account name of the user to invalidate.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account.
IllegalOperationException - if the authentication is not internal.
@ExecutionPermission(id=modifyUserData)
UserGroup createUserGroup(String id,
String name,
String description,
Date validFrom,
Date validTo)
throws UserGroupExistsException,
IllegalOperationException,
org.eclipse.stardust.common.security.InvalidPasswordException,
org.eclipse.stardust.common.error.InvalidArgumentException
id - the user group ID. Must not be null or empty and must be unique.name - the user group name. Must not be null or empty.description - short description. Must not be null.validFrom - validity start time or null if unlimited.validTo - validity end time or null if unlimited.
UserGroupExistsException - if another user group with the specified ID already exists.
org.eclipse.stardust.common.error.InvalidArgumentException - if ID is empty
if name is empty
if description is empty
IllegalOperationException - if operation is not allowed in this context.
org.eclipse.stardust.common.security.InvalidPasswordException
@ExecutionPermission(id=readUserData,
defaults=ALL)
UserGroup getUserGroup(String id)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
id - the id of the user group to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user group with the specified ID.
@ExecutionPermission(id=readUserData,
defaults=ALL)
UserGroup getUserGroup(long oid)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
oid - the OID of the user group to retrieve.
org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user group with the specified OID.
@ExecutionPermission(id=modifyUserData)
UserGroup modifyUserGroup(UserGroup userGroup)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
userGroup - the user group to be modified.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user group.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user group is not found.
IllegalOperationException - if operation is not allowed in this context.
@ExecutionPermission(id=modifyUserData)
UserGroup invalidateUserGroup(String id)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
id - the ID of the user group to be invalidated.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user group.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user group is not found.
IllegalOperationException - if operation is not allowed in this context.
@ExecutionPermission(id=modifyUserData)
UserGroup invalidateUserGroup(long oid)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
oid - the OID of the user group to invalidate.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user group.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user group is not found.
IllegalOperationException - if operation is not allowed in this context.
@ExecutionPermission(id=modifyUserData)
UserRealm createUserRealm(String id,
String name,
String description)
throws UserRealmExistsException,
IllegalOperationException
id - the user realm ID.name - the user realm name.description - short description.
UserRealmExistsException - if another user realm with the specified ID already exists.
IllegalOperationException - if operation is not allowed in this context.
@ExecutionPermission(id=modifyUserData)
void dropUserRealm(String id)
throws org.eclipse.stardust.common.error.ConcurrencyException,
org.eclipse.stardust.common.error.ObjectNotFoundException,
IllegalOperationException
id - the ID of the user realm to be dropped.
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user realm.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the user realm is not found.
IllegalOperationException - if at least one user is assigned to the user realm.
@ExecutionPermission(id=readUserData,
defaults=ALL)
List getUserRealms()
throws org.eclipse.stardust.common.error.ConcurrencyException,
IllegalOperationException
org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the user realms.
IllegalOperationException - if operation is not allowed in this context.
@ExecutionPermission(id=manageDeputies)
org.eclipse.stardust.engine.api.runtime.Deputy addDeputy(UserInfo user,
UserInfo deputyUser,
DeputyOptions options)
throws org.eclipse.stardust.common.error.InvalidArgumentException
fromDate is set to a date in the past then it will be set to new Date() (now).
user - the user to which a deputy user shall be added.deputyUser - the deputy user.options - the options associated with the operation. Can be null, in which case the
default options will be used.
org.eclipse.stardust.engine.api.runtime.DeputyExistsException - if the requested deputy already exists.
org.eclipse.stardust.common.error.InvalidArgumentException - if options.toDate is in the past
@ExecutionPermission(id=manageDeputies)
org.eclipse.stardust.engine.api.runtime.Deputy modifyDeputy(UserInfo user,
UserInfo deputyUser,
DeputyOptions options)
throws org.eclipse.stardust.common.error.ObjectNotFoundException,
org.eclipse.stardust.common.error.InvalidArgumentException
fromDate is set to a date in the past then it will be set to new Date() (now).
user - the user for which a deputy user shall be modified.deputyUser - the deputy user.options - Used to provide the time frame for which the modification should apply.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the requested deputy does not exists.
org.eclipse.stardust.common.error.InvalidArgumentException - if options.toDate is in the past
@ExecutionPermission(id=manageDeputies)
void removeDeputy(UserInfo user,
UserInfo deputyUser)
throws org.eclipse.stardust.common.error.ObjectNotFoundException
user - the user for which a deputy user shall be removed.deputyUser - the deputy user.
org.eclipse.stardust.common.error.ObjectNotFoundException - if the requested deputy does not exists.@ExecutionPermission(id=manageDeputies) List<org.eclipse.stardust.engine.api.runtime.Deputy> getDeputies(UserInfo user)
user - the user whose deputy users shall be returned.
@ExecutionPermission(id=manageDeputies) List<org.eclipse.stardust.engine.api.runtime.Deputy> getUsersBeingDeputyFor(UserInfo deputyUser)
deputyUser - the deputy user whose users shall be returned.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||