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:

56264

Author:

ubirkemeyer

Method Summary

void	closeSession(java.lang.String sessionId) Tracks the ending of a user session.
User	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) Creates a new user with default realm ID.
User	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) Creates a new user.
UserGroup	createUserGroup(java.lang.String id, java.lang.String name, java.lang.String description, java.util.Date validFrom, java.util.Date validTo) Creates a new user group.
UserRealm	createUserRealm(java.lang.String id, java.lang.String name, java.lang.String description) Creates a new user realm.
void	dropUserRealm(java.lang.String id) Drops the user realm associated with the given ID.
User	getUser() Retrieves information on the current user.
User	getUser(long userOID) Retrieves the specified user.
User	getUser(java.lang.String account) Retrieves the user associated with the given account.
User	getUser(java.lang.String realm, java.lang.String account) Retrieves the user associated with the given account.
UserGroup	getUserGroup(long oid) Retrieves the specified user group.
UserGroup	getUserGroup(java.lang.String id) Retrieves the user group associated with the given ID.
java.util.List	getUserRealms() Retrives all existing user realms.
User	invalidate(java.lang.String account) Deprecated. Please use invalidateUser(String) instead.
User	invalidateUser(java.lang.String account) Invalidates the user with the specified account.
User	invalidateUser(java.lang.String realm, java.lang.String account) Invalidates the user with the specified account.
UserGroup	invalidateUserGroup(long oid) Invalidates the specified user group.
UserGroup	invalidateUserGroup(java.lang.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(java.lang.String userId, java.lang.String password)
void	login(java.lang.String userId, java.lang.String password, java.util.Map properties)
void	logout()
User	modifyLoginUser(java.lang.String oldPassword, java.lang.String firstName, java.lang.String lastName, java.lang.String newPassword, java.lang.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	resetPassword(java.lang.String account, java.util.Map properties) Resets the password of specified user by generated password according to configured password rules.
java.lang.String	startSession(java.lang.String clientId) Tracks the starting of a new user session.

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

startSession

java.lang.String startSession(java.lang.String clientId)
                              throws WorkflowException

Tracks the starting of a new user session.

Parameters:

clientId - the client starting the session.

Returns:

the new session id.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.startSession( java.lang.String clientId)

closeSession

void closeSession(java.lang.String sessionId)
                  throws WorkflowException

Tracks the ending of a user session.

Parameters:

sessionId - the id of the ending session.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.closeSession( java.lang.String sessionId)

isInternalAuthentified

boolean isInternalAuthentified()
                               throws WorkflowException

Deprecated. Superseded by isInternalAuthentication().

Checks if internal authentication is used.

Returns:

true if CARNOT services use internal authentication.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.isInternalAuthentified()

isInternalAuthentication

boolean isInternalAuthentication()
                                 throws WorkflowException

Checks if internal authentication is used.

Returns:

true if CARNOT services use internal authentication.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.isInternalAuthentication()

isInternalAuthorization

boolean isInternalAuthorization()
                                throws WorkflowException

Checks if internal authorization is used.

Returns:

true if Carnot services use internal authorization.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.isInternalAuthorization()

getUser

User getUser()
             throws WorkflowException

Retrieves information on the current user.

Returns:

the current user.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.getUser()

modifyLoginUser

User modifyLoginUser(java.lang.String oldPassword,
                     java.lang.String firstName,
                     java.lang.String lastName,
                     java.lang.String newPassword,
                     java.lang.String eMail)
                     throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.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 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

resetPassword

void resetPassword(java.lang.String account,
                   java.util.Map properties)
                   throws WorkflowException

Resets the password of specified user by generated password according to configured password rules.

Parameters:

account - the user account to be modified.

properties - Map providing further login properties.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

modifyUser

User modifyUser(User user,
                boolean generatePassword)
                throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

createUser

User 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)
                throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.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(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)
                throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.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(java.lang.String account)
             throws WorkflowException

Retrieves the user associated with the given account.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.getUser(java.lang.String account)

getUser

User getUser(java.lang.String realm,
             java.lang.String account)
             throws WorkflowException

Retrieves the user associated with the given account.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

getUser

User getUser(long userOID)
             throws WorkflowException

Retrieves the specified user.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.getUser(long userOID)

invalidate

User invalidate(java.lang.String account)
                throws WorkflowException

Deprecated. Please use invalidateUser(String) instead.

Throws:

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.invalidate( java.lang.String account)

invalidateUser

User invalidateUser(java.lang.String account)
                    throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.invalidateUser( java.lang.String account)

invalidateUser

User invalidateUser(java.lang.String realm,
                    java.lang.String account)
                    throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

createUserGroup

UserGroup createUserGroup(java.lang.String id,
                          java.lang.String name,
                          java.lang.String description,
                          java.util.Date validFrom,
                          java.util.Date validTo)
                          throws 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.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.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(java.lang.String id)
                       throws WorkflowException

Retrieves the user group associated with the given ID.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.getUserGroup(java.lang.String id)

getUserGroup

UserGroup getUserGroup(long oid)
                       throws WorkflowException

Retrieves the specified user group.

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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.getUserGroup(long oid)

modifyUserGroup

UserGroup modifyUserGroup(UserGroup userGroup)
                          throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

invalidateUserGroup

UserGroup invalidateUserGroup(java.lang.String id)
                              throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.invalidateUserGroup( java.lang.String id)

invalidateUserGroup

UserGroup invalidateUserGroup(long oid)
                              throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.invalidateUserGroup(long oid)

createUserRealm

UserRealm createUserRealm(java.lang.String id,
                          java.lang.String name,
                          java.lang.String description)
                          throws 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:

org.eclipse.stardust.engine.api.runtime.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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

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

dropUserRealm

void dropUserRealm(java.lang.String id)
                   throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.dropUserRealm(java.lang.String id)

getUserRealms

java.util.List getUserRealms()
                             throws 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.

WorkflowException - as a wrapper for org.eclipse.stardust.engine.api.ejb2.PublicExceptions and org.eclipse.stardust.engine.api.ejb2.ResourceExceptions

See Also:

UserService.getUserRealms()

login

void login(java.lang.String userId,
           java.lang.String password)
           throws WorkflowException

Throws:

WorkflowException

login

void login(java.lang.String userId,
           java.lang.String password,
           java.util.Map properties)
           throws WorkflowException

Throws:

WorkflowException

logout

void logout()