com.saperion.jcs.modules.users.api

Interface UserService

All Superinterfaces:

Remote

public interface UserService
extends Remote

The remote interface for the user-management API.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RMI_USERSERVICE_APPLICATION_NAME Name of the user service application in the registry.

Method Summary

Methods

Modifier and Type	Method and Description
void	changePassword(int token, int id, String oldPassword, String newPassword)
<Type extends UserManagementItem> Type	clone(int token, int id, Type item, Class<Type> type) The original user will be retrieved by id.
<Type extends UserManagementItem> Type	create(int token, Type user, Class<Type> type) Creates a new user.
String	decrypt(int token, String toEncrypt) Decrypt a String in the context of the server and user.
<Type extends UserManagementItem> void	delete(int token, int id, Class<Type> type) Deletes an item.
String	encrypt(int token, String toEncrypt) Encrypt a String in the context of the server and user.
<Type extends UserManagementItem> Set<Type>	find(int token, SearchOptions<Type> options) Finds items by searching for the specified values in the specified fields.
com.saperion.jcs.modules.authentication.api.AccessToken<String>	generate(int token, 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(int token, Class<Type> type) Gets the descriptor of an item-type.
void	setPassword(int token, int userId, String newPassword) Sets a new password to a user.
<Type extends UserManagementItem> Type	update(int token, Type item, Class<Type> type) Updates the respective item in the Backend.

Field Detail

RMI_USERSERVICE_APPLICATION_NAME

static final String RMI_USERSERVICE_APPLICATION_NAME

Name of the user service application in the registry.

See Also:

Constant Field Values

Method Detail

create

@Privileged
<Type extends UserManagementItem> Type create(int token,
                                                       Type user,
                                                       Class<Type> type)
                                       throws RemoteException

Creates a new user.

Parameters:

token - token to identify the user who wants to create another user

user - the new user

Throws:

RemoteException - remote exception

find

<Type extends UserManagementItem> Set<Type> find(int token,
                                               SearchOptions<Type> options)
                                          throws RemoteException

Finds items by searching for the specified values in the specified fields. All fields must match the specified values (AND).

Parameters:

token - token to identify the user who wants to search for other users

fields - fields-values-map to use in search. Available fields can be obtained by getting a descriptor.

type - the type of item to search for. Can be any class that extends UserManagementItem

op -

Returns:

set of users matching the condition

Throws:

RemoteException - remote exception

getDescriptor

<Type extends UserManagementItem> Descriptor<Type> getDescriptor(int token,
                                                               Class<Type> type)
                                                          throws RemoteException

Gets the descriptor of an item-type. A descriptor is a set of meta-data describing all the attributes of a type with name, data-type and if this attribute comes from an extension-table.

Type Parameters:

Type - any class that extends UserManagementItem

Parameters:

token - token for identification

type - the type of the item. Can be any class that extends UserManagementItem

Returns:

the descriptor of all the attributes of the item-type

Throws:

RemoteException - remote exception

delete

@Privileged
<Type extends UserManagementItem> void delete(int token,
                                                       int id,
                                                       Class<Type> type)
            throws RemoteException

Deletes an item.

Type Parameters:

Type - any class that extends UserManagementItem

Parameters:

token - token for identification

id - the id of the item

type - the type of the item. Can be any class that extends UserManagementItem

Throws:

RemoteException - remote exception

update

<Type extends UserManagementItem> Type update(int token,
                                            Type item,
                                            Class<Type> type)
                                       throws RemoteException

Updates the respective item in the Backend. The item to update in the Backend is identified using the provided item's id

Type Parameters:

Type - any class that extends UserManagementItem

Parameters:

token - token for identification

item - the item which should be updated. Must contain all attributes

type - the type of the item. Can be any class that extends UserManagementItem

Returns:

the updated item

Throws:

RemoteException - remote exception

clone

<Type extends UserManagementItem> Type clone(int token,
                                           int id,
                                           Type item,
                                           Class<Type> type)
                                      throws RemoteException

The original user will be retrieved by id. The values (DisplayName, MailAdress and Description) of the item will be overwritten, by the values of the original user. All values stored in the schema extension will be loaded of the original user. If the item contains extended values, they will overwrite the original ones. If the item contains the tenant id, the user will be cloned into the specific tenant. If no tenant was specified or is the same, the new user will be added to the same groups of the original user.

Parameters:

token - session token

id - id of the original user

item - cloned item

type - Type of the item which should be created

Returns:

Throws:

RemoteException

changePassword

void changePassword(int token,
                  int id,
                  String oldPassword,
                  String newPassword)
                    throws RemoteException

Parameters:

token - A valid Token for your Session

oldPassword - old password

newPassword - new password

Throws:

RemoteException - Exception if the Password couldn't be changed

setPassword

@Privileged
void setPassword(int token,
                          int userId,
                          String newPassword)
                 throws RemoteException

Sets a new password to a user. This action requires administrative rights.

Parameters:

token - A valid Token for your Session.

userId - the id of the user to change the password for - may not be null or empty. The user must exist in the system.

newPassword - new password - may not be null or empty.

Throws:

RemoteException - Exception if the Password couldn't be changed

encrypt

String encrypt(int token,
             String toEncrypt)
               throws RemoteException

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:

token - A valid Token for your Session

toEncrypt - the string which should be encrypted

Returns:

the encrypted string

Throws:

RemoteException - if the string couldn't be encrypted

decrypt

String decrypt(int token,
             String toEncrypt)
               throws RemoteException

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:

token - A valid Token for your Session

toEncrypt - the encrypted string which should be decrypted

Returns:

the decrypted string

Throws:

RemoteException - if the string couldn't be decrypted

generate

com.saperion.jcs.modules.authentication.api.AccessToken<String> generate(int token,
                                                                       long expires,
                                                                       TimeUnit unit,
                                                                       Collection<String> additionalOptions)
                                                                         throws RemoteException

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

Parameters:

token - A valid Token for your Session

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:

Throws:

RemoteException