org.eclipse.stardust.engine.api.ejb2

Interface LocalUserService

All Superinterfaces:

javax.ejb.EJBLocalObject

public interface LocalUserService
extends javax.ejb.EJBLocalObject

The UserService provides functionality for operating on CARNOT users.

This includes:

• creating, modifying and invalidating users, and
• accessing user data.

Version:

$Revision

Author:

ubirkemeyer

Method Summary

Methods

Modifier and Type	Method and Description
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.
void	login(String userId, String password)
void	login(String userId, String password, Map properties)
void	logout()
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.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

startSession

String startSession(String clientId)
                    throws org.eclipse.stardust.common.error.WorkflowException

Tracks the starting of a new user session.

Parameters:

clientId - the client starting the session.

Returns:

the new session id.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.startSession( java.lang.String clientId)

closeSession

void closeSession(String sessionId)
                  throws org.eclipse.stardust.common.error.WorkflowException

Tracks the ending of a user session.

Parameters:

sessionId - the id of the ending session.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.closeSession( java.lang.String sessionId)

isInternalAuthentified

boolean isInternalAuthentified()
                               throws org.eclipse.stardust.common.error.WorkflowException

Deprecated. Superseded by isInternalAuthentication().

Checks if internal authentication is used.

Returns:

true if CARNOT services use internal authentication.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.isInternalAuthentified()

isInternalAuthentication

boolean isInternalAuthentication()
                                 throws org.eclipse.stardust.common.error.WorkflowException

Checks if internal authentication is used.

Returns:

true if CARNOT services use internal authentication.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.isInternalAuthentication()

isInternalAuthorization

boolean isInternalAuthorization()
                                throws org.eclipse.stardust.common.error.WorkflowException

Checks if internal authorization is used.

Returns:

true if Carnot services use internal authorization.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.isInternalAuthorization()

getUser

User getUser()
             throws org.eclipse.stardust.common.error.WorkflowException

Retrieves information on the current user.

Returns:

the current user.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUser()

modifyLoginUser

User modifyLoginUser(String oldPassword,
                   String firstName,
                   String lastName,
                   String newPassword,
                   String eMail)
                     throws org.eclipse.stardust.common.error.WorkflowException

Modifies the current user.

Parameters:

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.

Returns:

the modified user.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the current user. Instances of ConcurrencyException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.security.InvalidPasswordException - if the new password does not match the given rules. Instances of InvalidPasswordException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.modifyLoginUser( java.lang.String oldPassword, java.lang.String firstName, java.lang.String lastName, java.lang.String newPassword, java.lang.String eMail)

modifyUser

User modifyUser(User user)
                throws org.eclipse.stardust.common.error.WorkflowException

Modifies the specified user.

Parameters:

user - the user to be modified.

Returns:

the modified user.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified one. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user or a given grant is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.security.InvalidPasswordException - if the new password does not match the given rules. Instances of InvalidPasswordException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not allowed for operation. Instances of AccessForbiddenException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.modifyUser( org.eclipse.stardust.engine.api.runtime.User user)

generatePasswordResetToken

void generatePasswordResetToken(String realm,
                              String account)
                                throws org.eclipse.stardust.common.error.WorkflowException

Generates a token which is required to perform resetPassword(String, java.util.Map, String)

Parameters:

realm - the realm ID of the user to retrieve.

account - the user account to generate the token for

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.generatePasswordResetToken( java.lang.String realm, java.lang.String account)

resetPassword

void resetPassword(String account,
                 Map properties,
                 String token)
                   throws org.eclipse.stardust.common.error.WorkflowException

Resets the password of specified user by generated password according to configured password rules. On synchronization with external repository the specified user will be created in audit trail if it is not already present there but exists in external repository. If the user exists in audit trail it will be updated on synchronization if there are any changes.

Parameters:

account - the user account to be modified.

properties - Map providing further login properties.

token - the token generated by generatePasswordResetToken(String, String)

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified one. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user or a given grant is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.resetPassword( java.lang.String account, java.util.Map properties, java.lang.String token)

modifyUser

User modifyUser(User user,
              boolean generatePassword)
                throws org.eclipse.stardust.common.error.WorkflowException

