com.saperion.jcs.modules.users.connector

Class UserManagement

java.lang.Object

com.saperion.jcs.modules.users.connector.UserManagement

public class UserManagement
extends Object

The UserManagement provides methods to search for, create, update and delete users, groups and tenants. To use the UserManagement, the saperion.properties of the Java Core Server must include the line rmi.userservice.enabled=true.

To create a new instance, use

UserManagement userManagement = new UserManagement.Config(connector).build();

where connector is an initialized and logged-on instance of the SaClassicConnector.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	UserManagement.Config Configuration for the UserManagement.

Method Summary

Methods

Modifier and Type	Method and Description
void	changePassword(int id, String oldPassword, String newPassword) Changes the user's password.
<Type extends UserManagementItem> Type	clone(Class<Type> type, Type item, int id)
<Type extends UserManagementItem> Type	create(Class<Type> type, Type item) Creates an Item.
String	decrypt(String toDecrypt) Decrypt a String in the context of the server and user.
<Type extends UserManagementItem> void	delete(Class<Type> type, int id) Deletes an Item.
String	encrypt(String toEncrypt) Encrypt a String in the context of the server and user.
<Type extends UserManagementItem> TypedFinder<Type>	find(Class<Type> type) Finds an item.
com.saperion.jcs.modules.authentication.api.AccessToken<String>	generate(long expires, TimeUnit unit, Collection<String> additionalOptions) Generates an AccessToken which can be used with the help of the UsernameAccessTokenKey to login into SAPERION.
<Type extends UserManagementItem> Descriptor<Type>	getDescriptor(Class<Type> type)
void	setPassword(int userId, String newPassword) Sets a new password to the user with the given userId.
<Type extends UserManagementItem> Type	update(Class<Type> type, Type item) Updates an Item.

Methods inherited from class java.lang.Object

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

Method Detail

getDescriptor

public <Type extends UserManagementItem> Descriptor<Type> getDescriptor(Class<Type> type)
                                                          throws AuthenticationException,
                                                                 BackendException

Throws:

AuthenticationException

BackendException

find

public <Type extends UserManagementItem> TypedFinder<Type> find(Class<Type> type)

Finds an item. The item can be a User, Group or Tenant.

Parameters:

type - type of the item to find

Returns:

TypedFinder used to define search conditions

create

public <Type extends UserManagementItem> Type create(Class<Type> type,
                                            Type item)
                                       throws AuthenticationException,
                                              BackendException

Creates an Item. The item can be a User, Group or Tenant.

Parameters:

type - type of the item to create

item - the prototype of the item providing the initial attribute-values.

Returns:

the created item

Throws:

AuthenticationException

BackendException

clone

public <Type extends UserManagementItem> Type clone(Class<Type> type,
                                           Type item,
                                           int id)
                                      throws AuthenticationException,
                                             BackendException

Throws:

AuthenticationException

BackendException

delete

public <Type extends UserManagementItem> void delete(Class<Type> type,
                                            int id)
            throws BackendException

Deletes an Item. The item can be a User, Group or Tenant.

Parameters:

type - type of the item to delete

id - the id of the item

Throws:

BackendException

update

public <Type extends UserManagementItem> Type update(Class<Type> type,
                                            Type item)
                                       throws AuthenticationException,
                                              BackendException

Updates an Item. The item can be a User, Group or Tenant.

Parameters:

type - type of the item to update

item - the new values of the item

Returns:

the updated item

Throws:

AuthenticationException

BackendException

changePassword

public void changePassword(int id,
                  String oldPassword,
                  String newPassword)
                    throws AuthenticationException,
                           BackendException

Changes the user's password.

Parameters:

oldPassword -

newPassword -

Throws:

AuthenticationException

BackendException

setPassword

@Privileged
public void setPassword(int userId,
                          String newPassword)
                 throws AuthenticationException,
                        BackendException

Sets a new password to the user with the given userId. Administrative rights required.

Parameters:

userId - the id of the user to change the password of. Must be greater than zero.

newPassword - the new password of the user. May not be null or empty.

Throws:

AuthenticationException

BackendException

generate

public com.saperion.jcs.modules.authentication.api.AccessToken<String> generate(long expires,
                                                                       TimeUnit unit,
                                                                       Collection<String> additionalOptions)
                                                                         throws AuthenticationException,
                                                                                BackendException

Generates an AccessToken which can be used with the help of the UsernameAccessTokenKey to login into SAPERION.

Parameters:

expires - count of seconds if unit == TimeUnit.SECONDS

unit - TimeUnit

additionalOptions - Values which will be encoded into the token, which must be passed with the login

Returns:

token A valid Token for your Session

Throws:

RemoteException

AuthenticationException

BackendException

encrypt

public String encrypt(String toEncrypt)
               throws BackendException

Encrypt a String in the context of the server and user. Only the user which has encrypted the string is able to decrypt it again.

Parameters:

toEncrypt - the string which should be encrypted

Returns:

the encrypted string

Throws:

BackendException - if the string couldn't be encrypted

decrypt

public String decrypt(String toDecrypt)
               throws BackendException

Decrypt a String in the context of the server and user. Only the user which has encrypted the string is able to decrypt it again.

Parameters:

toEncrypt - the encrypted string which should be decrypted

Returns:

the decrypted string

Throws:

BackendException - if the string couldn't be decrypted