org.nuclos.api.provider

Class UserProvider

java.lang.Object

org.nuclos.api.provider.UserProvider

public class UserProvider
extends java.lang.Object

The UserProvider provides several methods to create users and manipulate user role data

Author:

reichama

Constructor Summary

Constructors

Constructor and Description
UserProvider()

Method Summary

Modifier and Type	Method and Description
static void	delete(NuclosUser user) This method allows to delete a specific user account.
static void	expire(NuclosUser user, java.util.Date date) This method allows to define a date on which to expire a specific user account.
static UID	grantMandator(NuclosMandator mandator, NuclosUser user) This method assigns a mandator to a given user.
static UID	grantRole(java.lang.Class<? extends NuclosRole> role, NuclosUser user) This method assigns a role to a given user.
static UID	grantRole(NuclosRole role, NuclosUser user) This method assigns a role to a given user.
static UID	insert(NuclosUser user) This method creates a Nuclos User and returns the id of the new object. A password will be generated and a default notification Email with the password will be send. A new user does not have any roles and therefore does not have any rights in Nuclos.
static UID	insert(NuclosUser user, java.lang.String password) This method creates a Nuclos User and returns the id of the new object. Sends a default notification Email with the password. A new user does not have any roles and therefore does not have any rights in Nuclos.
static UID	insert(NuclosUser user, java.lang.String password, boolean sendNotification) This method creates a Nuclos User and returns the id of the new object. A new user does not have any roles and therefore does not have any rights in Nuclos.
static UID	insert(java.lang.String username, java.lang.String firstname, java.lang.String lastname, java.lang.String email, java.lang.Boolean passwordChangeRequired) Deprecated.
static UID	insert(java.lang.String username, java.lang.String firstname, java.lang.String lastname, java.lang.String email, java.lang.String password, java.lang.Boolean passwordChangeRequired) Deprecated.
static boolean	isMandatorGranted(NuclosMandator mandator, NuclosUser user) This method checks if a mandator is granted to a given user.
static void	resetPassword(NuclosUser user, java.lang.String password, boolean sendNotification) This method resets the password for the given Nuclos User.
static void	revokeMandator(NuclosMandator mandator, NuclosUser user) This method revokes a mandator from a given user.
static void	revokeRole(java.lang.Class<? extends NuclosRole> role, NuclosUser user) This method dispossesses a user of the given role.
static void	revokeRole(NuclosRole role, NuclosUser user) This method dispossesses a user of the given role.
void	setUserService(UserService repService)
static void	update(NuclosUser user) This method updates the given Nuclos User.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UserProvider

public UserProvider()

Method Detail

setUserService

public void setUserService(UserService repService)

insert

public static UID insert(NuclosUser user)
                  throws BusinessException

This method creates a Nuclos User and returns the id of the new object.
A password will be generated and a default notification Email with the password will be send.
A new user does not have any roles and therefore does not have any rights in Nuclos. Use method addRole() and removeRole() for modifications

Parameters:

user -

Returns:

Throws:

BusinessException

insert

public static UID insert(NuclosUser user,
                         java.lang.String password)
                  throws BusinessException

This method creates a Nuclos User and returns the id of the new object.
Sends a default notification Email with the password.
A new user does not have any roles and therefore does not have any rights in Nuclos. Use method addRole() and removeRole() for modifications

Parameters:

user -

password - If no password is given, one will be generated. The same applies to the username.

Returns:

Throws:

BusinessException

insert

public static UID insert(NuclosUser user,
                         java.lang.String password,
                         boolean sendNotification)
                  throws BusinessException

This method creates a Nuclos User and returns the id of the new object.
A new user does not have any roles and therefore does not have any rights in Nuclos. Use method addRole() and removeRole() for modifications

Parameters:

user -

password - If no password is given, one will be generated. The same applies to the username.

sendNotification - Send a default notification Email with the password

Returns:

Throws:

BusinessException

insert

@Deprecated
public static UID insert(java.lang.String username,
                                     java.lang.String firstname,
                                     java.lang.String lastname,
                                     java.lang.String email,
                                     java.lang.Boolean passwordChangeRequired)
                              throws BusinessException

Deprecated.

Deprecated: Use the insert methods with NuclosUser This method creates a Nuclos User and returns the id of the new object. Password is created by Nuclos automatically. Afterwards a notification Email containing the password is sent to the user.
Note: A new user does not have any roles and therefore does not have any rights in Nuclos. Use method addRole() and removeRole() for modifications

Parameters:

username, - firstname, lastname, email, passwordChangeRequired

Returns:

UID

Throws:

BusinessException

insert