Modifies the specified user.

Parameters:

user - the user to be modified.

generatePassword - if set to true a password will be generated and send by mail to the user.

Returns:

the modified user.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified one. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user or a given grant is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.security.InvalidPasswordException - if the new password does not match the given rules. Instances of InvalidPasswordException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.AccessForbiddenException - if the current user is not allowed for operation. Instances of AccessForbiddenException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.modifyUser( org.eclipse.stardust.engine.api.runtime.User user, boolean generatePassword)

createUser

User createUser(String account,
              String firstName,
              String lastName,
              String description,
              String password,
              String eMail,
              Date validFrom,
              Date validTo)
                throws org.eclipse.stardust.common.error.WorkflowException

Creates a new user with default realm ID.

Parameters:

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.

Returns:

the newly created user.

Throws:

UserExistsException - if another user with the specified account already exists. Instances of UserExistsException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.createUser( java.lang.String account, java.lang.String firstName, java.lang.String lastName, java.lang.String description, java.lang.String password, java.lang.String eMail, java.util.Date validFrom, java.util.Date validTo)

createUser

User createUser(String realm,
              String account,
              String firstName,
              String lastName,
              String description,
              String password,
              String eMail,
              Date validFrom,
              Date validTo)
                throws org.eclipse.stardust.common.error.WorkflowException

Creates a new user.

Parameters:

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.

Returns:

the newly created user.

Throws:

UserExistsException - if another user with the specified account already exists. Instances of UserExistsException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.createUser( java.lang.String realm, java.lang.String account, java.lang.String firstName, java.lang.String lastName, java.lang.String description, java.lang.String password, java.lang.String eMail, java.util.Date validFrom, java.util.Date validTo)

getUser

User getUser(String account)
             throws org.eclipse.stardust.common.error.WorkflowException

Retrieves the user associated with the given account. On synchronization with external repository the specified user will be created in audit trail if it is not already present there but exists in external repository. If the user exists in audit trail it will be updated on synchronization if there are any changes.

Parameters:

account - the account name of the user to retrieve.

Returns:

the user.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUser(java.lang.String account)

getUser

User getUser(String realm,
           String account)
             throws org.eclipse.stardust.common.error.WorkflowException

Retrieves the user associated with the given account. On synchronization with external repository the specified user will be created in audit trail if it is not already present there but exists in external repository. If the user exists in audit trail it will be updated on synchronization if there are any changes.

Parameters:

realm - the realm ID of the user to retrieve.

account - the account name of the user to retrieve.

Returns:

the user.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUser( java.lang.String realm, java.lang.String account)

getUser

User getUser(long userOID)
             throws org.eclipse.stardust.common.error.WorkflowException

Retrieves the specified user. On synchronization the user with specified oid will be updated if this user exists in audit trail and there are any changes. If this user does not exist in audit trail but is present in external repository it will not be created in audit trail on synchronization with external repository.

Parameters:

userOID - the OID of the user to retrieve.

Returns:

the user.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified oid. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUser(long userOID)

invalidate

User invalidate(String account)
                throws org.eclipse.stardust.common.error.WorkflowException

Deprecated. Please use invalidateUser(String) instead.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.invalidate( java.lang.String account)

invalidateUser

User invalidateUser(String account)
                    throws org.eclipse.stardust.common.error.WorkflowException

Invalidates the user with the specified account.

Parameters:

account - the account name of the user to invalidate.

Returns:

the invalidated user.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.invalidateUser( java.lang.String account)

invalidateUser

User invalidateUser(String realm,
                  String account)
                    throws org.eclipse.stardust.common.error.WorkflowException

Invalidates the user with the specified account.

Parameters:

realm - the realm ID of the user to invalidate.

account - the account name of the user to invalidate.

Returns:

the invalidated user.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user with the specified account. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if the authentication is not internal. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.invalidateUser( java.lang.String realm, java.lang.String account)

createUserGroup

UserGroup createUserGroup(String id,
                        String name,
                        String description,
                        Date validFrom,
                        Date validTo)
                          throws org.eclipse.stardust.common.error.WorkflowException

Creates a new user group.

Parameters:

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.

Returns:

the newly created user group.

Throws:

UserGroupExistsException - if another user group with the specified ID already exists. Instances of UserGroupExistsException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.InvalidArgumentException - if ID is empty if name is empty if description is empty Instances of InvalidArgumentException will be wrapped inside WorkflowException.

IllegalOperationException - if operation is not allowed in this context. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.createUserGroup( java.lang.String id, java.lang.String name, java.lang.String description, java.util.Date validFrom, java.util.Date validTo)

getUserGroup

UserGroup getUserGroup(String id)
                       throws org.eclipse.stardust.common.error.WorkflowException

Retrieves the user group associated with the given ID. On synchronization with external repository the specified user group will be created in audit trail if it is not already present there but exists in external repository. If the user group exists in audit trail it will be updated on synchronization if there are any changes.

Parameters:

id - the id of the user group to retrieve.

Returns:

the user group.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user group with the specified ID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUserGroup(java.lang.String id)

getUserGroup

UserGroup getUserGroup(long oid)
                       throws org.eclipse.stardust.common.error.WorkflowException

Retrieves the specified user group. On synchronization the user group with specified oid will be updated if this user group exists in audit trail and there are any changes. If this user group does not exist in audit trail but is present in external repository it will not be created in audit trail on synchronization with external repository.

Parameters:

oid - the OID of the user group to retrieve.

Returns:

the user group.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if there is no user group with the specified OID. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUserGroup(long oid)

modifyUserGroup

UserGroup modifyUserGroup(UserGroup userGroup)
                          throws org.eclipse.stardust.common.error.WorkflowException

Modifies the specified user group.

Parameters:

userGroup - the user group to be modified.

Returns:

the modified user group.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user group. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user group is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if operation is not allowed in this context. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.modifyUserGroup( org.eclipse.stardust.engine.api.runtime.UserGroup userGroup)

invalidateUserGroup

UserGroup invalidateUserGroup(String id)
                              throws org.eclipse.stardust.common.error.WorkflowException

Invalidates the user group associated with the given ID.

Parameters:

id - the ID of the user group to be invalidated.

Returns:

the invalidated user group.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user group. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user group is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if operation is not allowed in this context. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.invalidateUserGroup( java.lang.String id)

invalidateUserGroup

UserGroup invalidateUserGroup(long oid)
                              throws org.eclipse.stardust.common.error.WorkflowException

Invalidates the specified user group.

Parameters:

oid - the OID of the user group to invalidate.

Returns:

the invalidated user group.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user group. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user group is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if operation is not allowed in this context. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.invalidateUserGroup(long oid)

createUserRealm

UserRealm createUserRealm(String id,
                        String name,
                        String description)
                          throws org.eclipse.stardust.common.error.WorkflowException

Creates a new user realm.

Parameters:

id - the user realm ID.

name - the user realm name.

description - short description.

Returns:

the newly created user realm.

Throws:

UserRealmExistsException - if another user realm with the specified ID already exists. Instances of UserRealmExistsException will be wrapped inside WorkflowException.

IllegalOperationException - if operation is not allowed in this context. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.createUserRealm( java.lang.String id, java.lang.String name, java.lang.String description)

dropUserRealm

void dropUserRealm(String id)
                   throws org.eclipse.stardust.common.error.WorkflowException

Drops the user realm associated with the given ID.

Parameters:

id - the ID of the user realm to be dropped.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the specified user realm. Instances of ConcurrencyException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.ObjectNotFoundException - if the user realm is not found. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

IllegalOperationException - if at least one user is assigned to the user realm. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.dropUserRealm(java.lang.String id)

getUserRealms

List getUserRealms()
                   throws org.eclipse.stardust.common.error.WorkflowException

Retrives all existing user realms.

Returns:

list of all existing user realms.

Throws:

org.eclipse.stardust.common.error.ConcurrencyException - if another user operates on the user realms. Instances of ConcurrencyException will be wrapped inside WorkflowException.

IllegalOperationException - if operation is not allowed in this context. Instances of IllegalOperationException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUserRealms()

addDeputy

org.eclipse.stardust.engine.api.runtime.Deputy addDeputy(UserInfo user,
                                                       UserInfo deputyUser,
                                                       DeputyOptions options)
                                                         throws org.eclipse.stardust.common.error.WorkflowException