@Deprecated
public static UID insert(java.lang.String username,
                                     java.lang.String firstname,
                                     java.lang.String lastname,
                                     java.lang.String email,
                                     java.lang.String password,
                                     java.lang.Boolean passwordChangeRequired)
                              throws BusinessException

Deprecated.

Deprecated: Use the insert methods with NuclosUser This method creates a Nuclos User and returns the id of the new object. A password must be provided. Afterwards a notification Email containing the password is sent to the user.
Note: A new user does not have any roles and therefore does not have any rights in Nuclos. Use method addRole() and removeRole() for modifications

Parameters:

username, - firstname, lastname, email, password, passwordChangeRequired

Returns:

UID

Throws:

BusinessException

update

public static void update(NuclosUser user)
                   throws BusinessException

This method updates the given Nuclos User.

Parameters:

user -

Throws:

BusinessException

resetPassword

public static void resetPassword(NuclosUser user,
                                 java.lang.String password,
                                 boolean sendNotification)
                          throws BusinessException

This method resets the password for the given Nuclos User.

Parameters:

user -

password - If no password is given, one will be generated. The same applies to the username.

sendNotification - Send a default notification Email with the password

Throws:

BusinessException

grantRole

public static UID grantRole(java.lang.Class<? extends NuclosRole> role,
                            NuclosUser user)
                     throws BusinessException

This method assigns a role to a given user. The class of the user role is generated automatically and corresponds to an existing user role in Nuclos. The NuclosUser can be extracted by using QueryProvider or BusinessObjectProvider

Parameters:

role -

user -

Returns:

Throws:

BusinessException

grantRole

public static UID grantRole(NuclosRole role,
                            NuclosUser user)
                     throws BusinessException

This method assigns a role to a given user. The NuclosUser and NuclosRole can be extracted by using QueryProvider or BusinessObjectProvider Use the classes org.nuclos.system.User and org.nuclos.system.Role

Parameters:

role -

user -

Returns:

Throws:

BusinessException

grantMandator

public static UID grantMandator(NuclosMandator mandator,
                                NuclosUser user)
                         throws BusinessException

This method assigns a mandator to a given user. The class of the user mandator is generated automatically and corresponds to an existing mandator in Nuclos. The NuclosMandator can be extracted by using QueryProvider or BusinessObjectProvider

Parameters:

mandator -

user -

Returns:

Throws:

BusinessException

revokeMandator

public static void revokeMandator(NuclosMandator mandator,
                                  NuclosUser user)
                           throws BusinessException

This method revokes a mandator from a given user. The class of the user mandator is generated automatically and corresponds to an existing mandator in Nuclos. The NuclosMandator can be extracted by using QueryProvider or BusinessObjectProvider

Parameters:

mandator -

user -

Throws:

BusinessException

isMandatorGranted

public static boolean isMandatorGranted(NuclosMandator mandator,
                                        NuclosUser user)
                                 throws BusinessException

This method checks if a mandator is granted to a given user. The class of the user mandator is generated automatically and corresponds to an existing mandator in Nuclos. The NuclosMandator can be extracted by using QueryProvider or BusinessObjectProvider

Parameters:

mandator -

user -

Returns:

true if the Mandator is granted to the given user

Throws:

BusinessException

revokeRole

public static void revokeRole(java.lang.Class<? extends NuclosRole> role,
                              NuclosUser user)
                       throws BusinessException

This method dispossesses a user of the given role. The class of the user role is generated automatically and corresponds to an existing user role in Nuclos. The NuclosUser can be extracted by using QueryProvider or BusinessObjectProvider. If the user is not assigned to the role a BusinessException is thrown.

Parameters:

role -

user -

Throws:

BusinessException

revokeRole

public static void revokeRole(NuclosRole role,
                              NuclosUser user)
                       throws BusinessException

This method dispossesses a user of the given role. The class of the user role is generated automatically and corresponds to an existing user role in Nuclos. The NuclosUser and NuclosRole can be extracted by using QueryProvider or BusinessObjectProvider. Use the classes org.nuclos.system.User and org.nuclos.system.Role. If the user is not assigned to the role a BusinessException is thrown.

Parameters:

role -

user -

Throws:

BusinessException

expire

public static void expire(NuclosUser user,
                          java.util.Date date)
                   throws BusinessException

This method allows to define a date on which to expire a specific user account. The NuclosUser can be extracted by using QueryProvider or BusinessObjectProvider.

Parameters:

user -

date -

Throws:

BusinessException

delete

public static void delete(NuclosUser user)
                   throws BusinessException

This method allows to delete a specific user account. The NuclosUser can be extracted by using QueryProvider or BusinessObjectProvider.

Parameters:

user -

Throws:

BusinessException