Adds a new deputy user for a given user. This deputy user inherits for the defined time frame all grants from given user. The deputy user has to login again before the inherited grants become active. If fromDate is set to a date in the past then it will be set to new Date() (now).

Parameters:

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.

Returns:

the created deputy.

Throws:

org.eclipse.stardust.engine.api.runtime.DeputyExistsException - if the requested deputy already exists. Instances of DeputyExistsException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.InvalidArgumentException - if options.toDate is in the past Instances of InvalidArgumentException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.addDeputy( org.eclipse.stardust.engine.api.runtime.UserInfo user, org.eclipse.stardust.engine.api.runtime.UserInfo deputyUser, org.eclipse.stardust.engine.api.runtime.DeputyOptions options)

modifyDeputy

org.eclipse.stardust.engine.api.runtime.Deputy modifyDeputy(UserInfo user,
                                                          UserInfo deputyUser,
                                                          DeputyOptions options)
                                                            throws org.eclipse.stardust.common.error.WorkflowException

Modifies an existing deputy user for a given user. This deputy user inherits for the defined time frame all grants from given user. The deputy user has to login again before changes become active. If fromDate is set to a date in the past then it will be set to new Date() (now).

Parameters:

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.

• fromDate: Date from when deputy user inherits all grants of user. Not allowed to be null.
• toDate: Date when inherited grants are revoked from deputy user. If date is null then no upper limit exists.

Returns:

the created deputy.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if the requested deputy does not exists. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.InvalidArgumentException - if options.toDate is in the past Instances of InvalidArgumentException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.modifyDeputy( org.eclipse.stardust.engine.api.runtime.UserInfo user, org.eclipse.stardust.engine.api.runtime.UserInfo deputyUser, org.eclipse.stardust.engine.api.runtime.DeputyOptions options)

removeDeputy

void removeDeputy(UserInfo user,
                UserInfo deputyUser)
                  throws org.eclipse.stardust.common.error.WorkflowException

Removes an existing deputy user for a given user. All inherited grants from user are revoked from deputy user. The deputy user has to login again before changes become active.

Parameters:

user - the user for which a deputy user shall be removed.

deputyUser - the deputy user.

Throws:

org.eclipse.stardust.common.error.ObjectNotFoundException - if the requested deputy does not exists. Instances of ObjectNotFoundException will be wrapped inside WorkflowException.

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.removeDeputy( org.eclipse.stardust.engine.api.runtime.UserInfo user, org.eclipse.stardust.engine.api.runtime.UserInfo deputyUser)

getDeputies

List<org.eclipse.stardust.engine.api.runtime.Deputy> getDeputies(UserInfo user)
                                                                 throws org.eclipse.stardust.common.error.WorkflowException

Returns a list of all deputy users for the given user.

Parameters:

user - the user whose deputy users shall be returned.

Returns:

List of deputy users for given user.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getDeputies( org.eclipse.stardust.engine.api.runtime.UserInfo user)

getUsersBeingDeputyFor

List<org.eclipse.stardust.engine.api.runtime.Deputy> getUsersBeingDeputyFor(UserInfo deputyUser)
                                                                            throws org.eclipse.stardust.common.error.WorkflowException

Returns a list of all users for which the given user is an deputy user.

Parameters:

deputyUser - the deputy user whose users shall be returned.

Returns:

List of users for given deputy user.

Throws:

org.eclipse.stardust.common.error.WorkflowException - as a wrapper for org.eclipse.stardust.common.error.PublicExceptions and org.eclipse.stardust.common.error.ResourceExceptions

See Also:

UserService.getUsersBeingDeputyFor( org.eclipse.stardust.engine.api.runtime.UserInfo deputyUser)

login

void login(String userId,
         String password)
           throws org.eclipse.stardust.common.error.WorkflowException

Throws:

org.eclipse.stardust.common.error.WorkflowException

login

void login(String userId,
         String password,
         Map properties)
           throws org.eclipse.stardust.common.error.WorkflowException

Throws:

org.eclipse.stardust.common.error.WorkflowException

logout

void logout()